X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=_manual%2F01_welcome-to-ardour%2F02_about-ardour-documentation.html;h=99c59ecd41244f22f3cb3634e5696d94cee00cd0;hb=7a9da70647ce4d4c48e042f93e05b89dd983399e;hp=c539e0804e84aadc0e69a97527fe54976a688377;hpb=afb6b04736a1aff7a560861381c78e6528998bea;p=ardour-manual diff --git a/_manual/01_welcome-to-ardour/02_about-ardour-documentation.html b/_manual/01_welcome-to-ardour/02_about-ardour-documentation.html index c539e08..99c59ec 100644 --- a/_manual/01_welcome-to-ardour/02_about-ardour-documentation.html +++ b/_manual/01_welcome-to-ardour/02_about-ardour-documentation.html @@ -5,97 +5,129 @@ title: About Ardour documentation
-This section covers some of the typographical and language conventions -used in this manual. + This section covers some of the typographical and language conventions + used in this manual.
-Keyboard bindings are shown like this: s or x. -Ctrl x means "press the Ctrl key, keep it pressed and then also -press the x key. You may also see key combinations such as -e, which mean that you should press the key, then while keeping it pressed also press the - key and then while -keeping them both pressed, finally press the e key.
+ Keyboard bindings are shown like this: s or + x. +-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 -Cmd where appropriate (for instance in the first example above). -On other machines you will see Ctrl instead. + x means "press the key, keep it pressed + and then also press the x key.
- -
-Menu items are indicated like this:
-Top > Next > Deeper. Each ">"-separated item
-indicates one level of a nested (sub-)menu.
+ You may also see key combinations
+ such as e, which mean that you should hold down
+ the key and the
+ key, and then, while keeping them both
+ down, press the e key.
-Choices in various dialogs, notably the Preferences and Properties dialog, are
-indicated like this:
-Edit > Preferences > Audio > Some Option.
-Each successive item indicates either a (sub-) menu or a tabbed dialog
-navigation. The final item is the one to choose or select.
+ 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 Cmd where appropriate (for instance
+ in the first example above). On other machines you will see
+ Ctrl instead.
-If you are requested to deselect an option, you will see something like
-this:
-Edit > Preferences > Audio > Some other
-Option.
+ We refer to mouse buttons as
+ Left, Middle and
+ Right. Ardour can use additional buttons, but they have
+ no default behaviour in the program.
+ Many editing functions are performed by clicking the mouse while holding a + modifier key, for example Left. +
--Important notes about things that might not otherwise be obvious are shown in this -format. +
+ 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 + ⇑ ⇐ + ⇓ ⇒.
--Hairy issues that might cause things to go wrong, lose data, or impair sound -quality is displayed in this way. +
+ The term context-click is used to indicate + that you should (typically) Right-click on a particular element of the graphical + user interface. Although right-click is the common, default way to do this, there + are other ways to accomplish the same thing - this term refers to any of them, + and the result is always that a menu specific to the item you clicked on will be + displayed.
++ 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 + interface. +
--We refer to mouse buttons as -Left, Middle and -Right. Ardour can use additional buttons, but they have -no default behaviour in the program. + Ardour supports hardware controllers, such as banks of + faders, knobs, or + buttons.
-
-Many editing functions are performed by clicking the mouse while holding a
-modifier key, for example Left.
+ Menu items are indicated like this:
+ Top > Next > Deeper.
+ Each ">"-separated item indicates one level of a nested (sub-)menu.
+
+ Choices in various dialogs, notably the Preferences and Properties dialog, are
+ indicated like this:
+ Edit > Preferences > Audio > Some
+ Option.
+ Each successive item indicates either a (sub-) menu or a tabbed dialog
+ navigation. The final item is the one to choose or select.
Many times the term context-click is used to indicate -that you should (typically) right-click on a particular element of the graphical -user interface. Although right-click is the common, default way to do this, there -are other ways to accomplish the same thing - this term refers to any of them, -and the result is always that a menu specific to the item you clicked on will be -displayed. +
+ If you are requested to deselect an option, you will see something like
+ this:
+ Edit > Preferences > Audio > Some other
+ Option.
-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 -interface. + Some dialogs or features may require you to type in some data + such as this. In rare cases, you will be required to perform certain + operations at the command line of your operating system:
+cat /proc/cpuinfo +sleep 3600 +ping www.google.com --Ardour supports hardware controllers, such as banks of faders, knobs, or buttons. + Important messages from Ardour or other programs will be displayed + like this. +
+ ++ Important notes about things that might not otherwise be obvious are shown in + this format. +
+ ++ Hairy issues that might cause things to go wrong, lose data, impair sound + quality, or eat your proverbial goldfish, are displayed in this way.