Difference between revisions of "Template:Documentation subpage"

From Teampedia
Jump to: navigation, search
Line 5: Line 5:
  
 
       -->{{#ifeq:{{{doc-notice|show}}} |show
 
       -->{{#ifeq:{{{doc-notice|show}}} |show
           | {{Mbox
+
           | {{ambox
 
             | type = notice
 
             | type = notice
             | style = margin-bottom:1.0em; background:#ecfcf4;
+
             | style = margin-bottom:1.0em;
             | image = [[File:Edit-copy-green.png|40px|alt=|link=]]
+
             | image = [[File:Edit-copy green.svg|40px|alt=|link=]]
 
             | 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:Subpage|subpage]] [[Wikipedia:Template documentation|documentation]] for {{{1|[[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}'''.<br /> This template contains usage information, [[Wikipedia:Categorization |categories]] and other content that is not part of {{#if:{{{text2|}}}|{{{text2}}} |{{#if:{{{text1|}}}|{{{text1}}} |{{#ifeq:{{SUBJECTSPACE}} |{{ns:User}} |{{lc:{{SUBJECTSPACE}}}} template page |{{#if:{{SUBJECTSPACE}} |{{lc:{{SUBJECTSPACE}}}} page|artikel}}}}}}}}.  
 
             }}
 
             }}
 
         }}<!--
 
         }}<!--
Line 19: Line 19:
 
           |  <includeonly><!--
 
           |  <includeonly><!--
 
               -->{{#ifexist:{{NAMESPACE}}:{{BASEPAGENAME}}
 
               -->{{#ifexist:{{NAMESPACE}}:{{BASEPAGENAME}}
                   | [[Category:{{#switch:{{SUBJECTSPACE}} |Template=Template |Module=Module |#default=}} documentation pages]]
+
                   | [[Category:Documentation page {{#switch:{{SUBJECTSPACE}} |Template=template|Module=module|User=the user |#default=Wikipedia}}]]
                   | [[Category:Documentation subpages without corresponding pages]]
+
                   | [[Category: Documentation subpage without related pages]]
 
                   }}<!--
 
                   }}<!--
 
           --></includeonly>
 
           --></includeonly>
Line 29: Line 29:
 
     | <!--(this template has not been transcluded on a /doc or /{{{override}}} page)-->
 
     | <!--(this template has not been transcluded on a /doc or /{{{override}}} page)-->
 
     }}<!--
 
     }}<!--
--></includeonly><noinclude>{{Documentation}}
+
--></includeonly><noinclude>{{Documentation}}</noinclude>
[[Category:Template documentation pages| ]]</noinclude>
+

Revision as of 22:06, 18 February 2020

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

Usage

{{documentation subpage}}

OR

{{documentation subpage|main page to link to}}

Customization of text

To manually change the text of the template, the "text1=your text here" and/or "text2=your other text here" parameters can be specified. "text1=" changes the automatic text on the first line to your own word(s). "text2=" changes the automatic text on the second line to your own word(s). If "text1=" parameter is specified without the "text2=" parameter, both the first and second line of text will be custom based on the text given in the "text1=" parameter.

Example usage:

{{documentation subpage|text1= custom first and second line text}}
{{documentation subpage|text2=custom second line text only}}
{{documentation subpage|text1=custom first line text|text2=custom second line text}}

How it is displayed

This template should 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 (ie, pages transcluding the "/doc" page), the template will not show. The template page itself (which contains {{Documentation}}) will automatically note that the documentation is transcluded from a subpage.

Functions

In addition to the output message, the template categorizes pages to Category:Template documentation, Category:User documentation, or similar (named after the subject space), but only for documentation pages in namespaces with the subpage feature. It defaults the sort key to the page name without namespace (ie, "Foo" on "Template:Foo", so it would be sorted in categories under 'F').

The above documentation is transcluded from Template:Documentation subpage/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Please add categories and interwikis to the /doc subpage. Subpages of this template.