mirror of
https://github.com/iluvcapra/ptulsconv.git
synced 2026-01-01 17:30:47 +00:00
A bunch of typo cleanups and styling.
This commit is contained in:
@@ -24,17 +24,19 @@ Step 2: Add More Information to Your Spots
|
|||||||
|
|
||||||
Clips, tracks and markers in your session can contain additional information
|
Clips, tracks and markers in your session can contain additional information
|
||||||
to make your ADR reports more complete and useful. You add this information
|
to make your ADR reports more complete and useful. You add this information
|
||||||
with *tagging*.
|
with :ref:`tagging<tags>`.
|
||||||
|
|
||||||
* Every ADR clip must have a unique cue number. After the name of each clip,
|
* Every ADR clip must have a unique cue number. After the name of each clip,
|
||||||
add the letters "$QN=" and then a unique number (any combination of letters
|
add the letters ``$QN=`` and then a unique number (any combination of letters
|
||||||
or numbers that don't contain a space). You can type these yourself or add
|
or numbers that don't contain a space). You can type these yourself or add
|
||||||
them with batch-renaming when you're done spotting.
|
them with batch-renaming when you're done spotting.
|
||||||
* ADR spots should usually have a reason indicated, so you can remember exactly
|
* ADR spots should usually have a reason indicated, so you can remember exactly
|
||||||
why you're replacing a particular line. Do this by adding the the text "{R="
|
why you're replacing a particular line. Do this by adding the the text
|
||||||
to your clip names after the prompt and then some short text describing the
|
``{R=`` to your clip names after the prompt and then some short text
|
||||||
reason, and then a closing "}". You can type anything, including spaces.
|
describing the reason, and then a closing ``}``. You can type anything,
|
||||||
* If a line is a TV cover line, you can add the text "[TV]" to the end.
|
including spaces.
|
||||||
|
* If, for example, a line is a TV cover line, you can add the text ``[TV]`` to
|
||||||
|
the end.
|
||||||
|
|
||||||
So for example, some ADR spot's clip name might look like::
|
So for example, some ADR spot's clip name might look like::
|
||||||
|
|
||||||
@@ -45,12 +47,12 @@ These tags can appear in any order.
|
|||||||
|
|
||||||
* You can add the name of an actor to a character's track, so this information
|
* You can add the name of an actor to a character's track, so this information
|
||||||
will appear on your reports. In the track name, or in the track comments,
|
will appear on your reports. In the track name, or in the track comments,
|
||||||
type "{Actor=xxx}" replacing the xxx with the actor's name.
|
type ``{Actor=xxx}`` replacing the xxx with the actor's name.
|
||||||
* Characters need to have a number (perhaps from the cast list) to express how
|
* Characters need to have a number (perhaps from the cast list) to express how
|
||||||
they should be collated. Add "$CN=xxx" with a unique number to each track (or
|
they should be collated. Add ``$CN=xxx`` with
|
||||||
the track's comments.)
|
a unique number to each track (or the track's comments.)
|
||||||
* Set the scene for each line with markers. Create a marker at the beginning of
|
* Set the scene for each line with markers. Create a marker at the beginning of
|
||||||
a scene and make it's name "{Sc=xxx}", replacing the xxx with the scene
|
a scene and make it's name ``{Sc=xxx}``, replacing the xxx with the scene
|
||||||
number and name.
|
number and name.
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -4,8 +4,8 @@ Tagging
|
|||||||
=======
|
=======
|
||||||
|
|
||||||
Tags are used to add additional data to a clip in an organized way. The
|
Tags are used to add additional data to a clip in an organized way. The
|
||||||
tagging system in `ptulsconv` allows is flexible and can be used to add
|
tagging system in `ptulsconv` is flexible and can be used to add any kind of
|
||||||
any kind of extra data to a clip.
|
extra data to a clip.
|
||||||
|
|
||||||
Fields in Clip Names
|
Fields in Clip Names
|
||||||
--------------------
|
--------------------
|
||||||
@@ -28,12 +28,15 @@ The row output for this clip will contain columns for the values:
|
|||||||
|
|
||||||
These fields can be defined in the clip name in three ways:
|
These fields can be defined in the clip name in three ways:
|
||||||
|
|
||||||
* `$NAME=VALUE` creates a field named `NAME` with a one-word value `VALUE`.
|
* ``$NAME=VALUE`` creates a field named ``NAME`` with a one-word value
|
||||||
* `{NAME=VALUE}` creates a field named `NAME` with the value `VALUE`. `VALUE`
|
``VALUE``.
|
||||||
in this case may contain spaces or any chartacter up to the closing bracket.
|
* ``{NAME=VALUE}`` creates a field named ``NAME`` with the value ``VALUE``.
|
||||||
* `[NAME]` creates a field named `NAME` with a value `NAME`. This can be used
|
``VALUE`` in this case may contain spaces or any chartacter up to the
|
||||||
to create a boolean-valued field; in the output, clips with the field
|
closing bracket.
|
||||||
will have it, and clips without will have the column with an empty value.
|
* ``[NAME]`` creates a field named ``NAME`` with a value ``NAME``. This can
|
||||||
|
be used to create a boolean-valued field; in the output, clips with the
|
||||||
|
field will have it, and clips without will have the column with an empty
|
||||||
|
value.
|
||||||
|
|
||||||
For example, if three clips are named:::
|
For example, if three clips are named:::
|
||||||
|
|
||||||
@@ -64,7 +67,7 @@ Fields in Track Names and Markers
|
|||||||
---------------------------------
|
---------------------------------
|
||||||
|
|
||||||
Fields set in track names, and in track comments, will be applied to *each*
|
Fields set in track names, and in track comments, will be applied to *each*
|
||||||
clip on that track. If a track comment contains the text `{Dept=Foley}` for
|
clip on that track. If a track comment contains the text ``{Dept=Foley}`` for
|
||||||
example, every clip on that track will have a "Foley" value in a "Dept" column.
|
example, every clip on that track will have a "Foley" value in a "Dept" column.
|
||||||
|
|
||||||
Likewise, fields set on the session name will apply to all clips in the session.
|
Likewise, fields set on the session name will apply to all clips in the session.
|
||||||
@@ -85,17 +88,17 @@ track, the value set on the clip will prevail.
|
|||||||
Apply Fields to a Time Range of Clips
|
Apply Fields to a Time Range of Clips
|
||||||
-------------------------------------
|
-------------------------------------
|
||||||
|
|
||||||
A clip name beginning with "@" will not be included in the output, but its
|
A clip name beginning with ``@`` will not be included in the output, but its
|
||||||
fields will be applied to clips within its time range on lower tracks.
|
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
|
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.
|
that range on lower tracks will have a field ``Sc`` with that value.
|
||||||
|
|
||||||
|
|
||||||
Combining Clips with Long Names or Many Tags
|
Combining Clips with Long Names or Many Tags
|
||||||
--------------------------------------------
|
--------------------------------------------
|
||||||
|
|
||||||
A clip name beginning with `&` will have its parsed clip name appended to the
|
A clip name beginning with ``&`` will have its parsed clip name appended to the
|
||||||
preceding cue, and the fields of following cues will be applied, earlier clips
|
preceding cue, and the fields of following cues will be applied, earlier clips
|
||||||
having precedence. The clips need not be touching, and the clips will be
|
having precedence. The clips need not be touching, and the clips will be
|
||||||
combined into a single row of the output. The start time of the first clip will
|
combined into a single row of the output. The start time of the first clip will
|
||||||
@@ -109,23 +112,24 @@ Setting Document Options
|
|||||||
.. note::
|
.. note::
|
||||||
Document options are not yet implemented.
|
Document options are not yet implemented.
|
||||||
|
|
||||||
A clip beginning with `!` sends a command to `ptulsconv`. These commands can
|
..
|
||||||
appear anywhere in the document and apply to the entire document. Commands are
|
A clip beginning with ``!`` sends a command to `ptulsconv`. These commands can
|
||||||
a list of words
|
appear anywhere in the document and apply to the entire document. Commands are
|
||||||
|
a list of words
|
||||||
|
|
||||||
The following commands are available:
|
The following commands are available:
|
||||||
|
|
||||||
page $SIZE=`(letter|legal|a4)`
|
page $SIZE=`(letter|legal|a4)`
|
||||||
Sets the PDF page size for the output.
|
Sets the PDF page size for the output.
|
||||||
|
|
||||||
font {NAME=`name`} {PATH=`path`}
|
font {NAME=`name`} {PATH=`path`}
|
||||||
Sets the primary font for the output.
|
Sets the primary font for the output.
|
||||||
|
|
||||||
sub `replacement text` {FOR=`text_to_replace`} {IN=`tag`}
|
sub `replacement text` {FOR=`text_to_replace`} {IN=`tag`}
|
||||||
Declares a substitution. Whereever text_to_replace is encountered in the
|
Declares a substitution. Whereever text_to_replace is encountered in the
|
||||||
document it will be replaced with "replacement text".
|
document it will be replaced with "replacement text".
|
||||||
|
|
||||||
If `tag` is set, this substitution will only be applied to the values of
|
If `tag` is set, this substitution will only be applied to the values of
|
||||||
that tag.
|
that tag.
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user