]> Shamusworld >> Repos - ardour-manual-diverged/commitdiff
Rudimentary documentation for the export dialog.
authorColin Fletcher <colin.m.fletcher@googlemail.com>
Fri, 4 Jul 2014 18:08:01 +0000 (19:08 +0100)
committerColin Fletcher <colin.m.fletcher@googlemail.com>
Fri, 4 Jul 2014 18:08:01 +0000 (19:08 +0100)
_manual/07_working-with-sessions/09_metadata.html [new file with mode: 0644]
_manual/18_exporting/01_export-dialog.html [new file with mode: 0644]
_manual/18_exporting/02_edit-export-format-profile.html [new file with mode: 0644]
source/ardour/manual/html/screenshots/edit-export-format-profile.png [new file with mode: 0644]
source/ardour/manual/html/screenshots/edit-session-metadata.png [new file with mode: 0644]
source/ardour/manual/html/screenshots/export-dialog-channels.png [new file with mode: 0644]
source/ardour/manual/html/screenshots/export-dialog-file-format.png [new file with mode: 0644]
source/ardour/manual/html/screenshots/export-dialog-timespan.png [new file with mode: 0644]

diff --git a/_manual/07_working-with-sessions/09_metadata.html b/_manual/07_working-with-sessions/09_metadata.html
new file mode 100644 (file)
index 0000000..702175e
--- /dev/null
@@ -0,0 +1,13 @@
+---
+layout: default
+title: Metadata
+---                        
+  
+<p>
+Sessions can have various items of metadata attached to them, via
+<kbd class ="menu">Session &gt; Metadata &gt; Edit Metadata...</kbd> and 
+<kbd class ="menu">Session &gt; Metadata &gt; Import Metadata...</kbd>.
+</p>
+
+<h2>Edit Session Metadata Dialog</h2>
+<img src="/ardour/manual/html/screenshots/edit-session-metadata.png" />
diff --git a/_manual/18_exporting/01_export-dialog.html b/_manual/18_exporting/01_export-dialog.html
new file mode 100644 (file)
index 0000000..19ee28d
--- /dev/null
@@ -0,0 +1,74 @@
+---
+layout: default
+title: Export Dialog
+---                        
+
+<p>
+When you have finished mixing your session, you probably want to export it to a sound 
+file to burn to a CD, upload to the web, or whatever. <kbd class="menu">Session &gt; Export &gt; Export to Audio file(s)...</kbd>
+shows the Export Dialog to do this.
+     
+</p>
+<p>
+You can also export the outputs of multiple tracks &amp; busses all at once via 
+<kbd class="menu">Session &gt; Export &gt; Stem Export...</kbd>.
+</p>
+
+<h2>File Format</h2>
+<img src="/ardour/manual/html/screenshots/export-dialog-file-format.png" />
+<p>
+This tab contains controls for the format of the exported audio file.
+You can enable more than one format here, in which case each will be exported in turn.
+Ardour is supplied with a list of export formats, including:
+<ul>
+<li>CD (Red Book)</li>
+<li>DVD-A</li>
+<li>FLAC 24 bit </li>
+<li>FLAC 24 bit (tagged)</li>
+<li>Ogg_Vorbis</li>
+<li>Ogg_Vorbis (tagged)</li>
+<li>Ring Tone</li>
+</ul>
+You can edit these formats, or create your own, with the <a href="/exporting/edit-export-format-profile/">"Edit Export Format Profile"</a> dialog, which
+appears when you click the "Edit" or "New" button to the right of the drop-down list of formats.
+</p>
+
+<p>
+You can also create a 'Preset' consisting of one or more formats. Ardour provides some ready-made presets, too:
+
+<ul>
+<li>CD + DVD-A</li>
+<li>CD + FLAC</li>
+<li>CD + FLAC (tagged)</li>
+<li>CD + Ogg_Vorbis + FLAC (tagged)</li>
+<li>CD + Ogg_Vorbis</li>
+<li>CD + Ogg_Vorbis (tagged)</li>
+<li>CD only</li>
+<li>DVD-A only</li>
+<li>FLAC</li>
+<li>FLAC (tagged)</li>
+<li>Ogg_Vorbis + FLAC</li>
+<li>Ogg_Vorbis + FLAC (tagged)</li>
+<li>Ogg_Vorbis </li>
+<li>Ogg_Vorbis (tagged)</li>
+</ul>
+</p>
+
+<h2>Time Span</h2>
+<img src="/ardour/manual/html/screenshots/export-dialog-timespan.png" />
+<p>
+This tab allows you to select the range (or ranges) of the timeline to export. By default, "session" is
+enabled - this will export the whole session from the start marker to the end marker.
+</p>
+
+
+<h2>Channels</h2>
+<img src="/ardour/manual/html/screenshots/export-dialog-channels.png" />
+<p>
+Here you can choose which outputs (tracks or busses) should be sent to the exported file.
+</p>
+
+
+{% children %}
+
+
diff --git a/_manual/18_exporting/02_edit-export-format-profile.html b/_manual/18_exporting/02_edit-export-format-profile.html
new file mode 100644 (file)
index 0000000..a408f8a
--- /dev/null
@@ -0,0 +1,138 @@
+---
+layout: default
+title: Export Format Profiles
+---                        
+
+<h2>Export Format Profiles</h2>
+
+<p>
+An Export Format Profile specifies the file format in which Ardour will export
+audio files, and also other audio file export options.
+</p>
+
+<p>
+Export Format Profiles are edited via the 'Edit Export Format Profile' dialog.
+</p>
+
+<img src="/ardour/manual/html/screenshots/edit-export-format-profile.png" />
+<p>
+<h3>Normalize</h3>
+<p>
+If enbled, peak levels of exported files will be normalized to the level chosen here.
+</p>
+
+<h3>Trim/Add silence at start/end</h3>
+<p>
+
+</p>
+
+<h3>Compatibility/Quality/File format/Sample rate</h3>
+<h4>Compatibility</h4>
+<p>
+Selecting an item in the 'Compatibility' column will display options in the
+other columns that are incompatible with that item in red.
+</p>
+
+<h4>Quality</h4>
+<p>
+The appropriate item in the 'Quality' column will be highlighted when you
+choose a file format. Clicking on items in the 'Quality' column currently
+doesn't seem to do anything useful.
+</p>
+
+<h4>File format</h4>
+<p>
+This column contains a list of Ardour's supported export file types. Click on
+the format you want to use.
+</p>
+
+<h4>Sample rate</h4>
+<p>
+You can explicitly choose the sample rate of your exported files here, or
+choose 'Session rate' to export in the current session's sample rate, without
+sample rate conversion.
+</p>
+
+<h4>Sample rate conversion quality</h4>
+<p>
+If your chosen sample rate does not match the current session's sample rate,
+choose the sample rate conversion quality here. Better quality options are
+slower.
+</p>
+
+<h3>Options</h3>
+<p>
+Options relevant to the chosen file format will appear here.
+Categories of audio file format are:
+<ul>
+<li>Linear encoding</li>
+<li>Broadcast Wave</li>
+<li>Ogg Vorbis</li>
+<li>FLAC</li>
+</ul>
+
+<p>
+Available options include a selection of the following:</p>
+
+<h4>Sample Format</h4>
+<p>
+Choose the bit depth of exported files.
+</p>
+
+<h4>Dithering</h4>
+<p>
+If the exported files bit depth is less than Ardour's native bit depth,
+choose the dithering algorithm to use.
+</p>
+
+<h4>Create CUE file/Create TOC file</h4>
+<p>
+As well as exporting an audio file, create a file (in CUE or TOC format
+respectively) containg CD track information, as defined in the
+<a href="/working-with-markers/rangesmarks-list/">Ranges &amp; Marks List</a>.
+
+
+<h4>Tag with session's metadata</h4>
+<p>
+If the exported file format supports metadata, use data entered in the
+<a href="/working-with-sessions/metadata/">Session Metadata</a>
+window to tag the exported files.
+</p>
+
+
+<h3>Label</h3>
+<p>
+The 'Label' field lets you choose the name which will be shown for this format
+in the drop-down list of export formats in the 'File Formats' tab of the 
+<a href="/exporting/export-dialog/">Export dialog</a>.
+
+<h3>Command to run post-export</h3>
+<p>
+If this is not blank, it is considered as a command to be run after the export
+of each file. Either the command must exist in $PATH, or you can specify an
+absolute path to an executable file here.
+</p>
+
+<p>
+Certain sequences are allowed here to stand for the exported file name and the
+like. Currently these are:
+<dl>
+<dt><code>%f</code></dt>
+<dd>Full path &amp; filename of the exported audio file</dd>
+<dt><code>%d</code></dt>
+<dd>Directory containing the exported audio file (including trailing directory separator)</dd>
+<dt><code>%b</code></dt>
+<dd>Basename of the exported audio file (without extension)</dd>
+<dt><code>%s</code></dt>
+<dd>Path to the current session file</dd>
+<dt><code>%n</code></dt>
+<dd>Name of the current session file</dd>
+<dt><code>%%</code></dt>
+<dd>A literal percent sign</dd>
+</dl>
+<p>
+Any pert of the command-line enclosed in double-quotes (") will be used as-is.
+
+{% children %}
+
+
diff --git a/source/ardour/manual/html/screenshots/edit-export-format-profile.png b/source/ardour/manual/html/screenshots/edit-export-format-profile.png
new file mode 100644 (file)
index 0000000..f2fdbc5
Binary files /dev/null and b/source/ardour/manual/html/screenshots/edit-export-format-profile.png differ
diff --git a/source/ardour/manual/html/screenshots/edit-session-metadata.png b/source/ardour/manual/html/screenshots/edit-session-metadata.png
new file mode 100644 (file)
index 0000000..8a9f2df
Binary files /dev/null and b/source/ardour/manual/html/screenshots/edit-session-metadata.png differ
diff --git a/source/ardour/manual/html/screenshots/export-dialog-channels.png b/source/ardour/manual/html/screenshots/export-dialog-channels.png
new file mode 100644 (file)
index 0000000..134ea42
Binary files /dev/null and b/source/ardour/manual/html/screenshots/export-dialog-channels.png differ
diff --git a/source/ardour/manual/html/screenshots/export-dialog-file-format.png b/source/ardour/manual/html/screenshots/export-dialog-file-format.png
new file mode 100644 (file)
index 0000000..f3de561
Binary files /dev/null and b/source/ardour/manual/html/screenshots/export-dialog-file-format.png differ
diff --git a/source/ardour/manual/html/screenshots/export-dialog-timespan.png b/source/ardour/manual/html/screenshots/export-dialog-timespan.png
new file mode 100644 (file)
index 0000000..c223ce1
Binary files /dev/null and b/source/ardour/manual/html/screenshots/export-dialog-timespan.png differ