compile-xhtml
The compile-xhtml subcommand parses and validates the given document, and then generates XHTML pages based on the content.
The -brand-bottom option specifies an XML file that will be appended to the body of each generated XHTML page. This effectively allows for custom footers on generated pages. Note that the XML file is parsed and the element is appended to the AST of each generated page. This guarantees that the output is well formed (although not necessarily valid) XHTML.
The -brand-top option specifies an XML file that will be prepended to the body of each generated XHTML page. This effectively allows for custom headers on generated pages. Note that the XML file is parsed and the element is prepended to the AST of each generated page. This guarantees that the output is well formed (although not necessarily valid) XHTML.
The -css-create-default option specifies that the default CSS files used by the kstructural should be written to the output directory. This option can be set to false if entirely custom CSS is to be used.
The -file option specifies the input file.
The -css-include-default option specifies that links to the default CSS files used by the kstructural should be generated in each XHTML page. This option can be set to false if entirely custom CSS is to be used.
The -output-dir option specifies the output directory.
The -pagination option specifies how the generated XHTML should be paginated. A value of single indicates that the output should be one large XHTML page. A value of multi indicates that a new page should be created for each document, part, and section.
The -render-toc-document option specifies whether or not a table of contents should be generated for the main document.
The -render-toc-section option specifies whether or not a table of contents should be generated at the start of each section.
The -render-toc-part option specifies whether or not a table of contents should be generated at the start of each part.
The -verbose option specifies the level of logging desired.
The command exits with code 0 if no errors occurred, and a positive exit code otherwise.
compile-latex
The compile-latex subcommand parses and validates the given document, and then generates LaTeX based on the content.
The -file option specifies the input file.
The -output-dir option specifies the output directory.
The -type-map option specifies a file that contains a set of mappings from terms to emphasis types. This is used to mark specific terms as being displayed in a monospaced font, in bold, or in italic. The file contains one line per term and has the following grammar:
For example, the following type map makes all text tagged with function monospaced, all text tagged with package bold, and all text tagged with term italic:
The -verbose option specifies the level of logging desired.
The command exits with code 0 if no errors occurred, and a positive exit code otherwise.
compile-plain
The compile-plain subcommand parses and validates the given document, and then generates plain text based on the content.
The -file option specifies the input file.
The -output-dir option specifies the output directory.
The -verbose option specifies the level of logging desired.
The command exits with code 0 if no errors occurred, and a positive exit code otherwise.