Template:Documentation subpage: Difference between revisions

From PZwiki
No edit summary
m (Update image link)
Line 4: Line 4:
     | {{NoticeBox
     | {{NoticeBox
       | color = #C0C0C0
       | color = #C0C0C0
       | image = [[File:Notepad.png|32px]]
       | image = [[File:Notebook.png|32px]]
       | text =  
       | text =  
'''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}}}}}}}}.  
'''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}}}}}}}}.  

Revision as of 22:45, 25 April 2023

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

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

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

Notebook.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)