Difference between revisions of "Template:Documentation/doc"
Jump to navigation
Jump to search
MyraMidnight (talk | contribs) m |
MyraMidnight (talk | contribs) m (→Usage) |
||
| (19 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {{Documentation subpage}} | |
| − | + | <!-- Categories go at the bottom of this page and interwikis go in Wikidata. --> | |
| + | This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation, categories, and interwiki links. It also reduces server resources by circumventing a technical limitation of templates | ||
| − | == | + | It detects the namespace, so when used on templates, it will say ''"Template Documentation"'' but on other namespaces it will just say ''"Documentation"''. |
| − | + | == Usage == | |
| − | + | |heading= (OPTIONAL) | |
| − | + | *<code>heading=</code> you can set a custom title, but if you include this parameter but leave it empty then the title will be removed along with the "edit/view" links. | |
| − | == | + | ==Documentation subpages== |
| − | + | Here is an example of how a <code>/doc</code> subpage setup should look like to be proper. | |
| − | + | :Categories that should be applied to the template should always go between <code><nowiki><includeonly></nowiki></code> and <code><nowiki></includeonly></nowiki></code> so they will not apply themselves to the documentation. | |
| − | + | <pre> | |
| − | { | + | {{Documentation subpage}} |
| − | <!-- | + | <!-- Categories go at the bottom of this page and interwiki links --> |
| − | + | ||
| − | | | + | == Usage == |
| − | + | | parameter= | |
| − | + | ||
| − | + | == See also == | |
| − | + | ||
| − | <!-- | + | <includeonly> |
| − | + | <!-- Categories go here, and interwikis go here --> | |
| − | + | </includeonly> | |
| − | + | </pre> | |
| − | + | ||
| − | + | == See also == | |
| − | + | *[[Template:Documentation subpage]] | |
| − | + | <includeonly> | |
| − | + | <!-- Categories go here, and interwikis go here --> | |
| + | [[Category:Template Documentation]] | ||
| + | </includeonly> | ||
Latest revision as of 09:26, 8 May 2017
|
This is a documentation subpage for Template:Documentation. It contains usage information, categories and other content that is not part of the original template page. |
This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation, categories, and interwiki links. It also reduces server resources by circumventing a technical limitation of templates
It detects the namespace, so when used on templates, it will say "Template Documentation" but on other namespaces it will just say "Documentation".
Usage[edit]
|heading= (OPTIONAL)
heading=you can set a custom title, but if you include this parameter but leave it empty then the title will be removed along with the "edit/view" links.
Documentation subpages[edit]
Here is an example of how a /doc subpage setup should look like to be proper.
- Categories that should be applied to the template should always go between
<includeonly>and</includeonly>so they will not apply themselves to the documentation.
{{Documentation subpage}}
<!-- Categories go at the bottom of this page and interwiki links -->
== Usage ==
| parameter=
== See also ==
<includeonly>
<!-- Categories go here, and interwikis go here -->
</includeonly>