Notation conventions: Difference between revisions
Jump to navigation
Jump to search
(Created page with "==Notation conventions== <p>Model 204 documentation uses the following standard notation conventions in syntax and examples: </p> <table> <tr> <th>Convention </th> <th>Desc...") |
m (misc cleanup) |
||
(One intermediate revision by one other user not shown) | |||
Line 1: | Line 1: | ||
<p>Model 204 documentation uses the following standard notation conventions in syntax and examples: </p> | <p>Model 204 documentation uses the following standard notation conventions in syntax and examples: </p> | ||
<table> | <table> | ||
<tr> | <tr class="head"> | ||
<th>Convention </th> | <th>Convention </th> | ||
Line 29: | Line 28: | ||
<tr> | <tr> | ||
<td>UNIQUE | PRIMARY KEY </td> | <td nowrap>UNIQUE | PRIMARY KEY </td> | ||
<td>A vertical bar ( | ) separates alternative options. In this example, specify either UNIQUE or PRIMARY KEY. </td> | <td>A vertical bar ( | ) separates alternative options. In this example, specify either UNIQUE or PRIMARY KEY. </td> | ||
Line 63: | Line 62: | ||
<tr> | <tr> | ||
<td>nested-key ::= column_name </td> | <td nowrap>nested-key ::= column_name </td> | ||
<td>A double colon followed by an equal sign indicates an equivalence. In this case, nested-key is equivalent to column_name.</td> | <td>A double colon followed by an equal sign indicates an equivalence. In this case, nested-key is equivalent to column_name.</td> | ||
</tr> | </tr> | ||
<tr><td>Enter your account: <strong>sales11</strong></td> | <tr><td>Enter your account: <br/><strong>sales11</strong></td> | ||
<td>In examples that include both system-supplied and user-entered text, or system prompts and user commands, boldface indicates what you enter. In this example, the system prompts for an account and the user enters <strong>sales11</strong>.</td> | <td>In examples that include both system-supplied and user-entered text, or system prompts and user commands, boldface indicates what you enter. In this example, the system prompts for an account and the user enters <strong>sales11</strong>.</td> | ||
</tr> | </tr> |
Latest revision as of 18:58, 25 February 2015
Model 204 documentation uses the following standard notation conventions in syntax and examples:
Convention | Description |
---|---|
TABLE | Uppercase represents a keyword that you must enter exactly as shown. |
TABLE tablename | In text, italics are used for variables and for emphasis. In examples, italics denote a variable value that you must supply. In this example, you must supply a value for tablename. |
READ [SCREEN] | Square brackets ( [ ] ) enclose an optional argument or portion of an argument. In this case, specify READ or READ SCREEN. |
UNIQUE | PRIMARY KEY | A vertical bar ( | ) separates alternative options. In this example, specify either UNIQUE or PRIMARY KEY. |
TRUST | NOTRUST | Underlining indicates the default. In this example, NOTRUST is the default. |
IS {NOT | LIKE} | Braces ( { } ) indicate that one of the enclosed alternatives is required. In this example, you must specify either IS NOT or IS LIKE. |
item ... | An ellipsis ( . . . ) indicates that you can repeat the preceding item. |
item ,... | An ellipsis preceded by a comma indicates that a comma is required to separate repeated items. |
All other symbols | In syntax, all other symbols (such as parentheses) are literal syntactic elements and must appear as shown. |
nested-key ::= column_name | A double colon followed by an equal sign indicates an equivalence. In this case, nested-key is equivalent to column_name. |
Enter your account: sales11 |
In examples that include both system-supplied and user-entered text, or system prompts and user commands, boldface indicates what you enter. In this example, the system prompts for an account and the user enters sales11. |
File > Save As | A right angle bracket (>) identifies the sequence of actions that you perform to select a command from a pull-down menu. In this example, select the Save As command from the File menu. |
EDIT | Partial bolding indicates a usable abbreviation, such as E for EDIT in this example. |