Programming guide to Unibase

9 : Creating modules

Definition of a module

<module [title="title"]	Title to the module.
[author="author"]	Orginal author of the module.
[revision="revision date"]	Last revision date.
[URL="URL"]	The URL to get more, recent, information about this module.
[maintainer="maintainer"]>	Current maintainer of the module.
... code ...
</module>

Within a module the documentation is also included. This has a few tags that can be used to layout it better.

Chapter

<chapter title="title">	Begin a new chapter.
... code ...
{<sub [title="title"]>	Begin a new sub-division.
... code ...}
</chapter>

The text in front of the first chapter is automatically placed in the first chapter the called 'preface'. The system also create a table of contence and links between the different chapters.

List

<list heading="heading">	Create a list.
{<item [name="name"]>	Heading to the list.
... text ... }	The different items in the list.
</list>

Syntax

< syntax heading="heading">	New syntax to describe in the documentation.
... code ...	The lines of code to describe.
< description>
... text ...	The lines of description placed after the code.
< /syntax>

In the tags of syntax should not be spaces. The spaces are now only there to let the documentation generator know that these are not 'real' tags.