Toggle menu
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Template:Documentation subpage: Difference between revisions

Template page
templatewiki>Rodejong
Updating and/or correcting
 
Created page with "{| |<div class="template-documentation"><div class="template-documentation-header" style="display: flex; align-items: center; justify-content: center;><!-- --><div>'''This is a template documentation subpage for {{{1|[[{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}.''' It contains usage information, categories, interlanguage links and other content that is not part of the original..."
Tag: Reverted
Line 1: Line 1:
<includeonly><!--
{|
-->{{#ifeq:{{lc:{{SUBPAGENAME}}}} |{{{override|doc}}}
|<div class="template-documentation"><div class="template-documentation-header" style="display: flex; align-items: center; justify-content: center;><!--
    | <!--(this template has been transcluded on a /doc or /{{{override}}} page)-->
--><div>'''This is a [[Help:Template documentation|template documentation]] [[mw:Help:Subpages|subpage]] for {{{1|[[{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}.'''
</includeonly><!--
It contains usage information, [[Help:Category|categories]], [[Help:Interlanguage links|interlanguage links]] and other content that is not part of the original {{#if: {{NAMESPACE}} | {{lc:{{NAMESPACE}}}}&nbsp;}}page.<!--
 
--></div><!--
      -->{{#ifeq:{{{doc-notice|show}}} |show
--><div class="mobile-hidden">&#91;[{{fullurl:{{FULLPAGENAME}}|action=purge }} purge]]</div><!--
          | {{Mbox
--></div></div>
            | type = notice
|}<!--
            | style = margin-bottom:1.0em;
            | image = [[File:Edit-copy green.svg|40px|alt=Documentation subpage|link=|Documentation subpage]]
            | text =
'''This is a documentation subpage''' for '''{{{1|[[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}'''.<br/> It contains usage information, [[mw:Help:Categories|categories]] and other content that is not part of the original {{#if:{{{text2|}}} |{{{text2}}} |{{#if:{{{text1|}}} |{{{text1}}} | page}}}}.
            }}
        }}<!--
 
      -->{{DEFAULTSORT:{{{defaultsort|{{PAGENAME}}}}}}}<!--
 
      -->{{#if:{{{inhibit|}}} |<!--(don't categorize)-->
          |  <includeonly><!--
              -->{{#ifexist:{{NAMESPACE}}:{{BASEPAGENAME}}
                  | [[Category:{{#switch:{{SUBJECTSPACE}} |Template=Template |Module=Module |User=User |#default=Wikipedia}} documentation pages]]
                  | [[Category:Documentation subpages without corresponding pages]]
                  }}<!--
          --></includeonly>
        }}<!--
 
(completing initial #ifeq: at start of template:)
--><includeonly>
--><includeonly>
    | <!--(this template has not been transcluded on a /doc or /{{{override}}} page)-->
{{#ifeq:{{SUBPAGENAME}}|doc|[[Category:Documentation templates|*]]}}</includeonly><!--
    }}<!--
--><noinclude>
--></includeonly><noinclude>{{Documentation}}</noinclude>
{{documentation}}
<!-- Put categories/interwiki on the documentation page -->
[[Category:Template documentation| ]]
</noinclude>

Revision as of 16:34, 16 June 2025

This is a template documentation subpage for Template:Documentation subpage. It contains usage information, categories, interlanguage links and other content that is not part of the original template page.
Documentation[view] [edit] [history] [purge]
This is a template documentation subpage for Template:Documentation subpage. It contains usage information, categories, interlanguage links and other content that is not part of the original template page.


Usage

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

Text customization

The parameters |text1= and |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: With text1 and text2: {{Documentation subpage |text1='''''text1 appears here''''' |text2='''''text2 appears here'''''}}

This is a template documentation subpage for [page] . It contains usage information, categories, interlanguage links and other content that is not part of the original template page.

With text2 only: {{Documentation subpage |text2='''''text2 appears here'''''}}

This is a template documentation subpage for [page] . It contains usage information, categories, interlanguage links and other content that is not part of the original template page.

With text1 only: {{Documentation subpage |text1='''''text1 appears here'''''}}

This is a template documentation subpage for [page] . It contains usage information, categories, interlanguage links and other content that is not part of the original template page.


Other parameters

|inhibit=yes will prevent this template from generating any categories. (By default, "Namespace documentation pages" (usually Category:Template documentation pages) is added, or Category:Documentation subpages without corresponding pages if the main page doesn't exist.)

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".

[view] [edit] [history] [purge]The above documentation is transcluded from Template:Documentation subpage/doc.