Template:Documentation: Difference between revisions

From IxWiki
Jump to navigation Jump to search
m Changed protection level for "Template:Documentation": downgraded protection level per consensus ([Edit=Allow only template editors and administrators] (indefinite) [Move=Allow only template editors and administrators] (indefinite))
 
No edit summary
Line 1: Line 1:
<onlyinclude>{{Autotranslate/clone_2
<includeonly>{{#invoke:Documentation|doc}}__NOEDITSECTION__{{#seo:
|base    = Documentation
|type = website
|lang    = {{{lang|{{int:Lang}} }}}
|description = {{FULLPAGENAME}} 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.
|1      = {{{1|{{SUBJECTPAGENAME}}/doc}}}
|site_name = Star Citizen Wiki
|2      = {{{heading|{{{2|}}} }}}
|locale = {{PAGELANGUAGE}}
|content = {{{content|}}}
}}</includeonly><noinclude>{{/doc}}</noinclude>
}}</onlyinclude><noinclude>
<!-- {{Autotranslate/clone_2}} is identical to {{Autotranslate}} and it is used to avoid "Warning: This page calls Template:Autotranslate which causes a template loop (an infinite recursive call). "-->
 
{{Documentation}}
 
</noinclude>

Revision as of 19:32, 18 March 2020

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

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[Edit template data]

ParameterDescriptionTypeStatus
No parameters specified