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

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