Template:Documentation: Difference between revisions

Revision as of 17:46, 6 April 2022

Template documentation

This documentation is transcluded from Template:Documentation/doc. (edit | history)

Template loop detected: Template:Documentation 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>}}.

The template will attempt to auto detect and link {{#Invoke:}} calls on template documentations or the require()/mw.loadData() depedency list on module documentations. If you want to supress the auto generated dependency list, use {{Documentation}}

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.

TemplateData

The documentation template is transcluded in the template/module documentation. This template should only be used on subpages titled "doc".

Template parameters
Parameter		Description	Type	Status
No parameters specified

@@ Line 1: / Line 1: @@
-<includeonly>{| class="article-table plainlinks" style="width:100%" role="complementary"
+<includeonly><div style="width:100%; border:1px solid #AAA; clear:both; position: relative; background:#ECFCF4; color:#000"><div style="margin-left:6px; margin-right:6px; margin-top:6px; margin-bottom:6px">{{#if:{{#pos:{{NAMESPACE}}|Template}}|<div style="text-align:left"><div style="float:right">[[{{fullurl:{{FULLPAGENAME}}/doc|action=edit}} edit]]</div>[[File:Template-info.png|50px]] <span style="font-size:17px; font-weight:bold">Template documentation</span></div>
-|- style="font-size:18px"
+-------------}}
-! style="padding:0" | <div class="color1" style="width:100%; padding:3px 0; text-align:center">Template Documentation</div>
+:''This documentation is transcluded from [[{{{1|{{FULLPAGENAME}}/doc}}}]].'' <small>([{{fullurl:{{{1|{{FULLPAGENAME}}/doc}}}|action=edit edit}}] | [{{fullurl:{{{1|{{FULLPAGENAME}}/doc}}}|action=history}} history])</small>
-|-
+{{#ifexist: {{FULLPAGENAME}}/sandbox|:''This template has a [[{{FULLPAGENAME}}/sandbox|sandbox]]''&nbsp;<small>([{{fullurl:{{FULLPAGENAME}}/sandbox|action=edit}} edit])</small>&nbsp;{{#ifexist: {{FULLPAGENAME}}/testcases|''and''|''for editors to experiment.''}}}}&nbsp;{{#ifexist: {{FULLPAGENAME}}/testcases|[[{{FULLPAGENAME}}/testcases|''testcases'']]&nbsp;<small>([{{fullurl:{{FULLPAGENAME}}/testcases|action=edit}} edit])</small>&nbsp;''for editors to experiment.''}} {{#ifexist: {{FULLPAGENAME}}/sandbox/test|''There is also a [[{{FULLPAGENAME}}/sandbox/test|sandbox test]] for editors to test their changes to the sandbox.''|}}
-| ''Note: portions of the template sample may not be visible without values provided.''
+{{{{{1|{{FULLPAGENAME}}/doc}}}}}<br clear="all">
-|-
+</div></div></includeonly><noinclude>{{Documentation}}</noinclude>
-| View or edit [[{{{1|Template:{{PAGENAMEE}}/doc}}}|this documentation]]. ([[Template:Documentation|About template documentation]])
-|-
-| Editors can experiment in this template's [{{fullurl:{{FULLPAGENAMEE}}/sandbox|action=edit}} sandbox] and [{{fullurl:{{FULLPAGENAMEE}}/testcases}} test case] pages.
-|}
-<div style="margin:0 1em">
-{{{{{1|{{PAGENAME}}/doc}}}}}</div></includeonly><noinclude>{{Documentation}}</noinclude>