These style and syntax conventions are used in Sybase® documentation.
Key | Definition |
---|---|
monospaced(fixed-width) |
|
italic monospaced | In SQL or program code snippets, placeholders for user-specified values (see example below). |
italic |
|
bold san serif |
|
If necessary, an explanation for a placeholder (system- or setup-specific values) follows in text. For example:
installation directory\start.bat
where installation directory is where the application is installed.
Key | Definition |
---|---|
{ } | Curly braces indicate that you must choose at least one of the enclosed options. Do not type the braces when you enter the command. |
[ ] | Brackets mean that choosing one or more of the enclosed options is optional. Do not type the brackets when you enter the command. |
( ) | Parentheses are to be typed as part of the command. |
| | The vertical bar means you can select only one of the options shown. |
, | The comma means you can choose as many of the options shown as you like, separating your choices with commas that you type as part of the command. |
... | An ellipsis (three dots) means you may repeat the last unit as many times as you need. Do not include ellipses in the command. |