1LATEXMLPOST(1)        User Contributed Perl Documentation       LATEXMLPOST(1)
2
3
4

NAME

6       "latexmlpost" - postprocesses an xml file generated by "latexml" to
7       perform common tasks, such as convert math to images and processing
8       graphics inclusions for the web.
9

SYNOPSIS

11       latexmlpost [options] xmlfile
12
13        Options:
14        --verbose               shows progress during processing.
15        --VERSION               show version number.
16        --help                  shows help message.
17        --sourcedirectory=sourcedir sets directory of the original
18                                source TeX file.
19        --validate, --novalidate Enables (the default) or disables
20                                validation of the source xml.
21        --format=html|html5|html4|xhtml|xml requests the output format.
22                                (html defaults to html5)
23        --destination=file      sets output file (and directory).
24        --omitdoctype           omits the Doctype declaration,
25        --noomitdoctype         disables the omission (the default)
26        --numbersections        enables (the default) the inclusion of
27                                section numbers in titles, crossrefs.
28        --nonumbersections      disables the above
29        --stylesheet=xslfile    requests the XSL transform using the
30                                given xslfile as stylesheet.
31        --css=cssfile           adds css stylesheet to (x)html(5)
32                                (can be repeated)
33        --nodefaultresources    disables processing built-in resources
34        --javscript=jsfile      adds a link to a javascript file into
35                                html4/html5/xhtml (can be repeated)
36        --xsltparameter=name:value passes parameters to the XSLT.
37        --split                 requests splitting each document
38        --nosplit               disables the above (default)
39        --splitat               sets level to split the document
40        --splitpath=xpath       sets xpath expression to use for
41                                splitting (default splits at
42                                sections, if splitting is enabled)
43        --splitnaming=(id|idrelative|label|labelrelative) specifies
44                                how to name split files (idrelative).
45        --scan                  scans documents to extract ids,
46                                labels, etc.
47                                section titles, etc. (default)
48        --noscan                disables the above
49        --crossref              fills in crossreferences (default)
50        --nocrossref            disables the above
51        --urlstyle=(server|negotiated|file) format to use for urls
52                                (default server).
53        --navigationtoc=(context|none) generates a table of contents
54                                in navigation bar
55        --index                 requests creating an index (default)
56        --noindex               disables the above
57        --splitindex            Splits index into pages per initial.
58        --nosplitindex          disables the above (default)
59        --permutedindex         permutes index phrases in the index
60        --nopermutedindex       disables the above (default)
61        --bibliography=file     sets a bibliography file
62        --splitbibliography     splits the bibliography into pages per
63                                initial.
64        --nosplitbibliography   disables the above (default)
65        --prescan               carries out only the split (if
66                                enabled) and scan, storing
67                                cross-referencing data in dbfile
68                                (default is complete processing)
69        --dbfile=dbfile         sets file to store crossreferences
70        --sitedirectory=dir     sets the base directory of the site
71        --mathimages            converts math to images
72                                (default for html4 format)
73        --nomathimages          disables the above
74        --mathsvg               converts math to svg images
75        --nomathsvg             disables the above
76        --mathimagemagnification=mag sets magnification factor
77        --presentationmathml    converts math to Presentation MathML
78                                (default for xhtml & html5 formats)
79        --pmml                  alias for --presentationmathml
80        --nopresentationmathml  disables the above
81        --linelength=n          formats presentation mathml to a
82                                linelength max of n characters
83        --contentmathml         converts math to Content MathML
84        --nocontentmathml       disables the above (default)
85        --cmml                  alias for --contentmathml
86        --openmath              converts math to OpenMath
87        --noopenmath            disables the above (default)
88        --om                    alias for --openmath
89        --keepXMath             preserves the intermediate XMath
90                                representation (default is to remove)
91        --mathtex               adds TeX annotation to parallel markup
92        --nomathtex             disables the above (default)
93        --plane1                use plane-1 unicode for symbols
94                                (default, if needed)
95        --noplane1              do not use plane-1 unicode
96        --graphicimages         converts graphics to images (default)
97        --nographicimages       disables the above
98        --graphicsmap=type.type specifies a graphics file mapping
99        --pictureimages         converts picture environments to
100                                images (default)
101        --nopictureimages       disables the above
102        --svg                   converts picture environments to SVG
103        --nosvg                 disables the above (default)
104
105       If xmlfile is '-', latexmlpost reads the XML from standard input.
106

OPTIONS AND ARGUMENTS

108   General Options
109       "--verbose"
110           Requests informative output as processing proceeds. Can be repeated
111           to increase the amount of information.
112
113       "--VERSION"
114           Shows the version number of the LaTeXML package..
115
116       "--help"
117           Shows this help message.
118
119   Source Options
120       "--sourcedirectory"=source
121           Specifies the directory where the original latex source is located.
122           Unless latexmlpost is run from that directory, or it can be
123           determined from the xml filename, it may be necessary to specify
124           this option in order to find graphics and style files.
125
126       "--validate", "--novalidate"
127           Enables (or disables) the validation of the source XML document
128           (the default).
129
130   Format Options
131       "--format"="(html|html5|html4|xhtml|xml)"
132           Specifies the output format for post processing.  By default, it
133           will be guessed from the file extension of the destination (if
134           given), with html implying "html5", xhtml implying "xhtml" and the
135           default being "xml", which you probably don't want.
136
137           The "html5" format converts the material to html5 form with
138           mathematics as MathML; "html5" supports SVG.  "html4" format
139           converts the material to the earlier html form, version 4, and the
140           mathematics to png images.  "xhtml" format converts to xhtml and
141           uses presentation MathML (after attempting to parse the
142           mathematics) for representing the math.  "html5" similarly converts
143           math to presentation MathML. In these cases, any graphics will be
144           converted to web-friendly formats and/or copied to the destination
145           directory. If you simply specify "html", it will treat that as
146           "html5".
147
148           For the default, "xml", the output is left in LaTeXML's internal
149           xml, although the math can be converted by enabling one of the math
150           postprocessors, such as --pmml to obtain presentation MathML.  For
151           html, html5 and xhtml, a default stylesheet is provided, but see
152           the "--stylesheet" option.
153
154       "--destination="destination
155           Specifies the destination file and directory.  The directory is
156           needed for mathimages, mathsvg and graphics processing.
157
158       "--omitdoctype", "--noomitdoctype"
159           Omits (or includes) the document type declaration.  The default is
160           to include it if the document model was based on a DTD.
161
162       "--numbersections", "--nonumbersections"
163           Includes (default), or disables the inclusion of section, equation,
164           etc, numbers in the formatted document and crossreference links.
165
166       "--stylesheet"=xslfile
167           Requests the XSL transformation of the document using the given
168           xslfile as stylesheet.  If the stylesheet is omitted, a `standard'
169           one appropriate for the format (html4, html5 or xhtml) will be
170           used.
171
172       "--css"=cssfile
173           Adds cssfile as a css stylesheet to be used in the transformed
174           html/html5/xhtml.  Multiple stylesheets can be used; they are
175           included in the html in the order given, following the default
176           "ltx-LaTeXML.css".  The stylesheet is copied to the destination
177           directory, unless it is an absolute url.
178
179           Some stylesheets included in the distribution are
180             --css=navbar-left   Puts a navigation bar on the left.
181                                 (default omits navbar)
182             --css=navbar-right  Puts a navigation bar on the left.
183             --css=theme-blue    A blue coloring theme for headings.
184             --css=amsart        A style suitable for journal articles.
185
186       "--javascript"=jsfile
187           Includes a link to the javascript file jsfile, to be used in the
188           transformed html/html5/xhtml.  Multiple javascript files can be
189           included; they are linked in the html in the order given.  The
190           javascript file is copied to the destination directory, unless it
191           is an absolute url.
192
193       "--icon"=iconfile
194           Copies iconfile to the destination directory and sets up the
195           linkage in the transformed html/html5/xhtml to use that as the
196           "favicon".
197
198       "--nodefaultresources"
199           Disables the copying and inclusion of resources added by the
200           binding files; This includes CSS, javascript or other files.  This
201           does not affect resources explicitly requested by the "--css" or
202           "--javascript" options.
203
204       "--timestamp"=timestamp
205           Provides a timestamp (typically a time and date) to be embedded in
206           the comments by the stock XSLT stylesheets.  If you don't supply a
207           timestamp, the current time and date will be used.  (You can use
208           "--timestamp=0" to omit the timestamp).
209
210       "--xsltparameter"=name:value
211           Passes parameters to the XSLT stylesheet.  See the manual or the
212           stylesheet itself for available parameters.
213
214   Site & Crossreferencing Options
215       "--split", "--nosplit"
216           Enables or disables (default) the splitting of documents into
217           multiple `pages'.  If enabled, the the document will be split into
218           sections, bibliography, index and appendices (if any) by default,
219           unless "--splitpath" is specified.
220
221       "--splitat="unit
222           Specifies what level of the document to split at. Should be one of
223           "chapter", "section" (the default), "subsection" or
224           "subsubsection".  For more control, see "--splitpath".
225
226       "--splitpath="xpath
227           Specifies an XPath expression to select nodes that will generate
228           separate pages. The default splitpath is
229             //ltx:section | //ltx:bibliography | //ltx:appendix | //ltx:index
230
231           Specifying
232
233             --splitpath="//ltx:section | //ltx:subsection
234                    | //ltx:bibliography | //ltx:appendix | //ltx:index"
235
236           would split the document at subsections as well as sections.
237
238       "--splitnaming"="(id|idrelative|label|labelrelative)"
239           Specifies how to name the files for subdocuments created by
240           splitting.  The values "id" and "label" simply use the id or label
241           of the subdocument's root node for it's filename.  "idrelative" and
242           "labelrelative" use the portion of the id or label that follows the
243           parent document's id or label. Furthermore, to impose structure and
244           uniqueness, if a split document has children that are also split,
245           that document (and it's children) will be in a separate
246           subdirectory with the name index.
247
248       "--scan", "--noscan"
249           Enables (default) or disables the scanning of documents for ids,
250           labels, references, indexmarks, etc, for use in filling in refs,
251           cites, index and so on.  It may be useful to disable when
252           generating documents not based on the LaTeXML doctype.
253
254       "--crossref", "--nocrossref"
255           Enables (default) or disables the filling in of references, hrefs,
256           etc based on a previous scan (either from "--scan", or "--dbfile")
257           It may be useful to disable when generating documents not based on
258           the LaTeXML doctype.
259
260       "--urlstyle"="(server|negotiated|file)"
261           This option determines the way that URLs within the documents are
262           formatted, depending on the way they are intended to be served.
263           The default, "server", eliminates unnecessary trailing
264           "index.html".  With "negotiated", the trailing file extension
265           (typically "html" or "xhtml") are eliminated.  The scheme "file"
266           preserves complete (but relative) urls so that the site can be
267           browsed as files without any server.
268
269       "--navigationtoc"="(context|none)"
270           Generates a table of contents in the navigation bar; default is
271           "none".  The `context' style of TOC, is somewhat verbose and
272           reveals more detail near the current page; it is most suitable for
273           navigation bars placed on the left or right.  Other styles of TOC
274           should be developed and added here, such as a short form.
275
276       "--index", "--noindex"
277           Enables (default) or disables the generation of an index from
278           indexmarks embedded within the document.  Enabling this has no
279           effect unless there is an index element in the document (generated
280           by \printindex).
281
282       "--splitindex", "--nosplitindex"
283           Enables or disables (default) the splitting of generated indexes
284           into separate pages per initial letter.
285
286       "--bibliography="pathname
287           Specifies a bibliography generated from a BibTeX file to be used to
288           fill in a bibliography element.  Hand-written bibliographies placed
289           in a "thebibliography" environment do not need this.  The option
290           has no effect unless there is an bibliography element in the
291           document (generated by \bibliography).
292
293           Note that this option provides the bibliography to be used to fill
294           in the bibliography element (generated by "\bibliography");
295           latexmlpost does not (currently) directly process and format such a
296           bibliography.
297
298       "--splitbibliography", "--nosplitbibliography"
299           Enables or disables (default) the splitting of generated
300           bibliographies into separate pages per initial letter.
301
302       "--prescan"
303           By default "latexmlpost" processes a single document into one (or
304           more; see "--split") destination files in a single pass.  When
305           generating a complicated site consisting of several documents it
306           may be advantageous to first scan through the documents to extract
307           and store (in "dbfile") cross-referencing data (such as ids,
308           titles, urls, and so on).  A later pass then has complete
309           information allowing all documents to reference each other, and
310           also constructs an index and bibliography that reflects the entire
311           document set.  The same effect (though less efficient) can be
312           achieved by running "latexmlpost" twice, provided a "dbfile" is
313           specified.
314
315       "--dbfile"=file
316           Specifies a filename to use for the crossreferencing data when
317           using two-pass processing.  This file may reside in the
318           intermediate destination directory.
319
320       "--sitedirectory="dir
321           Specifies the base directory of the overall web site.  Pathnames in
322           the database are stored in a form relative to this directory to
323           make it more portable.
324
325   Math Options
326       These options specify how math should be converted into other formats.
327       Multiple formats can be requested; how they will be combined depends on
328       the format and other options.
329
330       "--mathimages", "--nomathimages"
331           Requests or disables the conversion of math to images (png by
332           default).  Conversion is the default for html4 format.
333
334       "--mathsvg", "--nomathsvg"
335           Requests or disables the conversion of math to svg images.
336
337       "--mathimagemagnification="factor
338           Specifies the magnification used for math images (both png and
339           svg), if they are made. Default is 1.75.
340
341       "--presentationmathml", "--nopresentationmathml"
342           Requests or disables conversion of math to Presentation MathML.
343           Conversion is the default for xhtml and html5 formats.
344
345       "--linelength"=number
346           (Experimental) Line-breaks the generated Presentation MathML so
347           that it is no longer than number `characters'.
348
349       "--plane1"
350           Converts the content of Presentation MathML token elements to the
351           appropriate Unicode Plane-1 codepoints according to the selected
352           font, when applicable (the default).
353
354       "--hackplane1"
355           Converts the content of Presentation MathML token elements to the
356           appropriate Unicode Plane-1 codepoints according to the selected
357           font, but only for the mathvariants double-struck, fraktur and
358           script.  This gives support for current (as of August 2009)
359           versions of Firefox and MathPlayer, provided a sufficient set of
360           fonts is available (eg. STIX).
361
362       "--contentmathml", "--nocontentmathml"
363           Requests or disables conversion of math to Content MathML.
364           Conversion is disabled by default.  Note that this conversion is
365           only partially implemented.
366
367       "--openmath"
368           Requests or disables conversion of math to OpenMath.  Conversion is
369           disabled by default.  Note that this conversion is only partially
370           implemented.
371
372       "--keepXMath"
373           By default, when any of the MathML or OpenMath conversions are
374           used, the intermediate math representation will be removed; this
375           option preserves it; it will be used as secondary parallel markup,
376           when it follows the options for other math representations.
377
378   Graphics Options
379       "--graphicimages", "--nographicimages"
380           Enables (default) or disables the conversion of graphics to web-
381           appropriate format (png).
382
383       "--graphicsmap="sourcetype.desttype
384           Specifies a mapping of graphics file types. Typically, graphics
385           elements specify a graphics file that will be converted to a more
386           appropriate file target format; for example, postscript files used
387           for graphics with LaTeX will be converted to png format for use on
388           the web.  As with LaTeX, when a graphics file is specified without
389           a file type, the system will search for the most appropriate target
390           type file.
391
392           When this option is used, it overrides and replaces the defaults
393           and provides a mapping of sourcetype to desttype.  The option can
394           be repeated to provide several mappings, with the earlier formats
395           preferred.  If the desttype is omitted, it specifies copying files
396           of type sourcetype, unchanged.
397
398           The default settings is equivalent to having supplied the options:
399
400             --graphicsmap=svg
401             --graphicsmap=png
402             --graphicsmap=gif
403             --graphicsmap=jpg
404             --graphicsmap=jpeg
405             --graphicsmap=eps.png
406             --graphicsmap=ps.png
407             --graphicsmap=ai.png
408             --graphicsmap=pdf.png
409
410           The first formats are preferred and used unchanged, while the
411           latter ones are converted to png.
412
413       "--pictureimages", "--nopictureimages"
414           Enables (default) or disables the conversion of picture
415           environments and pstricks material into images.
416
417       "--svg", "--nosvg"
418           Enables or disables (default) the conversion of picture
419           environments and pstricks material to SVG.
420

SEE ALSO

422       latexml, latexmlmath, LaTeXML
423
424
425
426perl v5.34.0                      2022-01-19                    LATEXMLPOST(1)
Impressum