Template:Documentation/doc: Difference between revisions
(Created page with "{{documentation subpage}} <!-- 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 transcluded in other pages, i.e. templates, whether in the template namespace or not. {{AccessibilityDispute}} == Usage == === Normal /doc === <noinclude>...") |
No edit summary |
||
| Line 2: | Line 2: | ||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | ||
__NOTOC__ | __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 [[ | 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 [[AEWiki:Transclusion|transcluded]] in other pages, i.e. templates, whether in the template namespace or not. | ||
{{AccessibilityDispute}} | {{AccessibilityDispute}} | ||
| Line 28: | Line 28: | ||
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. | ||
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 [[ | 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 [[AEWiki:Template documentation‎#Categories and interwiki links]]. | ||
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;". | ||
| Line 43: | Line 43: | ||
== Rationale == | == Rationale == | ||
Use of this template allows templates to be [[ | Use of this template allows templates to be [[AEWiki:Protection policy|protected]] where necessary, while allowing anyone to edit the documentation, categories, and interwiki links. | ||
== See also == | == See also == | ||
| Line 50: | Line 50: | ||
<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS --> | <includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS --> | ||
[[Category:Template documentation| ]] | [[Category:Template documentation| ]] | ||
[[Category: | [[Category:AEWiki formatting and function templates|Template documentation]] | ||
</includeonly> | </includeonly> | ||
Latest revision as of 03:47, 4 February 2023
| File:Edit-copy green.svg.png | This is a documentation subpage for Template:Documentation (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template 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 transcluded in other pages, i.e. templates, whether in the template namespace or not.
| The accessibility of this article or template is in question. For specifics, please see the relevant discussion on the talk page. Information on making articles more accessible can be found at Wikiproject Accessibility. |
Usage[edit source]
Normal /doc[edit source]
<noinclude>{{Documentation}}</noinclude>
Any /doc page[edit source]
<noinclude>{{Documentation|Template:any page/doc}}</noinclude>
In-line content[edit source]
<noinclude>{{Documentation|content=This is documentation.}}</noinclude>
In-line content with [view][edit] links[edit source]
<noinclude>{{Documentation
|1 = Template:any page/doc
|content ={{Template:any page/doc|parameters}}
}}</noinclude>
Best practice[edit source]
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 AEWiki: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[edit source]
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[edit source]
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[edit source]
Use of this template allows templates to be protected where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.
See also[edit source]
General information about documentation for templates
{{ Documentation }} family[edit source]
Meta Wiki {{ Documentation }} ancestor[edit source]