]> Shamusworld >> Repos - ardour-manual-diverged/commitdiff
copy-editing section 6. the beat goes on...
authorJörn Nettingsmeier <nettings@stackingdwarves.net>
Tue, 4 Feb 2014 21:55:37 +0000 (22:55 +0100)
committerJörn Nettingsmeier <nettings@stackingdwarves.net>
Tue, 4 Feb 2014 21:55:37 +0000 (22:55 +0100)
STYLE_GUIDE
_manual/05_controlling-playback/04_using-the-nudge-controls.html
_manual/06_working-with-markers.html
_manual/06_working-with-markers/01_creating-location-markers.html
_manual/06_working-with-markers/02_creating-range-markers.html
_manual/06_working-with-markers/03_rangesmarks-list.html
_manual/06_working-with-markers/04_moving-markers.html
_manual/06_working-with-markers/05_loop-range.html
_manual/06_working-with-markers/06_marker-context-menu.html
_manual/06_working-with-markers/07_punch-range.html
source/css/app.css

index 5c367ab6dc3cf519f250c625c1fec5842ef4d918..4c57d00ca94a9d487a505adb974278858c78e1e6 100644 (file)
@@ -102,6 +102,11 @@ level below its predecessor. Do not abuse headings to style a head line.
 Every snippet of text should be enclosed in a block level element. The
 default choice is <p>, the plain paragraph.
 
+<a>
+Cross-reference links in the manual are reasonably stable, since they are
+independent of the ordering number (which gets removed from the URL) and the
+pretty page title (the URL is created from the file name). So unless a file
+is renamed or moved to another sub-directory, links should be ok.
 
 4.1 Inline markups
 ------------------
@@ -248,8 +253,8 @@ paragraph.
   additional information, if at all.
 
 
-5.3 Headline Capitalization
----------------------------
+5.3 Chapter Headline Capitalization
+------------------------------------
 
 Capitalization follows
 https://developer.gnome.org/hig-book/3.6/design-text-labels.html.en#layout-capitalization
@@ -260,4 +265,7 @@ https://developer.gnome.org/hig-book/3.6/design-text-labels.html.en#layout-capit
     Conjunctions: and, but, for, not, so, yet ...
     Prepositions of three or fewer letters: at, for, by, in, to ...
 * Keep headlines short and concise.
+* secondary headlines in articles are not capitalized
+* Do not capitalize concepts in the text body, with the possible exceptions
+  of _the_ Editor and _the_ Mixer.
 
index 64b68987ada7a77fb79bd792bd19fb975d074d2f..07f3d08b80320dbc419b72174480e1647d4c61fd 100644 (file)
@@ -2,10 +2,18 @@
 layout: default
 title: Using the Nudge Controls
 ---                        
-
-
   
-  
-<p>If there are no selected objects, the nudge controls can be used to move the playhead by a fixed amount backward or forward. The left and right buttons move either backward or forward in time, and the small clock to the left of these buttons sets the amount of time to nudge by. As with all other clocks, you can right-click on the clock to choose the time representation you want to use.</p>
-<p>Note that this is a secondary purpose of the nudge controls - it is usually used to move selected objects by specific distances, rather than the playhead.</p>
+<p>
+  If there are no selected objects, the <dfn>nudge controls</dfn> can be 
+  used to move the playhead backward or forward by a fixed amount. The left 
+  and right buttons move either backward or forward in time, and the small 
+  clock to the left of these buttons sets the amount of time to nudge by. 
+  As with all other clocks, you can right-click on the clock to choose the 
+  time representation you want to use.
+</p>
+<p>
+  Note that this is a secondary purpose of the nudge controls &mdash; it is
+  usually used to move selected <dfn>objects</dfn> by specific distances, rather than
+  the playhead.
+</p>
   
index 6610a992f05912d7158642ab13eb6d641dc1f962..cb8a13c395f7a68855d3ad595f882cbc68ba8725 100644 (file)
@@ -2,19 +2,30 @@
 layout: default
 title: Working With Markers
 ---                        
-
-
-  
   
-<p>It is very useful to be able to tag different locations in a session for use when editing and mixing. Ardour supports both <code>locations</code>, which define specific single positions in time and <code>ranges</code> which define a start and end position in time. </p>
-<p>In addition to the standard location markers there are also 3 kinds of special markers:</p>
-<dl class="narrower-table">
-<dt>CD markers</dt>
-<dd>locations that are restricted to legal CD track boundaries, and be used to add track marks/info to compact disc (CD) images.</dd>
-<dt>Loop range</dt>
-<dd>a range used to define transport loop start and end points.</dd>
-<dt>Punch range</dt>
-<dd>a range used to define start and/or end points for punch recording</dd>
-</dl>
+<p>
+  It is very useful to be able to tag different locations in a session for
+  later use when editing and mixing. Ardour supports both
+  <dfn>locations</dfn>, which define specific positions in time, 
+  and <dfn>ranges</dfn> which define a start and end position in time. 
+</p>
+<p>
+  In addition to the standard location markers, there are three kinds of 
+  special markers:
+</p>
+<ul>
+  <li>
+    <dfn>CD markers</dfn> are locations that are restricted to legal 
+    <dfn>CD sector boundaries</dfn>. They can be used to add track index 
+    markers to compact disc images.
+  </li>
+  <li>
+    The <dfn>Loop range</dfn> defines the start end end points for Looping.
+  </li>
+  <li>
+    The <dfn>punch range</dfn> defines the in and out points for punch
+    recording.
+  </li>
+</ul>
 
 {% children %}
index a1f25bd76b46b0bc3f3e1522db0fe804a81ef124..e0d64f14597cdd986afc2c072252b920301e446e 100644 (file)
@@ -3,20 +3,29 @@ layout: default
 title: Creating Location Markers
 ---                        
 
-
-  
-  
-<p><code>Location Markers</code> appear in the Location Marker ruler at the top of the Timeline. The "begin" and "end" markers appear automatically, but you can create custom markers at any position in a session.</p>
-
-<h3>Add Marker to Current Playhead Position</h3>
-<h4>Via Context Menu</h4>
-<p>Right click anywhere on the Location Marker ruler and select <code>New location marker</code>. Then move the marker to the current <code>Playhead</code> location by right clicking on the new marker and selecting <code>Move Mark to Playhead</code>.</p>
-<p>It is also possible to create a Location Mark at the current playhead using the <code>Editor List</code> For details see <a href="/working-with-markers/getting-to-know-the-rangesmarks-list/">Getting To Know the Ranges & Marks List</a>.</p>
-<h4>Via Keyboard</h4>
-<p>To create a <code>Location Marker</code> at the current playhead location using the keyboard  press <code>Enter</code> on the numeric keypad.</p>
-<h4>Via Main Menu</h4>
-<p>To create a <code>Location Marker</code> at the current playhead location using pull down mens select <code>Transport</code> &gt; <code>Markers</code> &gt; <code>Add Mark from Playhead</code>.</p>
-
-<h3>Add Marker to Specific Position on the Timeline</h3>
-<p>You can create a <code>Location Marker</code> at a specific location in the <code>Timeline</code> by moving the playhead to the specific location and then using the methods outline above.</p>
-<p>Alternatively, a location marker can be set to a specific location by using the <code>Ranges &amp; Marks</code> tab, using either the <code>Use PH</code> button to move a mark to the current playhead location or the clock to set a specific location manually.</p>
+<p>
+  <dfn>Location Markers</dfn> appear in the <dfn>Locations ruler</dfn> at the top
+  of the timeline. The <dfn>begin</dfn> and <dfn>end</dfn> markers appear 
+  automatically, but you can create custom markers at any position in a 
+  session.
+</p>
+<p>
+  To add a marker at the <strong>current playhead position</strong>, press
+  <kbd>Num-&crarr;</kbd> (the Enter key on the numeric  keypad).
+  Alternatively, use <kbd class="menu">Transport &gt; Markers &gt; Add 
+  Mark from Playhead</kbd>.
+</p>
+<p>
+  To add a marker at an <strong>arbitrary location</strong> on the timeline,
+  navigate to the desired position, right-click on the Locations ruler and
+  select <kbd class="menu">New Location Marker</kbd>.
+  You can also go to the Editor list, click <kbd class="menu">New
+  Marker</kbd> and use the clock widget to set its position.
+</p>
+<p>
+  For details see 
+  <a href="/working-with-markers/getting-to-know-the-rangesmarks-list/">Getting To Know the Ranges
+  &amp; Marks List</a> and <a
+  href="/ardours-interface/using-ardour-clock-displays/"> Using Ardour Clock
+  Displays</a>.
+</p>
\ No newline at end of file
index d7c93c2f64d09c7bcabd952b2adbe0c9d2048a37..42b7a1f8367152cbcc262b0ea614f4d742986cd1 100644 (file)
@@ -2,20 +2,23 @@
 layout: default
 title: Creating Range Markers
 ---                        
-
-
   
 <p>
-  Rages are essentially two Location Markers the are grouped
+  <dfn>Range markers</dfn> are essentially two location markers the are grouped
   together to mark the beginning and end of a section in the timeline. 
 </p> 
-<h3>Creating a Range on the timeline</h3>
+<h2>Creating a Range on the timeline</h2>
 <p>
-  To create a <code>Range</code> on the timeline, right click on the  
-  <code>Range Markers</code> <code>Ruler</code> at the top of the 
-  <code>Timeline</code> then select <code>New Range</code>. 
+  To create a new <dfn>range</dfn>, right-click on the  
+  Ranges ruler at the top of the timeline, then select
+  <kbd class="menu">New Range</kbd>. 
   Two markers with the same name will appear along the ruler. 
-  Both marks can be moved along the timeline by clicking and dragging them to the desired location.
+  Both marks can be moved along the timeline by clicking and dragging 
+  them to the desired location.
+</p>
+<p>
+  It is also possible to create range markers from a selected range or
+  region in the Editor window, or to use the <kbd class="menu">Ranges 
+  &amp; Marks List</kbd> in the Editor list.
 </p>
-<h3>Creating a Range from the Ranges &amp; Marks List</h3>
   
index 8982b7e09496ae3ff759abe81b1d04258181914d..97b265392b2d16da7c8ba8680b1364a0b6cb1980 100644 (file)
@@ -2,21 +2,67 @@
 layout: default
 title: Ranges &amp; Marks List
 ---                        
-
-
   
-  
-<p>The <code>Ranges &amp; Marks</code> List is visible on a tab in the <code>Editor Lists</code> area. If the editor list area isn't visible it can be enabled by checking the box in the main pull down menus <code>View &gt; Show Editor List</code>. The <code>Ranges &amp; Marks</code> list can be used as a single point of control for all range and location markers (including the punch and loop ranges), or as a supplement to other methods of working with them.</p>
-
-<h3>Loop/Punch Ranges</h3>
-<p>The first section <code>Loop/Punch Ranges</code> shows the current loop and punch range settings; there are three clocks, the first is the start of the range, the second is the end of the range and the last is the length of the range. The start and end points have a ‘Use PH’ button beside them, which can be clicked to set the corresponding position clock to the current position of the playhead in the editor timeline. Last in the row are 3 checkboxes. The first checkbox is <code>Hide</code>, which hides the marker in the editor. Even though it is now hidden it is possible to still locate to the marker. The next checkbox is <code>Lock</code>, this will lock the marker in the editor so it can't be moved until it is unlocked. The last checkbox is <code>Glue</code>, this fixes the marker position relative to the current tempo and respects changes in tempo.</p>
+<p>
+  The <dfn>Ranges &amp; Marks List</dfn> is a tab in the <dfn>Editor
+  Lists</dfn> area on the right of the Editor window. If the editor 
+  list area isn't visible it can be enabled by checking 
+  <kbd class="option">View &gt; Show Editor List</kbd>. 
+  The Ranges &amp; Marks list can be used as a single point 
+  of control for all range and location markers (including the punch and 
+  loop ranges), or as a supplement to other methods of working with them.
+</p>
 
-<h3>Markers (Including CD Index)</h3>
-<p>The next section is <code>Markers (Including CD Index)</code> which is a list of the session's markers. For each marker there is a name dialog, that can be edited by clicking on it, a clock that represents the location of the marker, a <code>Use PH</code> button that moves the marker to the current playhead location, and four checkboxes. The first checkbox is <code>CD</code>, which sets the marker for Redbook TOC exporting. The <code>Hide</code>, <code>Lock</code>, and <code>Glue</code> buttons all function the same as in the above section.</p>
 
-<h3>Ranges (Including CD Track Ranges)</h3>
-<p>The next section is the <code>Ranges (Including CD Track Ranges)</code>. Just like the <code>Loop/Punch Ranges</code> section there are three clocks that serve the same purpose. The checkboxes are the same arrangement and function as the <code>Markers (Including CD Index)</code> however without the <code>Glue</code> checkbox</p>
+<h2>Common elements</h2>
+<p>
+  Each section has a set of <dfn>editable <a
+  href="/ardours-interface/using-ardour-clock-displays/">clock widgets</a></dfn> 
+  which display
+  the location of a marker, or the start, end, and duration times of a range,
+  respectively.<br />
+  The <kbd class="menu">Use PH</kbd> buttons allow you to set 
+  the corresponding clock to the current playhead position.
+  A <kbd class="mouse">Middle</kbd> click on any of the clocks will move 
+  the playhead to that location. Both functions are also available from the
+  clock context menus.<br />
+  Right clicking on any of the clocks brings up a context menu that allows 
+  changing of the display between Timecode, Bars:Beats, Minutes:Seconds,
+  and Samples.<br />
+</p>
+<p>
+ The <kbd class="menu">&mdash;</kbd> (subtract) button in front of each
+ user-defined range or marker in the list allows that particular item to
+ be removed. The name fields of custom ranges and markers can be edited. 
+</p>    
+<p>
+  The <kbd class="option">Hide</kbd> checkboxes make markers and ranges invisible 
+  on the respective ruler to reduce visual clutter; the markers remain
+  active however, and can be used normally.<br />
+  Selecting <kbd class="option">Lock</kbd> prevents the respective marker 
+  from being moved until unlocked.
+  Where applicable, <kbd class="option">Glue</kbd> fixes the marker position
+  relative to the current musical position expressed in bars and beats, rather 
+  than the absolute time. This will make the respective marker follow
+  changes in the tempo map.
+</p>
+<p>
+  At the bottom of the list are buttons to add new markers or ranges.
+</p>
+ <h2>List sections</h2>
 
-<h3>General</h3>
-<p>At the bottom of the list are buttons to add new markers or ranges.</p>
-<p>The subtract button (<code>-</code>) beside each item in the list allows that particular marker to be removed. A middle click over any of the clocks will locate the playhead at that location in the editor. Right clicking on any of the clocks brings up a context menu that allows changing of the display between, <code>Timecode</code>, <code>Bars:Beats</code>, <code>Minutes:Seconds</code> and <code>Samples</code>. In addition to the clock displays there is an option in the context menu to select <code>Set From Playhead</code>, that sets the markers location to the current location of the playhead in the editor window, and <code>Locate to This Time</code>, that moves the playhead to the location of the position listed in the clock.</p>
+<dl>
+  <dt>Loop/Punch Ranges</dt>
+  <dd>This list shows the current <dfn>loop</dfn> and <dfn>punch</dfn> range 
+  settings. Since these are built-in ranges, you cannot rename or remove them.</dd>
+  <dt>Markers (Including CD Index)</dt>
+  <dd>This section lists the session's <dfn>markers</dfn>. By ticking <kbd
+  class="option">CD</kbd>, you instruct Ardour to create a <dfn>CD track
+  index</dfn> from this marker, which will be included in the TOC or CUE file when you
+  export.</dd>
+  <dt>Ranges (Including CD Track Ranges)</dt>
+  <dd>This is the list of <dfn>ranges</dfn> (including <dfn>CD track
+  ranges</dfn>). Ticking <kbd class="option">CD</kbd> will convert
+  the range to a <dfn>CD track</dfn>, which will again be included in
+  exported TOC or CUE files. This is relevant for Disk-At-Once recordings
+  that may contain audio data between tracks.</dd>
index 9cb7b4652f6549bbf70dac09639c1d534b7dd056..77e93bd8158151e3a3fb939bc2b6dd2e6cfd8b1f 100644 (file)
@@ -2,12 +2,25 @@
 layout: default\r
 title: Moving Markers\r
 ---                        \r
-\r
-\r
   \r
-  <h2>Single marker</h2>\r
-<p>Click and drag to move a single marker to a new location on the timeline. </p>\r
+<h2>Single marker</h2>\r
+<p>\r
+  <kbd class="mouse">Left</kbd>-click and drag to move a single marker to a \r
+  new location on the timeline.\r
+</p>\r
+\r
 <h2>Multiple markers</h2>\r
-<p>It is possible to move multiple markers by the same distance. Ctrl-click each marker you want to move, then drag one of the selected markers to a new location. All other selected markers will move together. Note that the markers are bounded by the zero point on the timeline. In otherwords the first marker in your selection cannot move to the left of zero on the timeline.</p>\r
+<p>\r
+  It is possible to move multiple markers by the same distance. <kbd\r
+  class="mouse mod1">Left</kbd>-click each marker you want to move, then drag \r
+  one of the selected markers to a new location. All selected markers will\r
+  then move together. Note that the markers are bounded by the zero point on \r
+  the timeline. In other words, the first marker in your selection cannot move \r
+  to the left of zero on the timeline.\r
+</p>\r
+\r
 <h2>Both ends of a range marker</h2>\r
-<p>Ctrl-drag one end of the range marker (either the start or the end). The other end of range marker will move by the same distance.</p>\r
+<p>\r
+  <kbd class="mod1 mouse">Left</kbd>-drag either end of the range marker. The \r
+  other end will move by the same distance.\r
+</p>\r
index 95f50f7119eb90cab5a21c52ff671128c3f8bc85..4f09cdad666c7f5234c3d22f2a8258c81d7ab07e 100644 (file)
@@ -1,12 +1,16 @@
 ---
 layout: default
-title: Loop Range
+title: The Loop Range
 ---                        
-
-
   
-  
-<p>The loop range is a special range that defines the start and end points when <code>loop-mode</code> is enabled in the transport bar.</p>
-<h3>Defining the loop range on the timeline</h3>
-<h3>Defining the loop range in the Locations+Marks list</h3>
+<p>
+  The <dfn>loop range</dfn> is a special range that defines the start and end points
+  for loop play, which can be enabled in the transport bar.
+</p>
+<p>
+  It can be defined via the <a href="/missing">timeline</a> or the <a
+  href="/working-with-markers/rangesmarks-list/">Ranges &amp; Marks
+  list</a>.
+</p>
+
   
index a6f3bd99e060942c758e74fba8bd5c1877cd04fb..f4dbb196750a87dd586dba70ff851fd8826da477 100644 (file)
@@ -3,30 +3,40 @@ layout: default
 title: Marker Context Menu
 ---                        
 
-
-  
-  
-<p> Several operations on markers are available by right-clicking them to open the marker context menu. From this menu, you can:</p>
+<p>
+  <kbd class="mouse">Right</kbd>-clicking a marker in the timeline opens the 
+  marker context menu. From this menu, you can:
+</p>
 <dl>
-<dt>Locate to Here</dt>
-<dd>move the playhead to this marker's position.</dd>
-<dt> Play from Here</dt>
-<dd>start playback from this marker's position.</dd>
-<dt>Move Mark to Playhead</dt>
-<dd>move this marker to the current playhead position.
-</dd>
-<dt>Create Range to Next Marker</dt>
-<dd>create a range marker between this location and the next one along on the timeline.</dd>
-<dt>Hide</dt>
-<dd>hide this marker from the view. It can be re-shown from the Locations window</dd>
-<dt>Rename</dt>
-<dd>change the name of the marker.</dd>
-<dt>Lock</dt>
-<dd>if this is ticked, it will be impossible to drag the marker's position; useful if you want to prevent accidental movements.</dd>
-<dt>Glue to Bars and Beats</dt>
-<dd>if this is ticked, the marker will maintain its position in bars and beats even if there are changes in tempo and meter</dd>
-<dt>Remove</dt>
-<dd>removes the marker. </dd>
+  <dt>Locate to Here</dt>
+  <dd>Move the playhead to this marker's position.</dd>
+  <dt>Play from Here</dt>
+  <dd>start playback from this marker's position.</dd>
+  <dt>Move Mark to Playhead</dt>
+  <dd>Move this marker to the current playhead position.</dd>
+  <dt>Create Range to Next Marker</dt>
+  <dd>Create a range marker between this location and the next one along on 
+  the timeline.</dd>
+  <dt>Hide</dt>
+  <dd>Hide this marker from the view. It can be made visible again from the
+  <kbd class="menu">Window &gt; Locations</kbd> window or the <a
+  href="/working-with-markers/rangesmarks-list/">Ranges &amp; Marks
+  list</a>.</dd>
+  <dt>Rename</dt>
+  <dd>Change the name of the marker.</dd>
+  <dt>Lock</dt>
+  <dd>If this is ticked, it will be impossible to drag the marker's 
+  position; useful if you want to prevent accidental movements.</dd>
+  <dt>Glue to Bars and Beats</dt>
+  <dd>If this is ticked, the marker will maintain its position in bars and 
+  beats even if there are changes in tempo and meter.</dd>
+  <dt>Remove</dt>
+  <dd>Removes the marker. </dd>
 </dl>
-<p>There are also a few options on the Active Mark submenu of the Transport menu. These options apply to the currently selected location marker, and move it to a nearby region boundary, region sync point, or to the playhead or mouse.</p>
+<p>
+  There are also a few options in <kbd class="menu">Transport &gt; Active
+  Mark</kbd>. These options apply to the currently selected location marker, 
+  and move it to a nearby region boundary, region sync point, or to the 
+  playhead or mouse.
+</p>
   
index 4d343acff0affeede00497682733a3f051af1ae1..c58d082ac83e91355fae9b9a562f9c13af2702f1 100644 (file)
@@ -2,11 +2,15 @@
 layout: default
 title: Punch Range
 ---                        
-
-
   
-  
-<p>The punch range is a special range used to define where recording will start and/or stop during a <code>punch</code>.</p>
-<h3>Defining the punch range on the timeline</h3>
-<h3>Defining the punch range in the Ranges & Marks list</h3>
+<p>
+  The <dfn>punch range</dfn> is a special range used to define where 
+  recording will start and/or stop during a <dfn>punch</dfn>.
+</p>
+<p>
+  It can be defined on the <a href="/missing">timeline</a> or in the 
+  <a href="/working-with-markers/rangesmarks-list/">Ranges &amp; Marks 
+  list.
+</p>
+
   
index ac31e379dd52ae48527310fe1a1e7fd2efd62de7..3fb82b515e5c4d1d8b39aa6f55e058d373511df6 100644 (file)
@@ -324,7 +324,6 @@ kbd.menu,kbd.option,kbd.optoff {
 }
 
 kbd.option:after,kbd.optoff:after {
-    content:'x';
     font-family:mono;
     font-weight:lighter;
     text-align:center;
@@ -332,7 +331,10 @@ kbd.option:after,kbd.optoff:after {
     -moz-border-radius:10px;
     border-radius:10px;
     margin-left:0.3em;
-    margin-right:0.5em;
+}
+kbd.option:after {
+    content:'X';
+
 }
 kbd.optoff:after {
     content:'    ';