Project | WXT | Basics | Download | Documentation | Samples
Documentation
Script
Definitions
Addressing
Author
Authors
Command
Formulas
Fragment
Fragments
Images
Logfile
ODTFormulas
Options
PathFragment
References
Template
Transformation
Module
*Dating
PDF-format

Script: option-element

The definition-element may contain options. These option influence the prefomance of WXT in different ways. 

<option name="" value="">
name(mandatory) Any string that identifies this option.
value(mandatory) A value matching the name.

Reckognized option names are:

expand-all Possible values: yes or no. no is default. If yes, all expansions (PI:expand and PI:expandsimple) will be done, regardless of the expanded parameter in the PIs, see Expand and ExpandSimple .
preformat-language Possible values: yes or no. no is default. By default Google's prettyprint is used for colorencoding of languages. If yes, WXT's internal colorcoding is used. This is less flexible but prepares material that is encoded independant of a webbrowser. Suited for PDF conversion. See Code Fragments .
indent-output Possible values: yes or no. no is default. If yes, you will get output which are easier to read, but may cause problems with further parsing.
default-encoding Default is utf-8. This encoding is used when there are no other way to decide encoding.
output-format Possible values are xml, text, html and xhtml.
html will produce modules in html5, that is without XML-header and doctype html.
xhtml will produce the same as xml, but without xml-header. The doctype will be copied from the source. This is typically xhtml-strict.
Default is html.
The detailed effect of the output option depends of course on the templates content.
reference-form Possible values are simple, ieee, harvard. Default is simple. Simple will produce a simple number, like [5], in the running text, and otherwise act as ieee.
reference-indexing Possible values are local and global. local will produce reference indices for each module. global will index references as encountered during the whole building. Default is local.
use-copy Possible values are yes , no and *. yes will import wiki and odt material from a local copy. no will access the material at the original source, produce a local copy and then fetch the result from this copy. Default is neutral: *.
This option will overrun the parameter usecopy in PIs, see ImportWIKI and ImportODF
drop-books You can use this to avoid building modules which are timeconsuming or should be left alone for other reasons. The value is a comma separated list of strings. The modules with matching books - attributes will be skipped when building. Space is not allowed in the string(list).
tidy-input If the parsing of XML input fails, WXT will attempt to tidy the source. You may turn this option off with value no. You may also use a file location as value. This file must containg attributes for the tidy-job.
Default value is yes.
Tidying is not without problems, and the tidyjob of WXT is neither waterproof nor complete. See module Tidy for more information.
verbose May be yes or no. no is default.
when yes WXT will produce more detailed output of errors and warnings in the build process.

Examples:

<option name="expand-all" value="yes"/>
<option name="default-encoding" value="ISO-8859-1"/>
<option name="indent-output" value="yes"/>
<option name="drop-books" value="topdf"/>