Documentation: Difference between revisions

From SL Pro Wrestling Wiki
/>ExE Boss
m Fix `content` parameter
/>SuperDragonXD1
Merge from sandbox version (User:SuperDragonXD1/sandbox/TW_Documentation)
Line 1: Line 1:
<includeonly>{{#ifeq:{{SITENAME}}|Templates Wiki|<div style="margin:0 1em;clear:both;"><div style="font-size:small;line-height:16px;">
<includeonly><!--
{{#ifeq:{{{SPW}}}|is not relevant||
-
:'''''[{{fullurl:Special:Export}}?link1=Template:{{PAGENAMEE}}&link2=Template:{{PAGENAMEE}}/doc{{#if:{{{dep1|}}}
- Article Header
|&link3={{{dep1}}}&link4={{{dep1}}}/doc}}{{#if:{{{dep2|}}}
-
|&link5={{{dep2}}}&link6={{{dep2}}}/doc}}{{#if:{{{dep3|}}}
-->{{#ifeq: {{SITENAME}}|Templates Wiki||<!--
|&link7={{{dep3}}}&link8={{{dep3}}}/doc}}{{#if:{{{dep4|}}}
--><div style="margin:1em; padding:10px; border: 0.5px solid #c91010; border-radius:10px; background:#f001"><span class="error">'''Your wiki got a version of [[Template:Documentation]] that is only relevant to [[w:c:templates|Templates Wiki]]!''' [{{fullurl:Template:Documentation}}?action=history Click here to revert it.]</span>
|&link9={{{dep4}}}&link10={{{dep4}}}/doc}} Export this template]''', then [[Help:Importing|import]], to install it.
For a documentation template you can use on your wiki, see [[w:c:templates:Template:Documentation (copy)|Template:Documentation (copy) on Templates Wiki]].</div>}}<!--
<!--:''Or copy [{{FULLURL:{{FULLPAGENAME}}}}?action=edit {{FULLPAGENAME}}]<sup>[[Special:Export/{{FULLPAGENAME}}|export]]</sup>, [{{FULLURL:{{FULLPAGENAME}}/doc}}?action=edit {{FULLPAGENAME}}/doc]<sup>[[Special:Export/{{FULLPAGENAME}}/doc|export]]</sup>{{#if:{{{dep1|}}}|,
 
[{{FULLURL:{{{dep1}}}}}?action=edit {{{dep1}}}]<sup>[[Special:Export/{{{dep1}}}|export]]</sup>{{#if:{{{dep2|}}}|,
--><div style="text-align:center;"><span style="font-size:large;">Template information, documentation, and installation instructions.</span><br/>
[{{FULLURL:{{{dep2}}}}}?action=edit {{{dep2}}}]<sup>[[Special:Export/{{{dep2}}}|export]]</sup>}}{{#if:{{{dep3|}}}|,
Expand the below text for usage and other information.</div><!--
[{{FULLURL:{{{dep3}}}}}?action=edit {{{dep3}}}]<sup>[[Special:Export/{{{dep3}}}|export]]</sup>}}}} to the same locations on your wiki. [[Help:How_to_copy_templates_to_your_wiki|Need help?]]''-->
-
:''Use edit summary: ''<code><nowiki>Copied from [[w:c:templates:</nowiki>{{FULLPAGENAME}}<nowiki>]]</nowiki></code>'' to properly attribute this template's editors.''}}{{#if:{{{vanilla|}}}|
- Documentation Transclusion
:''This template is compatible with vanilla Mediawiki.''}}
-
--><div style="padding:10px; border:1px solid #444c4d; clear:both; margin-bottom:0; border-bottom:unset; border-radius:10px 10px 0 0;" class="mw-collapsible mw-collapsed article-table" data-collapsetext="Hide documentation" data-expandtext="Show documentation"><!--
- Documentation Header
-->
<span style="font-size:large;>Template Documentation</span><!--
--><div style="margin:0; padding:1em; border: 0.5px solid #444c4d; border-radius:10px;" class="mw-collapsible-content"><!--
-->''Note: The template above might be broken without the parameters; this is normal.''<br/><!--
- Documentation Tools
-->{{#if: {{{content|}}}
  | [{{fullurl: {{FULLPAGENAME}}|action=edit}} Edit this template] for the documentation<!--
  -
-->| {{#ifexist: {{{1|{{FULLPAGENAME}}/doc}}}
    | View, edit, or check the history of [[:{{{1|{{FULLPAGENAME}}/doc}}}|this documentation]].
    |[{{fullurl: {{{{1|{{FULLPAGENAME}}/doc}}}
              |action=edit&preload=Template:Documentation/preload<!--
            -->&summary={{urlencode:Create documentation for [[{{FULLPAGENAME}}]]}}
              }} Create documentation] for this template.
    }}
    }} ([[Template:Documentation/doc|How does this work?]])<br/>Editors can experiment with this template's {{#ifexist: {{{sandbox|{{FULLPAGENAME}}/sandbox}}}
| [[{{{sandbox|{{FULLPAGENAME}}/sandbox}}}|sandbox]]
| sandbox [{{fullurl:{{{sandbox|{{FULLPAGENAME}}/sandbox}}}
  | action=edit&preload=Template:Documentation/preload-sandbox<!--
  -->&summary={{urlencode:Create sandbox version of [[{{FULLPAGENAME}}]]}}
  }} (create)]
}} and <!--
-
-->{{#ifexist: {{{testcases|{{FULLPAGENAME}}/testcases}}}
| [[{{{testcases|{{FULLPAGENAME}}/testcases}}}|testcases]]
| testcases [{{fullurl:{{{testcases|{{FULLPAGENAME}}/testcases}}}
  | action=edit&preload=Template:Documentation/preload-testcases<!--
  -->&summary={{urlencode:Create testcases subpage of [[{{FULLPAGENAME}}]]}}
  }} (create)]
}}</div><!--
-
--><div style="background:none;" class="mw-collapsible-content">
{{Tocright}}
{{#if:{{{content|}}}
  | {{{content}}}
 
  | {{#ifexist: {{{1|{{FULLPAGENAME}}/doc}}}
    | {{#if: {{{1}}}
      |{{{{{1}}}}}
      |{{:{{FULLPAGENAME}}/doc}}}}
    | Documentation does not exist. Create it at [{{fullurl:
              {{#if:{{{1|}}}|{{{1}}}|{{FULLPAGENAME}}/doc}}
              |action=edit&preload=Template:Documentation/preload<!--
            -->&summary={{urlencode:Create documentation for [[{{FULLPAGENAME}}]]}}<!--
            --> {{#if:{{{1|}}}|{{{1}}}|{{FULLPAGENAME}}/doc}}].
  }}<!--end if 1-->
}}
<!--end if content-->
}}
</div></div><!--
- Installation
-
--><div style="padding:10px;border:1px solid #444c4d; margin-top:0; border-radius:0 0 10px 10px;" class="mw-collapsible article-table" data-collapsetext="Hide install insturctions" data-expandtext="Show install instuctions">
<span style="font-size:large;">Installation Instructions</span><!--
--><div class="mw-collapsible-content">
<!--
-
- The section for the exporting the template.
-
--><div style="margin:1em; padding:5px; background:#0121; border: 0.5px solid #36475e; border-radius:10px;">
  {{#ifeq:{{{SPW}}}|is not relevant
    |
    <!--
    - Export links
    -->
    |:'''''[{{fullurl:Special:Export}}?link1=Template:{{PAGENAMEE}}&link2=Template:{{PAGENAMEE}}/doc<!--
    -->{{#if:{{{dep1|}}}|&link3={{{dep1}}}&link4={{{dep1}}}/doc}}<!--
    -->{{#if:{{{dep2|}}}|&link5={{{dep2}}}&link6={{{dep2}}}/doc}}<!--
    -->{{#if:{{{dep3|}}}|&link7={{{dep3}}}&link8={{{dep3}}}/doc}}<!--
    -->{{#if:{{{dep4|}}}|&link9={{{dep4}}}&link10={{{dep4}}}/doc}}<!--
    -
    - Main Text
    -
    --> Export this template]''', then [[Help:Importing|import]], to install it.<br/><!--
    -->''Use edit summary: ''<code><nowiki>Copied from [[w:c:templates:</nowiki>{{FULLPAGENAME}}<nowiki>]]</nowiki></code>'' to properly attribute this template's editors.''}}<!--
    - If compatible with vanilla MediaWiki
    -->{{#if:{{{vanilla|}}}|:''This template is compatible with vanilla Mediawiki.''}}
    <!--
    -
    - Text to show if the page is:
    -  is newer = Newer than Starter Pages Wiki (SPW)
    -  is not relevant = Should be '''NOT''' copied
    -  is on = Is on SPW
    -  is not on | #default = Not in SPW
    -
    -->
:''{{#switch: {{{SPW|{{Template:Is SPW}}}}}
:''{{#switch: {{{SPW|{{Template:Is SPW}}}}}
| is newer
| is newer | is newer than =
| is newer than =
[[w:c:templates:Help:Starter pages|This template is probably newer than one that is already on your wiki.]]<!--
[[w:c:templates:Help:Starter pages|This template is probably newer than one that is already on your wiki.]]{{#ifeq: {{SITENAME}} | Templates Wiki | [[Category:Newer than on starter pages|{{PAGENAME}}]] }}
  -->{{#ifeq: {{SITENAME}}  
        | Templates Wiki
        | [[Category:Newer than on starter pages|{{PAGENAME}}]]
      }}
| is not relevant
| is not relevant
| is not relevant to =
| is not relevant to =
This template is not on [[w:c:starter|Fandom starter pages]] because it is probably not relevant to wikis other than Templates Wiki. '''You probably don't want to copy this template to your wiki.''' {{#if:{{{SPW-link|}}}|For a similar template intended to be copied, see [[:Template:{{{SPW-link}}}]].}} {{#ifeq: {{SITENAME}} | Templates Wiki | [[Category:Templates Wiki templates|{{PAGENAME}}]] }}
This template is not on [[w:c:starter|Fandom starter pages]] because it is probably not relevant to wikis other than Templates Wiki. '''You probably don't want to copy this template to your wiki.''' {{#if:{{{SPW-link|}}}|For a similar template intended to be copied, see [[:Template:{{{SPW-link}}}]].}}<!--
  -->{{#ifeq: {{SITENAME}}
        | Templates Wiki
        | [[Category:Templates Wiki templates|{{PAGENAME}}]]
      }}
| true <!-- Automatically checked against list of SPW templates at Template: Is SPW -->
| true <!-- Automatically checked against list of SPW templates at Template: Is SPW -->
| is on =
| is on =
[[w:c:templates:Help:Starter pages|This template is probably already on your wiki.]]{{#ifeq: {{SITENAME}} | Templates Wiki | [[Category:From starter pages|{{PAGENAME}}]] }}
[[w:c:templates:Help:Starter pages|This template is probably already on your wiki.]]<!--
  -->{{#ifeq: {{SITENAME}}
        | Templates Wiki
        | [[Category:From starter pages|{{PAGENAME}}]]
      }}
| is not on
| is not on
| #default =
| #default = <!--
[[w:c:templates:Help:Starter pages|This template is probably not already on your wiki.]]
    -->[[w:c:templates:Help:Starter pages|This template is probably not already on your wiki.]]
}}''</div>
}}''
</div>
</div><!-- End Section -->
{{#ifeq:{{CONTENTLANG}}|ja||{{#if:{{{ja|}}}|[[Category:Interwiki specified]][[ja:{{{ja}}}]]|{{#switch:{{{nothing|{{Is JA}}}}}|true=[[ja:Template:{{PAGENAME}}]]}}}}}}
<!--
{{#ifeq:{{CONTENTLANG}}|zh||{{#if:{{{zh|}}}|[[Category:Interwiki specified]][[zh:{{{zh}}}]]|{{#switch:{{{nothing|{{Is ZH}}}}}|true=[[zh:Template:{{PAGENAME}}]]}}}}}}
-
{{#ifeq:{{CONTENTLANG}}|en||{{#if:{{{en|}}}|[[Category:Interwiki specified]][[en:{{{en}}}]]|{{#switch:{{{nothing|{{Is EN 1}}{{Is EN 2}}{{Is EN 3}}}}}|true=[[en:Template:{{PAGENAME}}]]}}}}}}|<span style="color:red;">'''Your wiki got a version of [[Template:Documentation]] that is only relevant to [[w:c:templates|Templates Wiki]]. [{{fullurl:Template:Documentation}}?action=history Click here to revert it.]'''</span>
- Interlanguage links
For a documentation template you can use on your wiki, see [[w:c:templates:Template:Documentation (copy)]].}}<!--
-
 
--><!--
  End of documentation blob - the ONLY part returned if called by "Template:Documentation (copy)"
- Japanese
 
-->{{#ifeq:{{CONTENTLANG}}|ja|
|{{#if:{{{ja|}}}
    |[[Category:Interwiki specified]][[ja:{{{ja}}}]]
    |{{#switch:{{{nothing|{{Is JA}}}}}
      |true=[[ja:Template:{{PAGENAME}}]]
      }}
  }}
}}<!--
- Simplified Chinese
-->{{#ifeq:{{CONTENTLANG}}|zh|
|{{#if:{{{zh|}}}
    |[[Category:Interwiki specified]][[zh:{{{zh}}}]]
    |{{#switch:{{{nothing|{{Is ZH}}}}}
      |true=[[zh:Template:{{PAGENAME}}]]
      }}
    }}
}}<!--
- English
-->{{#ifeq:{{CONTENTLANG}}|en|
|{{#if:{{{en|}}}
  |[[Category:Interwiki specified]][[en:{{{en}}}]]
  |{{#switch:{{{nothing|{{Is EN 1}}{{Is EN 2}}{{Is EN 3}}}}}
    |true=[[en:Template:{{PAGENAME}}]]
    }}
  }}
}}
<!--
-
- Installation Instructions
-
-->
-->
{{#ifeq:{{PAGENAME}}|Documentation (copy)||
{{#ifeq: {{SPW}}|is not relevant |  
{{(!}} class="article-table" style="width:100%;" role="complementary"
|{{#ifexist: {{{install|{{FULLPAGENAME}}/install}}}
{{!}}- style="font-size:18px;"
  | ''The above message will be enough for most cases; if there are addtional insturctions, you can see them below.''<br/><!--
! style="padding:0px;" {{!}} <div style="width:100%; padding:3px 0px; text-align:center;" class="color1">Template documentation</div>
  --> {{<!---->{{{install|{{FULLPAGENAME}}/install}}}}}
{{!}}-
  | :There is no addtional installation instuctions for this template. If there is any, you may create it at [{{fullurl:
{{!}} ''Note: the template above may sometimes be partially or fully invisible.''
              {{{install|{{FULLPAGENAME}}/install}}}
{{!}}-
              |action=edit&preload=Template:Documentation/preload-install<!--
{{!}} <!--
-->}} {{{install|{{FULLPAGENAME}}/install}}}].
-->{{#if:{{{content|}}}|<!--
}}
-->Edit [{{fullurl:<!--
}}
-->{{FULLPAGENAME}}<!--
</div></div></includeonly><noinclude>
-->|action=edit<!--
{{Documentation|SPW = is not relevant|SPW-link = Documentation (copy)|content= This is a version of Template:Documentation customized for Templates Wiki and so not designed to be copied to other wikis.
-->}}<!--end fullurl--> this template for the documentation].<!--
-->|<!--else if content--><!--
-->{{#ifexist: {{#if:{{{1|}}}|{{{1}}}|{{FULLPAGENAME}}/doc}}<!--end if 1-->|<!--
-->View or edit [[:{{#if:{{{1|}}}|{{{1}}}|{{FULLPAGENAME}}/doc}}|this documentation]].<!--
-->|<!--else ifexist--><!--
-->[{{fullurl:<!--
-->{{#if:{{{1|}}}|{{{1}}}|{{FULLPAGENAME}}/doc}}<!--end if 1--><!--
-->|action=edit&preload=Template:Documentation/preload<!--
-->}}<!--end fullurl--> create this documentation]<!--
-->}}<!--end ifexist--><!--
-->}}<!--end if content--> ([[Template:Documentation|How does this work?]])
{{!}}-
{{!}} Editors can experiment with this template's {{#if: {{{sandbox|}}} | {{#switch: {{#sub:{{lc:{{{sandbox}}}}}|0|1}}
| y | t | 1 = [[{{FULLPAGENAME}}/sandbox|sandbox]]
| #default = [{{fullurl:{{FULLPAGENAME}}/sandbox|action=edit}} sandbox] }}<!--end switch--> | [{{fullurl:{{FULLPAGENAME}}/sandbox|action=edit}} sandbox]}}<!--end if sandbox--> and {{#if: {{{testcases|}}} | {{#switch: {{#sub:{{lc:{{{testcases}}}}}|0|1}}
| y | t | 1 = [[{{FULLPAGENAME}}/testcases|test case]]
| #default = [{{fullurl:{{FULLPAGENAME}}/testcases|action=edit}} test case] }}<!--end switch--> | [{{fullurl:{{FULLPAGENAME}}/testcases|action=edit}} test case]}} pages.
{{!)}}
}}<!--end ifeq PAGENAME-->
{{#ifeq:{{PAGENAME}}|Documentation (copy)||
{{#if:{{{content|}}}|{{{content}}}|
{{#if:{{{1|}}}|{{{{{1}}}}}|{{:{{FULLPAGENAME}}/doc}}}}<!--end if 1-->
}}<!--end if content-->
}}<!--end ifeq PAGENAME-->
</includeonly><noinclude>
{{Documentation|SPW = is not relevant|SPW-link = Documentation (copy)|sandbox=yes|content= This is a version of Template:Documentation customized for Templates Wiki and so not designed to be copied to other wikis.


It acts identically to the usual Template:Documentation - and should be treated identically - except for a few particular cases.
It acts identically to the usual Template:Documentation - and should be treated identically - except for a few particular cases.

Revision as of 02:06, 1 November 2021