Fallout Wiki
Advertisement
Fallout Wiki
Template documentation (for the template shown above, sometimes hidden or invisible)

For use on template documentation pages. Adds header and category.

The template is the header on documentation pages. if seen on an article, please delete it.

Template parameters

ParameterDescriptionTypeStatus
Page1 page

Name of the page the documentation belongs to

Default
{{PAGENAME}}
Example
Template:Example
Stringoptional
Documentation page typetype

Allows for specification of documentation page type. See Template:Documentationpage for options

Default
default
Example
standard
Stringoptional
Template statusstatus

Should be used when a template is no longer in use, but cannot be removed from the wiki due to technical limitations. Enter "legacy" to mark it as a legacy template

Example
legacy
Stringoptional

Options available to the type parameter:

  • default: This page is a normal documentation page.
  • standard: This page is a standard documentation page for all templates based on a specific meta template.

Usage

Place the following at the top of the documentation page:

<noinclude>{{Documentationpage}}</noinclude>

Technical

This template is based on {{directionbox}}. The parameters are mapped as follows:

Parent parameterChild parametersDescription
imageIcon template doc.svgThe icon shown on the left of the box
text{{{1|}}}, {{{type}}}, {{{status}}}If a template has a type of standard, the additional text "the standard documentation for all templates based on" is displayed, otherwise "usage information for" is shown followed by a link to either the page title or 1 if set. If the status is set as legacy "This template is classed as a legacy template and should not be used on any articles, it has not been removed due to technical limitations." is added to the end.

The status parameter will also switch the documentation to the Legacy template documentation category if set to legacy, otherwise it set the category to Template Documentation.

Documentation transcluded from Template:Documentationpage/doc.
Advertisement