Document Conventions
Document
Conventions
The conventions used in this document are designed to be completely predictable and are used for the following
specific purposes.
Conventions List
Typeface Usage
Italic
Used to indicate the following:
•
The first mention of new terms in any information unit. For example:
The
rudaplex
and the
strataguide
have been the modified for this model.
•
References to titles of books, chapters, headings, CDs, diskettes, or
software programs. For example:
Refer to
The Technical Manual
for technical term descriptions.
•
Variables that the user types. For example:
Type the
User ID
in the
User ID
text box.
Bold
Used to indicate the following:
•
Exact text strings typed. For example: Type
ABCDEFG
.
•
Keyboard keys pressed. For example:
Press Ctrl-A
, then press
Enter
.
Blue Underline
Used to indicate linked email, IP, Network, or Web addresses. For example:
Go to
http://www.microsoft.com
for more information about Microsoft
products.
Cross-Reference
Used to indicate a reference to another part of the same document. The grey
portion of the cross-reference is hot linked to the appropriate section of the
document, followed by a page number, also hot-linked to the same portion of
the document. For example:
For more information about the Document Conventions, see the "
".
Operating System Text
Used to indicate text that appears in a shell session for an operating system.
The displayed text pertains to operating system text only, not application
elements. For example:
Type
LIST MAIN FOLDER
. The screen displays the
Main
folder.
Program Code
Used to indicate code listings. For example:
{
# do something;
}
# check to see if $user has the attrib 'atrib'
if (hasKey($user_obj, 'atrib', $dbh) != 1)
{
print "User not Authorized to update!";25
}
Screen Element
Screen elements consist of anything that is displayed on screen (exclusive of
the operating system). This includes toolbar menu items, drop-down lists and
items in a drop-down list, buttons, or anything else a user sees on screen. For
example:
•
From the
Printer
drop-down list, choose Local Printer. The
Are You
Sure?
dialog box appears. Click
OK
.
•
The following message appears:
User Not Authorized
Document Conventions
10
