Difference between revisions of "Conventions used in this guide"
From MIPAV
(→Conventions used in this guide) |
(→Conventions used in this guide) |
||
| Line 1: | Line 1: | ||
| − | + | This guide uses the following conventions:<br /> | |
| − | + | ||
| − | + | ||
{| border="1" cellpadding="5" | {| border="1" cellpadding="5" | ||
Revision as of 17:06, 16 February 2012
This guide uses the following conventions:
|
This convention . . .
|
Stands for . . .
|
|---|---|
|
Italics
|
Names of books, guides, or manuals as references New terms or emphasis Names of executable files
|
|
Bold
|
User input Names of programming commands
|
|
All caps
|
File types, such as TIFF, GIF, or JPG
|
|
Upper- and lowercase
|
Names of keys
|
|
name@address.com
|
E-mail address format
|
|
Hyperlink
|
An internet link (position the cursor on this word and click the left mouse button)*
|
|
Monospace
|
Code sample, including keywords and variables within text and as separate paragraphs, and user-defined program elements within text
|
|
*All figure and table citations, such as Figure 1 or Table 1, are hyperlinks although they are not underscored. Clicking the citation displays the appropriate figure or table.
| |
</font></div>
Both volumes of the MIPAV User's Guide include special information that briefly highlights particular features or functions or that provide clarification. Based on the type of information they convey, these notes are labeled "note," "tip," "example," "recommendation," "remember," "reference," "caution," and "disclaimer." The following examples indicate how these notes appear and the type of information they include.
| Note: Notes provide additional information that is related to the subject at hand. They tend to be "by the way" types of information or asides. | |
| Tip: Tip paragraphs point out application shortcuts or briefly describe special features of the software. | |
| Example: An example paragraph provides an example of a task or incident in which something of note could occur. | |
| Recommendation: Paragraphs that are labeled "Recommendation" suggest methods of good practice or advice. | |
| Definition: The definitions of specific words or phrases of note appear in "definition" paragraphs. | |
| Notes labeled "Remember" present information that was previously discussed and that is pertinent in the current topic. | |
| Reference: A reference note highlights one or more references that contain information on the current topic. | |
| Caution: A paragraph labeled "Caution," alerts you to be very careful about avoiding some action that could harm your equipment or data. | |
|
|
Disclaimer: A disclaimer indicates the possible limitations or ramifications of a topic. |
