io7m
io7m-jstructural 2.0.0
4.1
jsc
4.1.1
Overview
1
The jsc tool transforms structural documents into XHTML 1.0 Strict.
2

    jsc: [options] --check        file
      or [options] --xhtml-single file outdir
      or [options] --xhtml-multi  file outdir
      or [options] --version

         --check                      Parse and validate all source files, but do not produce output
         --debug                      Enable debugging (debug messages, exception backtraces)
      -h,--help                       Show this help message
         --version                    Display version
         --xhtml-body-end <file>      Insert the given file into the resulting XHTML at the end of the document's body
         --xhtml-body-start <file>    Insert the given file into the resulting XHTML at the start of the document's body
         --xhtml-multi                Produce multiple XHTML files as output
         --xhtml-single               Produce a single XHTML file as output

3
When the --check argument is specified, the file file is parsed and validated according to the structural schema. XIncludes are understood by jsc and will be processed prior to validation.
4
When the --xhtml-single argument is specified, the given file is validated exactly as with --check, and then a single XHTML 1.0 Strict document is written to outdir/index.xhtml. The outdir directory is created iff it does not already exist.
5
When the --xhtml-multi argument is specified, the given file is validated exactly as with --check, and then a single XHTML 1.0 Strict document is written to outdir/index-m.xhtml, which represents the front page of the document, and a series of files are written to outdir/*.xhtml, representing the parts and sections of the document. The outdir directory is created iff it does not already exist.
6
When either --xhtml-multi or --xhtml-single are specified, the files outdir/jstructural-2.0.0-layout.css and outdir/jstructural-2.0.0-colour.css are created iff they do not already exist. These files contain CSS controlling the visual presentation of the XHTML.
7
The --xhtml-body-start option causes the contents of the given XML file to be inserted as the first child of the resulting XHTML body element on each page. It is the user's responsibility to ensure that the resulting document is valid XHTML 1.0 Strict.
8
The --xhtml-body-end option causes the contents of the given XML file to be inserted as the last child of the resulting XHTML body element on each page. It is the user's responsibility to ensure that the resulting document is valid XHTML 1.0 Strict.
4.1.2
Packaging
1
The jsc tool is packaged into the standalone io7m-jstructural-tools-2.0.0-jsc.jar file distributed with jstructural.