Documentation: Difference between revisions

From SL Pro Wrestling Wiki
/>Henstepl
+ Template documentation
m 303 revisions imported
 
(118 intermediate revisions by 16 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"
 
For a documentation template you can use on your wiki, see [[w:c:templates:Template:Documentation (copy)]].}}
{| class="article-table" style="width:100%;" role="complementary"
|- style="font-size:18px;"
|- style="font-size:18px;"
! style="padding:0px;" | <div style="width:100%; padding:3px 0px; text-align:center;" class="color1">Template documentation</div>
! style="padding:0px;" | <div style="width:100%; padding:3px 0px; text-align:center;" class="color1">Template documentation</div>
|-
|-
| ''Note: the template above may sometimes be partially or fully invisible.''
| ''Note: portions of the template sample may not be visible without values provided.''
|-
|-
| Visit {{#if:{{{1|}}}|[[:{{{1}}}]]|[[:{{FULLPAGENAME}}/doc]]}} to edit this documentation. ([[Template:Documentation|How does this work?]])
| View or edit [[{{{1|Template:{{PAGENAMEE}}/doc}}}|this documentation]]. ([[Template:Documentation|About template documentation]])
|-
| Editors can experiment in this template's [{{fullurl:{{FULLPAGENAMEE}}/sandbox|action=edit}} sandbox] and [{{fullurl:{{FULLPAGENAMEE}}/testcases}} test case] pages.
|}
|}
{{#ifeq:{{SITENAME}}|Templates Wiki|<div style="margin:0 1em;"><div style="font-size:small;line-height:16px;">
<div style="margin:0 1em;">
:''{{#switch: {{{SPW|{{subst:Template:Is SPW}}}}}
{{{{{1|{{PAGENAME}}/doc}}}}}</div></includeonly><noinclude>{{Documentation}}[[Category:Documentation templates]]</noinclude>
| is newer
| is newer than =
This template is newer than a similar one on [[w:c:starter:Template:{{{SPW-link|{{PAGENAME}}}}}|the Starter Pages Wikia]]. 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 Wikia|{{PAGENAME}}]] }}
| is not relevant
| is not relevant to =
This template is not on [[w:c:starter|the Starter Pages Wikia]] because it is probably not relevant to wikis other than Templates Wikia. '''You probably don't want to copy this template to your wiki.''' {{#if:{{{SPW-link|}}}|For a similar template intended to be copied, see [[:{{{SPW-link}}}]].}} {{#ifeq: {{SITENAME}} | Templates Wiki | [[Category:Templates Wikia 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:{{PAGENAME}}|the Starter Pages Wikia]], whence it is incorporated in every new Wikia site and can be copied to older ones. {{#ifeq: {{SITENAME}} | Templates Wiki | [[Category:From Starter Pages Wikia|{{PAGENAME}}]] }}
| is not on     
| #default =
This template is not on [[w:c:starter:Template:{{PAGENAME}}|the Starter Pages Wikia]]. It can be copied to other Wikia sites, but it is not included on any by default.{{#ifeq: {{SITENAME}} | Templates Wiki | [[Category:Not on Starter Pages Wikia]] }}
}}''
{{#ifeq:{{{SPW}}}|is not relevant||
:''To install it, copy [{{FULLURL:{{FULLPAGENAME}}}}?action=edit this template]<sup>[[Special:Export/{{{SPW-link|{{FULLPAGENAME}}}}}|export]]</sup> and [{{FULLURL:{{FULLPAGENAME}}/doc}}?action=edit its documentation]<sup>[[Special:Export/{{{SPW-link|{{FULLPAGENAME}}}}}/doc|export]]</sup> to '''{{{SPW-link|{{FULLPAGENAME}}}}}'''  and '''{{{SPW-link|{{FULLPAGENAME}}}}}/doc''' on your wiki. [[Help:How_to_copy_templates_to_your_wiki|Need help?]]''{{#if:{{{dep1|}}}|
:''Copy also'' <!--
-->[{{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 location{{#if:{{{dep2|}}}|(s) on your wiki.}}}}
:''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.''}}
}}</div>
</div>
{{#if:{{{ja|}}}|[[ja:{{{ja}}}]]|{{#if:{{subst:Template:Is JA}}|[[ja:Template:{{PAGENAME}}]]}}}}
{{#if:{{{zh|}}}|[[zh:{{{zh}}}]]|{{#if:{{subst:Template:Is ZH}}|[[zh:Template:{{PAGENAME}}]]}}}}
}}
{{#if:{{{content|}}}|{{{content}}}|
{{#if:{{{1|}}}|{{{{{1}}}}}|{{{{FULLPAGENAME}}/doc}}}}
}}
</includeonly><noinclude>
{{Documentation|SPW = is not relevant|SPW-link = Template:Documentation (copy)|ja=Template:Documentation|zh=Template:Documentation|content=
This is a version of Template:Documentation customized for Wikia Templates 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.
#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.
#If the template '''exists on [[w:c:starter:|Starter Pages Wikia]] but has been upgraded,''' use <code><nowiki>{{Documentation|SPW=is newer than}}</nowiki></code>.
#:The other possible relations to SPW - "is not on" and "is on" [and unchanged] are automatically inserted, in which cases no parameter is needed.
#:Some templates (such as this one) are not relevant to wikis other than Wikia Templates: these can be marked by <code><nowiki>{{Documentation|SPW=is not relevant}}</nowiki></code>.
 
== Maintenance ==
* Periodically check [http://starter.wikia.com/index.php?title=Special%3AAllPages&from=&to=&namespace=10 the list of templates on 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.
** When modifying this template, use caution in modifying the calls for these three templates. They are specifically coded to not register as template dependencies, so they are not included when templates on this wiki are exported.
}}[[Category:Template documentation Templates]]
 
</noinclude>

Latest revision as of 09:12, 2 August 2024