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