Documentation Conventions

Syntax Descriptions

The following conventions are used in syntax descriptions, such as ProcScript statements and functions, configuration and assignment settings, APIs, and so on. Unless otherwise specified, names, commands, and settings are not case sensitive.

Syntax Conventions

Syntax Element	Description	Example
Exact String command setting api property value /switch	Monospace typeface is used for literal information that must be typed as shown (although you can usually ignore the case).	"a message" retrieveENTITY_A backcolor="red" /asn=app1.asn
VariableContent	Italic typeface must be replaced by actual data. It is typically used for parameters.	TargetFilename
{ ... }	Braces indicate optional information, such as optional arguments, parameters, options, values, or switches	{Entity}
|	Vertical bars separate a list of options where only one item can be entered. They are used for mutually exclusive arguments, parameters, options, values, or switches.	true | false
default value	Underlined value indicates the value used if a property is not specified	true
;!	Underlined punctuation represent profile characters or subfield separators in Uniface lists. These separators can be entered using the Gold key. On Windows, this is mapped to the plus (+) symbol in the numeric keypad. On laptops, you can use the blue Fn key to access the numeric keypad. For example Fn+/ ; to enter ;

For example, the following syntax description indicates that the rollback command can occur with no following arguments, or with either of the two optional arguments:

rollback {"Connector" | "$Path"}

According to this syntax description, the following forms of the rollback statement are allowed:

rollback
rollback "SYB"
rollback "$MYPATH"

Uppercase and Lowercase

Uniface ProcScript instructions, assignment and initialization settings, object names, and so on are case-insensitive. However, the following conventions are used in the documentation:

• Assignment settings and assignment file sections are in uppercase. For example, $DEF_CHARSET in the [SETTINGS] section.
• Initialization settings are in mixed case and file sections in lowercase. For example AutoMaximize in the [upi] section.
• ProcScript commands and data types are usually lowercase. Sometime, mixed case is used for readability. For example, $procerror, $CurEntProperties, structToXml.

Typographic Conventions

Typographic Conventions

Convention	Used for	Example
Italic	Variable content such as parameters Citations or references to other documents Word emphasis	retrieve/eEntityName Refer to the Uniface Library. ... known as an operation.
^Function	Structure editor function	^Add_Occ
Key KeyKey Key+Key	Keyboard keys Keys separated by a space are pressed sequentially. Keys joined by a plus symbol are pressed in simultaneously.	F1 GoldR Alt+F
Bold	Labels in the user interface, such as window titles, tabs, and field or property names.	Structure
Monospace	Literal values that must be entered as is (except for the case), including: ProcScript keywords (statements, functions, data types, and so on) Assignment settings Initialization settings Command lines switches APIs Values of properties, parameters, and variables Literal user input File and directory names	retrieveENTITY_A backcolor="red" /asn=app1.asn "a message"
Underline ;!	Default value Uniface list separators such as Gold ; or Gold !	True | False red;blue