Difference between revisions of "Template:Documentation subpage"

From LIMSWiki
Jump to navigationJump to search
m (Updated version.)
m (Protected "Template:Documentation subpage" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)) [cascading])
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
<includeonly><!--
<includeonly>{{#ifeq: {{lc:{{SUBPAGENAME}}}} | {{{override|doc}}}
-->{{#ifeq:{{lc:{{SUBPAGENAME}}}} |{{{override|doc}}}
  | <!-- doc page -->
    | <!--(this template has been transcluded on a /doc or /{{{override}}} page)-->
</includeonly>{{
</includeonly><!--
    #ifeq: {{{doc-notice|show}}} | show
 
    | {{mbox
      -->{{#ifeq:{{{doc-notice|show}}} |show
      | type = notice
          | {{Mbox
      | image = [[File:Edit-copy green.svg|40px]]
            | type = notice
      | text =  
            | style = margin-bottom:1.0em;
'''This is a documentation subpage for {{{1|[[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}'''.<br />It contains usage information, [[LIMSWiki:Category guidelines|categories]], interlanguage links, 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}}}}}}}}.  
            | image = [[File:Edit-copy green.svg|40px|alt=|link=]]
      }}
            | text =
    }}{{DEFAULTSORT:{{{defaultsort|{{PAGENAME}}}}}}}{{
'''This is a [[LIMSWiki:Template documentation|documentation]] [[LIMSWiki:Subpages|subpage]] for {{{1|[[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}'''.<br />It contains usage information, [[LIMSWiki: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}}}}}}}}.  
    #if: {{{inhibit|}}}
            }}
    | <!-- skip -->
        }}<!--
    | <includeonly>[[Category:{{
 
      #if: {{SUBJECTSPACE}}
      -->{{DEFAULTSORT:{{{defaultsort|{{PAGENAME}}}}}}}<!--
      | {{SUBJECTSPACE}}
 
      | Article
      -->{{#if:{{{inhibit|}}} |<!--(don't categorize)-->
    }} documentation {{#ifeq:{{SUBJECTSPACE}}|Template|pages}}]]</includeonly>
          |   <includeonly><!--
  }}<includeonly>
              -->{{#ifexist:{{NAMESPACE}}:{{BASEPAGENAME}}
| <!-- if not on a /doc subpage, do nothing -->
                  | [[Category:{{#switch:{{SUBJECTSPACE}} |Template=Template |Module=Module |User=User |#default=LIMSwiki}} documentation pages]]
}}</includeonly><noinclude>
                  | [[Category:Documentation subpages without corresponding pages]]
{{documentation}}
                  }}<!--
<!-- Add categories and interwikis to the /doc subpage, not here! -->
          --></includeonly>
</noinclude>
        }}<!--
 
(completing initial #ifeq: at start of template:)
--><includeonly>
    | <!--(this template has not been transcluded on a /doc or /{{{override}}} page)-->
    }}<!--
--></includeonly><noinclude>{{Documentation}}</noinclude>

Latest revision as of 23:32, 26 January 2018

[edit] [purge] Template documentation

Usage

{{Documentation subpage}}
or
{{Documentation subpage |[[Page where the documentation transcluded]]}}

Userbox documentation

To set this template to use "userbox" and "userbox page" rather than "template" and "template page" or "user template" and "user template page", use:

{{Userbox documentation subpage}}
or
{{Userbox documentation subpage |[[userbox page]]}}

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:

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 (which contains {{Documentation}}) will automatically note that the documentation is transcluded from a subpage.

Functions

In addition to its message, the template adds pages to Category:Template documentation pages, Category:User documentation pages, 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: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".

tn:Template:Documentation subpage