Template:Documentation/doc

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.

{{#seo:

|type = website |description = Template:Documentation/doc is a template page used on the Star Citizen Wiki. Templates are pages that are embedded (transcluded) into other pages to allow for the repetition of information. |site_name = Star Citizen Wiki |locale = en }} 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

Parameter		Description	Type	Status
No parameters specified