| about timian |
|---|
|
summary & news overview some samples license mailing-lists things to do bugs!! the author |
| get timian |
|---|
|
supported platforms download building binaries |
| documentation |
|---|
|
manpage change log XSLT report formats report specs Xalan extensions DTDs |
| styles |
|---|
|
overview writing gallery |
| analog |
|---|
|
summary XML explained DTD analog-data |
| i18n |
|---|
|
Overview locale languages ISO639-2 ISO3166 UTF-8 |
| feedback |
|---|
| tell me |
|
© 2003 Per Jessen, per@computer.org. Verbatim copying and distribution of this entire article is permitted in any medium, provided this notice is preserved. |
the Timian man page
Timian is essentially just a custom XSLT tranformer built on Xalan (and Xerces) from
the Apache Software Foundation.
Running Timian itself is straight forward. It accepts only a few command-line arguments; the more interesting and
complex part is in the format settings and the use of XSLT.
Running Timian
The general format for invoking Timian is:
The arguments are explained below.
help
Optional.
Display a help message.
v
Optional.
Specifies that the input XML document should be validated against the DTD specified in the document. For normal/regular use there is little reason, but it can be quite useful whenever you change the analog configuration - changing certain options may invalidate the XML document.
output
Optional.
Specifies an outputfile; defaults to stdout.
locale
Optional.
Specifies the locale to be used for the report. Default is generally en_GB, but may be changed when you configure Timian for a build.
A locale is of the form "language[_territory][@modifier]". The format is similar to that of the setlocale() C library call, except any specification of a codeset will be ignored. (Timian reports are always written using UTF-8). See section internationali[sz]ation.
spec
Optional.
Specifies the name of an XML document to be provided as the report specification. The value specified is passed straight to the XSLT code as a parameter.
xmldata
Required. Specifies the name of the XML document produced by analog. (at a later point Timian will also be able to read the XML data from stdin).
xsltfile
Required. Specifies the name of the file containing the XSLT code. (this is likely to change to become a keyword argument rather than a positional).
Example
To run timian with the following settings:
- analog XML document is "data540.xml",
- report format is "timian.xsl",
- we want American English as language and locale,
- report specification is "rd-jan.xml",
- and we just want the report written to stdout:
Personally I prefer putting analog and timian into the same makefile and just use Make to run the whole thing, but it would be just as easy to wrap everything in a few lines of Perl or shell-script.
| Last time this page was updated: Monday 9 June 2003 12:16 |
|