Template:Documentation/doc: Difference between revisions

Template page
m (Fix.)
(Updated.)
 
Line 1: Line 1:
{{Documentation}}
{{Documentation}}
The '''documentation''' template is transcluded in the template/module documentation. This template should only be used on subpages titled "doc".
The '''documentation''' template is transcluded in the template/module documentation. This template should only be used on subpages titled "doc".  


== Usage ==
== Usage ==
Place {{T|Documentation}} at the top of the documentation page.
Place {{T|Documentation}} at the top of the documentation page.  


If the page to be documented is a subpage, use {{T|Documentation|pagename of page to be documented}} at the top of the documentation page. For example, Template:Foo/bar's documentation page would use {{T|Documentation|Template:Foo/bar}}.
If the page to be documented is a subpage, use {{T|Documentation|pagename of page to be documented}} at the top of the documentation page. For example, Template:Foo/bar's documentation page would use {{T|Documentation|Template:Foo/bar}}.
Line 10: Line 10:


== Note ==
== 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.
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.  
<includeonly></includeonly>
<includeonly></includeonly>



Latest revision as of 17:20, 8 April 2022

Template:Documentation invokes function doc in 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>}}.

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

ParameterDescriptionTypeStatus
No parameters specified
Cookies help us deliver our services. By using our services, you agree to our use of cookies.