jamie/ptulsconv
1
0
Fork 0
mirror of https://github.com/iluvcapra/ptulsconv.git synced 2025-12-31 08:50:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

New feature doc

Browse Source
This commit is contained in:
Jamie Hardt
2022-11-18 16:14:55 -08:00
parent 900dd5d582
commit dadeab49fe
1 changed files with 33 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
docs/source/tagging.rst
View File

@@ -81,8 +81,8 @@ track, the value set on the clip will prevail.
.. _tag-range: .. _tag-range:
Using @ to 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.
@@ -91,12 +91,40 @@ 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.
Using & to Combine Clips 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
become the start time of the row, and the finish time of the last clip will become the start time of the row, and the finish time of the last clip will
become the finish time of the row. become the finish time of the row.
Setting Document Options
------------------------
.. note::
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 list of words
The following commands are available:
pagesize `(letter|legal|a4)`
Sets the PDF page size for the output.
font -n `name` -p `path`
Sets the primary font for the output.
sub [-t `tag`] -t `text_to_replace` `replacement text`
Declares a substitution. Whereever text_to_replace is encountered in the
document it will be replaced with "replacement text".
If `tag` is set, this substitution will only be applied to the values of
that tag.