Gboyers: moved Template:Documentation/doc to Template:Doc/doc

2009-06-30T16:02:30Z

moved Template:Documentation/doc to Template:Doc/doc

← Older revision	Revision as of 16:02, 30 June 2009
(No difference)

Gboyers: Created page with '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 [[Wiki...'

2009-06-14T22:36:19Z

Created page with '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 [[Wiki...'

New page

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 [[Wikipedia:Transclusion|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.

== Usage ==

=== Normal /doc ===
<noinclude>{{{{{template-name|Documentation}}}}}</noinclude>

=== Any /doc page ===
<noinclude>{{{{{template-name|Documentation}}}|Template:any page/doc}}</noinclude>

=== In-line content ===
<noinclude>{{{{{template-name|Documentation}}}|content=This is documentation.}}</noinclude>

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

<noinclude>{{{{{template-name|Documentation}}}
|1 = Template:any page/doc
|content ={{Template:any page/doc|parameters}}
}}</noinclude>

=== Best practice ===

This code should be added at the bottom of the template code, with no extra space before "<code><noinclude></code>" (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 <code><includeonly> </includeonly></code> 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;".

=== Customizing display ===

Overrides exist to customize the output in special cases:
* <code>{{documentation| '''heading''' = ...}}</code> − 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.

== Functions ==

If the documentation page doesn't exist, the "edit" link includes a [[mw:Manual:Creating pages with preloaded text|preload]] parameter so that clicking it will pre-fill the edit form with the basic documentation page format.

== Rationale ==

Use of this template allows templates to be [[Wikipedia:Protection policy|protected]] where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.

Template:Doc/doc - Revision history

Gboyers: moved Template:Documentation/doc to Template:Doc/doc

Gboyers: Created page with '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 [[Wiki...'