Documentation: Difference between revisions

From SL Pro Wrestling Wiki
/>Henstepl
Typo fix(es)
m 303 revisions imported
 
(72 intermediate revisions by 14 users not shown)
Line 1: Line 1:
<includeonly>{{#ifeq:{{SITENAME}}|Templates Wiki||<span style="color:red;">'''You don't want this version of the documentation template on your wiki! [{{fullurl:Template:Documentation}}?action=history Click here to revert it.]'''</span>
<includeonly>{| class="article-table plainlinks" style="width:100%;" role="complementary"
 
|- style="font-size:18px;"
For a documentation template you can use on your wiki, see [[w:c:templates:Template:Documentation (copy)]].}}
! style="padding:0px;" | <div style="width:100%; padding:3px 0px; text-align:center;" class="color1">Template documentation</div>
{{#ifeq:{{PAGENAME}}|Documentation (copy)||
|-
{{{!}} class="article-table" style="width:100%;" role="complementary"
| ''Note: portions of the template sample may not be visible without values provided.''
{{!}}- style="font-size:18px;"
|-
! style="padding:0px;" {{!}} <div style="width:100%; padding:3px 0px; text-align:center;" class="color1">Template documentation</div>
| View or edit [[{{{1|Template:{{PAGENAMEE}}/doc}}}|this documentation]]. ([[Template:Documentation|About template documentation]])
{{!}}-
|-
{{!}} ''Note: the template above may sometimes be partially or fully invisible.''
| Editors can experiment in this template's [{{fullurl:{{FULLPAGENAMEE}}/sandbox|action=edit}} sandbox] and [{{fullurl:{{FULLPAGENAMEE}}/testcases}} test case] pages.
{{!}}-
|}
{{!}} {{#if:{{{content|}}}|Edit [{{fullurl:{{FULLPAGENAME}}}}?action=edit this template for the documentation].|View or edit [[:{{#if:{{{1|}}}|{{{1}}}|{{FULLPAGENAME}}/doc}}|this documentation]].}} ([[Template:Documentation|How does this work?]])
<div style="margin:0 1em;">
{{!}}-
{{{{{1|{{PAGENAME}}/doc}}}}}</div></includeonly><noinclude>{{Documentation}}[[Category:Documentation templates]]</noinclude>
{{!}} 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] }} | [{{fullurl:{{FULLPAGENAME}}/sandbox|action=edit}} 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] }} | [{{fullurl:{{FULLPAGENAME}}/testcases|action=edit}} test case]}} pages.
{{!}}}
}}<!--
 
  Begin documentation blob. This blob is the ONLY thing returned if this template is called from Template:Documentation (copy).
 
-->{{#ifeq:{{SITENAME}}|Templates Wiki|<div style="margin:0 1em;"><div style="font-size:small;line-height:16px;">
{{#ifeq:{{{SPW}}}|is not relevant||
:'''''[{{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}}}&link7={{{dep3}}}/doc}}{{#if:{{{dep4|}}}
|&link9={{{dep4}}}&link8={{{dep4}}}/doc}} Export this template]''', then [[Help:Importing|import]], to install it.
:''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|}}}|, <!--
-->[{{FULLURL:{{{dep2}}}}}?action=edit {{{dep2}}}]<sup>[[Special:Export/{{{dep2}}}|export]]</sup>}}{{#if:{{{dep3|}}}|, <!--
-->[{{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|}}}|
:''This template is compatible with vanilla Mediawiki.''}}
 
:''{{#switch: {{{SPW|{{Template:Is SPW}}}}}
| is newer
| is newer than =
This template is newer than a similar one on [[w:c:starter:Template:{{{SPW-link|{{PAGENAME}}}}}|FANDOM starter pages]]. This template may therefore have bug fixes or improvements when compared to the older version.{{#ifeq: {{SITENAME}} | Templates Wiki | [[Category:Newer than on starter pages|{{PAGENAME}}]] }}
| is not relevant
| 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}}]] }}
| true <!-- Automatically checked against list of SPW templates at Template: Is SPW -->
| is on =
This template or a similar one is on [[w:c:starter:Template:{{{SPW-link|{{PAGENAME}}}}}|FANDOM starter pages]], whence it is incorporated in every new FANDOM site and can be copied to older ones. {{#ifeq: {{SITENAME}} | Templates Wiki | [[Category:From starter pages|{{PAGENAME}}]] }}
| is not on
| #default =
This template is not on [[w:c:starter:Template:{{PAGENAME}}|FANDOM starter pages]]. It can be copied to other FANDOM sites, but it is not included on any by default.
}}''</div>
</div>
{{#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}}]]}}}}}}
}}<!--
 
  End documentation blob
 
-->
{{#ifeq:{{PAGENAME}}|Documentation (copy)||
{{#if:{{{content|}}}|{{{content}}}|
{{#if:{{{1|}}}|{{{{{1}}}}}|{{{{FULLPAGENAME}}/doc}}}}
}}}}
</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.
* <code>content = </code> should the template have just a short blurb for documentation and not need a new page for it.
* <code>sandbox = yes</code> should the template have a /sandbox page.
* <code>testcases = yes</code> should the template have a /testcases page.
* If the template '''should transclude a documentation page other than its /doc subpage,''' use <code><nowiki>{{Documentation|documentation page}}</nowiki></code>.
*: You may also use <code><nowiki>{{Documentation|content=documentation goes here}}</nowiki></code> to include documentation without a subpage at all.
* If the template '''should be [[Help:Interlanguage links|interlanguage linked]] but at a different name,''' use <code><nowiki>{{Documentation|ja=Japanese name|zh=Chinese name}}</nowiki></code>.
*: You might instead create a [[Help:redirect|redirect]] on the foreign-language wiki from the name used on this wiki to theirs (and then update the relevant template in [[#Maintenance]]).
*: Interlanguage links to existing Japanese and Chinese pages are automatically inserted if their names are equivalent, in which case no parameter is needed.
* SPW
** <code>SPW=is newer than</code> - The template '''exists on [[w:c:starter:|FANDOM starter pages]] but has been upgraded'''.
** <code>SPW=is not relevant</code> - The template (such as this one) are not relevant to wikis other than Templates Wiki.
** The other possible relations to SPW - "<code>is not on</code>" and "<code>is on</code>" [and unchanged] are automatically inserted, in which cases no parameter is needed.
* <code>dep1=</code><code>dep2=</code><code>dep3=</code><code>dep4=</code> to name up to four dependency templates (include Template: prefix, no need to name /doc pages).
== Maintenance ==
* Periodically check [http://starter.wikia.com/index.php?title=Special%3AAllPages&from=&to=&namespace=10 the list of templates on FANDOM starter pages wiki] to see if the list encoded into [[:Template:Is SPW]] is up-to-date.
* Periodically check [http://ja.templates.wikia.com/index.php?title=Special%3AAllPages&from=&to=&namespace=10 the list of templates on Japanese Templates Wiki] to see if the list encoded into [[:Template:Is JA]] is up-to-date.
* Periodically check [http://zh.templates.wikia.com/index.php?title=Special%3AAllPages&from=&to=&namespace=10 the list of templates on Chinese Templates Wiki] to see if the list encoded into [[:Template:Is ZH]] is up-to-date.
}}[[Category:Documentation templates| ]]</noinclude>

Latest revision as of 08:12, 2 August 2024