![]() |
![]() |
![]() |
![]() |
![]() |
Typographic Conventions
This section describes the typographic conventions used in all volumes of the user documentation.
Menu Commands and UI Objects
All user interface objects, such as labels, menu names, menu items and button texts, are shown in italics:
- The Edit menu provides a Paste command...
Click the OK button...Menu commands can also be expressed in a single form by separating the menu, submenu and menu item by a `>' character:
- Select Edit > Paste to...
The command Tools > Link > Traverse is used for...File Names, Variables, etc.
Names of files and directories, variables, source code literals, file keywords, etc. are usually shown in a typewriter font:
- The sdt.ssl file...
Set the $telelogic variable...Textual Input/Output, Listings, etc.
Listings of source code, file contents and textual output from the computer is shown in a typewriter font:
State1:Sig1:INPUTSig2:SAVEDState2:Sig3:INPUTSig1:UNHANDLEDWhen you are asked to type in characters from the keyboard during an interactive session, a bold typewriter font is used:
- Now enter Convert, Demon, System
C:\IBM\Rational\SDL_TTCN_Suite6.3> mkdir examplePlaceholders
Information within angle brackets "< >" denotes symbolic names (placeholders) which should be replaced by actual names:
- The syntax is "<process instance> <variable name>"...
Keys
Special keys or key combinations are shown in a typewriter font within angle brackets. Keys to be pressed together are separated by `+':
- To execute the command, press <Return>...
Press <Ctrl+C> to...
The shortcut is <Ctrl+Meta+V>...Platform Differences
The documentation is common to UNIX and Windows. The differences that exist between the platforms are usually indicated in the text by a platform indicator (a bold, sans-serif font) which always contains the word UNIX or Windows. Examples:
- The information is stored in the file .sdtpref (on UNIX) or sdt.ini (in Windows).
- XYZ consists of the following:
If a complete section of text is platform specific, the platform is indicated in the section heading:
Performing the Operation (on UNIX)
Performing the Operation (in Windows)
Screenshots are shown in either a UNIX or Windows version. Even if the appearance and layout may differ slightly between the platforms or different screen setups, the functionality is identical.
http://www.ibm.com/rational |
![]() |
![]() |
![]() |
![]() |