Shamusworld >> Repos - ardour-manual-diverged/blob - _manual/01_welcome-to-ardour/02_about-ardour-documentation.html

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