Template:Documentation: Difference between revisions

From Vigyanwiki
(Now uses /core. Doc links now in a box below the main doc box. Link /sandbox and /testcases also when they don't exist, with (create) links with preload. See talkpage, section "Documentation/links".)
m (1 revision imported)
 
(62 intermediate revisions by 26 users not shown)
Line 1: Line 1:
<!--
<noinclude>
  Automatically add {{template sandbox notice}} when on a /sandbox page.
<languages/>
-->{{#ifeq: {{SUBPAGENAME}} | sandbox
</noinclude><includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude>
| <div style="clear: both;"></div>{{template sandbox notice}}
{{documentation|content=
}}<!--
  Automatically add {{pp-template}} to protected templates.
-->{{template other
| {{#ifeq: {{PROTECTIONLEVEL:move}} | sysop
  | {{pp-template}}
  | {{#if: {{PROTECTIONLEVEL:edit}}
    | {{pp-template}}
    | <!--Not protected, or only semi-move-protected-->
    }}
  }}
}}<!--
  Start of green doc box.
-->{{documentation/core
| heading = {{{heading|¬}}}  <!--Empty but defined means no header-->
| heading-style = {{{heading-style|}}}
| content = {{{content|}}}
| docpage =
  {{#if: {{{1|}}}
  | {{{1|}}}
  | {{#switch: {{SUBPAGENAME}}
    | sandbox
    | testcases = {{#rel2abs: ../doc }}
    | #default = {{SUBJECTPAGENAME}}/doc
    }}
  }}
| doc exist =
  {{#ifexist:
    {{#if: {{{1|}}}
    | {{{1|}}}
    | {{#switch: {{SUBPAGENAME}}
      | sandbox
      | testcases = {{#rel2abs: ../doc }}
      | #default = {{SUBJECTPAGENAME}}/doc
      }}
    }}
  | yes
  }}
| sandbox =
  {{#switch: {{SUBPAGENAME}}
  | sandbox
  | testcases = {{#rel2abs: ../sandbox }}
  | #default = {{FULLPAGENAME}}/sandbox
  }}
| testcases =
  {{#switch: {{SUBPAGENAME}}
  | sandbox
  | testcases = {{#rel2abs: ../testcases }}
  | #default = {{FULLPAGENAME}}/testcases
  }}
}}<!--End of green doc box--><noinclude>


<!-- Add categories and interwikis to the /doc subpage, not here! -->
{{Lua|Module:Documentation}}
</noinclude>
<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>
 
}}
[[Category:Formatting templates{{#translation:}}|Template documentation]]
[[Category:Template documentation{{#translation:}}| ]]
</noinclude><includeonly>{{#if:{{{content|}}}|
[[Category:Template documentation pages{{#translation:}}]]
}}</includeonly>

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’