Template:Documentation subpage: Difference between revisions
m (changed image icon from svg to png (svg not supported on pzwiki)) |
No edit summary |
||
Line 1: | Line 1: | ||
<includeonly>{{#ifeq: {{lc:{{SUBPAGENAME}}}} | {{{override|doc}}} | <includeonly>{{#ifeq: {{lc:{{SUBPAGENAME}}}} | {{{override|doc}}} | ||
| <!-- doc page --> | | <!-- doc page --> | ||
{{#ifeq: {{{doc-notice|show}}} | show | |||
| {{mbox | | {{mbox | ||
| type = notice | | type = notice | ||
| image = [[File:Edit-copy green.png| | | image = [[File:Edit-copy green.png|48px]] | ||
| text = | | text = | ||
'''This is a [[Wikipedia:Template documentation|documentation]] [[Wikipedia:Subpages|subpage]] for {{{1|[[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}'''.<br />It contains usage information, [[Wikipedia:Categorization|categories]] and other content that is not part of the original {{ #if: {{{text2|}}} | {{{text2}}} | {{ #if: {{{text1|}}} | {{{text1}}} | {{ #ifeq: {{SUBJECTSPACE}} | {{ns:User}} | {{lc:{{SUBJECTSPACE}}}} template page | {{ #if: {{SUBJECTSPACE}} |{{lc:{{SUBJECTSPACE}}}} page|article}}}}}}}}. | '''This is a [[Wikipedia:Template documentation|documentation]] [[Wikipedia:Subpages|subpage]] for {{{1|[[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}'''.<br />It contains usage information, [[Wikipedia:Categorization|categories]] and other content that is not part of the original {{ #if: {{{text2|}}} | {{{text2}}} | {{ #if: {{{text1|}}} | {{{text1}}} | {{ #ifeq: {{SUBJECTSPACE}} | {{ns:User}} | {{lc:{{SUBJECTSPACE}}}} template page | {{ #if: {{SUBJECTSPACE}} |{{lc:{{SUBJECTSPACE}}}} page|article}}}}}}}}. | ||
Line 12: | Line 11: | ||
#if: {{{inhibit|}}} | #if: {{{inhibit|}}} | ||
| <!-- skip --> | | <!-- skip --> | ||
| | | {{#ifexist:{{NAMESPACE}}:{{BASEPAGENAME}}|[[Category:{{ | ||
#switch: {{SUBJECTSPACE}} | #switch: {{SUBJECTSPACE}} | ||
| Template = Template | | Template = Template | ||
| Module = Module | | Module = Module | ||
| User = User | | User = User | ||
| #default = | | #default = PZwiki | ||
}} documentation pages]]|[[Category:Documentation subpages without corresponding pages]]}} | }} documentation pages]]|[[Category:Documentation subpages without corresponding pages]]}} | ||
}} | }} | ||
| <!-- if not on a /doc subpage, do nothing --> | | <!-- if not on a /doc subpage, do nothing --> | ||
}}</includeonly><noinclude> | }}</includeonly><noinclude> |
Revision as of 17:33, 21 May 2018
Usage
{{Documentation subpage}}
- or
{{Documentation subpage |[[Page where the documentation transcluded]]}}
Text customization
The parameters |text1=
and/or |text2=
can be used to set the text of, respectively, the template's first and second lines. If text1 is set but not text2, both lines' text will derive from text1:
{{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}}
{{Documentation subpage |text2='''''text2 appears here'''''}}
{{Documentation subpage |text1='''''text1 appears here'''''}}
Display
This template should normally be placed at the top of /doc pages. It changes output depending on where it is viewed:
- On a /doc page, it displays a box explaining template documentation and links to the template page.
- On other pages – i.e. pages transcluding the /doc page – the template will not show. The template page itself will automatically note that the documentation is transcluded from a subpage.
See also
Editors can experiment in this template's sandbox (create)