]> Shamusworld >> Repos - ardour-manual-diverged/commitdiff
copy-editing chapter 8.
authorJörn Nettingsmeier <nettings@stackingdwarves.net>
Wed, 5 Feb 2014 10:19:59 +0000 (11:19 +0100)
committerJörn Nettingsmeier <nettings@stackingdwarves.net>
Wed, 5 Feb 2014 10:19:59 +0000 (11:19 +0100)
STYLE_GUIDE
_manual/08_working-with-regions.html
_manual/08_working-with-regions/01_region-naming.html
_manual/08_working-with-regions/02_region-selection-equivalence.html
_manual/08_working-with-regions/03_region-context-menu.html
source/css/app.css

index 278c65a0d4bd1860480b3f19fb9a72a28dc544f1..7d2dad4ee7db2489a6d13d079d13917bb792c442 100644 (file)
@@ -270,3 +270,11 @@ https://developer.gnome.org/hig-book/3.6/design-text-labels.html.en#layout-capit
 * Do not capitalize concepts in the text body, with the possible exceptions
   of _the_ Editor and _the_ Mixer.
 
+
+5.4 Janitorial tasks/review
+---------------------------
+
+If you encounter something that is unclear or patent nonsense, but you are
+not bold or knowledgeable to fix it, express your doubts with an <p
+class="fixme">editorial note</p>, so that readers will be warned and fellow
+editors know where there's work to do.
index 03c391bc5a4b68aa1cf4e36beca96d8e18ee1a81..49ea835d87ec2347f9a089636d9bf831f9f9ecf7 100644 (file)
@@ -3,29 +3,51 @@ layout: default
 title: Working With Regions
 ---                        
 
-
-  
-  <h2>Working With Regions</h2>
-<p>Regions are the basic elements of editing and composing in Ardour. In most cases, a region represents a single contiguous section of one or more media files. Regions are defined by a fixed set of attributes:</p>
+<h2>Working With Regions</h2>
+<p>
+  <dfn>Regions</dfn> are the basic elements of editing and composing in 
+  Ardour. In most cases, a region represents a single contiguous section 
+  of one or more media files. Regions are defined by a fixed set of attributes:
+</p>
 <ul>
-<li>the source audio/MIDI file(s) they represent
-</li>
-<li>a starting point in the audio/MIDI file(s)
-</li>
-<li>a length
-</li>
+  <li>the audio or 
+  <abbr title="Musical Instrument Digital Interface">MIDI</abbr>
+  <dfn>source file(s)</dfn> they represent,</li>
+  <li>an <dfn>offset</dfn> (the "start point") in the audio or MIDI file(s), and</li>
+  <li>a <dfn>length</dfn>.</li>
 </ul>
-<p>When placed into a playlist, they gain additional attributes:</p>
+<p>
+  When placed into a playlist, they gain additional attributes:
+</p>
 <ul>
-<li>    a position along the timeline</li>
-<li>    a layer</li>
+  <li>a <dfn>position</dfn> along the timeline, and</li>
+  <li>a <dfn>layer</dfn>.</li>
 </ul>
-<p>There are other attributes as well, but they do not define the region. Things you should know about regions:</p>
+<p>
+  There are other attributes as well, but they do not <em>define</em> the 
+  region. Things you should know about regions:
+</p>
 
 <h3>Regions Are Cheap</h3>
-<p>By themselves, regions consume very little of your computer's resources. Each region requires a small amount of memory, and represents a rather small amount of CPU work if placed into an active track. So, don't worry about creating regions whenever you need to.</p>
+<p>
+  By themselves, regions consume very little of your computer's resources.
+  Each region requires a small amount of memory, and represents a rather 
+  small amount of CPU work if placed into an active track. So, don't worry 
+  about creating regions whenever you need to.
+</p>
 
 <h3>Regions Are Not Files</h3>
-<p>Although a region can represent an entire audio file, they are never equivalent to an audio file. Most regions represent just parts of an audio file(s) on disk, and removing a region from a track has nothing to do with removing the audio file(s) from the disk (the Destroy operation, one of Ardour's few destructive operations, can affect this). Changing the length of a region has no effect on the audio file(s) on disk. Splitting and copying regions does not alter the audio file in anyway, nor does it create new audio files (only recording, and the Export, Bounce and Reverse operations create new audio files).</p>
+<p>
+  Although a region can represent an entire audio file, they are never 
+  equivalent to an audio file. Most regions represent just parts of an audio 
+  file(s) on disk, and removing a region from a track has nothing to do with 
+  removing the audio file(s) from the disk (the <kbd
+  class="menu">Destroy</kbd> operation, one of Ardour's few destructive
+  operations, can affect this). Changing the length of a region has no effect 
+  on the audio file(s) on disk. Splitting and copying regions does not alter 
+  the audio file in anyway, nor does it create new audio files (only
+  <dfn>recording</dfn>, 
+  and the <kbd class="menu">Export</kbd>, <kbd class="menu">Bounce</kbd> and 
+  <kbd class="menu">Reverse</kbd> operations create new audio files).</p>
 
 {% children %}
index 9b202671ff29825be2e247b951b76b6934c7da86..1ebbdd9cb856aa8e35e04f6829390f5cecf93d28 100644 (file)
@@ -2,28 +2,67 @@
 layout: default
 title: Region Naming
 ---                        
-
-
   
-  
-<p>Regions are initially named using either:</p>
+<p><dfn>Region names</dfn> are initially derived from either</p>
 <ul>
-<li>    the name of the playlist for which they were recorded
-</li>
-<li>    the name of the track for which they were recorded
-</li>
-<li>    the name of the embedded/imported file they represent
-</li>
+  <li>the name of the playlist for which they were recorded,</li>
+  <li>the name of the track for which they were recorded, or</li>
+  <li>the name of the embedded/imported file they represent.</li>
 </ul>
-<h3>Whole File Region Names</h3>
-<p>These are not audio files, but regions that represent the full extent of an audio file. Every time a new recording is done, or a new file is embedded/imported, a new region is created that represents the entire audio file(s) This region will have the name of the track/playlist/original file, followed by a "-" and then a number plus a dot and then a number.</p>
-<p>For recorded regions, the number will increase each time a new recording is made. So, for example, if there is a playlist called "Didgeridoo", the first recorded whole file region for that playlist will be called "Digderidoo-1". The next one will be "Digeridoo-2" and so on.</p>
-<p>For imported/embedded files, the region name will be based on the file name, but with any final suffix (e.g. ".wav" or ".aiff") removed.</p>
-<p>Normally, whole file regions are not inserted into tracks/playlists, but regions derived from them are. The whole-file versions live in the editor region list where they act as an organizing mechanism for regions that are derived from them.</p>
-<h3>Normal Region Names</h3>
-<p>When a region is inserted into a track/playlist, its initial name will end in a version number, such as ".1" or ".103". For a recorded region, if the whole file region was "Hang drum-1", then the region in the track will appear with the name "Hang drum-1.1". For an imported/embedded region, if the whole file region was "Bach:Invention3", then the region in the track will appear with the name "Bach:Invention3.1".</p>
-<h3>Copied Region Names</h3>
-<p>If you copy a region, it initially shares the same name as the original. When you perform an operation modifies one of the copies, Ardour will increment the version number on the particular copy that changed.</p>
-<h3>Renaming Regions</h3>
-<p>You can rename a region at any time. Use the region context menu to popup the Rename dialog. The new name does not need to have a version number in it (in fact, it probably should not). Ardour will add a version number in the future if needed (e.g. if you copy or split the region).</p>
+<p class="fixme">
+  It appears that recorded regions are always named after the track, not the
+  active playlist in that track.
+</p>
+
+<h2>Whole File Region Names</h2>
+<p>
+  These are not audio files, but regions that represent the full extent of an
+  audio file. Every time a new recording is done, or a new file is imported
+  to the session, a new region is created that represents the <dfn>entire audio 
+  file</dfn>. This region will have the name of the track/playlist/original file, 
+  followed by a "-", then a number plus a dot and then a number.
+</p>
+<p>
+  For <dfn>recorded regions</dfn>, the number will increase each time a new recording 
+  is made. So, for example, if there is a playlist called
+  <samp>Didgeridoo</samp>, the 
+  first recorded whole file region for that playlist will be called
+  <samp>Digderidoo-1</samp>. The next one will be <samp>Digeridoo-2</samp> and so on.
+</p>
+<p>
+  For <dfn>imported regions</dfn>, the region name will be based on the original file 
+  name, but with any final suffix (e.g. ".wav" or ".aiff") removed.
+</p>
+<p>
+  Normally, whole file regions are not inserted into tracks or playlists, 
+  but regions derived from them are. The whole-file versions live in the 
+  editor region list where they act as an organizing mechanism for regions 
+  that are derived from them.
+</p>
+
+<h2>Normal Region Names</h2>
+<p>
+  When a region is inserted into a track and playlist, its initial name will 
+  end in a <dfn>version number</dfn>, such as <samp>.1</samp>. For a recorded region, 
+  if the whole file region was <samp>Hang drum-1</samp>, then the region in 
+  the track will appear with the name <samp>Hang drum-1.1</samp>. For an 
+  imported region, if the whole file region was <samp>Bach:Invention3</samp>, 
+  then the region in the track will appear with the name
+  <samp>Bach:Invention3.1</samp>.
+</p>
+
+<h2>Copied Region Names</h2>
+<p>
+  If you <dfn>copy a region</dfn>, it initially shares the same name as the original. 
+  When you perform an operation modifies one of the copies, Ardour will 
+  increment the version number on the particular copy that changed.
+</p>
+
+<h2>Renaming Regions</h2>
+<p>
+  You can <dfn>rename a region</dfn> at any time. Use the region context menu to 
+  pop up the <kbd class="menu">Rename</kbd> dialog. The new name does not need to 
+  have a version number in it (in fact, it probably should not). Ardour will add a 
+  version number in the future if needed (e.g. if you copy or split the region).
+</p>
   
index eea654b3ccafc05dbc94495f504c0a395ba45305..13f3f9cb254403657f143eb6828fb351a0101a00 100644 (file)
@@ -1,22 +1,46 @@
 ---
 layout: default
-title: Region Selection Equivalence
+title: Equivalent Region Selection
 ---                        
-
-
   
-  <p><a href="/working-with-tracks/track-and-bus-groups/">Track Groups</a> have a property titled "Select" which, if enabled, Ardour to tries to propagate a region selection in one of a group's member tracks to the other members of the group.. </p>
-<p>For example, let's assume you have used multiple microphones to record a drum kit to multiple tracks. You have created a track group, added all the drum tracks, enabled the group and enabled the "Select" property for the group. When you select a region in one of the drum tracks, Ardour will select the corresponding track in every other drum track, which in turn means that a subsequent edit operation will affect all the selected regions (and thus all the drum tracks) together. </p>
+<p>
+  <a href="/working-with-tracks/track-and-bus-groups/">Track Groups</a> have
+  a property titled <kbd class="option">Select</kbd> which, if enabled, cause 
+  Ardour to propagate a region selection in one track of a group to the
+  <dfn>equivalent regions</dfn> of the other tracks in that group.
+ </p>
+<p>
+  For example, let's assume you have used multiple microphones to record a 
+  drum kit to multiple tracks. You have created a track group, added all the 
+  drum tracks, enabled the group and enabled the Select property for the group. 
+  When you select a region in one of the drum tracks, Ardour will select the
+  corresponding region in every other drum track, which in turn means that a 
+  subsequent edit operation will affect all the drum tracks together. 
+</p>
 
 <h2>How Ardour Decides Which Regions are "Equivalent"</h2>
-<p>Regions in different tracks are considered to be equivalent for the purposes of sharing "selection" if they satisfy all the following criteria:</p>
+<p>
+  Regions in different tracks are considered to be equivalent for the purposes 
+  of sharing <dfn>selection</dfn> if they satisfy <em>all</em> the following criteria:
+</p>
 <ol>
-<li>Each region starts at the same offset within its source file</li>
-<li>Each region is located at the same position on the timeline</li>
-<li>Each region has the same length</li>
+  <li>Each region starts at the <dfn>same offset</dfn> within its source file,</li>
+  <li>each region is located at the <dfn>same position</dfn> on the timeline, and</li>
+  <li>each region has the <dfn>same length</dfn>.</li>
 </ol>
 
 <h2>Overlap Equivalence</h2>
-<p>Sometimes, the rules outlined above are too strict to get Ardour to do what you want. Regions may be slightly different lengths, or positioned slightly differently, and this will cause Ardour to not select regions in other grouped tracks.</p>
-<p>In this case, enable <code>Edit &gt; Preferences &gt; Editor &gt; Use overlap equivalency for regions</code>. With this option enabled, regions in different tracks will be considered equivalent for the purposes of selection if they overlap. This is much more flexible and will cover almost all of the cases that the fixed rules above might make cumbersome.</p>
+<p>
+  Sometimes, the rules outlined above are too strict to get Ardour to do what you 
+  want. Regions may have been trimmed to slightly different lengths, or positioned 
+  slightly differently, and this will cause Ardour to not select regions in other 
+  grouped tracks.</p>
+<p>
+  In this case, enable 
+  <kbd class="option">Edit &gt; Preferences &gt; Editor &gt; Use overlap equivalency for
+  regions</kbd>. With this option enabled, regions in different tracks will be 
+  considered equivalent for the purposes of selection if they
+  <dfn>overlap</dfn>. This is much more flexible and will cover almost all of the 
+  cases that the fixed rules above might make cumbersome.
+</p>
   
index ff9cf95c919f8519dad82dcf83fdb50eea86ce57..2b8a4733dd4d7711dd8dc54c7e048130ee5f3ea0 100644 (file)
@@ -3,64 +3,78 @@ layout: default
 title: Region Context Menu
 ---                        
 
-
-  
-  <p>In the editor window, right clicking (context clicking) on a region displays a menu with many region operations. The menu begins with the name of the region, or "Selected Regions" if multiple regions are selected.</p>
-<p> If there is more than one region layered at the point where you clicked, the menu will also contain an item "Choose Top." The "Choose Top" dialog lets you select which layer you want on top. See <a href="manual/region_layering">Adjusting Region Layering</a> for more details.</p>
-<p>Below these items is the rest of the <a href="/working-with-tracks/track-context-menu">Track Context Menu</a>, which provides access to track-level operations. To see the region context menu's contents, select the region name or "Selected Regions", and the following submenu structure appears:</p>
+<p>
+  In the editor window, right clicking (context clicking) on a region
+  displays a menu with <dfn>track and region operations</dfn>. The menu begins with the
+  name of the region, or <kbd class="menu">Selected Regions</kbd> if multiple 
+  regions are selected.
+</p>
+<p>
+  If there is more than one region layered at the point where you clicked, the 
+  menu will also contain an item <kbd class="menu">Choose Top</kbd>. This
+  dialog lets you select which region you want on the top <dfn>layer</dfn>. See 
+  <a href="manual/region_layering">Adjusting Region Layering</a> for more details.
+</p>
+<p>
+  Below these items is the rest of the 
+  <a href="/working-with-tracks/track-context-menu">Track Context Menu</a>, which 
+  provides access to <dfn>track-level operations</dfn>. To see the contents
+  of the region context menu, select the region name or "Selected Regions", and 
+  the following submenu structure appears:
+</p>
 <dl class="narrower-table">
-<dt>Play</dt>
-<dd></dd>
-<dt>Loop</dt>
-<dd></dd>
-<dt>Properties</dt>
-<dd></dd>
-<dt>Rename</dt>
-<dd></dd>
-<dt>Edit</dt>
-<dd>
-<dl class="wide-table">
-<dt>Combine</dt>
-<dd></dd>
-<dt>Uncombine</dt>
-<dd></dd>
-<dt>Split</dt>
-<dd></dd>
-<dt>Make Mono Regions</dt>
-<dd></dd>
-<dt>Opaque</dt>
-<dd></dd>
-<dt>Mute</dt>
-<dd></dd>
-<dt>Pitch Shift</dt>
-<dd></dd>
-<dt>Reverse</dt>
-<dd></dd>
-<dt>Close Gaps</dt>
-<dd></dd>
-<dt>Place Transients</dt>
-<dd></dd>
-<dt>Rhythm Ferret</dt>
-<dd></dd>
-<dt>Strip Silence</dt>
-<dd></dd>
-</dl>
-</dd>
-<dt>Position</dt>
-<dd>
-<dl class="wide-table">
-<dt>Move To Original Position</dt>
-<dd></dd>
-<dt>Lock</dt>
-<dd></dd>
-<dt>Glue to Bars and Beats</dt>
-<dd></dd>
-<dt>Snap Position to Grid</dt>
-<dd></dd>
-<dt>Set Sync Position</dt>
-<dd></dd>
-<dt>Remove Sync</dt>
-<dd></dd>
+  <dt>Play</dt>
+  <dd></dd>
+  <dt>Loop</dt>
+  <dd></dd>
+  <dt>Properties</dt>
+  <dd></dd>
+  <dt>Rename</dt>
+  <dd></dd>
+  <dt>Edit</dt>
+  <dd>
+    <dl class="wide-table">
+      <dt>Combine</dt>
+      <dd></dd>
+      <dt>Uncombine</dt>
+      <dd></dd>
+      <dt>Split</dt>
+      <dd></dd>
+      <dt>Make Mono Regions</dt>
+      <dd></dd>
+      <dt>Opaque</dt>
+      <dd></dd>
+      <dt>Mute</dt>
+      <dd></dd>
+      <dt>Pitch Shift</dt>
+      <dd></dd>
+      <dt>Reverse</dt>
+      <dd></dd>
+      <dt>Close Gaps</dt>
+      <dd></dd>
+      <dt>Place Transients</dt>
+      <dd></dd>
+      <dt>Rhythm Ferret</dt>
+      <dd></dd>
+      <dt>Strip Silence</dt>
+      <dd></dd>
+    </dl>
+  </dd>
+  <dt>Position</dt>
+  <dd>
+    <dl class="wide-table">
+      <dt>Move To Original Position</dt>
+      <dd></dd>
+      <dt>Lock</dt>
+      <dd></dd>
+      <dt>Glue to Bars and Beats</dt>
+      <dd></dd>
+      <dt>Snap Position to Grid</dt>
+      <dd></dd>
+      <dt>Set Sync Position</dt>
+      <dd></dd>
+      <dt>Remove Sync</dt>
+      <dd></dd>
 <dt>Nudge Later</dt>
 <dd></dd>
 <dt>Nudge Earlier</dt>
index 3fb82b515e5c4d1d8b39aa6f55e058d373511df6..5506111fc48b677bdbf410817551fe9ae88527c9 100644 (file)
@@ -328,8 +328,6 @@ kbd.option:after,kbd.optoff:after {
     font-weight:lighter;
     text-align:center;
     border:solid 1px black;
-    -moz-border-radius:10px;
-    border-radius:10px;
     margin-left:0.3em;
 }
 kbd.option:after {
@@ -408,17 +406,19 @@ samp:after {
     float:left;
 }
 
-#content .note,.warning {
+#content .note,.warning,.fixme {
     min-height: 20px;
     padding: 19px;
     margin-bottom: 20px;
-    border: 1px solid 
+    border-style: solid;
+    border-width: 1px 1px 1px 8px; 
     -webkit-border-radius: 4px;
        -moz-border-radius: 4px;
             border-radius: 4px;
     -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.05);
        -moz-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.05);
             box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.05);
+
 }
 
 #content .note {
@@ -427,10 +427,22 @@ samp:after {
 }
 
 #content .warning {
-    border-color: #990000;
+    border-color: #995555;
     background-color: #ffeeee;
 }
 
+#content .fixme {
+    border-color: #999944;
+    background-color: #f0f0e0;
+}
+
+.fixme:before {
+    content:'FIXME: ';
+    font-weight: bold;
+    font-style: italic;
+}
+
+
 
 
 .mod1:before {