Shamusworld >> Repos - ardour-manual/blob - include/about-ardours-documentation.html

   1
   2 <h2>Conventions Used In This Manual</h2>
   3
   4 <p>
   5   This section covers some of the typographical and language conventions
   6   used in this manual.
   7 </p>
   8
   9 <h3>Keyboards and Modifiers</h3>
  10
  11 <p>
  12   <dfn>Keyboard bindings</dfn> are shown like this: <kbd>s</kbd> or
  13   <kbd class="mod1">x</kbd>.
  14 </p>
  15
  16 <p>
  17   <kbd class="mod1">x</kbd> means "press the <kbd class="mod1n"></kbd>
  18   key, keep it pressed and then also press the <kbd>x</kbd> key".
  19 </p>
  20
  21 <p>
  22   Combinations such as <kbd class="mod12">e</kbd> may be seen, which means
  23   "hold down the <kbd class="mod1n"></kbd> key <em>and</em> the <kbd
  24   class="mod2n"></kbd> key, and then, while keeping them both down, press the
  25   <kbd>e</kbd> key".
  26 </p>
  27
  28 <p class="note">
  29   Different platforms have different conventions for which modifier key
  30   (Control or Command) to use as the primary or most common modifier. When
  31   viewing this manual from a machine identifying itself as running OS X,
  32   <kbd>Cmd</kbd> will be seen where appropriate (for instance in the first
  33   example above). On other machines <kbd>Ctrl</kbd> will be seen instead.
  34 </p>
  35
  36 <h3>Mouse Buttons</h3>
  37
  38 <p>
  39  <a href="@@mouse">Mouse buttons</a> are referred to as <kbd
  40  class="mouse">Left</kbd>, <kbd class="mouse">Middle</kbd> and <kbd
  41  class="mouse">Right</kbd>. Ardour can use additional buttons, but they have no
  42  default behaviour in the program.
  43 </p>
  44
  45 <h4>Mouse Click Modifiers</h4>
  46
  47 <p>
  48   Many editing functions are performed by clicking the mouse while holding a
  49   modifier key, for example <kbd class="mouse mod1">Left</kbd>.
  50 </p>
  51
  52 <h4>Mouse Wheel</h4>
  53
  54 <p>
  55   Some GUI elements can optionally be controlled with the mouse wheel when
  56   the pointer is hovering over them. The notation for mouse wheel action is
  57   <kbd class="mouse">&uArr;</kbd> <kbd class="mouse">&lArr;</kbd>
  58   <kbd class="mouse">&dArr;</kbd> <kbd class="mouse">&rArr;</kbd>.
  59 </p>
  60
  61 <h4>Context-click</h4>
  62
  63 <p>
  64   The term <dfn>context-click</dfn> is used to indicate a <kbd
  65   class="mouse">Right</kbd>-click on a particular element of the graphical user
  66   interface. Although right-click is the common, default way to do this, there
  67   are other ways to accomplish the same thing&mdash;this term refers to any of
  68   them, and the result is always that a menu specific to the item clicked on
  69   will be displayed.
  70 </p>
  71
  72 <h4>"The Pointer"</h4>
  73
  74 <p>
  75   When the manual refers to the "pointer", it means the on-screen
  76   representation of the mouse position or the location of a touch action if
  77   touch interface is being used.
  78 </p>
  79
  80 <h3>Other User Input</h3>
  81
  82 <p>
  83   Ardour supports hardware controllers, such as banks of <kbd
  84   class="fader">faders</kbd>, <kbd class="knob">knobs</kbd>, or <kbd
  85   class="button">buttons</kbd>.
  86 </p>
  87
  88 <h3>Menu Items</h3>
  89
  90 <p>
  91   Menu items are indicated like this: <kbd class="menu">Top &gt; Next &gt;
  92   Deeper</kbd>. Each "&gt;"-separated item indicates one level of a nested menu
  93   or sub-menu.
  94 </p>
  95
  96 <h3>OSC Messages</h3>
  97
  98 <p>
  99   OSC messages, whether sent or received, are displayed like this: <kbd class="osc">/transport_stop</kbd>.
 100 </p>
 101
 102 <h3>Preference/Dialog Options</h3>
 103
 104 <p>
 105   Choices in various dialogs, notably the Preferences and Properties dialog,
 106   are indicated thus:
 107 </p>
 108
 109 <p>
 110   <kbd class="option">Edit &gt; Preferences &gt; Audio &gt; Some Option</kbd>.
 111 </p>
 112
 113 <p>
 114   Each successive item indicates either a menu, sub-menu, or a tabbed dialog
 115   navigation. The final item is the one to choose or select.
 116 </p>
 117
 118 <p>
 119   If an option is deselected, it will look like this:
 120 </p>
 121
 122 <p>
 123   <kbd class="optoff">Edit &gt; Preferences &gt; Audio &gt; Some other
 124   Option</kbd>.
 125 </p>
 126
 127 <h3>User Input</h3>
 128
 129 <p>
 130   Some dialogs or features may require the user to input data <kbd class="input">such as this</kbd>. In rare cases, certain operations will be required to be performed at the command line of the operating system:
 131 </p>
 132
 133 <kbd class="cmd lin">cat /proc/cpuinfo</kbd>
 134 <kbd class="cmd mac">sleep 3600</kbd>
 135 <kbd class="cmd win">ping www.google.com</kbd>
 136
 137 <h3>Program Output</h3>
 138
 139 <p>
 140   Important messages from Ardour or other programs will be displayed <samp>like
 141   this</samp>.
 142 </p>
 143
 144 <h3>Notes</h3>
 145
 146 <p class="note">
 147   Important notes about things that might not otherwise be obvious are shown in
 148   this format.
 149 </p>
 150
 151 <h3>Warnings</h3>
 152
 153 <p class="warning">
 154   Hairy issues that might cause things to go wrong, lose data, impair sound
 155   quality, or eat your proverbial goldfish, are displayed in this way.
 156 </p>
 157