ardour/manual
13
0
Fork 0
Code Pull Requests Releases Activity

Major reordering of Part IV, including some section cleanup.

Browse Source
This commit is contained in:
Shamus Hammons 2017-02-22 22:45:23 -06:00
parent 6842c3f6a9
commit 0f52306465
21 changed files with 270 additions and 292 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/backup-and-sharing-of-sessions.html
View File

@ -1,10 +1,10 @@
<p>
An Ardour session is stored in a single folder on your computer's filesystem. This makes <dfn>backup</dfn> very easy&mdash;any tool capable of backing up a folder can be used to backup a session. You pick the location of a session when it is created&mdash;by default it will be in your default session location, which can be altered via <kbd class="menu">Edit &gt; Preferences &gt; Misc &gt; Session Management</kbd>.
An Ardour session is stored in a single folder on the computer's filesystem. This makes <dfn>backup</dfn> very easy&mdash;any tool capable of backing up a folder can be used to backup a session. The location of a session can be chosen when it is created&mdash;by default it will be in the default session location, which can be altered via <kbd class="menu">Edit &gt; Preferences &gt; Misc &gt; Session Management</kbd>.
</p>
<p class="warning">
There is one complication: a session may reference media files that are stored outside of the session folder, if the user has opted not to select <kbd class="optoff">Session &gt; Import &gt; Copy to Session</kbd> during import. Backing up a session with embedded files will not create a copy of the session containing those files.
There is one complication: a session may reference media files that are stored outside of the session folder, if <kbd class="optoff">Session &gt; Import &gt; Copy to Session</kbd> is not selected during import. Backing up a session without embedded files will <strong>not</strong> create a copy of the session containing those files.
</p>
<p>

1
include/control-masters-mixer-strips.html
View File

@ -63,3 +63,4 @@ A VCA strip is made of (from top to bottom in the screenshot):
multiple buttons. Disconnecting a VCA from a track is done by unchecking this VCA in
the list that pops up, or clicking <kbd class="menu">Unassign All</kbd> to disconnect from all VCAs at once.
</p>

91
include/controlling-track-ordering.html
View File

@ -3,18 +3,87 @@
Ardour does not impose any particular ordering of tracks and busses in
either the editor or mixer windows. The default arrangements are as follows:
</p>
<p>
In the <dfn>Editor</dfn>, the Master bus will always be on top unless
In the <dfn>Editor</dfn> window, the Master bus will always be on top unless
hidden. Tracks and busses will appear in their initial order, from top to
bottom. The monitor section (if used) will never be visible in the editor
window.
</p>
<p>
In the <dfn>Mixer</dfn>, the tracks and busses will be displayed in their
initial order, from left to right. The Master bus is always on the far
right and occupies its own pane, so that it is always visible no matter
how you scroll the other mixer strips. If a Monitor section is used,
it shows up at the right edge of the mixer window, from where it can be
torn off into a separate window.
bottom. The monitor section (if used) is never visible in the editor window.
</p>
<p>
In the <dfn>Mixer</dfn> window, the tracks and busses will be displayed in
their initial order, from left to right. The Master bus is always on the far
right and occupies its own pane, so that it is always visible no matter how
many other mixer strips are present. If a Monitor section is used, it shows
up at the right edge of the mixer window; it can also be torn off into a
separate window.
</p>
<h2>Reordering Tracks</h2>
<p>
The <dfn>track ordering</dfn> of the Editor and Mixer is
<dfn>synchronized</dfn>: if you reorder in one window, the ordering in the
other window will follow.
</p>
<h3>Reordering in the Editor Window</h3>
<p>
Select the tracks to be moved, then use <kbd class="menu">Track &gt; Move Selected Tracks Up</kbd> (shortcut: <kbd class="mod1">&uarr;</kbd>) or <kbd class="menu">Track &gt; Move Selected Tracks Down</kbd> (shortcut: <kbd class="mod1">&darr;</kbd>).
</p>
<p>
Alternatively, the <a href="@@the-tracks-and-busses-list"><kbd
class="menu">Tracks &amp; Busses</kbd> panel of the Editor Lists</a> can be
used, if visible. Here, tracks and busses can be freely dragged-and-dropped
into any desired order.
</p>
<h3>Reordering in the Mixer Window</h3>
<p>
Within the <kbd class="menu">Strips</kbd> pane at the top left of the Mixer
window, tracks and busses can be freely dragged-and-dropped into any desired
order.
</p>
<h3>"Collecting" Group Members</h3>
<p>
Tracks and Busses that are members of a group can be reordered so that they
display contiguously within the Editor and Mixer windows. <kbd
class=mouse>Right</kbd>-click on the group tab and choose <kbd
class="menu">Collect</kbd>.
</p>
<h2>Ordering of New Tracks</h2>
<p>
When <dfn>adding new tracks</dfn>, the current selection determines their
placement. New tracks will be placed after the rightmost (in the mixer) or
bottom-most (in the editor) selected track. If no tracks are selected, new
tracks will be added at the end.
</p>
<p class="note">
Because new tracks are automatically selected, they can be quickly reordered
in the editor window via the keyboard shortcuts after adding them.
</p>
<h2>Track Ordering and Remote Control IDs</h2>
<p>
Every track and bus in Ardour is assigned a <dfn>remote control ID</dfn>.
When a <a href="@@control-surfaces">control surface</a> or any other
remote control is used to control Ardour, these IDs are used to identify
which track(s) or buss(es) are the intended target of incoming commands.
</p>
<p>
Remote IDs are assigned to tracks and buses in the order that they appear in
the mixer window from left to right, starting from #1; manual assignment of
remote IDs is not possible. The master bus and monitor section can be
accessed by name.
</p>

1
include/file-and-session-management-and-compatibility.html
View File

@ -1,3 +1,2 @@
<p class="fixme">Add content</p>

1
include/files-and-directories-ardour-knows-about.html
View File

@ -161,3 +161,4 @@
<p>
This is the subdirectory where exported files end up.
</p>

2
include/grouping-tracks.html
View File

@ -1,2 +0,0 @@

1
include/importing-and-exporting-session-data.html
View File

@ -1,3 +1,2 @@
<p class="fixme">Add content</p>

2
include/lua-scripting-in-ardour.html
View File

@ -1,2 +0,0 @@

2
include/metadata.html
View File

@ -7,3 +7,5 @@
<img src="/images/edit-session-metadata.png" />
<p class=fixme>Add content</p>

2
include/midi-event-list.html
View File

@ -1,2 +0,0 @@

1
include/midi-list-editor.html
View File

@ -42,3 +42,4 @@
The Name field is related to the Number one, and cannot be edited. To change a
note, its number must be changed, which will be reflected in the Name field.
</p>

12
include/renaming-a-session.html
View File

@ -1,13 +1,19 @@
<p>
Use <kbd class="menu">Session &gt; Rename</kbd> to give your session a new name. A dialog will appear to ask you for the new name.
Use <kbd class="menu">Session &gt; Rename</kbd> to give the session a new
name. A dialog will appear asking for the new name.
</p>
<p>
This operation does <strong>not</strong> make a new session folder&mdash;the existing session folder and relevant contents are renamed. If your session was not saved before a rename operation, it will be saved automatically and then renaming will continue.
This operation does <strong>not</strong> make a new session folder&mdash;the
existing session folder and relevant contents are renamed. If the session was
not saved before a rename operation, it will be saved automatically and then
renaming will continue.
</p>
<p class="warning">
Ardour's <kbd class="menu">Session &gt; Save As</kbd> operation will not make a new copy of the session folder and its contents. All it does is create a new session file.
Ardour's <kbd class="menu">Session &gt; Save As</kbd> operation will not make
a new copy of the session folder and its contents. All it does is create a
new session file.
</p>

46
include/reordering-tracks.html
View File

@ -1,46 +0,0 @@
<p>
The <dfn>track ordering</dfn> of the Editor and Mixer is <dfn>synchronized</dfn>: if you
reorder in one window, the ordering in the other window will follow.
</p>
<h2>Reordering in the Editor Window</h2>
<p>
Select the tracks you want to move. Then use<br>
<kbd class="menu">Track &gt; Move Selected Tracks Up</kbd>
(shortcut: <kbd class="mod1">&uarr;</kbd>) or<br>
<kbd class="menu">Track &gt; Move Selected Tracks Down</kbd>
(shortcut: <kbd class="mod1">&darr;</kbd>).
</p>
<p>
Alternatively, you can use the <a href="@@the-tracks-and-busses-list"><kbd class="menu">Tracks &amp; Busses</kbd>
panel of the Editor Lists</a>, if visible.
Here, you can freely drag-and-drop tracks and busses into any order you prefer.
</p>
<h2>Reordering in the Mixer Window</h2>
<p>
Within the <kbd class="menu">Strips</kbd> pane at the top left of the
Mixer window, you can freely drag-and-drop tracks and busses into any
desired order.
</p>
<h2>"Collecting" Group Members</h2>
<p>
Tracks and Busses that are members of a group can be reordered so that they
display contiguously within the Editor and Mixer windows. Context-click on
the group tab and choose <kbd class="menu">Collect</kbd>.
</p>
<h2>Ordering of New Tracks</h2>
<p>
When <dfn>adding new tracks</dfn>, the current selection determines their
placement. New tracks will be placed after the rightmost (in the mixer) or
bottom-most (in the editor) selected track. If no tracks are selected, new
tracks will be added at the end.
</p>
<p class="note">
Because new tracks are automatically selected, you can quickly reorder them
in the editor window via the keyboard shortcuts after adding them (see above).
</p>

1
include/rhythm-ferret.html
View File

@ -167,3 +167,4 @@
<kbd class="mouse">RIGHT</kbd> click &gt; Selected Regions &gt; Position &gt;
Snap position to grid.
</p>

26
include/status-indicators-and-mode-buttons.html
View File

@ -1,26 +0,0 @@
<img src="/images/status-and-mode-buttons.png" alt="The Status buttons, the Mode buttons and " />
<p>
The <dfn>Status</dfn> buttons show the current session state:
</p>
<dl>
<dt>Solo</dt><dd>Blinks when one or more tracks are being soloed, see <a href="@@muting-and-soloing">Muting and Soloing</a>. Clicking this button disables any active explicit and implicit solo on all tracks and busses. Clicking this button desactivates the solo on every track/bus.</dd>
<dt>Audition</dt><dd>Blinks when some audio is auditionned, e.g. by using the import dialog, or using the <kbd class="menu">Audition</kbd> context menu in the <a href="@@the-region-list">Regions List</a>. Clicking this button stops the auditionning.</dd>
<dt>Feedback</dt><dd>Blinks when Ardour detects a <dfn>feedback loop</dfn>, which happens when the output of an audio signal chain is plugged back to its input. This is probably not wanted and can be dangerous for the hardware and the listener.</dd>
</dl>
<p>
The Mode Selector allows switching between Editor, Mixer and the Preferences window.
If a window is detached, the corresponding button is lit in blue. Clicking the botton
switches the detached window visibility.
</p>
<p>
The global meter shows the levels of the master's output. Its the same meter that sits
in the <a href="@@master-bus-strip">Master's Mixer strip</a>,
and also shows a peak indicator, that turns red when any level exceeds 0dB. It can
be reset by a <kbd class="mouse">Left</kbd> click.
</p>

1
include/the-region-menu.html
View File

@ -85,3 +85,4 @@
<dt>Remove</dt><dd>Deletes the region from the edit (no file is harmed in the process, and the region stays in the Editor for later use)</dd>
</dl>

5
include/track-context-menu.html
View File

@ -69,3 +69,8 @@
<dt>Freeze</dt>
</dl>
<!-- FIXME: Adding a <p>aragraph with fixme, note, or warning classes after a <dl> causes the styling of the class to hijack the styling of the definition list, hence, the following ugliness: -->
<p>&nbsp;</p>
<p class=fixme>Add content</p>

14
include/track-ordering-and-remote-control-ids.html
View File

@ -1,14 +0,0 @@
<p>
Every track and bus in Ardour is assigned a <dfn>remote control ID</dfn>.
When a <a href="@@control-surfaces">control surface</a> or any other
remote control is used to control Ardour, these IDs are used to identify
which track(s) or buss(es) are the intended target of incoming commands.
</p>
<p>
Remote IDs will be assigned to tracks and buses in the order that
they appear in the mixer window from left to right, starting from 1.
Manual assignment of remote IDs is not possible.
The master bus and monitor section can be accessed by name.
</p>

1
include/transport-bar.html
View File

@ -102,3 +102,4 @@
Go to the <kdb class="menu">Transport</kbd> and <kdb class="menu">Transport &gt;
Playhead</kbd> to find more.
</p>

17
include/where-are-sessions-stored.html
View File

@ -1,17 +1,14 @@
<p>
<dfn>Sessions</dfn> are stored in a single folder on your computer's filesystem.
<dfn>Sessions</dfn> are stored in a single folder on the computer's
filesystem. The first time Ardour is run, it will ask for the default location for this folder, with the initial choice being the current user's home folder.
</p>
<p>
The first time you run Ardour, you will be asked where you would like the
default location for sessions to be, with the initial choice being your
home folder.
</p>
<p>
After the first-run dialog, you can still change the default location at
After the first-run dialog, the default location can still be changed at
any time via <kbd class="menu">Edit &gt; Preferences &gt; Misc &gt; Session
Management</kbd>. You can also specify a particular (different) location for
a session when creating it, in the
<a href="@@newopen-session-dialog">New Session dialog</a>.
Management</kbd>. A particular (different) location for a session can also be
specified when creating it, in the <a href="@@newopen-session-dialog">New
Session dialog</a>.
</p>

331
master-doc.txt
View File

@ -878,14 +878,6 @@ uri: working-with-sessions
part: chapter
---
---
title: New/Open Session Dialog
include: newopen-session-dialog.html
link: newopen-session-dialog
uri: working-with-sessions/the-new-session-dialog
part: subchapter
---
---
title: What's in a Session?
include: whats-in-a-session.html
@ -903,42 +895,10 @@ part: subchapter
---
---
title: Backup and Sharing of Sessions
include: backup-and-sharing-of-sessions.html
link: backup-and-sharing-of-sessions
uri: working-with-sessions/backup-and-sharing-of-sessions
part: subchapter
---
---
title: Interchange with other DAWs
include: interchange-with-other-daws.html
link: interchange-with-other-daws
uri: working-with-sessions/interchange-with-other-daws
part: subchapter
---
---
title: Copying The Interchange Folder
include: copying-the-interchange-folder.html
link: copying-the-interchange-folder
uri: working-with-sessions/interchange-with-other-daws/copying-the-interchange-folder
part: subchapter
---
---
title: Stem Exports
include: stem-exports.html
link: stem-exports
uri: working-with-sessions/interchange-with-other-daws/stem-exports
part: subchapter
---
---
title: Using AATranslator
include: using-aatranslator.html
link: using-aatranslator
uri: working-with-sessions/interchange-with-other-daws/using-aatranslator
title: New/Open Session Dialog
include: newopen-session-dialog.html
link: newopen-session-dialog
uri: working-with-sessions/the-new-session-dialog
part: subchapter
---
@ -951,23 +911,7 @@ part: subchapter
---
---
title: Session Templates
include: session-templates.html
link: session-templates
uri: working-with-sessions/session-templates
part: subchapter
---
---
title: Snapshots
include: snapshots.html
link: snapshots
uri: working-with-sessions/snapshots
part: subchapter
---
---
title: Metadata
title: Session Metadata
include: metadata.html
link: metadata
uri: working-with-sessions/metadata
@ -975,50 +919,10 @@ part: subchapter
---
---
title: Cleaning up Sessions
include: cleaning-up-sessions.html
link: cleaning-up-sessions
uri: working-with-sessions/cleaning_up
part: subchapter
---
---
title: Copying versus Linking
include: copying-versus-linking.html
link: copying-versus-linking
uri: adding-pre-existing-material/copying-versus-linking
part: subchapter
---
---
title: Adding Pre-existing Material
include: adding-pre-existing-material.html
link: adding-pre-existing-material
uri: adding-pre-existing-material
part: subchapter
---
---
title: Import Dialog
include: import-dialog.html
link: import-dialog
uri: adding-pre-existing-material/import-dialog
part: subchapter
---
---
title: Searching for Files Using Tags
include: searching-for-files-using-tags.html
link: searching-for-files-using-tags
uri: adding-pre-existing-material/searching-for-files-using-tags
part: subchapter
---
---
title: Supported File Formats
include: supported-file-formats.html
link: supported-file-formats
uri: adding-pre-existing-material/supported-file-formats
title: Backup and Sharing of Sessions
include: backup-and-sharing-of-sessions.html
link: backup-and-sharing-of-sessions
uri: working-with-sessions/backup-and-sharing-of-sessions
part: subchapter
---
@ -1054,12 +958,59 @@ uri: working-with-tracks/selecting-tracks
part: subchapter
---
---
title: Controlling Track Ordering
include: controlling-track-ordering.html
link: controlling-track-ordering
uri: working-with-tracks/controlling-track-ordering
part: subchapter
---
---
title: Track Context Menu
include: track-context-menu.html
link: track-context-menu
uri: working-with-tracks/track-context-menu
part: subchapter
---
---
title: Track Controls
include: track-controls.html
link: track-controls
part: chapter
---
---
title: Bus Controls
include: bus-controls.html
link: bus-controls
uri: working-with-tracks/bus-controls
part: subchapter
---
---
title: Audio Track Controls
include: audio-track-controls.html
link: audio-track-controls
uri: working-with-tracks/audio-track-controls
part: subchapter
---
---
title: MIDI Track Controls
include: midi-track-controls.html
link: midi-track-controls
uri: working-with-tracks/midi-track-controls
part: subchapter
---
---
title: Controlling Track Appearance
include: controlling-track-appearance.html
link: controlling-track-appearance
uri: working-with-tracks/controlling-track-appearance
part: subchapter
part: chapter
---
---
@ -1094,91 +1045,126 @@ uri: working-with-tracks/controlling-track-appearance/waveform-display
part: subchapter
---
---
title: Controlling Track Ordering
include: controlling-track-ordering.html
link: controlling-track-ordering
uri: working-with-tracks/controlling-track-ordering
part: subchapter
---
---
title: Reordering Tracks
include: reordering-tracks.html
link: reordering-tracks
uri: working-with-tracks/controlling-track-ordering/reordering-tracks
part: subchapter
---
---
title: Track Ordering and Remote Control IDs
include: track-ordering-and-remote-control-ids.html
link: track-ordering-and-remote-control-ids
uri: working-with-tracks/controlling-track-ordering/track-ordering-and-remote-control-ids
part: subchapter
---
---
title: Bus Controls
include: bus-controls.html
link: bus-controls
uri: working-with-tracks/bus-controls
part: subchapter
---
---
title: Audio Track Controls
include: audio-track-controls.html
link: audio-track-controls
uri: working-with-tracks/audio-track-controls
part: subchapter
---
---
title: MIDI Track Controls
include: midi-track-controls.html
link: midi-track-controls
uri: working-with-tracks/midi-track-controls
part: subchapter
---
---
title: Track Context Menu
include: track-context-menu.html
link: track-context-menu
uri: working-with-tracks/track-context-menu
part: subchapter
---
---
title: Grouping Tracks
include: grouping-tracks.html
link: grouping-tracks
part: chapter
---
---
title: Track and Bus Groups
include: track-and-bus-groups.html
link: track-and-bus-groups
uri: working-with-tracks/track-and-bus-groups
part: subchapter
part: chapter
---
---
title: Importing and Exporting Session Data
menu_title: Import/Export Session Data
include: importing-and-exporting-session-data.html
link: importing-and-exporting-session-data
part: chapter
---
---
title: Import Dialog
include: import-dialog.html
link: import-dialog
uri: adding-pre-existing-material/import-dialog
part: subchapter
---
---
title: Supported File Formats
include: supported-file-formats.html
link: supported-file-formats
uri: adding-pre-existing-material/supported-file-formats
part: subchapter
---
---
title: Adding Pre-existing Material
include: adding-pre-existing-material.html
link: adding-pre-existing-material
uri: adding-pre-existing-material
part: subchapter
---
---
title: Copying Versus Linking
include: copying-versus-linking.html
link: copying-versus-linking
uri: adding-pre-existing-material/copying-versus-linking
part: subchapter
---
---
title: Searching for Files Using Tags
include: searching-for-files-using-tags.html
link: searching-for-files-using-tags
uri: adding-pre-existing-material/searching-for-files-using-tags
part: subchapter
---
---
title: Stem Exports
include: stem-exports.html
link: stem-exports
uri: working-with-sessions/interchange-with-other-daws/stem-exports
part: subchapter
---
---
title: File and Session Management and Compatibility
menu_title: File/Session Mgmt &amp; Compat.
include: file-and-session-management-and-compatibility.html
link: file-and-session-management-and-compatibility
part: chapter
---
---
title: Session Templates
include: session-templates.html
link: session-templates
uri: working-with-sessions/session-templates
part: subchapter
---
---
title: Snapshots
include: snapshots.html
link: snapshots
uri: working-with-sessions/snapshots
part: subchapter
---
---
title: Cleaning Up Sessions
include: cleaning-up-sessions.html
link: cleaning-up-sessions
uri: working-with-sessions/cleaning_up
part: subchapter
---
---
title: Interchange with other DAWs
include: interchange-with-other-daws.html
link: interchange-with-other-daws
uri: working-with-sessions/interchange-with-other-daws
part: subchapter
---
---
title: Copying The Interchange Folder
include: copying-the-interchange-folder.html
link: copying-the-interchange-folder
uri: working-with-sessions/interchange-with-other-daws/copying-the-interchange-folder
part: subchapter
---
---
title: Using AATranslator
include: using-aatranslator.html
link: using-aatranslator
uri: working-with-sessions/interchange-with-other-daws/using-aatranslator
part: subchapter
---
---
title: Playback & Recording
uri: recording
@ -1708,8 +1694,8 @@ part: subchapter
---
title: MIDI List Editor
link: midi-list-editor
include: midi-list-editor.html
link: midi-list-editor
part: subchapter
---
@ -2075,6 +2061,7 @@ part: chapter
---
title: Multichannel Tracks and Signal Routing
menu_title: Multichannel Signal Routing
include: multichannel-tracks-and-signal-routing.html
link: multichannel-tracks-and-signal-routing
part: chapter
@ -2434,7 +2421,7 @@ part: chapter
---
title: MIDI notes reference
link: midi-notes-ref
include: midi-notes-ref.html
link: midi-notes-ref
part: chapter
---