##### docsite

- Overview
- Description File
- Download

##### Project Documentation

- Project Information

## Description File Format

XML is used to describe the site generation process.

The root node of this description looks like this:

    <docsite xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="folder" title="Title of Root Folder">
      ...
    </docsite>

The name attribute specifies the name of the root folder, title is its display title.

The root node may contain a list of folders.

Each folder is described as follows:

    <folder name="foldername" title="Title of Folder">
      ...
    </folder>

Again, name is the folder directory name and title is displayed for it.

Folders may contain other folders, links, generated documents, or text in an arbitrary sequence.

A document looks like this:

    <doc name="docname" title="Title of Document">
      ...
    </doc>

name is the document file name, title its dispay title.

A link is specified as

    <link title="Title of Link" src="linksource"/>

title is displayed for the link.

If src is a local reference, not starting with a protocol (like http: ) or slash (or drive X: under Windows), a file with this name is copied from the corresponding path of the source tree to the target folder.

If src is an external link, it is directly used to refer to the target document. Nothing is copied.

Free text may be specified in folders and documents as

    <text>
       Some free text or CDATA section
    </text>

This text is copied to the target documents as is.

    <heading>
       Some free text or CDATA section
    </heading>

This text is copied to the target documents and marked as level 2 HTML heading.

A document may contain other documents, links, free text, or images.

An image is described by

    <img src="imgsource" title="Image Title" width="..." height="..."/>

If src is a local reference, not starting with a protocol (like http: ) or slash (or drive X: under Windows), a file with this name is copied from the corresponding path of the source tree to the target folder.

If src is an external link, it is directly used in the document to include the image. Nothing is copied.

title is an optional alternative title of the image.

The optional arguments width and height specify the display size of the image within the document.