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