Update Luadoc for upcoming Ardour 7

[ardour-manual] / include / the-region-list.html

diff --git a/include/the-region-list.html b/include/the-region-list.html
index 2b4d887aa258303e983570e710153c0ef84e463a..e9183d9fa031d1f96345f0cfec42e6e272cdd8b3 100644 (file)
--- a/include/the-region-list.html
+++ b/include/the-region-list.html
@@ -1,21 +1,20 @@
 
 <p>
-  The region list shows all the regions in the session. The left-hand column gives the region name,
-  and there are a range of times given for information:
+  The region list shows all the regions in the session, with infos about them 
+  in a tabular form. Any column caption can be clicked to sort the list
+  according to the clicked value:
 </p>
 
 <table class="dl">
-  <tr><th>Position</th><td>position of the start of the region on the global timeline</td></tr>
-  <tr><th>End</th><td>position of the region on the global timeline</td></tr>
+  <tr><th>Name</th><td>The name of the region, can be modified by double-clicking it</td></tr>
+  <tr><th># Ch</th><td>Number of channels for an audio region (0 for MIDI)</td></tr>
+  <tr><th>Tags</th><td>User-added tag text, can be modified by double clicking it</td></tr>
+  <tr><th>Start</th><td>position of the start of the region on the global timeline</td></tr>
   <tr><th>Length</th><td>duration of the region</td></tr>
-  <tr><th>Sync</th><td>position of the sync point, relative to the start of region (can be negative)</td></tr>
-  <tr><th>Fade In</th><td>duration of the fade in. Can't be less than 1 ms, to avoid clipping.</td></tr>
-  <tr><th>Fade Out</th><td>duration of the fade out (positive value, &ge; 1 ms).</td></tr>
 </table>
 
 <p>
-  The secondary clock defines the time unit used in this list.
-  <a href="@@editing-clocks">Set the secondary clock</a> to the type of unit desired.
+  The time format used for <em>Start</em> and <em>Length</em> follows the <a href="@@editing-clocks">Primary Clock</a> one.
 </p>
 
 <p>
@@ -23,14 +22,14 @@
 </p>
 
 <table class="dl">
-  <tr><th>L</th>
+  <tr><th>&square;&nbsp;L</th>
   <td>whether the region position is locked, so that it cannot be moved.</td></tr>
-  <tr><th>G</th>
+  <tr><th>&square;&nbsp;G</th>
   <td>whether the region's position is &lsquo;glued&rsquo; to bars and beats.
   If so, the region will stay at the same position in bars and beats even if the tempo and/or time signature change.</td></tr>
-  <tr><th>M</th>
+  <tr><th>&square;&nbsp;M</th>
   <td>whether the region is muted, so that it will not be heard.</td></tr>
-  <tr><th>O</th>
+  <tr><th>&square;&nbsp;O</th>
   <td>whether the region is opaque; opaque regions &lsquo;block&rsquo; regions below them from being heard, whereas &lsquo;transparent&rsquo; regions have their contents mixed with whatever is underneath. </td></tr>
 </table>