LATEXMLPOST(1p) User Contributed Perl Documentation LATEXMLPOST(1p)
NAME
"latexmlpost" - postprocesses an xml file generated by "latexml" to perform common tasks, such as convert math to images and processing
graphics inclusions for the web.
SYNOPSIS
latexmlpost [options] xmlfile
Options:
--verbose shows progress during processing.
--VERSION show version number.
--help shows help message.
--sourcedirectory=sourcedir specifies directory of the original
source TeX file.
--validate, --novalidate Enables (the default) or disables
validation of the source xml.
--format=html|xhtml|xml requests the output format.
--destination=file specifies output file (and directory).
--omitdoctype omits the Doctype declaration,
--noomitdoctype disables the omission (the default)
--numbersections enables (the default) the inclusion of
section numbers in titles and crossrefs.
--nonumbersections disables the above
--stylesheet=xslfile requests the XSL transform using the
given xslfile as stylesheet.
--css=cssfile adds a css stylesheet to html/xhtml
(can be repeated)
--nodefaultcss disables the default css stylesheet
--split requests splitting each document
--nosplit disables the above (default)
--splitat specifies level to split the document
--splitpath=xpath specifies xpath expression for splitting
(default is section-like, if splitting)
--splitnaming=(id|idrelative|label|labelrelative) specifies how
to name split files (def. idrelative).
--scan scans documents to extract ids, labels,
section titles, etc. (default)
--noscan disables the above
--crossref fills in crossreferences (default)
--nocrossref disables the above
--urlstyle=(server|negotiated|file) format to use for urls
(default server).
--index requests filling in the index (default)
--noindex disables the above
--splitindex Splits the index into pages per initial.
--nosplitindex disables the above (default)
--permutedindex permutes index phrases in the index
--nopermutedindex disables the above (default)
--bibliography=file specifies a bibliography file
--splitbibliography splits the bibliography into pages per
initial.
--nosplitbibliography disables the above (default)
--prescan carries out only the split (if enabled)
and scan, storing cross-referencing data
in dbfile
(default is complete processing)
--dbfile=dbfile specifies file to store crossreferences
--sitedirectory=dir specifies the base directory of the site
--mathimages converts math to images
(default for html format)
--nomathimages disables the above
--mathimagemagnification=mag specifies magnification factor
--presentationmathml converts math to Presentation MathML
(default for xhtml format)
--pmml alias for --presentationmathml
--nopresentationmathml disables the above
--linelength=n formats presentation mathml to a
linelength max of n characters
--contentmathml converts math to Content MathML
--nocontentmathml disables the above (default)
--cmml alias for --contentmathml
--openmath converts math to OpenMath
--noopenmath disables the above (default)
--om alias for --openmath
--parallelmath requests parallel math markup for MathML
(default when multiple math formats)
--noparallelmath disables the above
--keepXMath preserves the intermediate XMath
representation (default is to remove)
--graphicimages converts graphics to images (default)
--nographicimages disables the above
--pictureimages converts picture environments to
images (default)
--nopictureimages disables the above
--svg converts picture environments to SVG
--nosvg disables the above (default)
If xmlfile is '-', latexmlpost reads the XML from standard input.
OPTIONS AND ARGUMENTS
General Options
"--verbose"
Requests informative output as processing proceeds. Can be repeated to increase the amount of information.
"--VERSION"
Shows the version number of the LaTeXML package..
"--help"
Shows this help message.
Source Options
"--sourcedirectory"=source
Specifies the directory where the original latex source is located. Unless latexmlpost is run from that directory, or it can be
determined from the xml filename, it may be necessary to specify this option in order to find graphics and style files.
"--validate", "--novalidate"
Enables (or disables) the validation of the source XML document (the default).
Format Options
"--format"="(html|xhtml|xml)"
Specifies the output format for post processing. "html" format converts the material to html and the mathematics to png images.
"xhtml" format converts to xhtml and uses presentation MathML (after attempting to parse the mathematics) for representing the math.
In both cases, any graphics will be converted to web-friendly formats and/or copied to the destination directory. By default, "xml",
the output is left in LaTeXML's xml, but the math is parsed and converted to presentation MathML. For html and xhtml, a default
stylesheet is provided, but see the "--stylesheet" option.
"--destination="destination
Specifies the destination file and directory. The directory is needed for mathimages and graphics processing.
"--omitdoctype", "--noomitdoctype"
Omits (or includes) the document type declaration. The default is to include it if the document model was based on a DTD.
"--numbersections", "--nonumbersections"
Includes (default), or disables the inclusion of section, equation, etc, numbers in the formatted document and crossreference links.
"--stylesheet"=xslfile
Requests the XSL transformation of the document using the given xslfile as stylesheet. If the stylesheet is omitted, a `standard' one
appropriate for the format (html or xhtml) will be used.
"--css"=cssfile
Adds cssfile as a css stylesheet to be used in the transformed html/xhtml. Multiple stylesheets can be used; they are included in the
html in the order given, following the default "core.css" (but see "--nodefaultcss"). Some stylesheets included in the distribution are
--css=navbar-left Puts a navigation bar on the left.
(default omits navbar)
--css=navbar-right Puts a navigation bar on the left.
--css=theme-blue A blue coloring theme for headings.
--css=amsart A style suitable for journal articles.
"--nodefaultcss"
Disables the inclusion of the default "core.css" stylesheet.
Site & Crossreferencing Options
"--split", "--nosplit"
Enables or disables (default) the splitting of documents into multiple `pages'. If enabled, the the document will be split into
sections, bibliography, index and appendices (if any) by default, unless "--splitpath" is specified.
"--splitat="unit
Specifies what level of the document to split at. Should be one of "chapter", "section" (the default), "subsection" or "subsubsection".
For more control, see "--splitpath".
"--splitpath="xpath
Specifies an XPath expression to select nodes that will generate separate pages. The default splitpath is
//ltx:section | //ltx:bibliography | //ltx:appendix | //ltx:index
Specifying
--splitpath="//ltx:section | //ltx:subsection | //ltx:bibliography
| //ltx:appendix | //ltx:index"
would split the document at subsections as well as sections.
"--splitnaming"="(id|idrelative|label|labelrelative)"
Specifies how to name the files for subdocuments created by splitting. The values "id" and "label" simply use the id or label of the
subdocument's root node for it's filename. "idrelative" and "labelrelative" use the portion of the id or label that follows the parent
document's id or label. Furthermore, to impose structure and uniqueness, if a split document has children that are also split, that
document (and it's children) will be in a separate subdirectory with the name index.
"--scan", "--noscan"
Enables (default) or disables the scanning of documents for ids, labels, references, indexmarks, etc, for use in filling in refs,
cites, index and so on. It may be useful to disable when generating documents not based on the LaTeXML doctype.
"--crossref", "--nocrossref"
Enables (default) or disables the filling in of references, hrefs, etc based on a previous scan (either from "--scan", or "--dbfile")
It may be useful to disable when generating documents not based on the LaTeXML doctype.
"--urlstyle"="(server|negotiated|file)"
This option determines the way that URLs within the documents are formatted, depending on the way they are intended to be served. The
default, "server", eliminates unneccessary trailing "index.html". With "negotiated", the trailing file extension (typically "html" or
"xhtml") are eliminated. The scheme "file" preserves complete (but relative) urls so that the site can be browsed as files without any
server.
"--index", "--noindex"
Enables (default) or disables the generation of an index from indexmarks embedded within the document. Enabling this has no effect
unless there is an index element in the document (generated by printindex).
"--splitindex", "--nosplitindex"
Enables or disables (default) the splitting of generated indexes into separate pages per initial letter.
"--bibliography="pathname
Specifies a bibliography file generated from a BibTeX file and used to fill in a bibliography element. Hand-written bibliographies
placed in a "thebibliography" environment do not need this processing. Enabling this has no effect unless there is an bibliography
element in the document (generated by ibliography).
Note that this option provides the bibliography to be used to fill in the bibliography element (generated by "ibliography");
latexmlpost does not (currently) directly process and format such a bibliography.
"--splitbibliography", "--nosplitbibliography"
Enables or disables (default) the splitting of generated bibliographies into separate pages per initial letter.
"--prescan"
By default "latexmlpost" processes a single document into one (or more; see "--split") destination files in a single pass. When
generating a complicated site consisting of several documents it may be advantageous to first scan through the documents to extract and
store (in "dbfile") cross-referencing data (such as ids, titles, urls, and so on). A later pass then has complete information allowing
all documents to reference each other, and also constructs an index and bibliography that reflects the entire document set. The same
effect (though less efficient) can be achieved by running "latexmlpost" twice, provided a "dbfile" is specified.
"--dbfile"=file
Specifies a filename to use for the crossreferencing data when using two-pass processing. This file may reside in the intermediate
destination directory.
"--sitedirectory="dir
Specifies the base directory of the overall web site. Pathnames in the database are stored in a form relative to this directory to
make it more portable.
Math Options
These options specify how math should be converted into other formats. Multiple formats can be requested; how they will be combined
depends on the format and other options.
"--mathimages", "--nomathimages"
Requests or disables the conversion of math to images. Conversion is the default for html format.
"--mathimagemagnification="factor
Specifies the magnification used for math images, if they are made. Default is 1.75.
"--presentationmathml", "--nopresentationmathml"
Requests or disables conversion of math to Presentation MathML. Conversion is the default for xhtml format.
"--linelength"=number
(Experimental) Line-breaks the generated Presentation MathML so that it is no longer than number `characters'.
"--contentmathml", "--nocontentmathml"
Requests or disables conversion of math to Content MathML. Conversion is disabled by default. Note that this conversion is only
partially implemented.
"--openmath"
Requests or disables conversion of math to OpenMath. Conversion is disabled by default. Note that this conversion is only partially
implemented.
"--parallelmath", "--noparallelmath"
Requests or disables parallel math markup. Parallel markup is the default for xhtml formats when multiple math formats are requested.
This method uses the MathML "semantics" element with additional formats appearing as "annotation"'s. The first math format requested
must be either Presentation or Content MathML; additional formats may be MathML or OpenMath.
If this option is disabled and multiple formats are requested, the representations are simply stored as separate children of the "Math"
element.
"--keepXMath"
By default, when any of the MathML or OpenMath conversions are used, the intermediate math representation will be removed; this option
preserves it.
Graphics Options
"--graphicimages", "--nographicimages"
Enables (default) or disables the conversion of graphics to web-appropriate format (png).
"--pictureimages", "--nopictureimages"
Enables (default) or disables the conversion of picture environments and pstricks material into images.
"--svg", "--nosvg"
Enables or disables (default) the conversion of picture environments and pstricks material to SVG.
SEE ALSO
latexml, latexmlmath, LaTeXML
perl v5.10.1 2009-06-16 LATEXMLPOST(1p)