Moved track renaming into its own section and file, also rewritten to

include fix for 1467

Added small section on default track names

Updated section and chapter templates to reference version 4.4 of the
docbook DTD

git-svn-id: svn://localhost/ardour2/trunk@1431 d708f5d6-7413-0410-9779-e7cbd77b26cf

diff --git a/manual/images/mixer_strip_name_button_popup.png b/manual/images/mixer_strip_name_button_popup.png
new file mode 100644 (file)
index 0000000..6092cec
Binary files /dev/null and b/manual/images/mixer_strip_name_button_popup.png differ

diff --git a/manual/images/track_name_field.png b/manual/images/track_name_field.png
new file mode 100644 (file)
index 0000000..8cf02b9
Binary files /dev/null and b/manual/images/track_name_field.png differ

diff --git a/manual/templates/chapter_template.xml b/manual/templates/chapter_template.xml
index fa044b04bc84c5f44380972fa520d941ef0a6870..7a82e3385395c8de509999689ee78b241c14d4b3 100644 (file)
--- a/manual/templates/chapter_template.xml
+++ b/manual/templates/chapter_template.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" standalone="no"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
 ]>
 

diff --git a/manual/templates/section_template.xml b/manual/templates/section_template.xml
index 7c21873bf0841726a2b4170e7884b281ffa7a0f5..a32339e520c1bf6857494499da197829cbce26c6 100644 (file)
--- a/manual/templates/section_template.xml
+++ b/manual/templates/section_template.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" standalone="no"?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
 ]>
 

diff --git a/manual/xml/default_track_names.xml b/manual/xml/default_track_names.xml
new file mode 100644 (file)
index 0000000..cad4345
--- /dev/null
+++ b/manual/xml/default_track_names.xml
@@ -0,0 +1,22 @@
+<?xml version="1.0" standalone="no"?>
+
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+
+]>
+
+<section id="default-track-names">
+       <title>Default Track Names</title>
+       <para>
+               When a track is added to the session it is given a default name based on the
+               Track type. For example, the first audio track that is added to the session
+               will be given the name <literal>Audio 1</literal> and the first bus will be
+               called <literal>Bus 1</literal> and any subsequently added tracks will be
+               consecutively numbered.
+       </para>
+
+       <para>
+               Track names determine the names of the files created when recording to a
+               track so it is suggested that meaningful names are given to tracks, see
+               <xref linkend="renaming-tracks"/>
+       </para>
+</section>

diff --git a/manual/xml/renaming_tracks.xml b/manual/xml/renaming_tracks.xml
index 8004e191931574058efff518acd03f2912dfd896..fc524eb0ed00933cc257815b3609c115613bcf7b 100644 (file)
--- a/manual/xml/renaming_tracks.xml
+++ b/manual/xml/renaming_tracks.xml
@@ -1,19 +1,56 @@
 <?xml version="1.0" standalone="no"?>
+
 <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
 ]>
 
-<section id="sn-renaming-tracks">
-
+<section id="renaming-tracks">
        <title>Renaming Tracks</title>
-
        <para>
-               In the editor or mixer, the track name. - In the New Track Name dialog, type a new track name.
+               Tracks can be renamed from within the <link linkend="sn-editor-window">Editor
+               Window</link> or the <link linkend="sn-mixer-window">Mixer Window</link>.
        </para>
 
-       <!--
-       <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 
-               href="Some_Subsection.xml" />
-       -->
+       <para>
+               To change the name of a track in the Editor Window click within the track
+               name field in the <link linkend="track-controls">Track Controls</link>,
+               enter the new track name and press the <keycap>Enter</keycap> key to confirm
+               the change.
+       </para>
+       <mediaobject>
+               <imageobject>
+                       <imagedata fileref="images/track_name_field.png"/>
+               </imageobject>
+       </mediaobject>
+       <para>
+               If you decide not to rename a track after already changing the content of
+               the track name field but before confirming the change pressing the
+               <keycap>ESC</keycap> key will restore the original track name.
+       </para>
+       <tip>
+               <para>
+                       Several tracks can be renamed quickly in sequence by using the
+                       <keycap>Tab</keycap> key to move the focus between the track name fields.
+               </para>
+       </tip>
+       <para>
+               To change the name of a track in Mixer Window click on the track name button
+               and choose <guimenuitem>Rename</guimenuitem> from the pop-up menu.
+       </para>
+       <mediaobject>
+               <imageobject>
+                       <imagedata fileref="images/mixer_strip_name_button_popup.png"/>
+               </imageobject>
+       </mediaobject>
+       <para>
+               A dialog will then appear allowing you to rename the track, input the new
+               name and press <keycap>Enter</keycap> or click
+               <guimenuitem>Rename</guimenuitem> to confirm the name change.
+       </para>
 
+       <caution>
+               <para>
+                       Changes to track names cannot be undone.
+               </para>
+       </caution>
 </section>

diff --git a/manual/xml/sessions.xml b/manual/xml/sessions.xml
index 2205a284f9bafb664ad655eda4db82d9b2679ee8..e7c153ee1cb2022102c93e442e3e17cecbe9dcd6 100644 (file)
--- a/manual/xml/sessions.xml
+++ b/manual/xml/sessions.xml
@@ -21,9 +21,6 @@
        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 
                href="adding_tracks.xml" />
 
-       <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 
-               href="renaming_tracks.xml" />
-
        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 
                href="opening_a_session.xml" />
 

diff --git a/manual/xml/tracks_and_busses.xml b/manual/xml/tracks_and_busses.xml
index 0485f9c44fbc8d360eeec069a63dc63ffb89584f..cbe1d7c6627e9576be02a8d90cf6f778b812816a 100644 (file)
--- a/manual/xml/tracks_and_busses.xml
+++ b/manual/xml/tracks_and_busses.xml
@@ -53,27 +53,11 @@
                                </para>
                        </listitem>
                </orderedlist>
-               <para>
-                       After the track is created, it is recommended that you change its name from
-                       the generic name it will have been provided with. To rename a track:
-               </para>
-               <orderedlist>
-                       <title>Renaming a Track</title>
-                       <listitem>
-                               <para>
-                                       In the editor or mixer, the track name, and select <guimenuitem>Rename</guimenuitem> from the
-                                       dialog that appears. This will cause the "New Track Name" dialog to appear.
-                               </para>
-                       </listitem>
-                       <listitem>
-                               <para>
-                                       In the New Track Name dialog, type a new track name, and then click the
-                                       <guibutton>OK</guibutton> button in that dialog.
-                               </para>
-                       </listitem>
-               </orderedlist>
        </section>
 
+       <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 
+               href="renaming_tracks.xml" />
+
        <section id="deleting-tracks">
                <title>Deleting Tracks</title>
                <para>
@@ -325,6 +309,15 @@
                        <para></para>
                </section>
        </section>
+
+       <section id="track-controls">
+               <title>Track Controls</title>
+               <para></para>
+       </section>
+
+       <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 
+               href="default_track_names.xml" />
+
 <!--
                        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" 
                                href="Some_Subsection.xml" />