Chapter 4. The Scilab subset of DocBook 5
Prev |  | Next

## Chapter 4. The Scilab subset of DocBook 5

The documentation of Scilab must be written using the strict subset of DocBook 5 defined in `doc_kit/schema/scilab.rnc`. DocBook 5 elements are fully documented in "DocBook 5.0: The Definitive Guide", therefore there is not much to add here.

### Important

The root element of a document which conforms to the Scilab DocBook 5 subset must have `version` attribute set to "`5.0-subset Scilab`". Example:

    <?xml version="1.0" encoding="UTF-8" ?>
    <refentry version="5.0-subset Scilab"
              xmlns="http://docbook.org/ns/docbook"
              ...

The subset comprises the following elements:

- `book` and its divisions:

  - `part`, `partintro`

  - `reference`

  - `chapter`, `section`

  - `appendix`

- Meta-info elements: `info`, `title`, `author`, `personname`, `affiliation`, `jobtitle`, `orgname`, `pubdate`, `keywordset`, `keyword`.

- `refentry` (the DocBook equivalent of a man page) and its divisions: `refnamediv`, `refname`, `refpurpose`, `refsynopsisdiv`, `synopsis`, `refsection`.

- Displayed elements:

  - `figure`, `mediaobject`, `imageobject`, `imagedata` (having either a `fileref` attribute or embedding MathML or SVG)

  - `example`

  - `note`

  - `equation`, `informalequation`

  - `table` (HTML tables only, that is, not CALS tables), `caption`, `informaltable`, `col`, `colgroup`, `tbody`, `thead`, `tfoot`, `tr`, `td`, `th`

- Other block-level elements:

  - `itemizedlist`, `orderedlist`, `listitem`

  - `variablelist`, `varlistentry`, `term`

  - `simplelist`, `member`

  - `para`

  - `programlisting`

- Inline-level elements:

  - `emphasis`, `literal`

  - `phrase`, `replaceable`,

  - `subscript`, `superscript`

  - `link`

  - `indexterm`, `primary`

  - `inlinemediaobject`

  - `inlineequation`

Prev |  | Next
Chapter 3. Contents of the distribution | Home | Chapter 5. The command-line tools