Feed The Beast Wiki:Template guideline

From Feed The Beast Wiki
Jump to: navigation, search

Templates are powerful tools for simplifying many tasks, organizing work, standardizing content, and otherwise improving the wiki. However, they also have potential drawbacks and limitations which should be kept in mind when developing new templates and using existing ones. Please follow the guidelines listed below when creating and editing templates.

Problems and questions[edit source]

Templates (and Scribunto modules, which some of them may use) on this wiki are maintained by the community. All questions and issues regarding templates may be directed to the specific template or module's talk page or the centralized discussion board.

Most important thing[edit source]

Many templates are widely used across the wiki, so please be careful when editing those templates. Breaking such templates can lead to serious consequences. If you don't know what you're doing, ask more experienced editors first. Of course, the most used templates (such as {{Gc}} and {{Infobox}}) are already protected to prevent edits by unauthorized users, so you may need to ask other editors anyway.

Creating templates[edit source]

Before creating any templates, please make sure that no template similar to yours exists. A full list with a brief description can be found on the wiki.

When creating templates, keep your code simple but effective and efficient. Making sure to document your template; documentation is required for every template (see Documenting templates). To include the documentation in the template page, add <noinclude><code>{{Documentation}}</noinclude></code> on the last line of your template. Don't put it on a new line, or the new line may be included in the template itself. Note some templates (such as {{Stub}} or the navboxes) have shared documentation that can be taken advantage of. Lastly, make sure to test your template!

After creating the template, please update the list of templates with your new template with an accompanying description.

Editing templates[edit source]

When editing templates, make sure that all brackets are balanced. It is recommended you use the preview feature (removing <includeonly> tags when needed) to make sure it works. An edit summary is usually a good idea.

If your change adds or removes parameters or changes the behavior of the template, you must also update the template documentation. Also, if the invocations of the template no longer function as a result of your change, make sure to work to fix that; if the template has only been used a few times, fixing it manually isn't too hard, although if the template is more used, some editors have bots that could assist in large-scale changes.

Documenting templates[edit source]

Template documentation should always be up-to-date and should be updated when templates are modified.

Documentation format[edit source]

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[edit source]

All documentation should start with {{Doc/Start}} and should end with {{Doc/End|{{subst:FULLPAGENAME}}}}.

Template purpose[edit source]

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 the templates works to assist editors that wish to edit the template.

Template parameters[edit source]

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[edit source]

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. Additional formatting, rows, and columns can be added if desired. The examples could be in the following formats depending on the size or properties:

Format 1[edit source]

Code[edit source]
<Description>
<pre><Code></pre>
produces:<br />
<Template call>
Result[edit source]

<Description>

<Code>

produces:
<Template call>

Format 2[edit source]

Code[edit source]
{| class="wikitable"
! Code !! Result
|-
| <Code> || <Result>
|}
Result[edit source]
Code Result
<Code> <Result>

Related templates[edit source]

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[edit source]

Include categories in the template documentation with {{TC}}, add the code: {{TC|<Category name>}} to the bottom of the documentation before the {{Doc/End}}.



Promotional Content