Feed The Beast Wiki:Template documentation project

Welcome to the Template documentation project.

Goals

 * Create a standard style and structure for template documentation.
 * Reformat existing documentation and document templates missing documentation.
 * Clean up existing template code for better editing.

Progress
[Purge&#93; * Reformat existing documentation and document templates missing documentation. * Clean up existing template code.

Scope

 * All existing templates.

Guideline
Please copy and paste the following code to the top of the template code you're working on. &lt;noinclude>&lt;/noinclude> &lt;noinclude>&lt;/noinclude> &lt;noinclude>&lt;/noinclude> &lt;noinclude>&lt;/noinclude>
 * Cleaning code (In progress)
 * Cleaning code (Done)
 * Documenting template (In progress)
 * Documenting template (Done)

Documentation format
Template documentation should generally include the following information in the order specified below:
 * The purpose of the template.
 * The parameters of the template.
 * Usage examples of the template.
 * Related templates.
 * Categories.

Documentation boilerplate
All documentation should start with Doc/start and should end with Doc/end.

Template purpose
The lead section of the template documentation should be a brief introduction purpose of the template, an accompanying "Usage" section to explain in detail of the purpose of the template, this section could also include how template works to assist editors that wish to edit the template, if should it goes too deep into detail of how it works, a sub-section should be used.

Template parameters
The second section of the template should be an unorded list of parameters and their default value, properties and description in the following format: * : (Optional or Default: )  which produces: Please omit the optional and default section if the parameter is required, only one of "Optional" and "Default: " should exist, since if a default value is set, the parameter is optional.
 * : (Optional or Default: ) 

Template examples
The following section should be examples of some general and common usage of the template, this section can be omitted if examples cannot be displayed. The examples could be in the following formats depending on the size or properties:

Code
 to the bottom of the documentation before the Doc/end.

Project Members
Please add your name to the list if you wish to participate in this project.
 * (Project leader)