Difference between revisions of "Template:Documentation"
Jump to navigation
Jump to search
Template documentation ()
MyraMidnight (talk | contribs) m |
MyraMidnight (talk | contribs) m (having a link 'subpages of this subpage' in the documentation seemed weird.) |
||
| (10 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | <onlyinclude><includeonly> | + | <onlyinclude><includeonly><div style=" |
| − | + | margin: 1em 0 1em 0; | |
| + | background-color: #fff5fa; | ||
| + | border: 1px #bfa3af solid; | ||
| + | border-collapse: collapse; | ||
| + | color: black; | ||
| + | padding: 1em;"> | ||
| + | <span style="{{#if: {{{heading-style|}}} | ||
| {{{heading-style|}}} | | {{{heading-style|}}} | ||
| {{#ifeq: {{SUBJECTSPACE}} | {{ns:Template}} | | {{#ifeq: {{SUBJECTSPACE}} | {{ns:Template}} | ||
| Line 10: | Line 16: | ||
<!--"heading" not defined in this or previous level--> | <!--"heading" not defined in this or previous level--> | ||
{{#switch: {{SUBJECTSPACE}} | {{#switch: {{SUBJECTSPACE}} | ||
| − | | {{ns:Template}} = [[File: | + | | {{ns:Template}} = [[File:Template_Info.png|50px|link=|alt=Documentation icon]] Template documentation ({{Navbar|{{PAGENAME}}/doc|text=}})<hr> |
| − | | {{ns:File}} = Summary | + | | {{ns:File}} = Summary <hr> |
| − | | #default = Documentation | + | | #default = Documentation <hr> |
}} | }} | ||
| #default = | | #default = | ||
<!--"heading" has data or is empty but defined--> | <!--"heading" has data or is empty but defined--> | ||
{{{heading|}}} | {{{heading|}}} | ||
| − | }} | + | }}</span> |
| − | + | <!--- | |
| − | |||
--->{{{{PAGENAME}}/doc}} | --->{{{{PAGENAME}}/doc}} | ||
| − | + | </div> | |
| − | + | <div style=" | |
| − | + | margin: 1em 0 1em 0; | |
| − | + | background-color: #fff5fa; | |
| − | The above documentation is transcluded from [[{{FULLPAGENAME}}/doc]]. | + | border: 1px #bfa3af solid; |
| − | + | border-collapse: collapse; | |
| − | + | color: black; | |
| − | + | padding: 1em;"> | |
| − | + | :The above documentation is transcluded from [[{{FULLPAGENAME}}/doc]]. | |
| − | + | :Editors can experiment in this template's [[{{FULLPAGENAME}}/sandbox|sandbox]] | |
| + | :Please add categories to the [[{{FULLPAGENAME}}/doc|'''/doc''' subpage]] within {{tag|includeonly}} | ||
| + | </div></includeonly></onlyinclude> | ||
{{Documentation}} | {{Documentation}} | ||
Latest revision as of 16:45, 10 October 2020
Template documentation ()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)
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
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>
See also
- The above documentation is transcluded from Template:Documentation/doc.
- Editors can experiment in this template's sandbox
- Please add categories to the /doc subpage within
<includeonly>...</includeonly>