From: Ed Ward Date: Thu, 12 Jan 2017 17:16:53 +0000 (+0100) Subject: Getting rid of Using This Documentation and placing subs elsewhere X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?p=ardour-manual-diverged;a=commitdiff_plain;h=6921f2a37e1d4734dc26140a3244f394813ebcd5 Getting rid of Using This Documentation and placing subs elsewhere --- diff --git a/master-doc.txt b/master-doc.txt index b8fa400..b4b1828 100644 --- a/master-doc.txt +++ b/master-doc.txt @@ -9,6 +9,125 @@ title: Welcome to Ardour part: chapter --- +--- +title: About Ardour's documentation +part: subchapter +--- + +

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

+ +

+ x means "press the   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 hold down the   key and the   key, and then, while keeping them both down, 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. +

+ +

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

+ +

Mouse click modifiers

+ +

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

+ +

Mouse wheel

+ +

+ 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 ⇑ ⇐ ⇓ ⇒. +

+ +

Context-click

+ +

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

+ +

Other user input

+ +

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

+ +

Menu Items

+ +

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

+ +

User Input

+ +

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

Program Output

+ +

+ Important messages from Ardour or other programs will be displayed like this. +

+ +

Notes

+ +

+ 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, impair sound quality, or eat your proverbial goldfish, are displayed in this way. +

+ --- title: Welcome to Ardour! @@ -200,11 +319,39 @@ part: subchapter
  • they are not available in source code form, making modifications, improvements, bugfixes by technically inclined users or their friends or consultants impossible.
    • +--- +title: Additional Resources +part: subchapter +--- + +

    + In addition to this documentation, you may check a variety of other resources: +

    + + + +

    + The IRC channels in particular are where most of the day-to-day development and debugging is done, and there are plenty of experienced users to help you if you run into problems. +

    + +

    + Please be prepared to hang around for a few hours, the chat is usually busiest from 19:00 UTC to 04:00 UTC. If you can, keep your chat window open, so that you don't miss a belated answer. Also, don't ask for permission to ask a question, just ask your question with the understanding that the answer (from the "right" people or not) could come seconds, minutes, hours, or never. +

    + + --- title: Creating Music with Ardour part: subchapter --- +

    misplaced

    Ardour can be used in many different ways, from extremely simple to extremely complex. Many projects will be handled using the following @@ -1686,158 +1833,6 @@ part: subchapter ---- -title: Using This Documentation -part: chapter ---- - - ---- -title: About Ardour documentation -part: subchapter ---- - -

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

    - -

    - x means "press the   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 hold down the   key and the   key, and then, while keeping them both down, 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. -

    - -

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

    - -

    Mouse click modifiers

    - -

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

    - -

    Mouse wheel

    - -

    - 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 ⇑ ⇐ ⇓ ⇒. -

    - -

    Context-click

    - -

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

    - -

    Other user input

    - -

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

    - -

    Menu Items

    - -

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

    - -

    User Input

    - -

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

    Program Output

    - -

    - Important messages from Ardour or other programs will be displayed like this. -

    - -

    Notes

    - -

    - 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, impair sound quality, or eat your proverbial goldfish, are displayed in this way. -

    - ---- -title: Additional Resources -part: subchapter ---- - -

    - In addition to this documentation, you may check a variety of other resources: -

    - - - -

    - The IRC channels in particular are where most of the day-to-day development and debugging is done, and there are plenty of experienced users to help you if you run into problems. -

    - -

    - Please be prepared to hang around for a few hours, the chat is usually busiest from 19:00 UTC to 04:00 UTC. If you can, keep your chat window open, so that you don't miss a belated answer. Also, don't ask for permission to ask a question, just ask your question with the understanding that the answer (from the "right" people or not) could come seconds, minutes, hours, or never. -

    - - --- title: System Configuration part: part @@ -6962,7 +6957,7 @@ part: part --- -title: Global view +title: About Ardour's Interface part: chapter ---