Template:Documentation: Difference between revisions

From Laserwiki
Jump to navigation Jump to search
(if there isn't any, nobody cares. stop spamming "NO sandbox and NO testcases" on every template page when both of these things are pointless)
m (360 revisions imported)
 
(269 intermediate revisions by more than 100 users not shown)
Line 1: Line 1:
<noinclude>
<noinclude>
{{ #ifeq: {{SUBPAGENAME}} | sandbox
<languages/>
  | {{Template sandbox notice}}
</noinclude><includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude>
  | {{pp-semi-template|small=yes}}
{{documentation|content=
 
{{Lua|Module:Documentation}}
<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|1>Special:MyLanguage/Help:Transclusion</>|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.
 
==Usage== <!--T:2-->
 
===Customizing display=== <!--T:3-->
 
<!--T:4-->
Overrides exist to customize 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-->
 
<!--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, categories, and interwiki links.</translate>
<translate>
<!--T:8-->
It also reduces server resources by circumventing a [[w:Wikipedia:Template limits|technical limitation of templates]] (see a [[<tvar|1>:en:Special:Diff/69888944</>|developer's explanation]]).
 
==See also== <!--T:9-->
</translate>
* <translate><!--T:14--> [[w:Template:Documentation subpage]]</translate>
* {{tim|Documentation}}
* <translate><!--T:11--> [[w:Wikipedia:Template documentation]]</translate>
 
}}
}}
{{intricate}}
[[Category:Formatting templates{{#translation:}}|Template documentation]]
{{
[[Category:Template documentation{{#translation:}}| ]]
  #ifeq: {{FULLPAGENAME}} | Template:Documentation |
</noinclude><includeonly>{{#if:{{{content|}}}|
  <!-- Moved to: Template:Documentation, template
[[Category:Template documentation pages{{#translation:}}]]
    {{Mergingfrom|Template doc|date=November 2007}}
}}</includeonly>
    [[User:ConradPino]] 21:45, 9 November 2007 (UTC)
  -->
}}
</noinclude><div class="template-documentation">{{
  #if: {{{heading|Documentation}}}
  |<!-- has heading --><div style="padding-bottom: {{{heading-padding|3px}}}; border-bottom: 1px solid #aaa; margin-bottom: {{{heading-margin|1ex}}}"><span class="editsection plainlinks" id="doc_editlinks">{{
    #ifexist: {{{1|{{Documentation/docname}}}}}
    |<!-- /doc exists -->[[{{fullurl:{{{1|{{Documentation/docname}}}}}}} view]] [[{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit}} edit]]
    |<!-- no /doc -->{{
      #if: {{{content|}}}
      |<!-- has content -->
      |<!-- no content -->[[{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit&preload={{{preload-doc|Template:Documentation/preload}}}}} edit]]
    }}
  }}</span> <span style="{{{heading-style|font-size: 150%}}}">{{{heading|Documentation}}}</span></div>
  |<!-- empty heading -->
}}<div id="template_doc_page_transcluded" class="dablink plainlinks">{{
  #ifeq: {{{transcluded|show}}} | show
  |<!-- transcluded show -->{{
    #ifexist: {{{1|{{Documentation/docname}}}}}
    |<!-- /doc exists -->This [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from [[{{{1|{{Documentation/docname}}}}}]]. <small style="font-style: normal">(<!--[[{{{1|{{Documentation/docname}}}}}|view]] &#124; -->[{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit}} edit] &#124; [{{fullurl:{{{1|{{Documentation/docname}}}}}|action=history}} history])</small><br />
    |<!-- no /doc -->
  }}
  |<!-- transcluded hide -->
}}{{
  #switch: {{SUBPAGENAME}}
  |sandbox=<!-- sandbox -->
  |testcases=<!-- testcases -->
  |#default={{
    #switch: {{SUBJECTSPACE}}/{{{sandbox-testcases|show}}}
    |{{ns:template}}/show|{{ns:user}}/show=<!-- show /sandbox /testcases -->This template has {{
      #ifexist: {{ #rel2abs: /sandbox }}
      |<!-- /sandbox -->This template has a [[/sandbox|sandbox]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /sandbox }}|action=edit}} edit])</small> {{
        #ifexist: {{ #rel2abs: /testcases }}
        |<!-- /sandbox AND /testcases -->and [[/testcases|testcases]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /testcases }}|action=edit}} edit]) for editors to experiment.</small>
        |<!-- /sandbox AND no /testcases --> for editors to experiment.}}
      |<!-- no /sandbox -->{{
        #ifexist: {{ #rel2abs: /testcases }}
        |<!-- no /sandbox AND /testcases -->This template has [[/testcases|testcases]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /testcases }}|action=edit}} edit]) for editors to experiment.</small>
        |<!-- no /sandbox AND  no /testcases -->}}
    }}
    |<!-- hide /sandbox /testcases -->
  }}
}}</div>
{{{content|{{ {{ #ifexist: {{{1|{{Documentation/docname}}}}} | {{{1|{{Documentation/docname}}}}} | ns:0 }} }}}}}
</div>

Latest revision as of 18:24, 17 September 2020

<languages/>

Template documentation

<translate> 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> It is intended for pages which are [[<tvar|1>Special:MyLanguage/Help:Transclusion</>|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.

Usage

Customizing display

Overrides exist to customize the output in special cases: </translate>

  • {{documentation|heading=}} - <translate> change the text of the "documentation" heading.</translate> <translate> If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.</translate>

<translate>

Rationale

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, categories, and interwiki links.</translate> <translate> It also reduces server resources by circumventing a technical limitation of templates (see a [[<tvar|1>:en:Special:Diff/69888944</>|developer's explanation]]).

See also

</translate>

[[Category:Template documentation pages{{#translation:}}]]

[[Category:Formatting templates{{#translation:}}|Template documentation]] [[Category:Template documentation{{#translation:}}| ]]