Template:Documentation: Difference between revisions

From Vigyanwiki
(merging: copy from sandbox; new content parameter, better sandbox testcases links)
m (1 revision imported)
 
(124 intermediate revisions by 54 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 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>
 
}}
}}
{{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|{{SUBJECTPAGENAME}}/doc}}}
    |<!-- /doc exists -->[[{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}}} view]] [[{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=edit}} edit]]
    |<!-- no /doc -->{{
      #if: {{{content|}}}
      |<!-- has content -->
      |<!-- no content -->[[{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=edit&preload=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|{{SUBJECTPAGENAME}}/doc}}}
    |<!-- /doc exists -->This [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from [[{{{1|{{SUBJECTPAGENAME}}/doc}}}]]. <small style="font-style: normal">([[{{{1|{{SUBJECTPAGENAME}}/doc}}}|view]] &#124; [{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=edit}} edit] &#124; [{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=history}} history])</small><br />
    |<!-- no /doc -->
  }}
  |<!-- transcluded hide -->
}}{{
  #switch: {{SUBPAGENAME}}
  |sandbox=<!-- sandbox -->
  |testcases=<!-- testcases -->
  |#default={{
    #switch: {{SUBJECTSPACE}}
    |{{ns:template}}|{{ns:user}}=<!-- show /sandbox /testcases -->This template has {{
      #ifexist: {{ #rel2abs: /sandbox }}
      |<!-- /sandbox -->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])</small>
        |<!-- /sandbox AND no /testcases -->but '''no''' [{{fullurl:{{ #rel2abs: /testcases }}|action=edit}} 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 /sandbox /testcases -->
  }}
}}</div>
{{{content|{{ {{ #ifexist: {{{1|{{SUBJECTPAGENAME}}/doc}}} | {{{1|{{SUBJECTPAGENAME}}/doc}}} | ns:0 }} }}}}}
</div>

Latest revision as of 18:25, 18 September 2023

<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 name=1>Special:MyLanguage/Help:Transclusion</tvar>|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.</translate>

<translate>

Usage

Customising display

Overrides exist to customise 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

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

<translate>

See also

</translate>

Editors can experiment in this template’s sandbox (create | mirror) and testcases (create) pages.
Subpages of this template.

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

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

Retrieved from ‘https://www.vigyanwiki.in/index.php?title=Template:Documentation&oldid=258418’