Template:Documentation: Difference between revisions

Template page
starcitizen>Alistair3149
mNo edit summary
en>Alistair3149
(Replaced content with "<includeonly>{{#invoke:Documentation|doc}}__NOEDITSECTION__</includeonly><noinclude>{{/doc}}</noinclude>")
Line 1: Line 1:
<noinclude><div style="display:none;"></noinclude><div style="margin:0; margin-top:1rem;box-shadow: 0 2px 2px 0 rgba(0,0,0,.14), 0 1px 5px 0 rgba(0,0,0,.12), 0 3px 1px -2px rgba(0,0,0,.2);"><div style="background:#ddd; color:#111; padding:1rem 1.5rem; margin:0em;">'''Template documentation''' <span style="font-size:85%;">(for the above template, sometimes hidden or invisible. Changes can be proposed in the talk page.)</span></div><div style="padding:1rem 1.5rem; padding-bottom:0em; margin:0em;">
<includeonly>{{#invoke:Documentation|doc}}__NOEDITSECTION__</includeonly><noinclude>{{/doc}}</noinclude>
{{{{PAGENAME}}/doc}}
</div><br style="clear:both;"/><div style="background:#ddd; color:#111; padding:0.5rem 1.5rem; margin:0; font-size:85%; text-align:right;">Visit [[Template:{{PAGENAME}}/doc]] to edit this text! ([[Template:Documentation|How does this work]]?)</div></div><noinclude></div>
{{documentation}}[[Category:Template documentation| ]]</noinclude>

Revision as of 03:37, 15 March 2020

Template documentation[view][edit][history][purge]
This documentation is transcluded from Template:Documentation/doc. Changes can be proposed in the talk page.

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".

[Edit template data]

Template parameters

ParameterDescriptionTypeStatus
No parameters specified