doc.scripts.DTBookToLaTeX.html Maven / Gradle / Ivy
Pipeline Script: DTBook to LaTeX [BETA]
Pipeline Script: DTBook to LaTeX [BETA]
Overview
This script converts a DTBook 2005 document to LaTeX.
The script can be used to produce LaTeX which can be rendered
to PDF and used for Large Print.
The main reason this script is still in "BETA" is to indicate
that the maintainer welcomes any feedback, requests or even bug
reports.
Input Requirements
No specific requirements beyond that the input needs to be a
valid DTBook 2005 document.
Output
The script generates LaTeX output which can be transformed to
PDF. A modern version of LaTeX is recommended as the generated
output requires XeTeX which
has features for Unicode
and TrueType
font handling. The best bet is probably to install
TeX Live which should
include XeTeX and many fonts.
On Linux you need to invoke xelatex to produce PDF
from the generated LaTeX document. For instructions on how to
invoke xelatex on Windows consult
the TeX Live
documentation.
It is also recommended that you install
the Tiresias
LPfont which is well suited for large print publications.
Please note that the PDF generated by LaTeX is not tagged and
hence not accessible. For producing hard copy
Large Print however this script is perfectly fine.
Configuration
- Input DTBook
- Required. The input DTBook document; the grammar version needs to be in the 2005 series.
- Output XHTML
- Required. Resulting XHTML 1.O document.
- Font size
- Optional. The font size to be used for the
generated LaTeX. See also the documentation of the extsizes
package
(http://www.ctan.org/tex-archive/macros/latex/contrib/extsizes).
- Font
- Optional. The font to be used for the
generated LaTeX. Make sure you have the specified fonts
installed on your system. See also
the TeX Live
documentation.
- Backup font
- Optional. secondary font to be used for
specific Unicode ranges specified in backupUnicodeRanges. The
ucharclasses package must be installed for this feature.
- Backup Unicode ranges
- Optional. Comma-separated list of Unicode
ranges (in camel case notation) for which the backup font must
be applied (example: Arabic,Hebrew,Cyrillic,GreekAndCoptic).
- Page style
- Optional. The page style to use for the
document. The three possible values are:
- Plain
- This is the simplest style. It contains
no headers, a very simple footer with the page number. Page
numbers of the original document are not displayed and the
sections are not numbered.
- Compact
- This style is similar in simplicity to
the 'Plain' style but level1 sections start on any page (in
the 'Plain' style they only start on a recto page).
- Spacious
- This style is similar in simplicity to the
'Plain' style but level2 sections start on a new page.
- With original page numbers
- This style is
similar in simplicity to the 'Plain' style but page numbers
of the original document are displayed.
- Scientific
- This is a more fancy page style that
contains the section title and the page number in the
header. Page numbers of the original are shown and the
sections are numbered. It corresponds to the standard LaTeX
book style.
- Alignment
- Optional. The alignment to use for standard
text. Normally text is normally best read if it is justified.
However under some circumstances text can be easier read if it
is left aligned. It will also have less hyphenated words.
- Default language
- Optional. The language to use for the babel
package if no xml:lang tag specifies it. For all valid values
check the babel documentation
(http://www.ctan.org/get/macros/latex/required/babel/babel.pdf).
- Stock size
- Optional. The large print book presumably
will be printed out. The stock size is the size of the paper on
which the book will be printed. Usually this paper will be
trimmed to the paper size of the actual book. This option lets
you define the stock size. You can either choose standard sizes such as A4
or letter.
- Paper size
- Optional. The paper size of the resulting
book can match the stock size, i.e. the size of the paper the
large print book is printed on. But it doesn't have to. If you
would like to have a different paper size you can define it
using the following parameters:
- Paper Width
- Optional.Width of the paper
- Paper Height
- Optional.Height of the paper
- Left Margin
- Optional.Inner margin of the paper
- Right Margin
- Optional.Outer margin of the paper
- Top Margin
- Optional.Top margin of the page
- Bottom Margin
- Optional.Bottom margin of the page
- Line spacing
- Optional. The line spacing to be used for the generated LaTeX.
- Footnote style
- Optional. Notes can be rendered in different ways. By default the are rendered as footnotes, i.e. on the same page. Alternatively you
can place them at the end of the document or at the end of each chapter (i.e. level1). You can pick between the following options:
- Plain Footnotes
- Optional (Default).Place the notes at the bottom of the page as footnotes.
- Document Endnotes
- Optional.Place the notes in a separate chapter at the end of the book, i.e. after rearmatter.
- Chapter Endnotes
- Optional.Place the notes at the end of the chapter (level1) in a separate "Endnote" section (level2).
- Image visibility
- Optional. Images are shown by default, but
for some use cases you might want to ignore them. Use either of
the following options:
- Show images
- Optional (Default). Show all images
- Ignore images
- Optional. Do not show any images.
- XML Validation Report
- Optional. Path to a file to store a validation XML report in.
Appendix: List of Transformers used
The documents linked below are parts of the Transformer technical documentation. These are developer and systems-administrator centric documents.