Documentation

docs/source/for_adr.rst

@@ -15,39 +15,41 @@ Project-Level Tags
 """"""""""""""""""
 
 It usually makes sense to place these either in the session name,
-or on a marker at the beginning of the session, so it will apply to
+or on a :ref:`marker <tag-marker>` at the beginning of the session, so it will apply to
 all of the clips in the session.
 
-``Title``:
+`Title`:
     The title of the project. This will appear at the top
     of every report.
 
-``Supv``:
+`Supv`:
     The supervisor of the project. This appears at the bottom
     of every report.
 
-``Client``:
+`Client`:
     The client of the project. This will often appear under the
     title on every report.
 
-``Spot``: The date or version number of the spotting report.
+`Spot`: 
+    The date or version number of the spotting report.
 
 
 Time Range Tags
 """""""""""""""
 
 All of these tags can be set to different values on each clip, but
-it often makes sense to use these tags in a time range.
+it often makes sense to use these tags in a :ref:`time range<tag-range>`.
 
-``Sc``:
+`Sc`:
     The scene description. This appears on the continuity report
     and is used in the Director's logs.
 
-``Ver``:
+`Ver`:
     The picture version. This appears beside the spot timecodes
     on most reports.
 
-``Reel``: The reel. This appears beside the spot timecodes
+`Reel`: 
+    The reel. This appears beside the spot timecodes
     on most reports and is used to summarize line totals on the
     line count report.
 
@@ -55,42 +57,48 @@ it often makes sense to use these tags in a time range.
 Line tags
 """""""""
 
-``P``: 
+`P`: 
     Priority.
 
-``QN``: 
+`QN`: 
-    Cue number. This appears on all reports and `ptulsconv` 
+    Cue number. This appears on all reports.
-    verify that all cues in a given report have unique cue numbers.
 
-``CN``: 
+.. warning::
+    `ptulsconv` will verify that all cue numbers in a given title are unique.
+
+    All lines must have a cue number in order to generate reports, if any lines
+    do not have a cue number set, `ptulsconv` will fail.
+
+
+`CN`: 
     Character number. This is used to collate character records
     and will appear on the line count and in character-collated 
     reports.
 
-``Char``: 
+`Char`: 
     Character name. By default, a clip will set this to the 
     name of the track it appears on, but the track name can be
     overridden here.
 
-``Actor``: 
+`Actor`: 
     Actor name.
 
-``Line``: 
+`Line`: 
     The prompt to appear for this ADR line. By default, this
     will be whatever text appears in a clip name prior to the first
     tag.
 
-``R``: 
+`R`: 
     Reason.
 
-``Mins``: 
+`Mins`: 
     Time budget for this line, in minutes. This is used in the
     line count report to give estimated times for each character. This 
-    can be set for the entire project (with a marker), or for individual 
+    can be set for the entire project (with a :ref:`marker <tag-marker>`), or for individual 
-    actors (with a tag in the track comments), or can be set for 
+    actors (with a tag in the :ref:`track comments<tag-track>`), or can be set for 
     individual lines to override these. 
 
-``Shot``: 
+`Shot`: 
     Shot. A Date or other description indicating the line has been
     recorded.
 
@@ -98,17 +106,18 @@ Line tags
 Boolean-valued ADR Tag Fields
 """""""""""""""""""""""""""""
 
-``EFF``: 
+`EFF`: 
     Effort. Lines with this tag are subtotaled in the line count report.
 
-``TV``: 
+`TV`: 
     TV line. Lines with this tag are subtotaled in the line count report.
 
-``TBW``: 
+`TBW`: 
     To be written.
 
-``ADLIB``:
+`ADLIB`:
     Ad-lib.
 
-``OPT``: 
+`OPT``: 
     Optional. Lines with this tag are subtotaled in the line count report.
+

docs/source/tagging.rst

@@ -54,6 +54,9 @@ The output will contain the range:
 +----------------------------------------------+------------+------+-----+------+-------+
 
 
+.. _tag-track:
+.. _tag-marker:
+
 Fields in Track Names and Markers
 ---------------------------------
 
@@ -73,6 +76,9 @@ An important note here is that, always, fields set on the clip name have the
 highest precedence. If a field is set in a clip name, the same field set on the 
 track, the value set on the clip will prevail.
 
+
+.. _tag-range:
+
 Using @ to Apply Fields to a Time Range of Clips
 --------------------------------------------------
 
@@ -82,6 +88,7 @@ fields will be applied to clips within its time range on lower tracks.
 If track 1 has a clip named `@ {Sc=1- The House}`, any clips beginning within 
 that range on lower tracks will have a field `Sc` with that value.
 
+
 Using & to Combine Clips
 --------------------------