UI Style Guide ARexx - Revision history

Steven Solie: /* Returning Data */

2014-05-02T16:25:00Z

Returning Data

← Older revision		Revision as of 16:25, 2 May 2014
Line 103:		Line 103:
	"*/".		"*/".

			<syntaxhighlight language="rexx">
	<pre>
	/* Example ARexx script */		/* Example ARexx script */

	OPTIONS RESULTS		OPTIONS RESULTS

	'GETLINE' /* Command telling the application to		'GETLINE' /* Command telling the application to
	return the line of text under the		return the line of text under the
	cursor. */		cursor. */

	line=RESULT /* Set the variable called "line" equal		line=RESULT /* Set the variable called "line" equal
	to ARexx's special variable called		to ARexx's special variable called
	"RESULT". */		"RESULT". */
			</syntaxhighlight>
	</pre>

	If the VAR (simple variable) or STEM (complex variable) switches are used, information should be placed into the named variable. For instance:		If the VAR (simple variable) or STEM (complex variable) switches are used, information should be placed into the named variable. For instance:

			<syntaxhighlight language="rexx">
	<pre>
	MYCOMMAND STEM comresult		MYCOMMAND STEM comresult
			</syntaxhighlight>
	</pre>

	This would place the return result in the variable named ''comresult''. The VAR and STEM switches make it easier for applications from different vendors to operate on the same data under ARexx.		This would place the return result in the variable named ''comresult''. The VAR and STEM switches make it easier for applications from different vendors to operate on the same data under ARexx.
Line 137:		Line 137:
	<pre>		<pre>
	"Letter to John Doe" "Notes on Standards" "Addresses of the Stars"		"Letter to John Doe" "Notes on Standards" "Addresses of the Stars"
	<pre>		</pre>

	When the command returns multiple records, it should allow the user to specify a stem variable to place the contents in. For example, a command that would return the names of the loaded documents in a text editor would normally return information in the RESULT field, but if the user chooses to place the information in a stem variable, he could specify:		When the command returns multiple records, it should allow the user to specify a stem variable to place the contents in. For example, a command that would return the names of the loaded documents in a text editor would normally return information in the RESULT field, but if the user chooses to place the information in a stem variable, he could specify:

			<syntaxhighlight language="rexx">
	<pre>
	GETATTRS DOCUMENTS STEM DocList.		GETATTRS DOCUMENTS STEM DocList.
			</syntaxhighlight>
	</pre>

	which would return:		which would return:

Steven Solie: /* Standards for ARexx */

2014-04-21T18:57:36Z

Standards for ARexx

← Older revision		Revision as of 18:57, 21 April 2014
Line 44:		Line 44:
	Your program should support at least a minimal subset of ARexx commands. It increases the power of your program, and as a powerful and seamless standard, it's good for the platform as a whole. Applications that don't support ARexx decrease the overall power and lure of the Amiga. Average users who decide to learn ARexx will almost certainly experience frustration when they run into the brick wall of the program that doesn't support ARexx.		Your program should support at least a minimal subset of ARexx commands. It increases the power of your program, and as a powerful and seamless standard, it's good for the platform as a whole. Applications that don't support ARexx decrease the overall power and lure of the Amiga. Average users who decide to learn ARexx will almost certainly experience frustration when they run into the brick wall of the program that doesn't support ARexx.

	Once you learn how, incorporating ARexx support into your application requires about as much programming effort as supporting menus - without having to deal with the graphics. This chapter discusses which ARexx commands to support and the style in which they should be supported. For more details on the ARexx language itself refer to the ~~Release~~ ~~2 Users~~ Manual ~~''Using the System Software''~~.		Once you learn how, incorporating ARexx support into your application requires about as much programming effort as supporting menus - without having to deal with the graphics. This chapter discusses which ARexx commands to support and the style in which they should be supported. For more details on the ARexx language itself refer to the [[AmigaOS_Manual:_ARexx\|AmigaOS ARexx Manual]].

	=== General Description and Guidelines ===		=== General Description and Guidelines ===

Alexandre Balaban: Categorized into User Interface Style Guide

2013-04-26T09:27:53Z

Categorized into User Interface Style Guide

← Older revision		Revision as of 09:27, 26 April 2013
Line 1:		Line 1:
			[[Category:User Interface Style Guide]]
	== ARexx ==		== ARexx ==

Steven Solie: /* Window-Related Commands */

2013-04-24T21:34:29Z

Window-Related Commands

← Older revision		Revision as of 21:34, 24 April 2013
Line 316:		Line 316:

	; CHANGEWINDOW LEFTEDGE/N,TOPEDGE/N,WIDTH/N,HEIGHT/N		; CHANGEWINDOW LEFTEDGE/N,TOPEDGE/N,WIDTH/N,HEIGHT/N
	: This command is similar to MOVEWINDOW and SIZEWINDOW but the application should move and size the window as one operation. This is important to the user because moving a window to a new size and position can require as many as three commands, depending on the original		: This command is similar to MOVEWINDOW and SIZEWINDOW but the application should move and size the window as one operation. This is important to the user because moving a window to a new size and position can require as many as three commands, depending on the original position and size as well as the target position and size.
	position and size as well as the target position and size.

	; WINDOWTOFRONT ,		; WINDOWTOFRONT ,

Steven Solie: /* Other Standard Commands */

2013-04-24T21:34:05Z

Other Standard Commands

← Older revision		Revision as of 21:34, 24 April 2013
Line 233:		Line 233:

	; HELP COMMAND,PROMPT/S		; HELP COMMAND,PROMPT/S
	: HELP provides access to information about your application. Information about things such as the supported functions and parameters required for		: HELP provides access to information about your application. Information about things such as the supported functions and parameters required for functions should be readily available. When triggered from a non-graphical user interface, HELP should present the user with a text list of all the commands that the application supports. COMMAND presents the user with the list of options available for that command. PROMPT activates a graphical help system.
	functions should be readily available. When triggered from a non-graphical user interface, HELP should present the user with a text list of all the commands that the application supports. COMMAND presents the user with the list of options available for that command. PROMPT activates a graphical help system.

	; FAULT /N		; FAULT /N

Steven Solie: /* Standard ARexx Commands */

2013-04-24T21:33:47Z

Standard ARexx Commands

← Older revision		Revision as of 21:33, 24 April 2013
Line 188:		Line 188:
	The commands are presented here in the same style as Shell commands discussed in Chapter 8. You should also use this style when you implement ARexx.		The commands are presented here in the same style as Shell commands discussed in Chapter 8. You should also use this style when you implement ARexx.

		⚫	{{Note\|text=Your application should support at least these 15 ARexx commands.}}
	{\| class="wikitable"
⚫	\| Your application should support at least these 15 ARexx commands.
	\|}

	=== Project-Related Commands ===		=== Project-Related Commands ===

Steven Solie: /* Command Shell */

2013-04-24T21:29:37Z

Command Shell

← Older revision		Revision as of 21:29, 24 April 2013
Line 172:		Line 172:
	Your application should allow the user to open a console window or command shell within your application's environment. There are two possible ways of handling this: you can provide a window that looks like a basic Shell window or one that looks like Workbench's Execute Command window.		Your application should allow the user to open a console window or command shell within your application's environment. There are two possible ways of handling this: you can provide a window that looks like a basic Shell window or one that looks like Workbench's Execute Command window.

	[[File:SG9-1.png\|frame\|center\|~~Fig 9.1:~~ Workbench's Execute Command window]]		[[File:SG9-1.png\|frame\|center\|Workbench's Execute Command window]]

	[[File:SG9-2.png\|frame\|center\|~~Fig 9.2:~~ A sample ARexx command shell]]		[[File:SG9-2.png\|frame\|center\|A sample ARexx command shell]]

	Commands entered into this window would allow direct control of your application.		Commands entered into this window would allow direct control of your application.

Steven Solie: /* Command Shell */

2012-09-03T18:04:33Z

Command Shell

← Older revision		Revision as of 18:04, 3 September 2012
Line 172:		Line 172:
	Your application should allow the user to open a console window or command shell within your application's environment. There are two possible ways of handling this: you can provide a window that looks like a basic Shell window or one that looks like Workbench's Execute Command window.		Your application should allow the user to open a console window or command shell within your application's environment. There are two possible ways of handling this: you can provide a window that looks like a basic Shell window or one that looks like Workbench's Execute Command window.

	Fig 9.1: Workbench's Execute Command window.		[[File:SG9-1.png\|frame\|center\|Fig 9.1: Workbench's Execute Command window]]

	[[File:SG9-2.png\|frame\|center\|Fig 9.2: A sample ARexx command shell]]		[[File:SG9-2.png\|frame\|center\|Fig 9.2: A sample ARexx command shell]]

Steven Solie: /* Benefits of ARexx */

2012-09-03T18:02:31Z

Benefits of ARexx

← Older revision		Revision as of 18:02, 3 September 2012
Line 23:		Line 23:
	ARexx has another role, too. It is the system module that allows application software from different vendors to inter-operate, share data and communicate with one another in a multitasking environment. For instance, with ARexx a communications package could be set up to download data from a financial bulletin board and pass the data to a separate spreadsheet application for further analysis.		ARexx has another role, too. It is the system module that allows application software from different vendors to inter-operate, share data and communicate with one another in a multitasking environment. For instance, with ARexx a communications package could be set up to download data from a financial bulletin board and pass the data to a separate spreadsheet application for further analysis.

		⚫	{{Note\|text=ARexx is based on REXX, variants of which are used across many platforms.}}
	{\| class="wikitable"
⚫	\| ARexx is based on REXX, variants of which are used across many platforms.
	\|}

	When told about ARexx, most people imagine its use by power users - but the benefits of ARexx aren't strictly limited to power users. In a corporate environment, an information manager could take off-the-shelf software, throw in a mix of macros, batch commands and IPC, and come up with a system that truly meets the needs of his office. Once set up, the new, customized program could be used even by novices.		When told about ARexx, most people imagine its use by power users - but the benefits of ARexx aren't strictly limited to power users. In a corporate environment, an information manager could take off-the-shelf software, throw in a mix of macros, batch commands and IPC, and come up with a system that truly meets the needs of his office. Once set up, the new, customized program could be used even by novices.

Steven Solie at 20:03, 1 September 2012

2012-09-01T20:03:37Z

← Older revision		Revision as of 20:03, 1 September 2012
Line 1:		Line 1:
			== ARexx ==

	Previous chapters covered aspects of the GUI and the Shell. The third built-in Amiga interface is ARexx.		Previous chapters covered aspects of the GUI and the Shell. The third built-in Amiga interface is ARexx.

Line 11:		Line 13:
	For example, many communications programs allow the user to set up a macro that will dial the phone number of a host system, log into it, check for messages and download those messages for later reading. The macro allows the user to do automatically what is usually done interactively.		For example, many communications programs allow the user to set up a macro that will dial the phone number of a host system, log into it, check for messages and download those messages for later reading. The macro allows the user to do automatically what is usually done interactively.

		⚫	{{Note\|text=ARexx provides Amiga users with a standard macro language.}}
	{\| class="wikitable"
⚫	\| ARexx provides Amiga users with a standard macro language.
	\|}

	=== Benefits of ARexx ===		=== Benefits of ARexx ===
Line 176:		Line 176:
	Fig 9.1: Workbench's Execute Command window.		Fig 9.1: Workbench's Execute Command window.

	Fig 9.2: A sample ARexx command shell.		[[File:SG9-2.png\|frame\|center\|Fig 9.2: A sample ARexx command shell]]

	Commands entered into this window would allow direct control of your application.		Commands entered into this window would allow direct control of your application.