FANDOM



Template documentation (for the above template, sometimes hidden or invisible) [view] [edit] [history] [purge/refresh]

This template automatically displays a documentation box like you are seeing now, of which the content is transcluded from another page. It is intended for pages which are transcluded wp in other pages, i.e. templates, whether in the template namespace or not.

Usage

{{documentation|Template:template-name/doc|doc=}}

  • Use this parameter when you use the template:any page/doc parameter.

This code should be added at the bottom of the template code "<noinclude> {{Documentation}} </noinclude>". The parameter can be used as shown above to transclude an arbitrary documentation page.

Add categories and interwiki links to the documentation page inside <includeonly> </includeonly> tags.

If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&lt;".

Functions

If the documentation page doesn't exist, the "edit" link includes a preload parameter so that clicking it will pre-fill the edit form with the basic documentation page format.

Customizing display

Overrides exist to customize the output in special cases:

  • {{documentation|heading=}}: change the text of the "documentation" heading. If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.

Rationale

This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation, categories, and interwiki links. It also reduces server resources by circumventing a technical limitation of templates (see a developer's explanation).

See also


The above text is transcluded from Template:Documentation/doc.
You can change it or view its history. (How does this work?)
If you're done making changes, please refresh the text. (Why?)
You can experiment in this template's Sandbox (create | Mirror ) and Testcases (create) pages.
Please add categories and interwikis to Template:Documentation/doc. (View all subpages of this page.)
Community content is available under CC-BY-SA unless otherwise noted.