plasTeX 3.0 — A Python Framework for Processing LaTeX Documents: General Options

2.1.1 General Options

Configuration files

Command-Line Options: --config=config-file or -c config-file
Config File: [ general ] config
specifies a configuration file to load. This should be the first option specified on the command-line. Below is a sample configuration file:

[general]
renderer=HTML5
copy-theme-extras=yes

[document]
lang-terms=lang.xml

[files]
split-level=1

Kpsewhich: Command-Line Options: --kpsewhich=program
Config File: [ general ] kpsewhich
Default: kpsewhich
specifies the kpsewhich program to use to locate L^aT_eX files and packages.

Plugins: Command-Line Options: --plugins=plugins
Config File: [ general ] plugins
Default: []
specifies a list of plugins to be used. Each element should be package name that python can import. See Section 6.8 for more details.

Load L^aT_eXpackages: Command-Line Options: --load-tex-packages or --no-load-tex-packages
Config File: [ general ] load-tex-packages
Default: True
specifies whether to attempt loading L^aT_eXimplementations of packages when no python implementation exists.

L^aT_eXpackages white-list: Command-Line Options: --tex-packages=packages
Config File: [ general ] tex-packages
Default: []
specifies a list of packages whose L^aT_eXimplementation should be loaded if there is no python implementations, even if --no-load-tex-packages is set.

Renderer: Command-Line Options: --renderer=renderer-name
Config File: [ general ] renderer
Default: HTML5
specifies which renderer to use. This is either one of the built in renderers, a renderer defined by a plugin, or a path to the directory of a renderer. A plugin can provide a renderer my_renderer by having a Renderers submodule containing a my_renderer submodule exporting a Renderer class.

Packages directories: Command-Line Options: --packages-dir=directories
Config File: [ general ] packages-dirs
Default: []
specifies a list of directories where python implementations of packages should be searched.

Themes: Command-Line Options: --theme=theme-name
Config File: [ general ] theme
Default: default
specifies which theme to use.

Extra theme files: Command-Line Options: --copy-theme-extras or --ignore-theme-extras
Config File: [ general ] copy-theme-extras
Default: yes
indicates whether or not extra files that belong to a theme (if there are any) should be copied to the output directory.

Extra templates directories: Command-Line Options: --extra-templates=directories
Config File: [ general ] extra-templates
Default: []
specifies a list of directories where extra templates should be searched. Paths are relative to the current directory.

Dump XML output: Command-Line Options: --xml
Config File: [ general ] xml
Default: False
dumps a XML representation of the document (for debugging).

Debug parsing: Command-Line Options: --debug
Config File: [ general ] debug
Default: False
parses the document and drops into a debugger.