part: chapter
---
+ ---
+ title: About Ardour's documentation
+ part: subchapter
+ ---
+
+ <h2>Conventions Used In This Manual</h2>
+
+ <p>
+ This section covers some of the typographical and language conventions used in this manual.
+ </p>
+
+ <h3>Keyboards and Modifiers</h3>
+
+ <p>
+ <dfn>Keyboard bindings</dfn> are shown like this: <kbd>s</kbd> or <kbd class="mod1">x</kbd>.
+ </p>
+
+ <p>
+ <kbd class="mod1">x</kbd> means "press the <kbd class="mod1"> </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"> </kbd> key <em>and</em> the <kbd class="mod2"> </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>Mouse Buttons</h3>
+
+ <p>
+ We refer to <a href="/setting-up-your-system/the-mouse">mouse buttons</a> as <kbd class="mouse">Left</kbd>, <kbd class="mouse">Middle</kbd> and <kbd class="mouse">Right</kbd>. Ardour can use additional buttons, but they have no default behaviour in the program.
+ </p>
+
+ <h4>Mouse click modifiers</h4>
+
+ <p>
+ Many editing functions are performed by clicking the mouse while holding a 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">⇑</kbd> <kbd class="mouse">⇐</kbd> <kbd class="mouse">⇓</kbd> <kbd class="mouse">⇒</kbd>.
+ </p>
+
+ <h4>Context-click</h4>
+
+ <p>
+ The term <dfn>context-click</dfn> is used to indicate that you should (typically) <kbd class="mouse">Right</kbd>-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.
+ </p>
+
+ <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 interface.
+ </p>
+
+ <h3>Other user input</h3>
+
+ <p>
+ Ardour supports hardware controllers, such as banks of <kbd class="fader">faders</kbd>, <kbd class="knob">knobs</kbd>, or <kbd class="button">buttons</kbd>.
+ </p>
+
+ <h3>Menu Items</h3>
+
+ <p>
+ Menu items are indicated like this:<br />
+ <kbd class="menu">Top > Next > Deeper</kbd>.<br />
+ Each ">"-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 > Preferences > Audio > 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 > Preferences > Audio > 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="cmd lin">cat /proc/cpuinfo</kbd>
+ <kbd class="cmd mac">sleep 3600</kbd>
+ <kbd class="cmd win">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>
+
---
title: Welcome to Ardour!
<li>they are not available in source code form, making modifications, improvements, bugfixes by technically inclined users or their friends or consultants impossible.</li>
</ul>
+ ---
+ title: Additional Resources
+ part: subchapter
+ ---
+
+ <p>
+ In addition to this documentation, you may check a variety of other <dfn>resources</dfn>:
+ </p>
+
+ <ul>
+ <li>the <a href="https://ardour.org/whatsnew.html">Ardour release
+ notes</a></li>
+ <li>the <a href="https://community.ardour.org/forums">Ardour
+ Forums</a></li>
+ <li>information about <a href="https://community.ardour.org/community">Ardour
+ Support</a> via mailing lists and IRC (chat)</li>
+ </ul>
+
+ <p>
+ The <dfn>IRC channels</dfn> 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.
+ </p>
+
+ <p>
+ 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.
+ </p>
+
+
---
title: Creating Music with Ardour
part: subchapter
---
+ <p class="fixme"> misplaced</p>
<p>
Ardour can be used in many different ways, from extremely simple to
extremely complex. Many projects will be handled using the following
</dl>
- ---
- title: Using This Documentation
- part: chapter
- ---
-
-
- ---
- title: About Ardour documentation
- part: subchapter
- ---
-
- <h2>Conventions Used In This Manual</h2>
-
- <p>
- This section covers some of the typographical and language conventions used in this manual.
- </p>
-
- <h3>Keyboards and Modifiers</h3>
-
- <p>
- <dfn>Keyboard bindings</dfn> are shown like this: <kbd>s</kbd> or <kbd class="mod1">x</kbd>.
- </p>
-
- <p>
- <kbd class="mod1">x</kbd> means "press the <kbd class="mod1"> </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"> </kbd> key <em>and</em> the <kbd class="mod2"> </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>Mouse Buttons</h3>
-
- <p>
- We refer to <a href="/setting-up-your-system/the-mouse">mouse buttons</a> as <kbd class="mouse">Left</kbd>, <kbd class="mouse">Middle</kbd> and <kbd class="mouse">Right</kbd>. Ardour can use additional buttons, but they have no default behaviour in the program.
- </p>
-
- <h4>Mouse click modifiers</h4>
-
- <p>
- Many editing functions are performed by clicking the mouse while holding a 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">⇑</kbd> <kbd class="mouse">⇐</kbd> <kbd class="mouse">⇓</kbd> <kbd class="mouse">⇒</kbd>.
- </p>
-
- <h4>Context-click</h4>
-
- <p>
- The term <dfn>context-click</dfn> is used to indicate that you should (typically) <kbd class="mouse">Right</kbd>-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.
- </p>
-
- <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 interface.
- </p>
-
- <h3>Other user input</h3>
-
- <p>
- Ardour supports hardware controllers, such as banks of <kbd class="fader">faders</kbd>, <kbd class="knob">knobs</kbd>, or <kbd class="button">buttons</kbd>.
- </p>
-
- <h3>Menu Items</h3>
-
- <p>
- Menu items are indicated like this:<br />
- <kbd class="menu">Top > Next > Deeper</kbd>.<br />
- Each ">"-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 > Preferences > Audio > 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 > Preferences > Audio > 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="cmd lin">cat /proc/cpuinfo</kbd>
- <kbd class="cmd mac">sleep 3600</kbd>
- <kbd class="cmd win">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>
-
- ---
- title: Additional Resources
- part: subchapter
- ---
-
- <p>
- In addition to this documentation, you may check a variety of other <dfn>resources</dfn>:
- </p>
-
- <ul>
- <li>the <a href="https://ardour.org/whatsnew.html">Ardour release
- notes</a></li>
- <li>the <a href="https://community.ardour.org/forums">Ardour
- Forums</a></li>
- <li>information about <a href="https://community.ardour.org/community">Ardour
- Support</a> via mailing lists and IRC (chat)</li>
- </ul>
-
- <p>
- The <dfn>IRC channels</dfn> 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.
- </p>
-
- <p>
- 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.
- </p>
-
-
---
title: System Configuration
part: part
---
- title: Global view
+ title: About Ardour's Interface
part: chapter
---
The <dfn>Transport Bar</dfn> groups all the actions regarding the control of playback and recording.
</p>
-<img src="/images/transport.png" alt="The transport controls" />
+<p class="center"><img src="/images/transport.png" alt="The transport controls" /></p>
<p>
This bar is made of (from left to right):
<ul>
<li>
- <dfn>Midi Panic</dfn>: allows to immediately stop all midi output.
+ <dfn>Midi Panic</dfn>: Immediately stops all midi output.
</li>
<li>
<dfn>Enable/disable Audio Click</dfn>: Toggles (on/off) a click track (metronome) along the <a href="/tempo-meter/tempo-and-meter/">tempo</a>.
<dfn>Go to End of the Session</dfn>: Jumps forward to the end of the session, as defined by the <a href="/working-with-markers/">end marker</a>.
</li>
<li>
- <dfn>Play Loop Range</dfn>: Repeats the defined <a href="/controlling-playback/looping-the-transport/">loop</a> as defined by the <a href="/working-with-markers/loop-range/">Loop range</a>, until the "Stop playback" button is pressed. Clicking the "Play loop Range" button while already active switches to normal Play mode, which allows to exit the loop without stopping and restarting the playback.
+ <dfn>Play Loop Range</dfn>: Repeats the defined <a href="/controlling-playback/looping-the-transport/">loop</a> as defined by the <a href="/working-with-markers/loop-range/">Loop range</a>, until the "Stop playback" button is pressed. Clicking the "Play loop Range" button while already active switches to normal Play mode, which exits the loop without stopping and restarting playback.
</li>
<li>
<dfn>Play Range/Selection</dfn>: If a range has been defined using the Range Mode button, plays the range, of if an audio or MIDI region is selected, plays this region. In both cases, the playback stops at the end of the range or selected region.
</li>
<li>
- <dfn>Play from playhead</dfn>: Starts the playback and optionally record (more bellow).
+ <dfn>Play from playhead</dfn>: Starts the playback and optionally record (more below).
</li>
<li>
<dfn>Stop</dfn>: Whatever the playing mode (loop, range, …) stops all playback. Depending on other settings, some effects (like chorus or reverb) might still be audible for a while.
</li>
<li>
- <dfn>Toggle Record</dfn>: Global switch button to activate/deactivate recording. While active, the button blinks red. The button doesn't start
the recording itself: if one or more tracks are marked as record-enabled, pressing the "Play from Playhead" starts the recording on this/these track(s). See <a href="/recording/">Recording</a>.
+ <dfn>Toggle Record</dfn>: Global switch button to activate/deactivate recording. While active, the button blinks red. The button doesn't start
recording by itself: if one or more tracks are marked as record-enabled, pressing the "Play from Playhead" starts recording on those tracks. See <a href="/recording/">Recording</a>.
</li>
</ul>
-<p class="fixme">Language in the above paragraphs is awkward</p>
+<p class="fixme">Add default keyboard shortcuts to the above.</p>
<p class="note">
All these actions are bound to keyboard shortcuts, which allows for speedier use and more focused work.
<dfn>Follow Edits</dfn> is a toggle that can be used to control whether or not making a selection (range or object) will move the playhead to the start of the selection.
</li>
<li>
- <dfn>Auto Return</dfn> is a toggle switch too. When active, pressing the Stop button returns the playhead to its previous position, and when inactive, pressing Stop keeps the playhead at its current location. Activating Auto Return can be useful for earing back the same part of the audio before and after having tweaked it, without having to loop on it.
+ <dfn>Auto Return</dfn> is a toggle switch too. When active, pressing the Stop button returns the playhead to its previous position, and when inactive, pressing Stop keeps the playhead at its current location. Activating Auto Return can be useful for hearing the same piece of audio before and after tweaking it, without having to set a loop range on it.
</li>
</ul>
projects / ardour-manual-diverged / commitdiff