|
|
| Line 1: |
Line 1: |
| <onlyinclude><includeonly><!-- | | <noinclude> |
| - | | <languages/> |
| - Article Header | | </noinclude><includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude> |
| - | | {{documentation|content= |
| -->{{#ifeq: {{SITENAME}}|Templates Wiki||<!-- | | |
| --><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> | | {{Lua|Module:Documentation}} |
| For a documentation template you can use on your wiki, see [[w:c:templates:Template:Documentation (copy)|Template:Documentation (copy) on Templates Wiki]].</div>}}<!--
| | <translate><!--T:12--> This template automatically displays a documentation box like the one you are seeing now, of which the content is sometimes transcluded from another page.</translate> |
| | <translate><!--T:13--> It is intended for pages which are [[<tvar name=1>Special:MyLanguage/Help:Transclusion</tvar>|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.</translate> |
| | |
| | <translate> |
| | ==Usage== <!--T:2--> |
| | |
| | ===Customising display=== <!--T:3--> |
| | |
| | <!--T:4--> |
| | Overrides exist to customise the output in special cases: |
| | </translate> |
| | * <nowiki>{{</nowiki>documentation{{!}}'''heading'''=<nowiki>}}</nowiki> - <translate><!--T:5--> change the text of the "documentation" heading.</translate> <translate><!--T:10--> If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.</translate> |
| | |
| | <translate> |
| | ==Rationale== <!--T:6--> |
| | </translate> |
| | <translate><!--T:7--> This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation and categories.</translate> |
| | <translate><!--T:8--> It also reduces server resources by circumventing a [[w:Wikipedia:Template limits|technical limitation of templates]] (see a [[<tvar name=1>:en:Special:Diff/69888944</tvar>|developer's explanation]]).</translate> |
| | |
| | <translate> |
| | ==See also== <!--T:9--> |
| | </translate> |
| | * <translate><!--T:14--> [[w:Template:Documentation subpage]]</translate> |
| | * {{tim|Documentation}} |
| | * <translate><!--T:11--> [[w:Wikipedia:Template documentation]]</translate> |
|
| |
|
| --><div style="text-align:center;"><span style="font-size:large;">Template information, documentation, and installation instructions.</span><br/>
| |
| Expand the below text for usage and other information.</div>
| |
| ----<!--
| |
| -
| |
| - Documentation Transclusion
| |
| -
| |
| -->{{#if: {{{installonly|}}} |<!-- Hide doc page, useful for documentation templates -->|<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 [{{fullurl:{{{sandbox|{{FULLPAGENAME}}/sandbox}}}
| |
| | action=edit&redlink=1&preload=Template:Documentation/preload-sandbox<!--
| |
| -->&summary={{urlencode:Create sandbox version of [[{{FULLPAGENAME}}]]}}
| |
| }} sandbox] and [{{fullurl:{{{testcases|{{FULLPAGENAME}}/testcases}}}
| |
| | action=edit&redlink=1&preload=Template:Documentation/preload-testcases<!--
| |
| -->&summary={{urlencode:Create testcases subpage of [[{{FULLPAGENAME}}]]}}
| |
| }} testcases].
| |
| </div>
| |
| <!--
| |
| -
| |
| --><div style="background:none;" class="mw-collapsible-content">
| |
| {{Tocright}}
| |
| {{#if:{{{content|}}}
| |
| | {{{content}}}{{clear}}
| |
|
| |
| | {{#ifexist: {{{1|{{FULLPAGENAME}}/doc}}}
| |
| | {{#if: {{{1|}}}
| |
| |{{{{{1}}}}}
| |
| |{{<!---->{{FULLPAGENAME}}/doc}}}}{{clear}}
| |
| | 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}}] [[category:templates without documentation]].
| |
| }}<!--end if 1-->
| |
| }} | | }} |
| <!--end if content-->
| | [[Category:Formatting templates{{#translation:}}|Template documentation]] |
| }}
| | [[Category:Template documentation{{#translation:}}| ]] |
| </div></div><div style="display:none;">
| | </noinclude><includeonly>{{#if:{{{content|}}}| |
| ----
| | [[Category:Template documentation pages{{#translation:}}]] |
| </div><!--
| | }}</includeonly> |
| - 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 instructions" data-expandtext="Show install instructions">
| |
| <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
| |
| --><!--
| |
| -
| |
| - Main Text
| |
| -
| |
| --> Export this template]''', then [[w:Help:Importing and exporting pages|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.''}}
| |
| <!--
| |
| -
| |
| - is not relevant = Should be '''NOT''' copied
| |
| -
| |
| -->
| |
| :{{#switch: {{{SPW|}}}
| |
| | starter = This template is created by default after March 11, 2020. It should be in your wiki. [[Category:Starter templates]]
| |
| | is not relevant
| |
| | is not relevant to = [[File:Warning.svg|left|50px]]<!--
| |
| -->''This template should not be copied, 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]]
| |
| }}
| |
| }}
| |
| </div><!-- End Section --> | |
| <!--
| |
| -
| |
| - Interlanguage links
| |
| -
| |
| --><!--
| |
| - French
| |
| -->{{#if:{{{fr|}}}
| |
| |[[fr:{{{fr}}}]]
| |
| |
| |
| }}<!--
| |
| - Japanese
| |
| -->{{#if:{{{ja|}}}
| |
| |[[ja:{{{ja}}}]]
| |
| |
| |
| }}<!--
| |
| - Turkish
| |
| -->{{#if:{{{tr|}}}
| |
| |[[tr:{{{tr}}}]]
| |
| |
| |
| }}<!--
| |
| - Simplified Chinese
| |
| -->{{#if:{{{zh|}}}
| |
| |[[zh:{{{zh}}}]]
| |
| |
| |
| }}
| |
| <!--
| |
| -
| |
| - Installation Instructions
| |
| -
| |
| -->
| |
| {{#ifeq: {{{SPW}}}|is not relevant |
| |
| |{{#if: {{PROTECTIONEXPIRY: edit |{{{install|{{FULLPAGENAME}}/install}}}}}
| |
| | ''The above message will be enough for most cases; if there are additional instructions, you can see them below.''<br/><!--
| |
| --> {{<!---->{{{install|{{FULLPAGENAME}}/install}}}}}
| |
| | :There is no additional installation instructions 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></onlyinclude>
| |
| {{Documentation|SPW = is not relevant|SPW-link = Documentation (copy)|fr=Modèle:Documentation|ja=Template:Documentation|tr=Şablon:Belgelendirme|zh=Template:Documentation|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>installonly =</code> for documentation templates
| |
| * 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 [[w:Help:Interlanguage links|interlanguage linked]] but at a different name,''' use <code><nowiki>{{Documentation|fr=French name|ja=Japanese name|tr=Turkish name|zh=Chinese name}}</nowiki></code>.
| |
| *: You might instead create a [[w:Help:Redirect|redirect]] on the foreign-language wiki from the name used on this wiki to theirs.
| |
| * SPW
| |
| ** <code>SPW=is not relevant</code> - The template (such as this one) are not relevant to wikis other than Templates Wiki.
| |
| ** <code>SPW=starter</code> - The wikis after created on March 11, 2020 by default.
| |
| * <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).
| |
| }}[[Category:Documentation templates| ]]
| |
.svg){kind=link}
