Template:Documentation

Revision as of 14:59, 23 February 2020 by en>Iiii I I I (5 revisions imported: import from osrsw:Template:Plinkt)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Script error: The function "doc" does not exist.

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}} at the top of the documentation page. For example, Template:Foo/bar's documentation page would use {{documentation}}.

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}}

On modules which are data modules (compatible with mw.loadData) the |isData=y parameter should be used to specify this.

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.