Difference between revisions of "Template:Documentation"
Jump to navigation
Jump to search
Tags: Undo Replaced |
|||
Line 1: | Line 1: | ||
− | <includeonly>{{# | + | <includeonly>{{#ifeq:{{SUBPAGENAME}}|doc |
+ | |<!-- Subpage header --> | ||
+ | <table class="messagebox info"><tr> | ||
+ | <td>[[File:Template-info.png|40px|Documentation]]</td> | ||
+ | <td>'''This is a documentation subpage for [[{{{1|{{#titleparts:{{FULLPAGENAME}}|-1}}}}}]]'''.<span style="font-size:0.85em"><br />It contains usage information, categories, and other content that is not part of the original template page.</span></td> | ||
+ | </tr></table>{{#ifeq:{{NAMESPACE}}|Template|[[Category:Template documentation|{{BASEPAGENAME}}]]}} | ||
+ | |||
+ | |<!-- Template header --> | ||
+ | |||
+ | <div class="documentation" style="clear:both;"> | ||
+ | |||
+ | <div style="padding-bottom:1px; border-bottom:1px solid #898989; margin-bottom:1px"> | ||
+ | <span style="font-weight:bold; font-size:125%">[[File:Template-info.png|32px|link=]] Template documentation</span><span class="editsection plainlinks" id="doc_editlinks"><small>[[{{fullurl:{{{1|{{FULLPAGENAME}}}}}/doc|action=edit}} edit]] [[{{fullurl:{{FULLPAGENAME}}|action=purge}} purge]]</small></span> | ||
+ | </div><span style="font-size:85%">This documentation is transcluded from [[{{{1|{{FULLPAGENAME}}}}}/doc]].</span><br /> | ||
+ | |||
+ | <div style="clear:both; margin-bottom:25px"></div><!-- The main DIV tag is intentionally left unclosed - for obvious reasons --> | ||
+ | }}__NOEDITSECTION__</includeonly><noinclude>{{/doc}}</noinclude> |
Revision as of 11:59, 20 February 2020
This documentation is transcluded from Template:Documentation/doc.
Template:Documentation invokes Module:Documentation using Lua.
The documentation template is transcluded in the template/module documentation. This template should only be used on subpages titled "doc".
Usage
Place {{documentation}}
at the top of the documentation page.
If the page to be documented is a subpage, use {{documentation|pagename of page to be documented}}
at the top of the documentation page. For example, Template:Foo/bar's documentation page would use {{documentation|Template:Foo/bar}}
.
Note
This template links to a /doc that may appear useless, however, it exists in order to link navboxes and userboxes to their base template's documentation.