Joomla! Documentation™

This is a documentation subpage for Template:Documentation.
It contains usage information, categories and other content that is not part of the original template page.
To view the template page itself, see Template:Documentation.

This template automatically displays a documentation box like the one you read now, of which the content is taken 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>

If called without a parameter the /doc subpage of the template is transcuded into the template for display -- like this "Documentation/doc" subpage is considered to be the documentation page of the "Documentation" template.

<noinclude>{{documentation|template:any page}}</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. Make sure to add the namespace prefix of the documentation page if necessary.

Add categories and interwiki links for the template 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;".

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. The header depends on the namespace; for example, it will display "Template documentation" in the template namespace.

Rationale

This template is not restricted to a particular namespace and 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).