Difference between revisions of "Template:Documentation"

From Confrontation.wiki
Jump to navigation Jump to search
imported>Malyctenar
(I'm pretty sure people know that clicking on the blue pagename link thingy makes them see it; also no need to test SUBPAGENAME within noinclude of a single template)
m (2 revisions imported)
 
(285 intermediate revisions by more than 100 users not shown)
Line 1: Line 1:
<noinclude>
<noinclude>
{{pp-semi-template|small=yes}}
<languages/>
{{intricate}}
</noinclude><includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude>
<!-- Moved to: Template:Documentation, template
{{documentation|content=
    {{Mergingfrom|Template doc|date=November 2007}}
 
    [[User:ConradPino]] 21:45, 9 November 2007 (UTC)
{{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>
</noinclude><div class="template-documentation">{{
<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>
  #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">{{
<translate>
    #ifexist: {{{1|{{Documentation/docname}}}}}
==Usage== <!--T:2-->
    |<!-- /doc exists -->[[{{fullurl:{{{1|{{Documentation/docname}}}}}}} view]] [[{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit}} edit]]
 
    |<!-- no /doc -->{{
===Customizing display=== <!--T:3-->
      #if: {{{content|}}}
 
      |
<!--T:4-->
      |<!-- only if no content, then -->[[{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit&preload={{{preload-doc|Template:Documentation/preload}}}}} edit]]
Overrides exist to customize the output in special cases:
    }}<!-- endif content, follows endifexist /doc  -->
</translate>
  }}</span> <span style="{{{heading-style|font-size: 150%}}}">{{{heading|Documentation}}}</span></div>
* <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>
<!-- follows endif heading: if empty, all of the above is skipped -->
 
}}<div id="template_doc_page_transcluded" class="dablink plainlinks">{{
<translate>
  #ifeq: {{{transcluded|show}}} | show
==Rationale== <!--T:6-->
  |<!-- transcluded show -->{{
</translate>
    #ifexist: {{{1|{{Documentation/docname}}}}}
<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, categories, and interwiki links.</translate>
    |<!-- /doc exists -->This [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from [[{{{1|{{Documentation/docname}}}}}]]. <small style="font-style: normal">([{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit}} edit] &#124; [{{fullurl:{{{1|{{Documentation/docname}}}}}|action=history}} history])</small><br />
<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>
  }}<!-- endifexist /doc;
 
            follows
<translate>
  endif transcluded = show : if hide, this was skipped -->
==See also== <!--T:9-->
}}{{
</translate>
  #switch: {{SUBPAGENAME}}
* <translate><!--T:14--> [[w:Template:Documentation subpage]]</translate>
  |sandbox=<!-- sandbox -->
* {{tim|Documentation}}
  |testcases=<!-- testcases -->
* <translate><!--T:11--> [[w:Wikipedia:Template documentation]]</translate>
  |#default={{
 
    #switch: {{SUBJECTSPACE}}/{{{sandbox-testcases|show}}}
}}
    |{{ns:template}}/show
[[Category:Formatting templates{{#translation:}}|Template documentation]]
    | {{ns:user}}/show =<!-- show experiment subpages -->This template has {{
[[Category:Template documentation{{#translation:}}| ]]
      #ifexist: {{ #rel2abs: /sandbox }}
</noinclude><includeonly>{{#if:{{{content|}}}|
      |<!-- /sandbox -->a [[/sandbox|sandbox]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /sandbox }}|action=edit}} edit])</small> {{
[[Category:Template documentation pages{{#translation:}}]]
        #ifexist: {{ #rel2abs: /testcases }}
}}</includeonly>
        | and [[/testcases|testcases]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /testcases }}|action=edit}} edit])</small>
        | but '''no''' [{{fullurl:{{ #rel2abs: /testcases }}|action=edit&preload={{{preload-testcases|Template:Documentation/preload/testcases}}}}} testcases]
      }}
      |<!-- no /sandbox -->'''no''' [{{fullurl:{{ #rel2abs: /sandbox }}|action=edit&preload={{{preload-sandbox|Template:Documentation/preload/sandbox}}}}} sandbox] {{
        #ifexist: {{ #rel2abs: /testcases }}
        |<!-- no /sandbox AND /testcases -->but has [[/testcases|testcases]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /testcases }}|action=edit}} edit])</small>
        |<!-- no /sandbox AND no /testcases -->and '''no''' [{{fullurl:{{ #rel2abs: /testcases }}|action=edit&preload={{{preload-testcases|Template:Documentation/preload/testcases}}}}} testcases]
        }}
    }} for editors to experiment.
    |<!-- hide experiment subpages: follow both endcases-->
  }}
}}</div>
{{{content|{{ {{ #ifexist: {{{1|{{Documentation/docname}}}}} | {{{1|{{Documentation/docname}}}}} | ns:0 }} }}}}}
</div>

Latest revision as of 08:28, 19 July 2021


Template documentation

Template:Lua This template automatically displays a documentation box like the one you are seeing now, of which the content is sometimes transcluded from another page. It is intended for pages which are 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:

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

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. It also reduces server resources by circumventing a technical limitation of templates (see a developer's explanation).

See also

Editors can experiment in this template’s sandbox (create | mirror) and testcases (create) pages.
Subpages of this template.
Retrieved from "https://confrontation.wiki/index.php?title=Template:Documentation&oldid=2272"