Template:Documentation/doc

From Old School RuneScape Wiki
Jump to: navigation, search
Information icon-grey.svg
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.

{{Documentation}} is transcluded in template/module documentation pages. This template should only be used on subpages titled "doc".

This is not the template of the same name from Wikipedia and it is not used in the same way.

Usage

Place {{documentation}} at the top of the documentation page, then transclude {{/doc}} directly from the main template page, within <noinclude> tags.

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.