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=c539e0804e84aadc0e69a97527fe54976a688377;hb=afb6b04736a1aff7a560861381c78e6528998bea;hp=233e5081b6da205a9b9d4b8462dfab0b3f63a71d;hpb=ae6efdc4a0dd1825a30a1b95b70d6a5f799713a9;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 233e508..c539e08 100644 --- a/_manual/01_welcome-to-ardour/02_about-ardour-documentation.html +++ b/_manual/01_welcome-to-ardour/02_about-ardour-documentation.html @@ -3,24 +3,99 @@ layout: default title: About Ardour documentation --- +

Conventions Used In This Manual

+

+This section covers some of the typographical and language conventions +used in this manual. +

- - -

Conventions Used In This Manual

-

This section covers some of the typographical and language conventions used in this manual.

Keyboards and Modifiers

-

Keyboard bindings are shown like this: s or x. Ctrl-x means "press the Ctrl, keep it pressed and then also press the x key. You may also see key combinations such as Ctrl-Shift-e, which mean that you should press the Ctrl key, then while keeping it pressed also press the Shift key and then while keeping them both pressed, finally press the e key.

-

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, will see Cmd- where appropriate. On other machines you will see Ctrl-

+

+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.

+

+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. +

+

Menu Items

-

Menu items are indicated like this: Top > Next > Deeper Each >-separated item indicates an item on a nested (sub) menu.

+

+Menu items are indicated like this:
+Top > Next > Deeper. Each ">"-separated item +indicates one level of a nested (sub-)menu. +

+

Preference/Dialog Options

-

Choices in various dialogs, notably the Preferences and Properties dialog, are indicated like this: Edit > Preferences > Audio > Some Option Each successive >-separated item indicates either a (sub) menu or tabbed dialog navigation. The final item is the one to choose/select/deselect, etc.

+

+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. +

+

+If you are requested to deselect an option, you will see something like +this:
+Edit > Preferences > Audio > Some other +Option. +

+ +

Notes

-

Important notes about things that might not otherwise be obvious are shown in this format

-

"Context-click"

-

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.

+

+Important notes about things that might not otherwise be obvious are shown in this +format. +

+ +

Warnings

+

+Hairy issues that might cause things to go wrong, lose data, or impair sound +quality is displayed in this way. +

+ +

Mouse Buttons

-

We refer to mouse buttons as Left, Middle and Right. Ardour can use additional buttons, but they have no default behaviour in the program.

+

+We refer to mouse buttons as +Left, Middle and +Right. Ardour can use additional buttons, but they have +no default behaviour in the program. +

+ +

Mouse click modifiers

+

+Many editing functions are performed by clicking the mouse while holding a +modifier key, for example Left. + +

+

"Context-click"

+

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. +

+

"The Pointer"

-

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.

- +

+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. +

+ +

Other user input

+

+Ardour supports hardware controllers, such as banks of faders, knobs, or buttons. +

+