docs/1.6/general.xml

   1 <?xml version='1.0' encoding='UTF-8'?>\r
   2 <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"\r
   3   xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="general">\r
   4   <title>General Elements and Other Elements not Discussed Elsewhere</title>\r
   5   <section>\r
   6     <title>Overview</title>\r
   7     <para>Since DocBook was defined to describe a wide range of publishable content, it includes a\r
   8       number of elements that are used to perform common tasks. These elements include ones that\r
   9       specify superscripts and emphasis.</para>\r
  10   </section>\r
  11   <section>\r
  12     <title>Formatting Elements</title>\r
  13     <para>The following are common formatting elements used in DocBook:</para>\r
  14     <segmentedlist>\r
  15       <segtitle>Element</segtitle>\r
  16       <segtitle>Description</segtitle>\r
  17       <seglistitem>\r
  18         <seg>\r
  19           <tag class="element">emphasis</tag>\r
  20         </seg>\r
  21         <seg>Specifies that the content of the element is to be emphasized by either\r
  22             <emphasis>italics</emphasis> or <emphasis role="strong">boldface</emphasis>. The default\r
  23           is to use italics. Specify boldface by setting the <tag class="attribute">role</tag>\r
  24           attribute to <tag class="attvalue">bold</tag>.</seg>\r
  25       </seglistitem><seglistitem>\r
  26         <seg>\r
  27           <tag class="element">literallayout</tag>\r
  28         </seg>\r
  29         <seg>Specifies that the content of the element is to be reproduced with all of the\r
  30           whitespace preserved.</seg>\r
  31       </seglistitem><seglistitem>\r
  32         <seg>\r
  33           <tag class="element">subscript</tag>\r
  34         </seg>\r
  35         <seg>Specifies that the content of the element is a subscript as in\r
  36             H<subscript>2</subscript>O.</seg>\r
  37       </seglistitem><seglistitem>\r
  38         <seg>\r
  39           <tag class="element">superscript</tag>\r
  40         </seg>\r
  41         <seg>Specifies that the content of the element is a superscript as in\r
  42             E=MC<superscript>2</superscript>.</seg>\r
  43       </seglistitem></segmentedlist>\r
  44   </section>\r
  45   <section>\r
  46     <title>General Computing Elements</title>\r
  47     <para>The following are elements used for describing computer technology:</para>\r
  48     <segmentedlist>\r
  49       <segtitle>Element</segtitle>\r
  50       <segtitle>Description</segtitle>\r
  51       <seglistitem>\r
  52         <seg>\r
  53           <tag class="element">action</tag>\r
  54         </seg>\r
  55         <seg>Specifies that content describes a response to some user initiated action.</seg>\r
  56       </seglistitem><seglistitem>\r
  57         <seg>\r
  58           <tag class="element">application</tag>\r
  59         </seg>\r
  60         <seg>Specifies that the content is the name of a piece of software.</seg>\r
  61       </seglistitem><seglistitem>\r
  62         <seg>\r
  63           <tag class="element">computeroutput</tag>\r
  64         </seg>\r
  65         <seg>Specifies that the content is text printed on a computer display.</seg>\r
  66       </seglistitem><seglistitem>\r
  67         <seg>\r
  68           <tag class="element">database</tag>\r
  69         </seg>\r
  70         <seg>Specifies that the content is the name of a database, or part of a database.</seg>\r
  71       </seglistitem><seglistitem>\r
  72         <seg>\r
  73           <tag class="element">email</tag>\r
  74         </seg>\r
  75         <seg>Specifies that the content is an e-mail address.</seg>\r
  76       </seglistitem><seglistitem>\r
  77         <seg>\r
  78           <tag class="element">envar</tag>\r
  79         </seg>\r
  80         <seg>Specifies that the content is the name of an environment variable.</seg>\r
  81       </seglistitem><seglistitem>\r
  82         <seg>\r
  83           <tag class="element">errorcode</tag>\r
  84         </seg>\r
  85         <seg>Specifies that the content is an error code.</seg>\r
  86       </seglistitem><seglistitem>\r
  87         <seg>\r
  88           <tag class="element">errorname</tag>\r
  89         </seg>\r
  90         <seg>Specifies that the content is the name of an error.</seg>\r
  91       </seglistitem><seglistitem>\r
  92         <seg>\r
  93           <tag class="element">errortext</tag>\r
  94         </seg>\r
  95         <seg>Specifies that the content is the text generated when an error occurs.</seg>\r
  96       </seglistitem><seglistitem>\r
  97         <seg>\r
  98           <tag class="element">filename</tag>\r
  99         </seg>\r
 100         <seg>Specifies that the content is the name of a file.</seg>\r
 101       </seglistitem><seglistitem>\r
 102         <seg>\r
 103           <tag class="element">hardware</tag>\r
 104         </seg>\r
 105         <seg>Specifies that the content is a piece of computer hardware.</seg>\r
 106       </seglistitem><seglistitem>\r
 107         <seg>\r
 108           <tag class="element">option</tag>\r
 109         </seg>\r
 110         <seg>Specifies that the content is an option to a command.</seg>\r
 111       </seglistitem><seglistitem>\r
 112         <seg>\r
 113           <tag class="element">prompt</tag>\r
 114         </seg>\r
 115         <seg>Specifies that the content is the string used as a prompt for data on a computer\r
 116           screen.</seg>\r
 117       </seglistitem><seglistitem>\r
 118         <seg>\r
 119           <tag class="element">userinput</tag>\r
 120         </seg>\r
 121         <seg>Specifies that the content is data a user enters into a computer system.</seg>\r
 122       </seglistitem></segmentedlist>\r
 123   </section>\r
 124   <section>\r
 125     <title>Other General Elements</title>\r
 126     <para>The following are other general use elements used in DocBook:</para>\r
 127     <segmentedlist>\r
 128       <segtitle>Element</segtitle>\r
 129       <segtitle>Description</segtitle>\r
 130       <seglistitem>\r
 131         <seg>\r
 132           <tag class="element">abbrev</tag>\r
 133         </seg>\r
 134         <seg>Specifies that the content is an abbreviation.</seg>\r
 135       </seglistitem><seglistitem>\r
 136         <seg>\r
 137           <tag class="element">acronym</tag>\r
 138         </seg>\r
 139         <seg>Specifies that the content is an acronym.</seg>\r
 140       </seglistitem><seglistitem>\r
 141         <seg>\r
 142           <tag class="element">firstterm</tag>\r
 143         </seg>\r
 144         <seg>Specifies that the content is the first occurrence of a new term or is a term that is\r
 145           used a context specific manner.</seg>\r
 146       </seglistitem><seglistitem>\r
 147         <seg>\r
 148           <tag class="element">literal</tag>\r
 149         </seg>\r
 150         <seg>Specifies that the content is a literal value.</seg>\r
 151       </seglistitem><seglistitem>\r
 152         <seg>\r
 153           <tag class="element">optional</tag>\r
 154         </seg>\r
 155         <seg>Specifies that the content is optional information. It is typically used in command\r
 156           synopsis.</seg>\r
 157       </seglistitem><seglistitem>\r
 158         <seg>\r
 159           <tag class="element">replaceable</tag>\r
 160         </seg>\r
 161         <seg>Specifies that the content represents a value that will be replaced by the user in\r
 162           using the product.</seg>\r
 163       </seglistitem></segmentedlist>\r
 164   </section>\r
 165   <section>\r
 166     <title>GUI Elements</title>\r
 167     <para>The following are DocBook elements used in documenting a GUI:</para>\r
 168     <segmentedlist>\r
 169       <segtitle>Element</segtitle>\r
 170       <segtitle>Description</segtitle>\r
 171       <seglistitem>\r
 172         <seg>\r
 173           <tag class="element">accel</tag>\r
 174         </seg>\r
 175         <seg>Specifies that the content is a keyboard shortcut.</seg>\r
 176       </seglistitem><seglistitem>\r
 177         <seg>\r
 178           <tag class="element">guibutton</tag>\r
 179         </seg>\r
 180         <seg>Specifies that the content is the label on a GUI button.</seg>\r
 181       </seglistitem><seglistitem>\r
 182         <seg>\r
 183           <tag class="element">guilabel</tag>\r
 184         </seg>\r
 185         <seg>Specifies that the content is a label on a GUI element other than a button.</seg>\r
 186       </seglistitem><seglistitem>\r
 187         <seg>\r
 188           <tag class="element">guimenu</tag>\r
 189         </seg>\r
 190         <seg>Specifies that the content is the name of a menu.</seg>\r
 191       </seglistitem><seglistitem>\r
 192         <seg>\r
 193           <tag class="element">guimenuitem</tag>\r
 194         </seg>\r
 195         <seg>Specifies that the content is a selectable item on a menu.</seg>\r
 196       </seglistitem><seglistitem>\r
 197         <seg>\r
 198           <tag class="element">guisubmenu</tag>\r
 199         </seg>\r
 200         <seg>Specifies that the content is the name of a sub-menu.</seg>\r
 201       </seglistitem><seglistitem>\r
 202         <seg>\r
 203           <tag class="element">mousebutton</tag>\r
 204         </seg>\r
 205         <seg>Specifies that the content is the name of a mouse button.</seg>\r
 206       </seglistitem></segmentedlist>\r
 207   </section>\r
 208 </chapter>\r