manual/xml/editor_window_region_list.xml

   1 <?xml version="1.0" standalone="no"?>
   2
   3 <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
   4
   5 ]>
   6
   7 <section id="editor-window-region-list">
   8   <title>Region List</title>
   9   <para>
  10     To the right of the track display is the region list, which uses a tree
  11     display to show all regions in the session. There are sections in the
  12     region list, &#8220;Captured&#8221; and &#8220;External&#8221;.
  13     &#8220;Captured&#8221; contains all regions that were either recorded by
  14     Ardour or imported as native audio files. &#8220;External&#8221;contains
  15     regions created using audio files external to Ardour (from a sample
  16     library, for example).
  17   </para>
  18
  19   <section id="region-list-organization">
  20     <title>Organization of the region list</title>
  21     <para>
  22       In both sections of the region list, any regions containing multiple
  23       channels will have its name followed by &#8220;[N]&#8221; where N is a
  24       number indicating the number of channels. Any region that ends in
  25       &#8220;-N&#8221;, where N is a number, is a region that describes an
  26       entire audio file. Any region that ends in &#8220;.N&#8221; is a
  27       region that describes part of an audio file. Any subtree within the
  28       region list can be hidden or displayed by clicking on the box left of
  29       its name.
  30     </para>
  31
  32     <para>
  33       Within the Captured part of the tree, each track is represented by its
  34       own subtree (strictly speaking, its not each track but each playlist
  35       that is represented). Within that subtree is an entry for each take
  36       recorded for that track. Remember that each take is stored as one and
  37       audio files (strictly, one per channel). Within the take tree is an
  38       entry for each region created from that take.
  39     </para>
  40
  41     <para>
  42       Within the External part of the tree, there is a subtree for each
  43       audio file embedded into the session. Within that subtree are entries
  44       for each region created from that audio file.
  45     </para>
  46   </section>
  47
  48   <section id="region-list-operations">
  49     <title>Region list operations</title>
  50     <para>
  51       Click on the box to the left of the name of part of the tree to
  52       hide/show that part of the subtree.
  53     </para>
  54
  55     <para>
  56       Click the name of a region and then drag it to the track display area
  57       to insert a region into a track.
  58     </para>
  59
  60     <para>
  61       Click on the title bar of the region list to display a menu allowing
  62       you to
  63     </para>
  64
  65     <table id="tbl-region-list-operations-menu">
  66       <title>Region List Context Menu</title>
  67       <tgroup cols = "2">
  68         <colspec colnum="1" colname="Snap Option" colwidth="1"/>
  69         <colspec colnum="2" colname="Action" colwidth= "2"/>
  70         <thead>
  71           <row>
  72             <entry>
  73               Menu Item
  74             </entry>
  75
  76             <entry>
  77               Description
  78             </entry>
  79           </row>
  80         </thead>
  81         <tbody>
  82           <row>
  83             <entry>
  84               Find
  85             </entry>
  86           </row>
  87
  88           <row>
  89             <entry>
  90               Show/Hide All
  91             </entry>
  92
  93             <entry>
  94               <para>
  95                 fully expand or collapse the region list
  96               </para>
  97             </entry>
  98           </row>
  99
 100           <row>
 101             <entry>
 102               Sort
 103             </entry>
 104           </row>
 105
 106           <row>
 107             <entry>
 108               Display Automatic Regions normally,
 109             </entry>
 110
 111             <entry>
 112               Ardour does not display regions created as a result of a side
 113               effect of user actions. If this option is selected, all
 114               regions will be included in the region list.
 115             </entry>
 116           </row>
 117
 118           <row>
 119             <entry>
 120               Import audio files
 121             </entry>
 122
 123             <entry>
 124               <para>
 125                 copy (and if necessary convert) audio files into the
 126                 session. See Importing for more details.
 127               </para>
 128             </entry>
 129           </row>
 130
 131           <row>
 132             <entry>
 133               Embed audio file
 134             </entry>
 135
 136             <entry>
 137               <para>
 138                 embed external audio files into the session. No new files
 139                 are created, and no format conversion is done. See
 140                 [[editing:Embedding]] for more details.
 141               </para>
 142             </entry>
 143           </row>
 144         </tbody>
 145       </tgroup>
 146     </table>
 147   </section>
 148 <!--
 149                                                         <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
 150                                                                 href="Some_Subsection.xml" />
 151                                                         -->
 152 </section>