From Ext4
(Difference between revisions)
Jump to: navigation, search
(New page: {{documentation subpage}}<includeonly>{{pp-semi-template|small=yes}}{{intricate template}}</includeonly> <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> __NOTOC__ ...)

Latest revision as of 00:16, 10 August 2008

{{#if: |

40px This is the template documentation page for Template:Documentation/doc.
This page may not be intended to be viewed directly.
Links using variables may appear broken; do not replace these with hardcoded page names or URLs.

}} |{{#ifeq: documentation/doc | doc



   #ifeq: show | show
This is a documentation subpage for Template:Documentation/doc (see that page for the {{ #if: Template | template | article }} itself).
It contains usage information, categories and other content that is not part of the original {{ #if: Template |template page|article}}.
   | [[Category:{{
     #if: Template
     | Template
     | Article
   }} documentation]]

| }}}}

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.

[edit] Usage

[edit] Normal /doc


[edit] Any /doc page

<noinclude>{{Documentation|Template:any page/doc}}</noinclude>

[edit] In-line content

<noinclude>{{Documentation|content=This is documentation.}}</noinclude>

[edit] In-line content with [view][edit] links

|1 = Template:any page/doc
|content ={{Template:any page/doc|parameters}}

[edit] Best practice

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.

Categories and interwiki links that apply to the template itself should be added to the documentation page, inside <includeonly> </includeonly> tags. For more complex cases, see Wikipedia:Template documentation‎#Categories and interwiki links.

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

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

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

[edit] Rationale

Use of this template allows templates to be protected where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.

[edit] See also

Template:Documentation/doc/see also

Personal tools