User Guide/The Script Controller - Revision history

Toni at 08:37, 20 January 2016

2016-01-20T08:37:40Z

← Older revision		Revision as of 10:37, 20 January 2016
Line 2:		Line 2:
	[[File:ws_sc.png]]		[[File:ws_sc.png]]

	The '''Script Controller''' is a part of the [[~~Userg_Guide~~/Workspace\|Workspace]] GUI, displayed in the upper right part of the window, and provides a convenient way to develop and run {{STx}} scripts.		The '''Script Controller''' is a part of the [[User_Guide/Workspace\|Workspace]] GUI, displayed in the upper right part of the window, and provides a convenient way to develop and run {{STx}} scripts.

	To hide or show the {{STx}} Script Controller, use the Workspace menu item "Scripts > Show Scripts".		To hide or show the {{STx}} Script Controller, use the Workspace menu item "Scripts > Show Scripts".

Toni at 08:36, 20 January 2016

2016-01-20T08:36:14Z

← Older revision		Revision as of 10:36, 20 January 2016
Line 2:		Line 2:
	[[File:ws_sc.png]]		[[File:ws_sc.png]]

	The '''Script Controller''' is a ~~subdialog~~ of the ~~{{STX}}~~ Workspace GUI, displayed in the upper right part of the window, and provides a convenient way to develop and run {{STx}} scripts.		The '''Script Controller''' is a part of the [[Userg_Guide/Workspace\|Workspace]] GUI, displayed in the upper right part of the window, and provides a convenient way to develop and run {{STx}} scripts.

	To hide or show the {{STx}} Script Controller, use the Workspace menu item "Scripts > Show Scripts".		To hide or show the {{STx}} Script Controller, use the Workspace menu item "Scripts > Show Scripts".
Line 21:		Line 21:
	;Console (button): Press this button to start the [[User_Guide/STX_Console\|{{STX}} Console application]], which provides a command line interface to an {{STX}} shell.		;Console (button): Press this button to start the [[User_Guide/STX_Console\|{{STX}} Console application]], which provides a command line interface to an {{STX}} shell.

	:<u>'''Four steps to run a script'''</u>:		<u>'''Four steps to run a script'''</u>:
	:# Select a script file by clicking the "Script File" button.		:# Select a script file by clicking the "Script File" button.
	:# Choose the macro to be run from the "Macro" combobox.		:# Choose the macro to be run from the "Macro" combobox.
Line 33:		Line 33:
	;New (button): Press this button to create a new script file via the standard new-file dialog. If a new file is created, it is also selected and opened in the external text editor.		;New (button): Press this button to create a new script file via the standard new-file dialog. If a new file is created, it is also selected and opened in the external text editor.

	:* <u>Content of a new script file created via the '''New'''-button</u>:		<u>Content of a new script file created via the '''New'''-button</u>:
	//{{4.2.14 (8805)}{2016.01.19 10.32.20} - automatically created version information - do not change or delete this line}		//{{4.2.14 (8805)}{2016.01.19 10.32.20} - automatically created version information - do not change or delete this line}

Toni at 15:03, 19 January 2016

2016-01-19T15:03:35Z

← Older revision		Revision as of 17:03, 19 January 2016
Line 64:		Line 64:

	;See also:		;See also:
	[[Programmer_Guide\|Programmer Guide]]		[[Programmer_Guide\|Programmer Guide]], [[User_Guide/Toolboxes\|Toolboxes]]

	[[Category:User Guide]][[Category:Workspace]][[Category:Scripts]]		[[Category:User Guide]][[Category:Workspace]][[Category:Scripts]]

Toni at 15:00, 19 January 2016

2016-01-19T15:00:37Z

← Older revision		Revision as of 17:00, 19 January 2016
Line 61:		Line 61:
	** Select the script file as the current file of the Script Controller		** Select the script file as the current file of the Script Controller
	** Edit the file ''filename''.'''sts'''		** Edit the file ''filename''.'''sts'''


	;See also:		;See also:
	[[Programmer_Guide]]		[[Programmer_Guide\|Programmer Guide]]

	[[Category:User Guide]][[Category:Workspace]][[Category:Scripts]]		[[Category:User Guide]][[Category:Workspace]][[Category:Scripts]]

Toni at 14:58, 19 January 2016

2016-01-19T14:58:57Z

Toni at 14:52, 19 January 2016

2016-01-19T14:52:43Z

Show changes

Toni at 10:47, 19 January 2016

2016-01-19T10:47:15Z

← Older revision		Revision as of 12:47, 19 January 2016
Line 20:		Line 20:
	//{{4.2.14 (8805)}{2016.01.19 10.32.20} - automatically created version information - do not change or delete this line}		//{{4.2.14 (8805)}{2016.01.19 10.32.20} - automatically created version information - do not change or delete this line}

	[Macro testfile ~~args~~: #arg1 #arg2 #arg3 #arg4 #arg5 #rest]		[Macro testfile read: #arg1 #arg2 #arg3 #arg4 #arg5 #rest]
	//>> begin of script - enter your source code below this line		//>> begin of script - enter your source code below this line

Line 28:		Line 28:
	exit 1 int 0		exit 1 int 0

	:		;Arguments: In this field the arguments to be passed to the selected macro can be provided. All entered arguments are stored in a history.


	;Edit - [[File:Resource_script_edit.png]]: Open the selected script file in the text editor.		;Edit - [[File:Resource_script_edit.png]]: Open the selected script file in the text editor.
Line 36:		Line 35:

	;Run - [[File:Resource_script_run.png]]: The script file is loaded into the BScript runtime environment and the macro selected by the combobox '''Macro''' is executed. See the options '''Debug''' and '''Console''' for the selection of special run modes of a script.		;Run - [[File:Resource_script_run.png]]: The script file is loaded into the BScript runtime environment and the macro selected by the combobox '''Macro''' is executed. See the options '''Debug''' and '''Console''' for the selection of special run modes of a script.

	;[[User_Guide/STX_Debugger\|Debug]]: Check this option to run the selected macro in the [[User_Guide/STX_Debugger\|debug mode]] and uncheck it, to execute the macro in without debugging. If the dubug mode is enabled, the Break-mode of the debugger is entered before the execution of the macro begins.

	;[[User_Guide/STX_Console\|Console]]: Check this option to run the script file in the [[User_Guide/STX_Console\|console mode]]. If the '''Run''' button is pressed, the script file is loaded and the console is started. This mode can be useful, e.g. to test some macros during the development of a complex script package or to load a script file that implements a set of special commands to be used in the command line.		;[] [[User_Guide/STX_Debugger\|Debug]]: Check this option to run the selected macro in the [[User_Guide/STX_Debugger\|debug mode]] and uncheck it, to execute the macro in without debugging. If the dubug mode is enabled, the Break-mode of the debugger is entered before the execution of the macro begins.

			;[] [[User_Guide/STX_Console\|Console]]: Check this option to run the script file in the [[User_Guide/STX_Console\|console mode]]. If the '''Run''' button is pressed, the script file is loaded and the console is started. This mode can be useful, e.g. to test some macros during the development of a complex script package or to load a script file that implements a set of special commands to be used in the command line.

			;[[User_Guide/STX_Console\|Console]]: If you press the Console button, the Console application is started. The Console is a command line interface to an {{STX}} shell.

			The Console can:
			# process commands on a line by line basis
			# process multiple commands pasted from the clipboard
			# maintain a command history (up/down keys)

	===Running a script===		===Running a script===

Toni at 10:37, 19 January 2016

2016-01-19T10:37:51Z

← Older revision		Revision as of 12:37, 19 January 2016
Line 10:		Line 10:
	===Dialog Elements===		===Dialog Elements===

	;~~ScriptFile~~: Press this button to open the standard open-file dialog to select a script file. The full path of the selected file is displayed as caption of the button.		;Script File: Press this button to open the standard open-file dialog to select a script file. The full path of the selected file is displayed as caption of the button.

			;Macro: This combo box contains a list of all visible macros (or executeable code blocks) of a script file. Use this list to select the macro to be executed when the '''Run''' button is pressed.
			:* To control the visibility of a code block, the scope-keywords ('''global''', '''local''', ...) or the special section '''[Scripts]''' can be used. A detailed description can be found in the section [[Programmer_Guide\|Source code]].

	;New: Press this button to create a new script file via the standard new-file dialog. If a new file is created, it is also selected and opened in the external text editor.		;New: Press this button to create a new script file via the standard new-file dialog. If a new file is created, it is also selected and opened in the external text editor.
	:Content of a new script file created via the new-button:
			:* <u>Content of a new script file created via the new-button</u>:
	//{{4.2.14 (8805)}{2016.01.19 10.32.20} - automatically created version information - do not change or delete this line}		//{{4.2.14 (8805)}{2016.01.19 10.32.20} - automatically created version information - do not change or delete this line}

Line 23:		Line 27:
	// ShowLogOnExit := 0 // close bscript log-window automatically (no wait)		// ShowLogOnExit := 0 // close bscript log-window automatically (no wait)
	exit 1 int 0		exit 1 int 0

			:


	;Edit - [[File:Resource_script_edit.png]]: Open the selected script file in the text editor.		;Edit - [[File:Resource_script_edit.png]]: Open the selected script file in the text editor.

Toni at 10:12, 19 January 2016

2016-01-19T10:12:13Z

← Older revision		Revision as of 12:12, 19 January 2016
Line 2:		Line 2:
	[[File:ws_sc.png]]		[[File:ws_sc.png]]

	The '''Script Controller''' is a subdialog of the {{STX}} Workspace GUI, displayed in the upper right part of the window, and provides a convenient way to run {{STx}} scripts.		The '''Script Controller''' is a subdialog of the {{STX}} Workspace GUI, displayed in the upper right part of the window, and provides a convenient way to develop and run {{STx}} scripts.

	To hide or show the {{STx}} Script Controller, use the Workspace menu item ~~'''~~Scripts > Show Scripts~~'''~~.		To hide or show the {{STx}} Script Controller, use the Workspace menu item "Scripts > Show Scripts".

	;Note: The [[~~Detailview_Find_Select~~\|Find / Select dialog]] of the detail view is displayed in the same part of the GUI. Only one of both dialogs can be visible.		Note: The [[User_Guide/Workspace_/Detail_Find_Select\|Find / Select dialog]] of the detail view is displayed in the same part of the GUI as the Script Controller. Only one of both dialogs can be visible.

	===Dialog Elements===		===Dialog Elements===
Line 13:		Line 13:

	;New: Press this button to create a new script file via the standard new-file dialog. If a new file is created, it is also selected and opened in the external text editor.		;New: Press this button to create a new script file via the standard new-file dialog. If a new file is created, it is also selected and opened in the external text editor.

	:Content of a new script file created via the new-button:		:Content of a new script file created via the new-button:
	//{{4.2.14 (8805)}{2016.01.19 10.32.20} - automatically created version information - do not change or delete this line}		//{{4.2.14 (8805)}{2016.01.19 10.32.20} - automatically created version information - do not change or delete this line}
Line 24:		Line 23:
	// ShowLogOnExit := 0 // close bscript log-window automatically (no wait)		// ShowLogOnExit := 0 // close bscript log-window automatically (no wait)
	exit 1 int 0		exit 1 int 0

			;Edit - [[File:Resource_script_edit.png]]: Open the selected script file in the text editor.

	;[[File:~~Resource_script_edit~~.png]]: ~~'''Edit'''~~ script file.		;Test - [[File:Resource_script_test.png]]: Use this button to test if the script file can be loaded (syntax check) and if it is compatible with your {{STX}} release. Note: If the script file can not be loaded, a short error message is displayed in a dialog box and detailed error messages are written to the [[User_Guide/Log_Window\|{{STX}} log window]].

	;[[File:Resource_script_test.png]]: '''Test''' script file. Use this button to test if the script file can be loaded (syntax check) and if it is compatible with your {{STX}} release. Note: If the script file can not be loaded, a short error message is displayed in a dialog box and detailed error messages are written to the [[User_Guide/Log_Window\|{{STX}} log window]].		;Run - [[File:Resource_script_run.png]]: The script file is loaded into the BScript runtime environment and the macro selected by the combobox '''Macro''' is executed. See the options '''Debug''' and '''Console''' for the selection of special run modes of a script.

	;[[File:Resource_script_run.png]]: ~~'''Run''' the selected macro of the script file.~~ The script file is loaded into the BScript runtime environment and the macro selected by the combobox '''Macro''' is executed. If the ~~checkbox~~ '''Debug''' ~~is checked, the debug mode is entered and~~ and the ~~[[User_Guide/STX_Debugger\|~~script ~~debugger]] is shown before the execution begins~~.		;[[User_Guide/STX_Debugger\|Debug]]: Check this option to run the selected macro in the [[User_Guide/STX_Debugger\|debug mode]] and uncheck it, to execute the macro in without debugging. If the dubug mode is enabled, the Break-mode of the debugger is entered before the execution of the macro begins.

	;[[User_Guide/STX_Debugger\|Debug]]: Check this option to run the selected macro in the ~~'''~~debug mode~~'''~~ and uncheck it, to execute the macro in without debugging.

	;[[User_Guide/STX_Console\|Console]]: Check this option to run the script file in the ~~'''~~console mode~~'''~~. If the '''Run''' button is pressed, the script file is loaded and the console is started. This mode can be useful, e.g. to test some macros during the development of a complex script package or to load a script file that implements a set of special commands to be used in the command line.		;[[User_Guide/STX_Console\|Console]]: Check this option to run the script file in the [[User_Guide/STX_Console\|console mode]]. If the '''Run''' button is pressed, the script file is loaded and the console is started. This mode can be useful, e.g. to test some macros during the development of a complex script package or to load a script file that implements a set of special commands to be used in the command line.

	===Running a script===		===Running a script===

Toni at 09:45, 19 January 2016

2016-01-19T09:45:48Z

@@ Line 10: / Line 10: @@
 ===Dialog Elements===
-;ScriptFile:
+;ScriptFile: Press this button to open the standard open-file dialog to select a script file. The full path of the selected file is displayed as caption of the button.
 ===Running a script===

← Older revision		Revision as of 16:58, 19 January 2016
Line 10:		Line 10:
	===Dialog Elements to Select and Run a Script===		===Dialog Elements to Select and Run a Script===

	;Script File: Press this button to open the standard open-file dialog to select a script file. The full path of the selected file is displayed as caption of the button.		;Script File (button): Press this button to open the standard open-file dialog to select a script file. The full path of the selected file is displayed as caption of the button.
	:* Note: To select a script file, you can also drop a file with the standard {{STX}} script file type '''.sts''' on the workspace window, and than press the button '''Select''' in the displayed popup dialog box.		:* Note: To select a script file, you can also drop a file with the standard {{STX}} script file type '''.sts''' on the workspace window, and than press the button '''Select''' in the displayed popup dialog box.

	;Macro: This combo box contains a list of all visible macros (or executeable code sections) of a script file. Use this list to select the macro to be executed when the '''Run''' button is pressed.		;Macro (combo box): This combo box contains a list of all visible macros (or executeable code sections) of a script file. Use this list to select the macro to be executed when the '''Run''' button is pressed.

	;Arguments: In this field you can provide the arguments for the selected macro. The arguments entered here, are stored in a history.		;Arguments (combo box): In this field you can provide the arguments for the selected macro. The arguments entered here, are stored in a history.

	;Run - [[File:Resource_script_run.png]]: The script file is loaded into the BScript runtime environment and the macro selected by the combobox '''Macro''' is executed. See the options '''Debug''' and '''Console''' for the selection of special run modes of a script.		;Run - [[File:Resource_script_run.png]] (button): The script file is loaded into the BScript runtime environment and the macro selected by the combobox '''Macro''' is executed. See the options '''Debug''' and '''Console''' for the selection of special run modes of a script.

	;Console (button): Press this button to start the [[User_Guide/STX_Console\|{{STX}} Console application]], which provides a command line interface to an {{STX}} shell.		;Console (button): Press this button to start the [[User_Guide/STX_Console\|{{STX}} Console application]], which provides a command line interface to an {{STX}} shell.
Line 31:		Line 31:
	===Dialog Elements for Script Development===		===Dialog Elements for Script Development===

	;New: Press this button to create a new script file via the standard new-file dialog. If a new file is created, it is also selected and opened in the external text editor.		;New (button): Press this button to create a new script file via the standard new-file dialog. If a new file is created, it is also selected and opened in the external text editor.

	:* <u>Content of a new script file created via the '''New'''-button</u>:		:* <u>Content of a new script file created via the '''New'''-button</u>:
Line 44:		Line 44:
	exit 1 int 0		exit 1 int 0

	;Edit - [[File:Resource_script_edit.png]]: Open the selected script file in the text editor.		;Edit - [[File:Resource_script_edit.png]] (button): Open the selected script file in the text editor.

	;Test - [[File:Resource_script_test.png]]: Use this button to test if the script file can be loaded (syntax check) and if it is compatible with your {{STX}} release. Note: If the script file can not be loaded, a short error message is displayed in a dialog box and detailed error messages are written to the [[User_Guide/Log_Window\|{{STX}} log window]].		;Test - [[File:Resource_script_test.png]] (button): Use this button to test if the script file can be loaded (syntax check) and if it is compatible with your {{STX}} release. Note: If the script file can not be loaded, a short error message is displayed in a dialog box and detailed error messages are written to the [[User_Guide/Log_Window\|{{STX}} log window]].

	;[[User_Guide/STX_Debugger\|Debug]] (check box): Check this option to run the selected macro in the [[User_Guide/STX_Debugger\|debug mode]] and uncheck it, to execute the macro without debugging. If the dubug mode is enabled, the Break-mode of the debugger is entered before the execution of the macro begins.		;[[User_Guide/STX_Debugger\|Debug]] (check box): Check this option to run the selected macro in the [[User_Guide/STX_Debugger\|debug mode]] and uncheck it, to execute the macro without debugging. If the dubug mode is enabled, the Break-mode of the debugger is entered before the execution of the macro begins.
Line 54:		Line 54:
	===Other ways to select / run Scripts===		===Other ways to select / run Scripts===

	* You can add scripts and store their configuration and arguments in the "Application & Setup Tree" under the entry ~~[[User Guide/Workspace/Scripts\|~~Scripts]]. If a script is ~~added~~ to the workspace, it can be started easily with a double-click.		* You can add scripts and store their configuration and arguments in the [[User_Guide/Workspace/Application_and_Setup_Tree\|Application & Setup Tree]] under the entry '''Scripts'''. If a script is linked to the workspace, it can be started easily with a double-click.
	* Start the [[User_Guide/BScript_Console\|{{STx}} Console]] to load and run scripts via the command line.		* Start the [[User_Guide/BScript_Console\|{{STx}} Console]] to load and run scripts via the command line.
	* If a script file ''filename''.'''sts''' is dropped on the workspace, a dialog comes up to select a function for the script file:		* If a script file ''filename''.'''sts''' is dropped on the workspace, a dialog comes up to select a function for the script file: