|
|
| (34 intermediate revisions by 6 users not shown) |
| Line 1: |
Line 1: |
| <includeonly> | | <includeonly>{| class="article-table plainlinks" style="width:100%;" role="complementary" |
| <!-- Checks if you are in Documentation (copy) -->
| | |- style="font-size:18px;" |
| {{#ifeq: {{PAGENAME}}|Documentation (copy)||<!--
| | ! style="padding: 0px;" | <div style=" width: 100%; padding: 3px 0px; text- align: center;" class=" color1"> Template documentation< /div> |
| -
| | |- |
| - Article Header
| | | ''Note: portions of the template sample may not be visible without values provided.'' |
| -
| | |- |
| -->{{#ifeq: {{SITENAME}}|Templates Wiki||<!--
| | | View or edit [[{{{1|Template:{{PAGENAMEE}}/doc}}}|this documentation]]. ([[Template:Documentation|About template documentation]]) |
| --><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>
| | |- |
| For a documentation template you can use on your wiki, see [[w:c:templates:Template:Documentation (copy)|Template:Documentation (copy) on Templates Wiki]].</div>}}<!--
| | | Editors can experiment in this template's [{{fullurl:{{FULLPAGENAMEE}}/sandbox|action=edit}} sandbox] and [{{fullurl:{{FULLPAGENAMEE}}/testcases}} test case] pages. |
| | | |} |
| --><div style="text-align:center;"><span style="font-size:large;">Template information, documentation, and installation instructions.</span><br/> | | <div style="margin:0 1em;"> |
| Expand the below text for usage and other information.</div><!--
| | {{{{{1|{{PAGENAME}}/doc}}}}}</div></includeonly><noinclude>{{Documentation}}[[Category:Documentation templates]]</noinclude> |
| -
| |
| - Documentation Transclusion
| |
| -
| |
| --><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 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;clear: both;">
| |
| {{#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}}<!--
| |
| - Alt text
| |
| -->:<span style="font-size:80%;">''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?]]''</span><!--
| |
| -
| |
| - 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}}}}}
| |
| | is newer | is newer than =
| |
| [[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}}]]
| |
| }}
| |
| | is not relevant
| |
| | is not relevant to = [[File:Warning.svg|left|50px]]<!--
| |
| -->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 =
| |
| [[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
| |
| | #default = <!--
| |
| -->[[w:c:templates:Help:Starter pages|This template is probably not already on your wiki.]]
| |
| }}''
| |
| </div><!-- End Section -->
| |
| <!--
| |
| -
| |
| - Interlanguage links
| |
| -
| |
| --><!--
| |
| - 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
| |
| -
| |
| -->
| |
| <!-- Checks if you are in Documentation (copy) -->
| |
| {{#ifeq: {{FULLPAGENAME}}|Template:Documentation (copy)||
| |
| {{#ifeq: {{{SPW}}}|is not relevant |
| |
| |{{#ifexist: {{{install|{{FULLPAGENAME}}/install}}}
| |
| | ''The above message will be enough for most cases; if there are addtional insturctions, you can see them below.''<br/><!--
| |
| --> {{<!---->{{{install|{{FULLPAGENAME}}/install}}}}}
| |
| | :There is no addtional installation instuctions for this template. If there is any, you may create it at [{{fullurl:
| |
| {{{install|{{FULLPAGENAME}}/install}}}
| |
| |action=edit&preload=Template:Documentation/preload-install<!--
| |
| -->}} {{{install|{{FULLPAGENAME}}/install}}}].
| |
| }} | |
| }} | |
| </div></div>}}</includeonly><noinclude> | |
| {{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.
| |
| | |
| 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> | |
