Template:Documentation

From Meta, a Wikimedia project coordination wiki
Jump to: navigation, search
Documentation icon Documentationviewedithistorypurge

This documentation is transcluded from Template:Documentation/doc.

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 in other pages, i.e. templates, whether in the template namespace or not.

Usage
<noinclude>{{documentation}}</noinclude>
<noinclude>{{documentation|else:where}}</noinclude>

This code should be added at the bottom of the template code, with no extra space before "<noinclude>" (which would cause extra space on pages where the template is used). 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 tags.

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

An optional second parameter or named parameter heading=… allows to 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.

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.

Purpose

Transclusion of a documentation page makes it possible to protect the page of the template itself while allowing anyone to edit the template's documentation and categories. Sometimes this also allows the use of msgnw to show the raw content of a template.

See also

  • {{docsubst}} to substitute (instead of transclude) a /doc subpage
  • Subpages, not all languages on commons are already copied.

Transclude documentation from a /doc subpage of the subject page or another page

Template parameters
Parameter Description Type Status
1 1

Page with /doc subpage.

Default
{{SUBJECTPAGENAME}}
Example
empty
Auto value
empty
wiki-page-name optional
2 2heading

Overwrite documentation heading.

Default
Icon + "Documentation" blurb
Example
empty
Auto value
empty
string optional
Lang lang

Overwrite MediaWiki:Lang

Default
{{int:Lang}}
Example
empty
Auto value
empty
string optional
Content content

Bypass /doc transclusion

Default
empty
Example
empty
Auto value
empty
string deprecated