+ Foundry comes with a documentation system which creates the reference documentations + for template tags and helper functions on the fly. The documentation system – + which you using at the moment by the way – consists of three parts: +
+index.jsp file in the doc directory which invokes the
+ XSL transformer. Using an JSP here has the advantage that the behaviour is similar
+ to an index.html.
+
+ The general structure of the documentation is defined by the
+ doc/foundry-documentation.xml file. This file is the entry point for the
+ XSL processor. The chapters of the documentation are defined by the
+ foundry:doc-chapter elements. The sections of the chapters are defined using
+ foundry:doc-section elements. The section which use static texts have
+ a static. The value of the static attribute is the name of the
+ file to include from the doc/static-texts directory. These files are normal
+ HTML files in XML syntax. They must have a main element. Only the content
+ of the main element is included into the documentation.
+
+ Sections which are generated on the fly from the XSL files of Foundry have a
+ generate attribute. The generate attribute controls which
+ documentations appear in the section.
+
+ Templates, functions and global variables are documented using the
+ foundry:doc element which is placed in the XSL directly before the element
+ to document. The foundry:doc element has two mandatory attributes. The
+ section elements is used to control in which section the documentation
+ appears. The second attribute is the type attribute. This attribute is
+ used to format the documentation. The possible values are:
+
template-tagenv-varxsl:variable or xsl:param defines
+ a global variable.
+ functionxsl:function is a helper function which can be used
+ in the implementation of template tags.
+ function-templatexsl:template is a helper template.
+
+ A foundry:doc element can have to following child elements:
+
foundry:doc-descp, even it is only a single paragraph.
+ Otherwise the text is not copied into the documentation. Look at one of the
+ XSL files of Foundry for an example.
+ foundry:doc-attributesfoundry:doc-attribute
+ elements. The foundry:doc-attribute has a mandatory attribute
+ name which contains the name of the attribute. The documentation of
+ the attribute must be enclosed in HTML elements. Look at one of the
+ XSL files of Foundry for an example.
+ foundry:doc-parametersfoundry:doc-parameter
+ elements. The foundry:doc-parameter has a mandatory parameter
+ name which contains the name of the parameter. The documentation of
+ the parameter must be enclosed in HTML elements. Look at one of the
+ XSL files of Foundry for an example.
+ foundry:doc-see-alsofoundry:doc-link attributes. Each
+ foundry:doc-link has a href attribute which the link.
+ The description of the link is the content of the element.
+