Diagram Conventions - Revision history

Laura: /* Uppercase VS Lowercase Letters */

2014-04-18T18:48:32Z

Uppercase VS Lowercase Letters

← Older revision		Revision as of 18:48, 18 April 2014
Line 1:		Line 1:
	~~===Uppercase VS Lowercase Letters===~~
	Throughout this reference material, uppercase letters are generally used to denote the names of commands, statements, functions and other specifications. Uppercase is also used with the names of most files or programs except where the file or program being referred to is exclusively used with the Unix or Linux operating system. Regardless of your operating system, Business Rules accepts both uppercase and lowercase letters as identical except when they are used in a literal string. It defaults to displaying all but literal strings in uppercase (see the BRConfig.sys [[STYLE]] specification to change this default).


	===Diagram Rules===		===Diagram Rules===
	;Syntax diagrams show the optional and required parameters for statements, commands and specifications. The following LINPUT statement diagram will serve as an example for the set of rules, which applies to all Business Rules syntax diagrams:<br>		;Syntax diagrams show the optional and required parameters for statements, commands and specifications. The following LINPUT statement diagram will serve as an example for the set of rules, which applies to all Business Rules syntax diagrams:<br>

Laura: /* Diagram Rules */

2014-04-18T18:47:06Z

Diagram Rules

← Older revision		Revision as of 18:47, 18 April 2014
Line 11:		Line 11:

	;Uppercase parameters are exact keywords		;Uppercase parameters are exact keywords
	Items in uppercase letters (LINPUT) are keywords and must be typed in either ~~letter-for-letter~~ as they appear or with an allowable abbreviation (see [[keyword abbreviation]]s for a complete list).		Items in uppercase letters (LINPUT) are keywords and must be typed in either exactly as they appear or with an allowable abbreviation (see [[keyword abbreviation]]s for a complete list).

	;Lowercase parameters must be replaced		;Lowercase parameters must be replaced
	Items in lowercase letters (string-var) are specifically defined in the Parameters section following each syntax diagram. When specified, these parameters must be replaced with a specification that fits the requirements of the definition. Descriptions of these parameters can be found in the [[Definitions]] ~~and~~ [[All Parameters]] sections.		Items in lowercase letters (string-var) are specifically defined in the Parameters section following each syntax diagram. When specified, these parameters must be replaced with a specification that fits the requirements of the definition. Descriptions of these parameters can be found in the [[Definitions]] or [[All Parameters]] sections.

	;Include special characters		;Include special characters
Line 22:		Line 22:
	Items that appear on the main line of the diagram (string-var) must be included in the written statement. If you can follow the line of the diagram to the end without passing a parameter, it is optional.		Items that appear on the main line of the diagram (string-var) must be included in the written statement. If you can follow the line of the diagram to the end without passing a parameter, it is optional.

	;~~Items above or below the line are optional~~		;Items with a returning dotted line may be repeated.
	~~Items that appear above or below the main line of the diagram (error-cond line-ref) are optional.~~		When multiple items are used, they must be separated with the punctuation mark (usually a comma or semi-colon).

	~~;Dotted line items with an arrow can be repeated~~
	Items with a returning dotted line may be repeated. When multiple items are ~~indicated~~, they must be separated with the punctuation mark (usually a comma or semi-colon).

	;Defaults are listed in angle brackets		;Defaults are listed in angle brackets
Line 32:		Line 29:

	;Insertable diagrams		;Insertable diagrams
	Some of Business Rules commands and statements are so powerful that it is difficult to show all the available options in a single diagram. In cases ~~such as this~~, a section of the diagram ~~may be~~ shown separately as an "insertable syntax". An example of this usage is the "[[helpstring]]" parameter that appears in several diagrams, including [[INPUT FIELDS]]. Another example is the "[[share spec]]" parameter (shown below). Insertable diagrams do not have start and end circles to prevent them from being confused with full syntax diagrams.<br>		Some of Business Rules commands and statements are so powerful that it is difficult to show all the available options in a single diagram. In such cases, a section of the diagram is shown separately as an "insertable syntax". An example of this usage is the "[[helpstring]]" parameter that appears in several diagrams, including [[INPUT FIELDS]]. Another example is the "[[share spec]]" parameter (shown below). Insertable diagrams do not have start and end circles to prevent them from being confused with full syntax diagrams.<br>
	[[Image:sharespec.png]]		[[Image:sharespec.png]]

Laura: /* Diagram Rules */

2014-04-17T00:10:33Z

Diagram Rules

← Older revision		Revision as of 00:10, 17 April 2014
Line 28:		Line 28:
	Items with a returning dotted line may be repeated. When multiple items are indicated, they must be separated with the punctuation mark (usually a comma or semi-colon).		Items with a returning dotted line may be repeated. When multiple items are indicated, they must be separated with the punctuation mark (usually a comma or semi-colon).

	;Defaults are listed in brackets		;Defaults are listed in angle brackets
	Numbers that are enclosed in brackets (<1>) identify the default action or value, which is taken when nothing is specified for an optional parameter. These numbers correlate to the "Defaults" section below each diagram.		Numbers that are enclosed in brackets (<1>) identify the default action or value, which is taken when nothing is specified for an optional parameter. These numbers correlate to the "Defaults" section below each diagram.

Laura at 21:22, 15 October 2013

2013-10-15T21:22:24Z

← Older revision		Revision as of 21:22, 15 October 2013
Line 42:		Line 42:
	<noinclude>		<noinclude>
	[[Category:Basics]]		[[Category:Basics]]
			[[Category:Syntax]]
	</noinclude>		</noinclude>

Laura at 19:37, 5 August 2013

2013-08-05T19:37:39Z

← Older revision		Revision as of 19:37, 5 August 2013
Line 39:		Line 39:

	For more details, see the [[Syntax]] description.		For more details, see the [[Syntax]] description.

			<noinclude>
			[[Category:Basics]]
			</noinclude>

Laura: moved Conventions to Diagram Conventions: more specific name.

2013-08-05T19:37:12Z

moved Conventions to Diagram Conventions: more specific name.

← Older revision	Revision as of 19:37, 5 August 2013
(No difference)

Laura: Created page with "===Uppercase VS Lowercase Letters=== Throughout this reference material, uppercase letters are generally used to denote the names of commands, statements, functions and other ..."

2013-08-05T19:34:25Z

Created page with "===Uppercase VS Lowercase Letters=== Throughout this reference material, uppercase letters are generally used to denote the names of commands, statements, functions and other ..."

New page

===Uppercase VS Lowercase Letters===
Throughout this reference material, uppercase letters are generally used to denote the names of commands, statements, functions and other specifications. Uppercase is also used with the names of most files or programs except where the file or program being referred to is exclusively used with the Unix or Linux operating system. Regardless of your operating system, Business Rules accepts both uppercase and lowercase letters as identical except when they are used in a literal string. It defaults to displaying all but literal strings in uppercase (see the BRConfig.sys [[STYLE]] specification to change this default).

===Diagram Rules===
;Syntax diagrams show the optional and required parameters for statements, commands and specifications. The following LINPUT statement diagram will serve as an example for the set of rules, which applies to all Business Rules syntax diagrams:<br>
[[Image:linput.png]]

;Read from left to right
The logic and order of the syntax always flows from left to right.

;Uppercase parameters are exact keywords
Items in uppercase letters (LINPUT) are keywords and must be typed in either letter-for-letter as they appear or with an allowable abbreviation (see [[keyword abbreviation]]s for a complete list).

;Lowercase parameters must be replaced
Items in lowercase letters (string-var) are specifically defined in the Parameters section following each syntax diagram. When specified, these parameters must be replaced with a specification that fits the requirements of the definition. Descriptions of these parameters can be found in the [[Definitions]] and [[All Parameters]] sections.

;Include special characters
Special characters, such as commas, colons and slashes (the colon in filenum:) must be included in the written statement.

;Items on the main line are required
Items that appear on the main line of the diagram (string-var) must be included in the written statement. If you can follow the line of the diagram to the end without passing a parameter, it is optional.

;Items above or below the line are optional
Items that appear above or below the main line of the diagram (error-cond line-ref) are optional.

;Dotted line items with an arrow can be repeated
Items with a returning dotted line may be repeated. When multiple items are indicated, they must be separated with the punctuation mark (usually a comma or semi-colon).

;Defaults are listed in brackets
Numbers that are enclosed in brackets (<1>) identify the default action or value, which is taken when nothing is specified for an optional parameter. These numbers correlate to the "Defaults" section below each diagram.

;Insertable diagrams
Some of Business Rules commands and statements are so powerful that it is difficult to show all the available options in a single diagram. In cases such as this, a section of the diagram may be shown separately as an "insertable syntax". An example of this usage is the "[[helpstring]]" parameter that appears in several diagrams, including [[INPUT FIELDS]]. Another example is the "[[share spec]]" parameter (shown below). Insertable diagrams do not have start and end circles to prevent them from being confused with full syntax diagrams.<br>
[[Image:sharespec.png]]

;End of statement
The circle at the end of the diagram identifies the end of the statement.

For more details, see the [[Syntax]] description.