Navigation

Home | Installation | Quick Start | Documentation | Cookbook

Documentation

A PDF version of this document is also available.

Paratext Stylesheet

\stylesheet{usfm.sty} – Define the Paratext stylesheet to be used as a basis for formatting (default=usfm.sty)

You can read multiple stylesheets (to override primary stylesheet values) For example:

\stylesheet{mods.sty}

In the file mods.sty, add standard Paratext marker style definition parameters to override the default stylesheet definitions provided through \stylesheet{...} (above).

\Marker s1
\Justification Left

\Marker r
\Justification Left

Page Setup

Dimensions

\PaperWidth=148.5mm – Page width (default = 148.5mm – A5)
\PaperHeight=210mm – Page height (default = 210mm – A5)

Crop Marks

\CropMarkstrue – Add crops marks to the PDF output? (default = false)

Margins

\MarginUnit=12mm – Basic unit for margins; changing this will alter them all. (default = 1in)

Note: The following top and bottom margin settings adjust the the size of margins around the body text area. You will need to keep in mind that adequate space needs to be provided for and headers and/or footers.

\def\TopMarginFactor{1.15} – Relative size of the top margin based on MarginUnit (default = 1.0)
\def\BottomMarginFactor{1.0} – Relative size of the bottom margin based on MarginUnit. If undefined, the \TopMarginFactor will be used for both top and bottom margins.
\def\SideMarginFactor{1.0} – Relative size of side margin based on MarginUnit (default = 0.7)
\BindingGutter=4mm – Amount for an additional margin on the binding side of the page (default = 5mm)
- \BindingGuttertrue must be specified for the \BindingGutter amount to be applied (default = false)

Columns

\TitleColumns=1 – Number of columns used to typeset the main title (default = 1)
\IntroColumns=1 – Number of columns used to typeset introduction material. Introduction material is defined by USFM markers beginning with \i (default = 1)
\BodyColumns=1 – Number of columns used to typeset the body text (default = 1)
\def\ColumnGutterFactor{15} – Used to set the size of the gutter between columns; relative to font size
\ColumnGutterRuletrue – Place a vertical line between the columns in the column gutter? (default = false)

## Peripheral mater Assuming that the perpheral matter has been marked with a USFM-3 id="...", thus: ``` \periph Introduction to OT|id="intot" ``` Then the ptx2pdf code now automatically stores certain peripheral divisions for later use. The material can be retrieved by e.g. `\zgetperiph|intot\*`. The divisions that are stored by default are: intbible, intnt, intot, intpent, inthistory, intpoetry, intprophesy, intdc, intgospels, intepistles, intletters, cover, spine. Control of which divisions are stored or not is via the configuration macros: ``` \StorePeriph{promo} \NoStorePeriph{intbible} \StorePeriphtrue \StorePeriphfalse ```

(If \StorePeriphfalse is declared, then no storing of peripherals will occur, and the assumption is that they have been (re-)positioned correctly).

Stored periph items are assumed to be single use, and are tidied away (deleted) unless otherwise instructed, in order to save memory. \KeepPeriph{intbible} instructs the code to keep the 'intbible' periphery for re-use. Irrespective of a periphery division being stored or not, material within a periph division may be styled with the prefix periph:id| , e.g.

\Marker periph:intbible|p

See styling.md for more details of how more complex styling may be applied.

NOTE that all of the above refers to the behaviour of the TeX macros. The python PTXprint code which pre-process the code may take different actions.

Fonts

\FontSizeUnit=0.75pt – Scaling factor for interpreting font sizes in the stylesheet. Changing this will scale all text proportionately (default = 0.9pt)

Faces

\def\regular{"Times New Roman"} – Font to use for text where the marker does not define a font style in the Paratext stylesheet (result is "plain" text)
\def\bold{"Times New Roman/B"} – Font to use for text where the marker is defined as "\Bold" in the Paratext stylesheet
\def\italic{"Times New Roman/I"} – Font to use for text where the marker is defined as "\Italic" in the Paratext stylesheet
\def\bolditalic{"Times New Roman/BI"} – Font to use for text where the marker is defined as "\Bold" + "\Italic" in the Paratext stylesheet

For Mac OS X, use the Postscript Name or Full Name in quotes from Font Book's Font Info.

Script specific features for fonts supporting the selected script can be enabled by adding a "script=" parameter to the end of the font name. For example, in the case of typesetting Arabic script, we might have: \def\regular{"Scheherazade:script=arab"}

The script parameter is an OpenType script tag. A list of common script tags is presented in an appendix at the end of this document.)

You can also specify a font definition like this directly in a stylesheet marker definition. For example:

     \Marker p
     \FontName Scheherazade:script=arab

Text Spacing

\def\LineSpacingFactor{1} – Scaling factor used to adjust line spacing (leading); relative to font size (default = 1.2)
\def\VerticalSpaceFactor{1.0} – Scaling factor used to adjust amount of vertical spaces applied for usfm.sty SpaceBefore and SpaceAfter values (default = 0.2}

Chapters & Verses

\OmitVerseNumberOnetrue – Omit the first verse number in every chapter? (default = false)
\OmitChapterNumbertrue – Omit the chapter numbers of the book. (Often used for one-chapter books. (default = false)
\OmitChapterNumberRHtrue – Omit the chapter numbers in the running header (RH). (default = false)
\def\AdornVerseNumber#1{(#1)} – Put parentheses around the verse number (which is represented by #1)
\def\AfterVerseSpaceFactor{0} – Remove extra space after verse numbers, when you have set them to be "invisible", or a very small size, such as \Marker v \FontSize 0.0001
\def\MakeChapterLabel#1#2{#1\ #2} – If there is a global (before \c 1) \cl, how should that be combined with the chapter number. The default is to put the label (#1) before the number (#2). Altering this macro would to \def\MakeChapterLabel#1#2{#2. #1} will make Hungarian-style numbering (23. Zsoltár) the default rather than English-style (Psalm 23).

Running Header/Footer

Header/Footer Position

\def\HeaderPosition{0.7} – Position of the baseline of the header relative to the top edge of the paper (not the text area) (default = 0.5)
\def\FooterPosition{0.5} – Position of the baseline of the footer relative to the bottom edge of the paper (not the text area) (default = 0.5)

The following parameters are used to specify the information to include in the running header (at top of pages, except title pages). Set the items to print at left/center/right of odd and even pages separately.

Odd Header

Headers for normal pages with an odd page number, e.g.:

\def\RHoddleft{\empty}
\def\RHoddcenter{\rangeref}
\def\RHoddright{\pagenumber}

Even Header

Headers for normal pages with an even page number, e.g.:

\def\RHevenleft{\pagenumber}
\def\RHevencenter{\rangeref}
\def\RHevenright{\empty}

Title-page Header

Headers for pages that start with the title of a book are normally defined without reference to the page being on an odd or oven page. e.g.:

\def\RHtitleleft{\empty}
\def\RHtitlecenter{\empty}
\def\RHtitleright{\empty}

There are, however, also side-specific versions, e.g. \def\RHtitleoddright{\pagenumber} Defining such a value means it will take priority over the 'both sides' setting on the relevant page.

Front / back matter Header

Headers for a page that has neither verses nor titles, e.g. a glossary.

\def\RHnoVoddleft{\empty}
\def\RHnoVoddcenter{\empty}
\def\RHnoVoddright{\pagenumber}
\def\RHnoVevenleft{\pagenumber}
\def\RHnoVevencenter{\empty}
\def\RHnoVevenright{\empty}

Footers

For control over the footer, fifteen similar \def commands are available, beginning with \RF instead of \RH.

Setting a complete set

It is sometimes desirable to set a complete set of the 6 header / footer postitions in one go. A convenience function has been implemented to allow this:

\HEADFOOTset{H}{noV}{\pageno}{\empty}{\empty}{\empty}{\empty}{\pageno}
\HEADFOOTset{F}{noV}{Draft}{\empty}{\isodate}{\isodate}{\empty}{Draft}

Will, (assuming the left-most page is odd-numbered) on the put page numbers on introduction / glossary pages into the outside of the header, 'Draft' into the outside footer, and the date into the inside-edge of the footer.

Header/Footer Content macros

Any appropriate combination of text and TeX macros may be used in the header or footer slots. The following are provided for convenience.

\rangeref – Scripture reference of the range of text on the page
\firstref – reference of the first verse on the page
\lastref – reference of the last verse on the page
\pagenumber – the page number
\empty – print nothing in this position
\usdate, \ukdate, \isodate - dates in various formats. (See FAQ for more examples)
\hrsmins - the time of day

Literal text can also be included (e.g., to add dashes around a centered page number, \\def\RFtitlecenter{-\pagenumber -}).

Header/Footer Scripture Ranges

Items such as rangeref, firstref, etc. need to know how to construct a scripture reference from individual parts. The following macros can be redefinied:

\def\RangeChar{\endash} specifies a character (can be multiple characters, of course) that the code should use for ranges in the running header, bridged verses, etc.
\def\RangeSeparator{\kern.1em\RangeChar\kern.1em} used for ranges of verses (in the running header). The default uses \RangeChar with some spacing either side.
\def\RangeChapSeparator{\kern.1em\RangeChar\kern.1em} the range separator for range of chapters or books (in the running header). The default uses RangeChar with some spacing.
\def\BookChapSeparator{ } By default a space, but maybe someone wants Genesis:1.2 or something in the running header.
\def\ChapterVerseSeparator{:} What goes between the chapter and verse numbers in the running header (typically \def\ChapterVerseSeparator{.} or {:)?

Other Header Setup

\RHruleposition=6pt – Position of a rule below the running header (default = 10pt)
\VerseRefstrue – Whether to include verse numbers in header/footer references, or only chapter numbers (default = false)

Other

\IndentAfterHeadingtrue – Remove paragraph indentation on the first paragraph after a section heading (default = false)

Notes

\AutoCallerStartChar=97 – Unicode value of first character to use for auto-generated callers (default = 97 = 'a')
\AutoCallerNumChars26 – Number of caller characters to generate before restarting sequence (default = 26)
\AutoCallers{f|x}{callers csv} – Make the specified note class use a specific sequence of symbols
- \AutoCallers{f}{*,+,¶,§,**,++,¶¶,§§}
- \AutoCallers{x}{} (this configuration would suppress callers for cross-references)
\NumericCallers{f} – Make the note class use numeric (instead of alphabetic) callers (specify f or x)
\PageResetCallers{f} – Restart numbering for the notes class on each page (specify f or x)
\OmitCallerInNote{x} – To omit callers from the note class at the bottom of the page (specify f or x)
\ParagraphedNotes{x} – Format the note class as a single paragraph, with larger space between note items (specify f or x)
\NoteCallerWidth=1.2ex - Adjust 'standard' width of a footnote-caller in notes area. A small amount of space is added to narrow callers, centering them in a space of this width, so that they and their note text align nicely in the footer. Wider callers take their natural size, without any padding. (default 1.1ex) (Control added 22 Sept. 2020)
\ifFootnoteGlyphMetrics Does the note use the font's descender design parameter, or the actual bottom of the glyph. If the former, then the bottom of notes have a common baseline. If the latter, then the glyphs sit as close to the bottom margin as they can, which may permit an extra line of text.

New Paragraphed notes

There are two sorts of paragraphed footnotes, old-style and new-style. As they produce different results, with spacing differences and subsequent changes in layout, new style notes are not currently active by default. Activate with \newparnotestrue. Differences are as below:

\fp behaviour: with new style notes, this starts produces a new paragraph, indented by the note-style's first line indent. In old style notes, this causes a medium-long, possibly very long space.
Footnote validation. Old style paragraphed notes are incompatible with the technique used to write \@noteid entries into the .parlocs file, which are then used to verify that a footnote caller and footnote text are on the correct page.
Control over various spaces (the defaults provide the closest results to old-style paragraph notes):
- \ifparnoteskillprevdepth (true) Kern away (kill) the glyph/font depth of earlier footnotes, via TeX's internal \prevdepth value
- \fparnoteskilldepth (false) Kern away (kill) the glyph/font depth of each footnote as it is added. If true this positions the bottom note's baseline on the margin.
- \ifparnotesruletopskip (false) If true, the footnote rule is positioned relative to the hypothetical baseline above the topmost footnote, rather than relative to the glyph/font height.
- \ifparnotesmidtopskip (true) If true, then the hypothetical baseline above the topmost entry in a given style is used as the basis for the vertical \InterNoteSpace, rather than the glyph/font height
Incompatability: No baseline correction between the overflow of center-column notes and footnotes. Old style paragraphed notes automatically apply this correction, it has not proven possible to replicate this yet. This leads to some significant spacing differences in a font with a high ascent, or with GlyphMetrics turned on.

End notes

\NoteAtEnd{f} – To make the specified note class an endnote (default: only fe 'endnotes' are endnotes).
\notesEachBookfalse – To place endnotes at the end of the entire volume rather than (default) the end of individual books.(default=true)
\EndNotesEarlyfalse – Do automatic endnotes come before the end-hooks for the book or after? Placing them early will put them ahead of any end-of-book markers, and (unless \EndNotesSingleColtrue has been given) they will be part of the dual-column text if that is the normal presentation. Placing them late may result in them being positioned single-column, depending on what other hooks do, and after any end-of-book markers, page-breaks, etc. (default=true)
\EndNotesSingleColtrue – Is a transition to single-column mode forced before any automatic endnotes are placed? (default=false)
\def\EndNoteRuleWidth{0.5} – Fraction of column width to make the rule above automatically inserted endnotes (default =0.5)
\def\EndNoteRuleThickness{0.4pt} – Thickness of the rule above automatically inserted endnotes (default=0.4pt)
\def\AboveEndNoteRule{14 pt} – Space between the body text and the end-note separator line.
\def\BelowEndNoteRule{10 pt} – Space between the separator line and the start of the end-notes. If this and \EndNoteRuleAbove add up to a whole number, then (with the default definition for \EndNoteSeparator) then gridding will be preserved. I.e. the macros will not ensure the above end note rule will keep to the grid.

Custom end-note use

\zplaceallnotes – Non-standard USFM marker to place any currently-waiting endnotes (with preceding endnote rule and spacing, if there are any endnotes).
\zpostendnoterule – Non-standard USFM marker to place an endnote rule, positioned 0.5 lineskips above the baseline. This might be wanted, for example, if endnotes are put mid-text, or within a mid-text side-bar. If no endnotes were found during the last call to \zplaceallnotes, this produces no output.
\zendnoterule – Non-standard USFM marker to unconditionally place the (pre-) endnote rule (with surrounding spacing) at this place (for use before the command below)
\zplacenotes-X – Non-standard USFM marker to place endnotes of a particular type collected until now. E.g. If \fe notes are endnotes, \zplacenotes-fe will place those notes at the specified place. This does not change the flag used by \zpostendnoterule.
\ztestnotes-X – Non-standard USFM marker to test for currently-waiting end-notes of a particular type, and set or unset the flag used by \zpostendnoterule. Note that the behaviour of this command is not the same as the logic of \zplaceallnotes, which tests to see if any end-note has contents. Also note that after the contents have been placed on the page, the end-note is not waiting by definition, therefore this should only be used before the relevant \zplacenotes-X

Footnote rule control

For now, if you want to change the appearance of (or remove) the footnote rule, redefine \def\footnoterule

\def\footnoterule{} – No footnote rule will be applied if the definition is empty (as in this example)
\def\EndNoteSeparator{} – No endnote rule will be placed if the definition is empty (as in this example). Alternatively the definition might include an image.

Illustrations (Figures)

\IncludeFigurestrue – Output illustrations (figures) marked in the text with USFM \fig...\fig* markup? (default = true)
\FigurePlaceholdersfalse – Operate in "figure placeholders" mode? If true, the macros will read your picture definitions, but only render a rectangular frame containing the text of the filename, rather than the actual graphic. (default = false)

Table of Contents control

\GenerateTOC[title]{filename} - where [title] is optional, default is "Table of Contents" Writes TOC entries from \toc1, \toc2, \toc3 markers to the given file, which can be used directly with \ptxfile{...} or renamed and edited as needed to customize the TOC.
\useTOConetrue - Include parameter of \toc1 (Full name) in above table of contents file. (default = true)
\useTOtwotrue - Include \toc2 (Short name) in from above table of contents file. (default = true)
\useTOCthreetrue - Include \toc3 (Abbreviation) in from above table of contents file. (default = true)

Thumb tabs

See the feature-specific documentation for a more extensive discussion.

\setthumbtab{GEN}{1} - generate a page-edge thumb-tab for all pages in the book of Genesis. The code (GEN in the example) must be an exact match of the code used in the USFM \id marker. All \setthumbtab commands should be complete before the first \ptxfile is loaded. The number (1 in the example), is termed index number in this documentation and (together with parameters below) controls the vertical position of the tabs for the given book, with 1 being nearest the top of the page.
\def\tabBoxCol{0.2 0.3 0.2} colour definition for the thumb-tab, the 3 numbers representing red, green and blue in the range of 0 (black), 0.5 (half) to 1 (fully lit). (Default 0 0 0).
\def\tabFontCol{0.5 1 0.5} colour definition for the thumb-tab, the 3 numbers representing red, green and blue in the range of 0 (black), 0.5 (half) to 1 (fully lit). (Default 1 1 1).
\tabheight=50pt Vertical dimension of the thumbtab. (default 50pt).
\tabwidth=25pt Vertical dimension of the thumbtab. (default 15pt).
\TabRotationNormaltrue When this is true, then when the \tabheight > \tabwidth the text on the tab will be rotated, and otherwise it will be horizontal. If false, the logic is inverted. This may be useful to force horizontal text in tall tabs, or if the assumption that the text is wider than it is tall is incorrect.
\setthumbtab{PSA}{} - Undo an earlier \setthumbtab command.
\setthumbtabFg{PSA}{0 1 0.8} - Override the default foreground colour \tabFontCol for the given book.
\setthumbtabBg{REV}{0.3 0.3 0} - Override the default background colour \tabBoxCol for the given book.
\TOCthreetabtrue - if false, then thumb-tabs will not have their content from the \toc3 entry. This will leave the tab blank unless set via the custom USFM marker \zthumbtab. (default = true)
\def\ThumbTabStyle{toc3} - use specified marker for selecting the font, size, weight, etc. (default = toc3)
\NumTabs=5 - Pre-set / reset the number of tabs between which the available space will be divided. Normally there is no need to set this number, as \setthumbtab{ZEC}{39} will set it to 39 unless it is already larger than that.
\TabsStart=10pt Distance between the upper edge of the topmost thumb-tab and the top margin of the page (text area). Negative values may be given to extend tabs into the upper margin.
\TabsEnd=10pt Distance between the lower edge of the lowermost thumb-tab and the bottom page margin (text area). Negative values may be given to extend tabs into the lower margins.
\def\TabBleed{1pt} - Amount the tab goes over the edge of the page. (default 1pt)

Hooks

Hooks can insert something (text, or any valid TeX instruction/control sequence) to the output, at selected marker (style) location(s).

\sethook{location}{marker}{insert} Example: \sethook{start}{s1}{~}

Valid locations are:
- before – prior to the start of the par or style run containing the selected style text (before its definition is applied)
- after – after the end of the par or style run containing the selected style text (after its definition is terminated)
- start – before the start of the selected style text (but after the paragraph or character style definition is applied)
- end – after the end of the selected style text (but before the paragraph or character style definition is terminated)

A useful hook is the command to "hang" verse numbers into the paragraph indent, often wanted on poetry styles: \sethook{start}{q1}{\hangversenumber} \sethook{start}{q2}{\hangversenumber}

This allows a verse number at the beginning of a paragraph to be typeset "hanging" into the paragraph indent, so that the text itself starts at the usual indent position. This is often used with poetic sections (\q# markers), so that the actual text stays neatly aligned for lines both with and without verse numbers.

<a name=#ptx2pdf-MacroSetupParameters-IntroMarkers">Introductory Markers

Introductory markers (those starting i, such as \ip) are used for book introductions and are often set in a full-width single column, even when the verse text is in dual columns. The code has, until now, assumed that this should always be the case. However, some introductory markers have a dual role, and serve as bridging text or chapter introductions. In this use-case they should not trigger a swap to single column mode. In normal scripture, it is thus appropriate that - after the first chapter mark has been met - this swapping between dual and single column mode should be prevented.

A complication is that in a Paratext module, it is very possible that multiple books appear in a given USFM file, and in this case it would appropriate that introductory markers exit from dual column mode, and return to single column mode. The XeTeX macros are unable to decide on their own how the markers are being used. The following setup parameters will hopefully help.

\introAmbigious{iex} – The marker specified will not initiate any swapping between single or double columns (in either direction). This also means it should not ever be the first marker in a book introduction. (default: only \iex has been declared ambiguous, as it is sometimes used for bridging material).
\ReenterIntroOKtrue – old behaviour, a marker starting i (introductory marker) will start single-column text, unless it's been declared ambiguous like \iex was as a stop-gap measure (this approach presents its own problems - ambiguous markers will not start single-column text at the start of a book either).
\ReenterIntroOKfalse – chapter numbers set an internal flag to true. Once this flag is set, then all markers are treated as body-text markers. The problematic ambiguous markers are no longer treated as ambiguous, (except for \tr). The internal flag is set to false at the start of a book.

Graph-paper and Grid

Sometimes it is useful to display a graph-paper-like measurement grid or the grid which the text is (should be) layed out to.

\def\doLines{\doGraphPaper} Display graph-paper
\def\doLines{\doGridLines} Display gridlines
\def\doLines{\doGraphPaper\doGridLines} Display both gridlines and graphpaper

The grid is set up using the page parameters, and the graph-paper as below. If any of these are changed part-way through a control-file (e.g. line spacing is altered before the start of the glossary) then the (cached) 'background page' should be cleared, so that the old page is not reused.

  \setbox\gp@box=\box\voidb@x

Graph-paper setup

\def\GraphPaperX{2mm} Horizontal spacing of the the grid lines on the graph-paper
\def\GraphPaperY{2mm} Vertical spacing of the grid lines on the graph-paper
\def\GraphPaperMajorDiv{5} Every fifth division will be styled as a major division.
\def\GraphPaperXoffset{0.0cm} Start (and stop) of the graph-paper relative to the nearest horizontal edge
\def\GraphPaperYoffset{0.0cm} Start (and stop) of the graph-paper relative to the nearest vertical edge
\def\GraphPaperLineMajor{0.6pt} Width of a major graph-paper line
\def\GraphPaperColMajor{0.8 0.6 0.6} Colour a major graph-paper line (R G B)
\def\GraphPaperLineMinor{0.3pt}Width of a minor graph-paper line
\def\GraphPaperColMinor{0.85 0.85 1.0} Colour a minor graph-paperline (R G B)
\def\GridPaperLineMajor{0.6pt} Width of a major grid-paper line
\def\GridPaperColMajor{0.8 0.6 0.6} Colour of of a major grid-paper line
\def\GridPaperLineMinor{0.3pt} Width of a minor grid-paperline
\def\GridPaperColMinor{0.85 0.85 1.0} Colour of a minor grid-paper line (R G B)

PageNumbers and Reference

Some special-purpose milestones have been defined for page and chapter:verse references within a publication:

\esb \cat BibleBackgroud\cat*
\zlabel|TypesOfPsalms\*
Scripure contains several different types of Psalms....
\esbe

...

\fe + \ft A psalm of ascent, see article on page \zpage|TypesOfPsalms\* \fe*

\f + \ft A maskil, see note at \zref|label="MaskilMeaking" show="b_c.v"\* \f*

The \zlabel milestone instructs TeX to remember the page number of the text when the text is written to the pdf file. (using the .picpages file). The next time the file is processed, the page number will be available. \zpage will use that number, assuming it is defined. It will use the page number as printed by default (i.e. Roman numerals for introductory matter).

The \zref milestone performs a similar task but giving book, chapter and verse for the specified text. It is most useful for footnotes, rather than side-bars or images, as these can end up some distance from their anchor point.

The (optional) parameter show gives a string that shows what should be printed:

b The book name (\toc1)
c Chapter number
v Verse number
\_ A space

Letters and punctuation that do not match the above special characters will copied into the output. The default value for show is b\_c:v, giving an output such as "Genesis 1:1". WARNING: spaces in the string are ignored (due to a peculiarity of TeX).

Other special-purpose milestones and commands

Blank pages

\def\TPILB{\hfil This Page Intentionally Left Blank} Message to appear on intentionally empty pages. The \hfil at the start will centre a single line of text. (default empty).
\zEmptyPage – Insert an intentionally empty page. The macro \TPILB will be used to provide any filler content. Headers and footers will be the ...noV... versions.
\zNeedOddPage - Insert 0 or 1 intentionally empty page(s) so that what follows is on a odd-numbered page.
\zNeedEvenPage - Insert 0 or 1 intentionally empty page(s) so that what follows is on a even-numbered page.
\zNeedQuadPage - Insert 0 to 3 intentionally empty page(s) so that what follows is on page exactly divisible by 4.
\zfillsignature|pagenums="no" extra="0" pages="8"\* Calculate \afterwordpages + "extra" + current page count. Work out how many pages are needed to fill the signature of "pages" pages, and call \zEmptyPage that many times. The pagenums parameter can either be entirely ommitted or contain "do" (\dopagenums) or "no" (\nopagenums). Note that the page count used by this is now the actual count of pages printed by PTXprint, not the current page number.

Vertical space

\zbl|3\* insert 3 blank lines \zgap|1in\* insert glue occupying 1inch \zgap|1in plus 2in minus 0.3in\* insert flexible glue.

ISBN barcode

\zISBNbarcode|isbn="01-234-56789"\* Create a barcode (EAN13) from a 10 or 13 digit ISBN. The provided ISBN will be printed as supplied (prefixed by 'ISBN'), normally with the barcode below. If a 10 digit ('old style') ISBN is supplied, the barcode will be prefixed with '978', and have the check-digit altered as described in the relevant Wikipedia article (which corresponds to various books). No barcode will be created if other than 10 or 13 digits are given. No spaces should be present in the ISBN, group separation is by hyphen/minus (U+002D), as above.

The optional parameters height="short" or height="medium"make the bars 5ex and 7ex high respectively, as opposed to the normal 10ex. The normal size may be altered by e.g. \def\b@rheight{9ex} Text/numbers are displayed in the font Andika by default, the font can be altered by: \def\ISBNfont{Helvetica}

ISBN barcodes with a price code

\zISBNbarcode|isbn="01-234-56789" price="$8.45" pricecode="50845"\* Some ISBN barcodes include a recommended sale price, using the EAN-5 extention, which can hold 5 digits. Only a few countries (mainly English-speaking) seem to use this, but at least one document states that it is necessary for books to scan properly in some countries. The price attribute is the text that should be printed. The pricecode designates the currency (1st digit) and the price (digits 2-5). Wikipedia states that the currency digit should be: 0 or 1: GBP, 3: AUD, 4: NZD, 5: USD, 6: CAD.

If the pricecode is not supplied, then no price barcode will be generated.

Misc. milestones

\zfiga|anchor\* An anchor point for a figure from the piclist. See figures.md. It can also be used as a trigger point. \zvar|value\* Output a stored string (defined in the user interface / tex file). `\zgetperiph|id* Output a stored periphery section. See earlier.

Conditional text

There are (so far) two tests which set up the pseudo-character styles \ztruetext ...\ztruetext* and \falsetext...\zfalsetext* Note that these are not true character styles, and they cannot be nested. All content (including paragraph markers, sidebars, etc) within them is swallowed as a TeX parameter and if the result of the test was true or false (as appropriate) it is re-read and re-processed. Because of how they operate, no attempt should be made to use them inside hooks or other macros.

Tests for conditional text.

\zifhooks|marker Sets up the conditional text code depending if there have been hooks set up for a given marker. This can be useful if markers for \add or \sls are inserting code via hooks.

\zifvarset|var="varname"\* Sets up the conditional text code depending if the zvar
varname has been set. The optional parameter emptyok="T" determines whether an empty variable should be treated as unset (the default, if emptyok is not specified) or as set (any value for emptyok except "F"). i.e., an empty varible will give the following results:

\zifvarset|var="varname"\* -> false
\zifvarset|var="varname" emptyok="F"\* -> false
\zifvarset|var="varname" emptyok="t"\* -> true
\zifvarset|var="varname" emptyok=""\* -> true
\zifvarset|var="varname" emptyok="rabbit"\* -> true

Appendix: Common OpenType script tags

Tag	Script
arab	Arabic
armn	Armenian
beng	Bengali
bopo	Bopomofo
cans	Canadian Syllabics
cher	Cherokee
hani	CJK Ideographic
cyrl	Cyrillic
deva	Devanagari
ethi	Ethiopic
geor	Georgian
grek	Greek
gujr	Gujarati
guru	Gurmukhi
jamo	Hangul Jamo
hang	Hangul
hebr	Hebrew
kana	Hiragana
knda	Kannada
kana	Katakana
khmr	Khmer
lao	Lao
mlym	Malayalam
mong	Mongolian
mymr	Myanmar
orya	Oriya
sinh	Sinhala
syrc	Syriac
taml	Tamil
telu	Telugu
thaa	Thaana
thai	Thai
tibt	Tibetan
yi	Yi

Attachments (1)

ptx2pdf-MacroSetupParameters.pdf - on May 17, 2011 by Jeff Klassen (Version 1)

Files

README.md

Latest commit

History