|
|
| (4 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| − | == Conventions used in this guide ==
| |
| | | | |
| − | <div style="font-style: normal; font-weight: normal; margin-bottom: 6pt; margin-left: 0pt; margin-right: 0pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> This guide uses the following conventions:<br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 0pt; margin-right: 0pt; margin-top: 1pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000">
| |
| − |
| |
| − | {| border="1" cellpadding="5"
| |
| − | |+
| |
| − | |- bgcolor="#CCCCCC"
| |
| − | !
| |
| − | <div class="CellHeading">This convention . . .</div>
| |
| − | !
| |
| − | <div class="CellHeading">Stands for . . .</div>
| |
| − | |-
| |
| − | |
| |
| − | <div class="CellBody"><span style="font-weight: normal; text-decoration: none; text-transform: none; vertical-align: baseline">''<font color="#000000">Italics</font>''</span></div>
| |
| − | |
| |
| − | <div class="CellBody">Names of books, guides, or manuals as references</div> <div class="CellBody">New terms or emphasis</div> <div class="CellBody">Names of executable files</div>
| |
| − | |-
| |
| − | |
| |
| − | <div class="CellBody"><span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">Bold</font>'''</span></div>
| |
| − | |
| |
| − | <div class="CellBody">User input</div> <div class="CellBody">Names of programming commands</div>
| |
| − | |-
| |
| − | |
| |
| − | <div class="CellBody">All caps</div>
| |
| − | |
| |
| − | <div class="CellBody">File types, such as TIFF, GIF, or JPG </div>
| |
| − | |-
| |
| − | |
| |
| − | <div class="CellBody">Upper- and lowercase</div>
| |
| − | |
| |
| − | <div class="CellBody">Names of keys</div>
| |
| − | |-
| |
| − | |
| |
| − | <div class="CellBody">name@address.com</div>
| |
| − | |
| |
| − | <div class="CellBody">E-mail address format</div>
| |
| − | |-
| |
| − | |
| |
| − | <div class="CellBody"><span style="font-style: normal; font-weight: normal; text-transform: none; vertical-align: baseline"><u><font color="#000000">Hyperlink</font></u></span></div>
| |
| − | |
| |
| − | <div class="CellBody">An internet link (position the cursor on this word and click the left mouse button)* </div>
| |
| − | |-
| |
| − | |
| |
| − | <div class="CellBody">Monospace</div>
| |
| − | |
| |
| − | <div class="CellBody">Code sample, including keywords and variables within text and as separate paragraphs, and user-defined program elements within text</div>
| |
| − | |-
| |
| − | | rowspan="1" colspan="2" |
| |
| − | <div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 0pt; margin-right: 0pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> <nowiki>*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.</nowiki><br /></font></div>
| |
| − | |}
| |
| − |
| |
| − | <br /></font></div>
| |
| − |
| |
| − | Both volumes of the <span style="font-weight: normal; text-decoration: none; text-transform: none; vertical-align: baseline">''<font color="#000000">MIPAV</font>''</span> <span style="font-weight: normal; text-decoration: none; text-transform: none; vertical-align: baseline">''<font color="#000000">User's Guide</font>''</span> 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.
| |
| − |
| |
| − | <div style="font-style: normal; font-weight: normal; margin-bottom: 5pt; margin-left: 0pt; margin-right: 0pt; margin-top: 5pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> <br clear="all" />
| |
| − |
| |
| − |
| |
| − | {| align="left"
| |
| − | |
| |
| − | [[Image:MIPAV_Preface2.gif]]
| |
| − | |}
| |
| − |
| |
| − | <br clear="all" /><span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">Note:</font>'''</span> Notes provide additional information that is related to the subject at hand. They tend to be "by the way" types of information or asides.<br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 0pt; margin-right: 0pt; margin-top: 5pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> <br clear="all" />
| |
| − |
| |
| − |
| |
| − | {| align="left"
| |
| − | |
| |
| − | [[Image:MIPAV_Preface3.gif]]
| |
| − | |}
| |
| − |
| |
| − | <br clear="all" /><span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">Tip:</font>'''</span> Tip paragraphs point out application shortcuts or briefly describe special features of the software.<br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 4pt; margin-left: 0pt; margin-right: 0pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#0000ff"> <span style="font-style: normal; font-weight: normal; text-decoration: none; text-transform: none; vertical-align: baseline"><font color="#000000"><br clear="all" />
| |
| − |
| |
| − |
| |
| − | {| align="left"
| |
| − | |
| |
| − | [[Image:MIPAV_Preface9.gif]]
| |
| − | |}
| |
| − |
| |
| − | <br clear="all" /></font></span><span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#0000ff">Example:</font>'''</span> An example paragraph provides an example of a task or incident in which something of note could occur.<br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 0pt; margin-right: 0pt; margin-top: 5pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> <span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000"><br clear="all" /> {| align="left" | [[Image:MIPAV_Preface4.gif]] |} <br clear="all" />Recommendation:</font>'''</span> Paragraphs that are labeled "Recommendation" suggest methods of good practice or advice.<br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 5pt; margin-left: 0pt; margin-right: 0pt; margin-top: 5pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> <br clear="all" />
| |
| − |
| |
| − | {| align="left"
| |
| − | |
| |
| − | [[Image:MIPAV_Prefacea.gif]]
| |
| − | |}
| |
| − |
| |
| − | <br clear="all" /><span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">Definition: </font>'''</span>The definitions of specific words or phrases of note appear in "definition" paragraphs. <br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 4pt; margin-left: 0pt; margin-right: 0pt; margin-top: 4pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> <span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">Remember:</font>'''</span><br clear="all" />
| |
| − |
| |
| − | {| align="left"
| |
| − | |
| |
| − | [[Image:MIPAV_Preface5.gif]]
| |
| − | |}
| |
| − |
| |
| − | <br clear="all" />Notes labeled "Remember" present information that was previously discussed and that is pertinent in the current topic.<br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 0pt; margin-right: 0pt; margin-top: 3pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> <br clear="all" />
| |
| − |
| |
| − | {| align="left"
| |
| − | |
| |
| − | [[Image:MIPAV_Preface6.gif]]
| |
| − | |}
| |
| − |
| |
| − | <br clear="all" /><span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000">Reference:</font>'''</span> A reference note highlights one or more references that contain information on the current topic.<br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 5pt; margin-left: 0pt; margin-right: 36pt; margin-top: 5pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> <span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000"><br clear="all" /> {| align="left" | [[Image:MIPAV_Preface7.gif]] |} <br clear="all" />Caution:</font>'''</span> A paragraph labeled "Caution," alerts you to be very careful about avoiding some action that could harm your equipment or data.<br /></font></div><div style="font-style: normal; margin-bottom: 0pt; margin-left: 0pt; margin-right: 0pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline">'''<font color="#000000"> <span style="font-style: normal; text-decoration: none; text-transform: none; vertical-align: baseline">'''<font color="#000000"><br clear="all" /> {| align="left" | [[Image:Disclaimer.jpg]] |} <br clear="all" /></font>'''</span><br /></font>'''</div><div style="font-style: normal; margin-bottom: 0pt; margin-left: 0pt; margin-right: 0pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline">'''<font color="#000000"> <br /></font>'''</div><div style="font-style: normal; margin-bottom: 0pt; margin-left: 0pt; margin-right: 0pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline">'''<font color="#000000"> <br /></font>'''</div><div style="font-style: normal; margin-bottom: 0pt; margin-left: 0pt; margin-right: 0pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline">'''<font color="#000000"> <br /></font>'''</div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 0pt; margin-right: 0pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> <br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 0pt; margin-right: 0pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> <br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 0pt; margin-right: 0pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> <br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 0pt; margin-right: 0pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> <br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 0pt; margin-right: 0pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> <br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 0pt; margin-right: 0pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> <br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 0pt; margin-right: 0pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> <br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 0pt; margin-right: 0pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> <br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 0pt; margin-left: 0pt; margin-right: 0pt; margin-top: 0pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> <br /></font></div><div style="font-style: normal; font-weight: normal; margin-bottom: 5pt; margin-left: 0pt; margin-right: 36pt; margin-top: 5pt; text-align: left; text-decoration: none; text-indent: 0pt; text-transform: none; vertical-align: baseline"><font color="#000000"> Disclaimer: A disclaimer indicates the possible limitations or ramifications of a topic.<br /></font></div>
| |
