LATEXMLPOST(1p)

📦
version 0.8.8 · 6 versions
, in ubuntu resolute, ubuntu stonking

🦋 LATEXMLPOST(1p) — User Contributed Perl Documentation 💖

okay bestie, pull up a chair, because this is the glow-up page for latexmlpost. (yes, the manual name is literally "latexmlpost", quotes and all, she's quirky like that 💅)

✨ 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 (yes, the whole squad, no cuts, no skips 💖):

  • --verbose — shows progress during processing.
  • --VERSION — show version number.
  • --help — shows help message.
  • --sourcedirectory=sourcedir — sets directory of the original source TeX file.
  • --validate, --novalidate — Enables (the default) or disables validation of the source xml.
  • --format=html|html5|html4|xhtml|xml — requests the output format. (html defaults to html5)
  • --destination=file — sets 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, crossrefs.
  • --nonumbersections — disables the above
  • --stylesheet=xslfile — requests the XSL transform using the given xslfile as stylesheet.
  • --css=cssfile — adds css stylesheet to (x)html(5) (can be repeated)
  • --nodefaultresources — disables processing built-in resources
  • --javascript=jsfile — adds a link to a javascript file into html4/html5/xhtml (can be repeated)
  • --xsltparameter=name:value — passes parameters to the XSLT.
  • --split — requests splitting each document
  • --nosplit — disables the above (default)
  • --splitat — sets level to split the document
  • --splitpath=xpath — sets xpath expression to use for splitting (default splits at sections, if splitting is enabled)
  • --splitnaming=(id|idrelative|label|labelrelative) — specifies how to name split files (idrelative).
  • --scan — scans documents to extract ids, labels, etc. 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).
  • --navigationtoc=(context|none) — generates a table of contents in navigation bar
  • --index — requests creating an index (default)
  • --noindex — disables the above
  • --splitindex — Splits index into pages per initial.
  • --nosplitindex — disables the above (default)
  • --permutedindex — permutes index phrases in the index
  • --nopermutedindex — disables the above (default)
  • --bibliography=file — sets 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 — sets file to store crossreferences
  • --sitedirectory=dir — sets the base directory of the site
  • --mathimages — converts math to images (default for html4 format)
  • --nomathimages — disables the above
  • --mathsvg — converts math to svg images
  • --nomathsvg — disables the above
  • --mathimagemagnification=mag — sets magnification factor
  • --presentationmathml — converts math to Presentation MathML (default for xhtml & html5 formats)
  • --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
  • --keepXMath — preserves the intermediate XMath representation (default is to remove)
  • --mathtex — adds TeX annotation to parallel markup
  • --nomathtex — disables the above (default)
  • --unicodemath — adds TeX annotation to parallel markup
  • --nounicodemath — disables the above (default)
  • --plane1 — use plane-1 unicode for symbols (default, if needed)
  • --noplane1 — do not use plane-1 unicode
  • --graphicimages — converts graphics to images (default)
  • --nographicimages — disables the above
  • --graphicsmap=type.type — specifies a graphics file mapping
  • --pictureimages — converts picture environments to images (default)
  • --nopictureimages — disables the above
  • --svg — converts picture environments to SVG
  • --nosvg — disables the above (default)

okay and the little plot twist 🫶: if xmlfile is -, latexmlpost reads the XML from standard input. like, literally just pipes it in. iconic.

💅 OPTIONS AND ARGUMENTS 💅

🧚 General Options 🧚

  • --verbose — Requests informative output as processing proceeds. Can be repeated to increase the amount of information. (so like, spam it as many times as you want for maximum yapping 📢)
  • --VERSION — Shows the version number of the LaTeXML package.. (two periods, she's dramatic, we respect it 💀)
  • --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. (ngl if she can't find the source, the graphics and style files just ghost you 🙈)
  • --validate, --novalidate — Enables (or disables) the validation of the source XML document (the default).

🌈 Format Options 🌈

  • --format="(html|html5|html4|xhtml|xml)" — Specifies the output format for post processing. By default, it will be guessed from the file extension of the destination (if given), with html implying "html5", xhtml implying "xhtml" and the default being "xml", which you probably don't want.

So here's the tea on the formats ☕:

  • The "html5" format converts the material to html5 form with mathematics as MathML; "html5" supports SVG.
  • "html4" format converts the material to the earlier html form, version 4, 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.
  • "html5" similarly converts math to presentation MathML. In these cases, any graphics will be converted to web-friendly formats and/or copied to the destination directory.
  • If you simply specify "html", it will treat that as "html5".

For the default, "xml", the output is left in LaTeXML's internal xml, although the math can be converted by enabling one of the math postprocessors, such as --pmml to obtain presentation MathML. For html, html5 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, mathsvg and graphics processing. (she needs a whole place to put her little guys 🫶)
  • --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 (html4, html5 or xhtml) will be used.
  • --css=cssfile — Adds cssfile as a css stylesheet to be used in the transformed html/html5/xhtml. Multiple stylesheets can be used; they are included in the html in the order given, following the default "ltx-LaTeXML.css". The stylesheet is copied to the destination directory, unless it is an absolute url.

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.
(yes navbar-right really does say "left" in the source, bestie. we did not touch it. she said what she said 💀)
  • --javascript=jsfile — Includes a link to the javascript file jsfile, to be used in the transformed html/html5/xhtml. Multiple javascript files can be included; they are linked in the html in the order given. The javascript file is copied to the destination directory, unless it is an absolute url.
  • --icon=iconfile — Copies iconfile to the destination directory and sets up the linkage in the transformed html/html5/xhtml to use that as the "favicon". 🎀 (tiny little tab icon, so cute)
  • --nodefaultresources — Disables the copying and inclusion of resources added by the binding files; This includes CSS, javascript or other files. This does not affect resources explicitly requested by the "--css" or "--javascript" options.
  • --timestamp=timestamp — Provides a timestamp (typically a time and date) to be embedded in the comments by the stock XSLT stylesheets. If you don't supply a timestamp, the current time and date will be used. (You can use "--timestamp=0" to omit the timestamp).
  • --xsltparameter=name:value — Passes parameters to the XSLT stylesheet. See the manual or the stylesheet itself for available parameters.

👑 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. (yes, "the the", she's excited, let her live 😭)
  • --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".

part 1 of 2, bestie — hold on, there's more coming 💜

  • --splitpath=xpath — bestie, this is how you tell it which nodes get their own separate page. The default splitpath is:
//ltx:section | //ltx:bibliography | //ltx:appendix | //ltx:index

And if you wanted to split at subsections too, you'd hand it something like:

--splitpath="//ltx:section | //ltx:subsection
       | //ltx:bibliography | //ltx:appendix | //ltx:index"

now the doc gets chopped at subsections as well as sections. 💅

  • --splitnaming=(id|idrelative|label|labelrelative) — the ✨naming✨ aesthetic for the files of all those subdocuments created by splitting. id and label are the simple ones: they just take the id or label of the subdocument's root node and use it as the filename. idrelative and labelrelative are the glow-up versions: they use only the chunk of the id or label that comes after the parent document's id or label. And because we love structure + uniqueness, if a split document has children that are also split, that document (and its children) get tucked into their own separate subdirectory named index. 🎀
  • --scan, --noscan — turns the scanning of documents for ids, labels, references, indexmarks, etc. on (that's the default) or off. What's the scan even for? Filling in refs, cites, index and all that good stuff. Ngl it may be useful to disable this one when you're generating documents that aren't based on the LaTeXML doctype. 🌸
  • --crossref, --nocrossref — turns the filling-in of references, hrefs, etc. on (default) or off, based on a previous scan (either from --scan, or from --dbfile). Again: it may be useful to disable when generating documents not based on the LaTeXML doctype. 🦋
  • --urlstyle=(server|negotiated|file) — this one decides how URLs inside your documents get formatted, depending on how you're planning to serve them. The default, server, drops those unnecessary trailing index.html bits. With negotiated, the trailing file extension (usually html or xhtml) gets eliminated. And the scheme file preserves complete (but relative) urls so you can browse the whole site straight as files, no server needed. 💖
  • --navigationtoc=(context|none) — generates a table of contents in the navigation bar; default is none. The context style of TOC is kind of verbose and reveals more detail near the current page, so it's most suitable for navigation bars placed on the left or right. And, direct quote energy: other styles of TOC should be developed and added here, such as a short form. 👑
  • --index, --noindex — enables (default) or disables generating an index from the indexmarks embedded in the document. Heads up though: enabling this does literally nothing unless there's an index element in the document (the one generated by \printindex). 🫶
  • --splitindex, --nosplitindex — enables, or disables (default), the splitting of generated indexes into separate pages per initial letter. 🔤
  • --bibliography=pathname — hands over a bibliography generated from a BibTeX file, to be used to fill in a bibliography element. Hand-written bibliographies sitting in a "thebibliography" environment don't need this at all. And this option has no effect unless there's a bibliography element in the document (the one generated by \bibliography).

⚠️ Also note: this option provides the bibliography that gets used to fill in the bibliography element (generated by "\bibliography"); 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 — okay so by default latexmlpost processes a single document into one (or more — see --split) destination files in a single pass. But when you're generating a complicated site made of several documents, it may be advantageous to first scan through the documents to extract and store (in dbfile) cross-referencing data — ids, titles, urls, and so on. Then a later pass has complete info, letting all the documents reference each other, plus it constructs an index and bibliography that reflects the entire document set. The same effect (though less efficient, fr) can be achieved by running latexmlpost twice, as long as you specify a dbfile. ✨
  • --dbfile=file — specifies a filename to use for the crossreferencing data when you're doing 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 relative to this directory, which makes it way more portable. 🌈

🧮 Math Options 🧮

These options specify how math should be converted into other formats. Multiple formats can be requested — how they'll get combined depends on the format and the other options. 🔥

  • --mathimages, --nomathimages — requests or disables the conversion of math to images (png by default). Conversion is the default for html4 format. 🖼️
  • --mathsvg, --nomathsvg — requests or disables the conversion of math to svg images. ✨
  • --mathimagemagnification=factor — specifies the magnification used for math images (both png and svg), if they're made. Default is 1.75. 🔍
  • --presentationmathml, --nopresentationmathml — requests or disables conversion of math to Presentation MathML. Conversion is the default for xhtml and html5 formats. 💅
  • --linelength=number — (Experimental) line-breaks the generated Presentation MathML so it's no longer than number characters. 📏
  • --plane1 — converts the content of Presentation MathML token elements to the appropriate Unicode Plane-1 codepoints according to the selected font, when applicable (this is the default). 🛸
  • --hackplane1 — converts the content of Presentation MathML token elements to the appropriate Unicode Plane-1 codepoints according to the selected font, but only for the mathvariants double-struck, fraktur and script. This gives support for current (as of August 2009) versions of Firefox and MathPlayer, provided a sufficient set of fonts is available (eg. STIX). no cap, that date is really in there 😭
  • --contentmathml, --nocontentmathml — requests or disables conversion of math to Content MathML. Conversion is disabled by default. Note that this conversion is only partially implemented — so, lowkey, don't expect the full thing. 🙈
  • --openmath — requests or disables conversion of math to OpenMath. Conversion is disabled by default. Note that this conversion is only partially implemented. 💀
  • --keepXMath — by default, when any of the MathML or OpenMath conversions are used, that intermediate math representation gets removed. This option preserves it, and it'll be used as secondary parallel markup when it follows the options for the other math representations. 🫶

🎨 Graphics Options 🎨

  • --graphicimages, --nographicimages — enables (default) or disables the conversion of graphics to web-appropriate format (png). 🖼️
  • --graphicsmap=sourcetype.desttype — specifies a mapping of graphics file types. Typically, graphics elements specify a graphics file that'll be converted to a more appropriate file target format; for example, postscript files used for graphics with LaTeX get converted to png format for use on the web. Same as with LaTeX: when a graphics file is specified without a file type, the system searches for the most appropriate target type file. 🔍

When this option is used, it overrides and replaces the defaults, giving you a mapping of sourcetype to desttype. The option can be repeated to provide several mappings, with the earlier formats preferred. And if the desttype is omitted, it specifies copying files of type sourcetype, unchanged.

The default setting is equivalent to having supplied the options:

--graphicsmap=svg
--graphicsmap=png
--graphicsmap=gif
--graphicsmap=jpg
--graphicsmap=jpeg
--graphicsmap=eps.png
--graphicsmap=ps.png
--graphicsmap=ai.png
--graphicsmap=pdf.png

The first formats are preferred and used unchanged, while the latter ones get converted to 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

okay bestie that's the whole page, we ate and left no crumbs 🍓 this one's from perl v5.40.1 and it's dated 2025-11-16 — LATEXMLPOST(1p), iconic behavior, go forth and convert 💖👑

📦 where this page comes from