]> Shamusworld >> Repos - ardour-manual/blobdiff - _manual/01_welcome-to-ardour/02_about-ardour-documentation.html
update markup in panner chapter.
[ardour-manual] / _manual / 01_welcome-to-ardour / 02_about-ardour-documentation.html
index 4b0440030f0bef9e0ba48465976addbc01215be3..3caf2e20da2de768030f73400cbf4453d1ec5615 100644 (file)
@@ -15,59 +15,25 @@ title: About Ardour documentation
   <kbd class="mod1">x</kbd>.
 </p>
 <p>
-  <kbd>Ctrl x</kbd> means "press the <kbd>Ctrl</kbd> key, keep it pressed
-  and then also press the <kbd>x</kbd> key. You may also see key combinations 
+  <kbd class="mod1">x</kbd> means "press the <kbd class="mod1">&nbsp;</kbd> key, keep it pressed
+  and then also press the <kbd>x</kbd> key.
+</p>
+<p>
+  You may also see key combinations 
   such as <kbd class="mod12">e</kbd>, which mean that you should hold down
   the <kbd class="mod1">&nbsp;</kbd> key <em>and</em> the
-  <kbd class="mod2">&nbsp;</kbd> key, and then while keeping them both
+  <kbd class="mod2">&nbsp;</kbd> key, and then, while keeping them both
   down, press the <kbd>e</kbd> key.
 </p>
 <p>
   Note that different platforms have different conventions for which
   modifier key (Control or Command) to use as the primary or most common
   modifier. When viewing this manual from a machine identifying itself as
-  running OS X, you will see  <kbd>Cmd</kbd> where appropriate (for instance
-  in the first example above). On other machines you will see <kbd>Ctrl</kbd>
-  instead.
-</p>
-
-<h3>Menu Items</h3>
-<p>
-  Menu items are indicated like this:<br />
-  <kbd class="menu">Top &gt; Next &gt; Deeper</kbd>.<br />
-  Each "&gt;"-separated item indicates one level of a nested (sub-)menu.
-</p>
-
-<h3>Preference/Dialog Options</h3>
-<p>
-  Choices in various dialogs, notably the Preferences and Properties dialog, are 
-  indicated like this:<br />
-  <kbd class="option">Edit &gt; Preferences &gt; Audio &gt; Some
-  Option</kbd>.<br />
-  Each successive item indicates either a (sub-) menu or a tabbed dialog
-  navigation. The final item is the one to choose or select.
-</p>
-<p>
-  If you are requested to deselect an option, you will see something like
-  this:<br />
-  <kbd class="optoff">Edit &gt; Preferences &gt; Audio &gt; Some other
-  Option</kbd>.<br />
-</p>
-
-
-<h3>Notes</h3>
-<p class="note">
-  Important notes about things that might not otherwise be obvious are shown in
-  this format.
-</p>
-
-<h3>Warnings</h3>
-<p class="warning">
-  Hairy issues that might cause things to go wrong, lose data, or impair sound
-  quality is displayed in this way.
+  running OS X, you will see  <kbd>Cmd&nbsp;</kbd> where appropriate (for instance
+  in the first example above). On other machines you will see
+  <kbd>Ctrl&nbsp;</kbd> instead.
 </p>
-
-
 <h3>Mouse Buttons</h3>
 <p>
   We refer to <a href="/setting-up-your-system/the-mouse">mouse buttons</a> as 
@@ -82,6 +48,14 @@ title: About Ardour documentation
   modifier key, for example <kbd class="mouse mod1">Left</kbd>.
 </p>
 
+<h4>Mouse wheel</h4>
+<p>
+  Some GUI elements can optionally be controlled with the mouse wheel when
+  the pointer is hovering over them. The notation for mouse wheel action is
+  <kbd class="mouse">&uArr;</kbd> <kbd class="mouse">&lArr;</kbd></dt>
+  <kbd class="mouse">&dArr;</kbd> <kbd class="mouse">&rArr;</kbd></dt>
+</p>
+
 <h4>"Context-click"</h4>
 <p>
   Many times the term <kbd class="mouse">context-click</kbd> is used to indicate
@@ -92,7 +66,7 @@ title: About Ardour documentation
   displayed.
 </p>
 
-<h3>"The Pointer"</h3>
+<h4>"The Pointer"</h4>
 <p>
   When the manual refers to the "pointer", it means the on-screen representation 
   of the mouse position or the location of a touch action if you are using a touch
@@ -106,3 +80,54 @@ title: About Ardour documentation
   <kbd class="button">buttons</kbd>.
 </p>
 
+<h3>Menu Items</h3>
+<p>
+  Menu items are indicated like this:<br />
+  <kbd class="menu">Top &gt; Next &gt; Deeper</kbd>.<br />
+  Each "&gt;"-separated item indicates one level of a nested (sub-)menu.
+</p>
+
+<h3>Preference/Dialog Options</h3>
+<p>
+  Choices in various dialogs, notably the Preferences and Properties dialog, are 
+  indicated like this:<br />
+  <kbd class="option">Edit &gt; Preferences &gt; Audio &gt; Some
+  Option</kbd>.<br />
+  Each successive item indicates either a (sub-) menu or a tabbed dialog
+  navigation. The final item is the one to choose or select.
+</p>
+<p>
+  If you are requested to deselect an option, you will see something like
+  this:<br />
+  <kbd class="optoff">Edit &gt; Preferences &gt; Audio &gt; Some other
+  Option</kbd>.<br />
+</p>
+
+<h3>User Input</h3>
+<p>
+  Some dialogs or features may require you to type in some <kbd class="input">data
+  such as this</kbd>. In rare cases, you will be required to perform certain
+  operations at the command line of your operating system:
+</p>
+<kbd class="lincmd">cat /proc/cpuinfo</kbd>
+<kbd class="maccmd">sleep 3600</kbd>
+<kbd class="wincmd">ping www.google.com</kbd>
+
+<h3>Program Output</h3>
+<p>
+  Important messages from Ardour or other programs will be displayed
+  <samp>like this</samp>.
+</p>
+
+<h3>Notes</h3>
+<p class="note">
+  Important notes about things that might not otherwise be obvious are shown in
+  this format.
+</p>
+
+<h3>Warnings</h3>
+<p class="warning">
+  Hairy issues that might cause things to go wrong, lose data, impair sound
+  quality, or eat your proverbial goldfish, are displayed in this way.
+</p>
+