MuliFex

Description

Creates a tools overview XML file from a set of tool directories and tool descriptions.

The tools overview XML file may then conveniently be processed by a set of stylesheets to build the overall tool documentation.

Tool Directories

The layout of a tool directory is as follows:

tooldir/                The tool group directory.
tooldir/tools.xml       Tool group overview file.
tooldir/atool/          Directory containing "atool".
tooldir/atool/tool.xml  Description of the tool "atool".
tooldir/btool/          Directory of tool "btool".
tooldir/btool/tool.xml  Description of the "btool".

Each directory, esp. the tool directories may contain additional files. These are ignored.

Tool Group Overview File

The tool group overview file has the following XML content:

<tools>
  <title>Title of the Tool Group</title>
  <type>ToolGroupType</type>
  <overview>
    <!-- HTML markup to be included in the documentation overview section. -->
    <p>This tool group does this.</p>
    <p>More tags allowed here.</p>
  </overview>
  <details>
    <!-- HTML markup to be included in the documentation details section. -->
    <p>The following sections show details about the tools.</p>
  </details>
</tools>

Tool Description Files

The tool description files have the following XML content:

<tool>
  <name>ctool</name>
  <version>N/A</version>
  <homepage>N/A</homepage>
  <license>N/A</license>
  <description>
    <!-- HTML markup to be included in the documentation of the tool. -->
    <p>This tool does this and that.</p>
  </description>
  <requires>
    <tool>atool</tool>
    <tool>btool</tool>
  </requires>
</tool>

If the tool is part of the project (i.e. the version, hompage and license are project specific), simply use the following:

<version>N/A</version>
<homepage>N/A</homepage>
<license>N/A</license>

Parameters

This task supports the following parameters.

Nested Elements

This task supports the following nested elements.

tooltype

Describes a group of tools belonging to the same type (e.g. build tools, runtime libraries, utilities).

Examples

<toollist force="false" toollist="tools.xml">
  <tooltype tooldir="tool/build" destination="buildtools.html"/>
  <tooltype tooldir="tool/lib" destination="libraries.html"/>
  <tooltype tooldir="tool/util" destination="utilities.html"/>
</toollist>