Template:Documentation: Difference between revisions

Latest revision as of 15:11, 20 May 2025

Template documentation[view][edit][history][purge]

This documentation is transcluded from Template:Documentation/doc. Changes can be proposed in the talk page.

{{#seo:

|type = website |description = Template:Documentation 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[Edit template data]
Parameter		Description	Type	Status
No parameters specified

@@ Line 1: / Line 1: @@
-<div class="template-documentation" style="clear: both; border: 1px solid black; margin: 1em;">
+<includeonly>{{#invoke:Documentation|doc}}__NOEDITSECTION__{{#seo:
-  <div class="color1" style="padding: 1em; margin: 0;">'''Template documentation''' <span style="font-size: 85%;">(for the above template, sometimes hidden or invisible)</span>{{ #if: {{{content|}}} || <span id="doc_editlinks" class="editsection plainlinks" style="font-size: 85%;">{{ #ifexist: {{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}
+|type			= website
-    | &#91;[[{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}|view]]&#93; [[{{fullurl:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}|action=edit}} edit]] [[{{fullurl:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}|action=history}} history]] [[{{fullurl:{{FULLPAGENAME}}|action=purge}} refresh]]
+|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.
-    | [[{{fullurl:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}|action=edit&preload=Template:Documentation/preload}} create]]
+|site_name		= Star Citizen Wiki
-  }}</span> }}</div>
+|locale			= {{PAGELANGUAGE}}
-  <div style="padding: 1em; padding-bottom: 0; margin: 0;">{{ #if: {{{content|}}}
+}}</includeonly><noinclude>{{/doc}}</noinclude>
-    | <nowiki/>
-{{{content}}}
-    | {{ #ifexist: {{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}
-      | {{tocright}}{{{{ #ifeq: {{NAMESPACE}} | {{ns:Template}}
-        || :{{NAMESPACE:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}} }}}}:
-      }}{{ #if: {{{1|}}} | {{PAGENAME:{{{1}}}}} | {{PAGENAME}}/doc}} }}
-      | :<strong class="error">This template doesn't have any documentation yet!</strong> Help out by [{{fullurl:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}|action=edit&preload=Template:Documentation/preload}} writing some]. {{ #ifeq: {{NAMESPACE}} | {{ns:10}}
-        | There may also be documentation on [[{{ #if: {{{1|}}} | {{{1}}} |Template:{{BASEPAGENAME}}/doc}}|the base page]] which can be copied.
-      }}[[Category:Templates without documentation|{{PAGENAME}}]]
-    }}
-  }}
-  </div>
-  <div class="color1" style="clear: both; padding: 0.5em; margin: 0; font-size: 85%; text-align: right;">{{ #if: {{{content|}}}
-    | [{{fullurl:{{FULLPAGENAME}}|action=edit}} Edit this page] to change the above text. ([[Template:Documentation|What is this?]])
-    | {{ #ifexist: {{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}
-      | The above text is [[m:Transclusion|<span class="color1">transcluded</span>]] from [[{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}]]; you can [{{fullurl:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}|action=edit}} change it] or [{{fullurl:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}|action=history}} view its history]. ([[Template:Documentation|How does this work?]])
-      | This template currently doesn't have any documentation; you can [{{fullurl:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}|action=edit&preload=Template:Documentation/preload}} create it] if you know how the template is used. ([[Template:Documentation|What is this?]])
-    }}
-  }}<br />If you're done making changes, please [{{fullurl:{{FULLPAGENAME}}|action=purge}} refresh the text]. ([[Help:Purge|Why?]])<br />You can experiment in this template's {{ #ifexist: {{ #if: {{{sandbox|}}} | {{{sandbox}}} | {{FULLPAGENAME}}/sandbox }} | [[{{ #if: {{{sandbox|}}} | {{{sandbox}}} | {{FULLPAGENAME}}/sandbox }}|sandbox]] ([{{fullurl:{{ #if: {{{sandbox|}}} | {{{sandbox}}} | {{FULLPAGENAME}}/sandbox }}|action=edit}} edit] &#124; [{{fullurl:Special:ComparePages|page1={{FULLPAGENAMEE}}&page2={{urlencode:{{ #if: {{{sandbox|}}} | {{{sandbox}}} | {{FULLPAGENAME}}/sandbox }}}}}} diff]) | sandbox ([{{fullurl:{{ #if: {{{sandbox|}}} | {{{sandbox}}} | {{FULLPAGENAME}}/sandbox }}|action=edit&preload=Template:Documentation/preload-sandbox}} create] &#124; [{{fullurl:{{ #if: {{{sandbox|}}} | {{{sandbox}}} | {{FULLPAGENAME}}/sandbox }}|action=edit&preload={{FULLPAGENAMEE}}&summary={{urlencode:Create sandbox version of [[{{FULLPAGENAME}}]]}}}} mirror]) }} and {{ #ifexist: {{ #if: {{{testcases|}}} | {{{testcases}}} | {{FULLPAGENAME}}/testcases }} | [[{{ #if: {{{testcases|}}} | {{{testcases}}} | {{FULLPAGENAME}}/testcases }}|testcases]] ([{{fullurl:{{ #if: {{{testcases|}}} | {{{testcases}}} | {{FULLPAGENAME}}/testcases }}|action=edit}} edit]) | testcases ([{{fullurl:{{ #if: {{{testcases|}}} | {{{testcases}}} | {{FULLPAGENAME}}/testcases }}|action=edit&preload=Template:Documentation/preload-testcases}} create]) }} pages.{{ #if: {{{content|}}} || <br />Please add [[Help:Categories|categories]] and [[Help:Interwiki links|interwikis]] to {{ #ifexist: {{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }} | [[{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}]] | [{{fullurl:{{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}|action=edit&preload=Template:Documentation/preload}} {{ #if: {{{1|}}} | {{{1}}} | {{FULLPAGENAME}}/doc }}] }}. }} ([[Special:PrefixIndex/{{FULLPAGENAME}}/|View all subpages of this page]].)</div>
-</div>