Template:Documentation subpage: Difference between revisions

From PZwiki
No edit summary
No edit summary
Line 2: Line 2:
   | <!-- doc page -->
   | <!-- doc page -->
{{#ifeq: {{{doc-notice|show}}} | show
{{#ifeq: {{{doc-notice|show}}} | show
     | {{mbox
     | {{NoticeBox
       | type = notice
       | color = #C0C0C0
       | image = [[File:Edit-copy green.png|48px]]
       | image = [[File:Notepad.png|32px]]
       | 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 documentation subpage for {{{1|[[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}'''.<br />It contains usage information 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}}}}}}}}.  
       }}
       }}
     }}{{DEFAULTSORT:{{{defaultsort|{{PAGENAME}}}}}}}{{
     }}{{DEFAULTSORT:{{{defaultsort|{{PAGENAME}}}}}}}{{
Line 17: Line 17:
       | User      = User
       | User      = User
       | #default  = PZwiki
       | #default  = PZwiki
     }} documentation pages]]|[[Category:Documentation subpages without corresponding pages]]}}
     }} documentation]]|[[Category:Documentation subpages without corresponding pages]]}}
   }}
   }}
| <!-- if not on a /doc subpage, do nothing -->
| <!-- if not on a /doc subpage, do nothing -->

Revision as of 16:37, 29 July 2018

[view] [edit] [history] [purge] Template documentation


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'''''}}

File:Notepad.png
This is a documentation subpage for [page] .
It contains usage information and other content that is not part of the original text2 appears here.


{{Documentation subpage |text2='''''text2 appears here'''''}}

File:Notepad.png
This is a documentation subpage for [page] .
It contains usage information and other content that is not part of the original text2 appears here.


{{Documentation subpage |text1='''''text1 appears here'''''}}

File:Notepad.png
This is a documentation subpage for [page] .
It contains usage information and other content that is not part of the original 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

Documentation transcluded from Template:Documentation subpage/doc.
Editors can experiment in this template's sandbox (create)