Feed The Beast Wiki
Feed The Beast Wiki

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

  • Reformat existing documentation and document templates missing documentation.
 
100% (223/223)
100% (223/223)
  • Clean up existing template code.
 
100% (226/226)
100% (226/226)


Scope

Guideline

Please copy and paste the following code to the top of the template code you're working on.

  • Cleaning code (In progress)
<noinclude>{{Project:Template_documentation_project/Status|code|<Username here>}}</noinclude>
  • Cleaning code (Done)
<noinclude>{{Project:Template_documentation_project/Status|codedone|<Username here>}}</noinclude>
  • Documenting template (In progress)
<noinclude>{{Project:Template_documentation_project/Status|doc|<Username here>}}</noinclude>
  • Documenting template (Done)
<noinclude>{{Project:Template_documentation_project/Status|docdone|<Username here>}}</noinclude>

Reports

Undocumented templates

Feed The Beast wiki:Template documentation project/Reports/Undocumented

Uncleaned code

Feed The Beast wiki:Template documentation project/Reports/Uncleaned

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:

* '''<Parameter name>''': ''(Optional or Default:<value>)'' <Description>

which produces:

  • <Parameter name>: (Optional or Default:<value>) <Description>

Please omit the optional and default section if the parameter is required, only one of "Optional" and "Default:<value>" should exist, since if a default value is set, the parameter is optional.

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:

Format 1

Code
<Description>
<pre><Code></pre>
produces:
<Template call>
Result

<Description>

<Code>

produces: <Template call>

Notes
  • A line break can be added after the "produces:" if desired.

Format 2

Code
{| class="wikitable"
! Code !! Result
|-
| <Code> || <Result>
|}
Result
Code Result
<Code> <Result>
Notes
  • Additional formatting, rows, and column can be added if desired.

Related templates

The last part of the documentation should include a list of related templates and a brief description of them. This part should be split into two sections, sub-templates or child-templates in a section named "Sub-templates", templates with similar purpose in a section named "See also". Closely related templates could share the same documentation of other templates by using:

{{Documentation|<Template name>}}

Template categories

Include categories in the template documentation with Template:TC, add the code: {{TC|<Category name>}} 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.

Open Tasks