Template:Documentation/doc: Difference between revisions

From [N8]
Jump to navigation Jump to search
Created page with "{{Documentation}} The '''documentation''' template is transcluded in the template/module documentation. This template should only be used on subpages titled "doc". ==Usage==..."
 
mNo edit summary
 
Line 1: Line 1:
{{Documentation}}
{{Documentation}}
{{Invokes|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".  


Line 6: Line 7:


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}}.
The template will attempt to auto detect and link <code><nowiki>{{#Invoke:}}</nowiki></code> calls on template documentations or the <code>require()</code>/<code>mw.loadData()</code> depedency list on module documentations. If you want to supress the auto generated dependency list, use {{t|documentation|DependencyList=no}}


==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>[[Category:Template documentation| ]]</includeonly>
<includeonly>[[Category:Template documentation| ]]</includeonly>

Latest revision as of 11:46, 20 February 2020

This is a documentation subpage for Template:Documentation.
It contains usage information, categories, and other content that is not part of the original template page.
Template:Documentation invokes function doc in Module:Documentation using Lua.
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.