This software is OSI Certified Open Source Software. OSI Certified is a certification mark of the Open Source Initiative.
The license (Mozilla version 1.0) can be read at the MMBase site. See http://www.mmbase.org/license
Abstract
Functional reference for [project description (optional)]
Table of Contents
[Place here an introduction text. This should simply outlay the purpose and content of this document.]
[Place here a (functional) description of the object model. If your project does not include an objectcloud, remove this section.]
[Place here a description of elementary techniques used in this project. This may also refer to external documents. Skip this section if there are no special techniques that need explanation.]
[Place here a text describing the objects and relations of interest to this project. Each seperate object can be described in more detail in seperate sections. Skip this section if the project does not use an object cloud.]
[Place here a text describing the object and its purpose.]
Fields:
[field name], [field guitype]([field MMBase type]), [unique|key].
[Description of the field. You need not list fields if they are not of import to the project. Do not list standard fields number, otype, owner, snumber, dnumber, rnumber, or dir. Note that this will often replicate the description from the builder xml.]
[Place here a text describing the (essential) web pages in this project and how to call them from outside the project. You should only include pages that other users are likely to call from other pages. Each page can be detailed in a separate section. Pages should be listed relative to a root web directory (which you should specify here).]
Place here a text describing the tags in the main xml formats of this project. Each seperate tag can be described in more detail in seperate sections. Skip this section if the project does not uses xml, otehr than for configuration (whcih goes in teh installation document). If you have separate xml formats, duplicate this section for each format and label them accordingly (do not forget to rename the section id).]
Syntax.
[tag syntax]
Usage. [Short description of how to use the tag]
[Additional descriptions. Use programlisting tags to list examples of usage]
Required Attributes.
[attribute description]
Optional Attributes.
[attribute description]
Required Child Nodes.
[attribute description]
Optional Child Nodes.
[attribute description]
Possible Parents.
[attribute description]
Example.
[example tag code]
This is part of the MMBase documentation.
For questions and remarks about this documentation mail to: documentation@mmbase.org