Add indexterm for renaming tracks

[ardour.git] / manual / xml / renaming_tracks.xml

diff --git a/manual/xml/renaming_tracks.xml b/manual/xml/renaming_tracks.xml
index 8004e191931574058efff518acd03f2912dfd896..bbac2963ebb429d4a8afdc6061360d7c72f363da 100644 (file)
--- a/manual/xml/renaming_tracks.xml
+++ b/manual/xml/renaming_tracks.xml
@@ -1,19 +1,63 @@
 <?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" [
 
-]>
+<!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">
+<!ENTITY % BOOK_ENTITIES SYSTEM "./entities.ent">
+%BOOK_ENTITIES;
 
-       <title>Renaming Tracks</title>
+]>
 
-       <para>
-               In the editor or mixer, the track name. - In the New Track Name dialog, type a new track name.
-       </para>
+<section id="renaming-tracks">
+  <title>Renaming Tracks</title>
+  <indexterm>
+    <primary>Tracks</primary>
+    <secondary>Renaming</secondary>
+  </indexterm>
+  <para>
+    Tracks can be renamed from within the &EDIT_WIN; or the &MIX_WIN;.
+  </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 &TRACK_CONTROLS;, 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>
 
+  <warning>
+    <para>
+      Changes to track names cannot be undone.
+    </para>
+  </warning>
 </section>