Template:Documentation/doc: Difference between revisions
>יובל מדר@en.wikipedia.org (+he) |
m (sortkey) |
||
| Line 5: | Line 5: | ||
== Usage == | == Usage == | ||
=== Normal /doc === | === Normal /doc === | ||
<noinclude>{{{{{template-name|Documentation}}}}}</noinclude> | <noinclude>{{{{{template-name|Documentation}}}}}</noinclude> | ||
| Line 16: | Line 15: | ||
=== In-line content with [view][edit] links === | === In-line content with [view][edit] links === | ||
<noinclude>{{{{{template-name|Documentation}}} | <noinclude>{{{{{template-name|Documentation}}} | ||
|1 = Template:any page/doc | |1 = Template:any page/doc | ||
| Line 23: | Line 21: | ||
=== Best practice === | === 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. | 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. | ||
| Line 31: | Line 28: | ||
=== Customizing display === | === Customizing display === | ||
Overrides exist to customize the output in special cases: | 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. | * <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 == | == 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. | 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 == | == 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. | 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. | ||
== See also == | == See also == | ||
{{ Documentation/doc/see also }} | {{Documentation/doc/see also}} | ||
<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS --> | <includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS --> | ||
[[Category:Template documentation| ]] | [[Category:Template documentation| ]] | ||
[[Category:Wikipedia formatting and function templates| | [[Category:Wikipedia formatting and function templates|{{PAGENAME}}]] | ||
[[simple:Template:Documentation]] | [[simple:Template:Documentation]] | ||
Revision as of 22:03, 26 June 2009
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
Normal /doc
<noinclude>{{Documentation}}</noinclude>
Any /doc page
<noinclude>{{Documentation|Template:any page/doc}}</noinclude>
In-line content
<noinclude>{{Documentation|content=This is documentation.}}</noinclude>
In-line content with [view][edit] links
<noinclude>{{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 "<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 "<".
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.
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.
Rationale
Use of this template allows templates to be protected where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.
See also
Template:Documentation/doc/see also