Template:Documentation/doc: Difference between revisions
Jump to navigation
Jump to search
(remove "Usage of template" (has been merged)) |
(Moved {{pp-template|small=yes}} and {{intricate template}} here instead of in the template code, since they are not part of the template code.) |
||
| Line 1: | Line 1: | ||
{{documentation subpage}}__NOTOC__ | {{documentation subpage}}<includeonly>{{pp-template|small=yes}}{{intricate template}}</includeonly> | ||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | |||
__NOTOC__ | |||
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. | 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 | == Usage == | ||
=== Normal /doc === | |||
<noinclude>{{{{{template-name|Documentation}}}}}</noinclude> | <noinclude>{{{{{template-name|Documentation}}}}}</noinclude> | ||
===Any /doc page=== | === Any /doc page === | ||
<noinclude>{{{{{template-name|Documentation}}}|Template:any page/doc}}</noinclude> | <noinclude>{{{{{template-name|Documentation}}}|Template:any page/doc}}</noinclude> | ||
===In-line content=== | === In-line content === | ||
<noinclude>{{{{{template-name|Documentation}}}|content=This is documentation.}}</noinclude> | <noinclude>{{{{{template-name|Documentation}}}|content=This is documentation.}}</noinclude> | ||
===In-line content with [view][edit] links=== | === In-line content with [view][edit] links === | ||
<noinclude>{{{{{template-name|Documentation}}} | <noinclude>{{{{{template-name|Documentation}}} | ||
| Line 23: | Line 22: | ||
}}</noinclude> | }}</noinclude> | ||
===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 30: | Line 30: | ||
If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&lt;". | If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&lt;". | ||
===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 --> | ||
-- | |||
[[Category:Template documentation| ]] | [[Category:Template documentation| ]] | ||
[[Category:Formatting templates|Template documentation]] | [[Category:Formatting templates|Template documentation]] | ||
Revision as of 17:12, 14 March 2008
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.
Add categories and interwiki links to the documentation page inside <includeonly> </includeonly> tags.
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