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        --javascript=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        --unicodemath           adds TeX annotation to parallel markup
94        --nounicodemath         disables the above (default)
95        --plane1                use plane-1 unicode for symbols
96                                (default, if needed)
97        --noplane1              do not use plane-1 unicode
98        --graphicimages         converts graphics to images (default)
99        --nographicimages       disables the above
100        --graphicsmap=type.type specifies a graphics file mapping
101        --pictureimages         converts picture environments to
102                                images (default)
103        --nopictureimages       disables the above
104        --svg                   converts picture environments to SVG
105        --nosvg                 disables the above (default)
106
107       If xmlfile is '-', latexmlpost reads the XML from standard input.
108

OPTIONS AND ARGUMENTS

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

SEE ALSO

424       latexml, latexmlmath, LaTeXML
425
426
427
428perl v5.38.0                      2023-07-19                    LATEXMLPOST(1)
Impressum