Difference between revisions of "Template:Documentation subpage"

From Captain of Industry Wiki
Jump to: navigation, search
m
(Original message box replaced with Ambox. Internal formatting.)
Line 1: Line 1:
{|align="center" class="plainlinks noeditsection" style="font-size:90%; font-weight: bold; border: 2px solid DarkGray; background: #222222; width:95%; margin:0 auto; padding:0.25em 1em 0.25em 1em; clear: both;"
{{Ambox
|-valign="middle"
  | name    = Documentation subpage
|width="1px" style="padding-right: 1em"|[[File:Edit-copy green.svg|40px|link=]]
  | type    = notice
|style="font-weight:bold" | This is a {{#switch: {{SUBJECTSPACE}} | Template = template | Module = module | user = user page | #default = page }} documentation [[mw:Help:Subpages|subpage]] for {{{1|[[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}.<br />It contains usage information, [[Wikipedia:Help:Categories|categories]], <!-- [[w:Help:Interlanguage links|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}}}}}}}}.
  | small    = 0
|}<includeonly>{{#ifeq: {{SUBPAGENAME}} | doc | [[Category:{{#switch: {{SUBJECTSPACE}} | Template = Template | Module = Module | User = User | #default = Page }} documentation]]|}}</includeonly><noinclude>
  | image    = [[File:Edit-copy green.svg|40px|link=]]
{{Documentation}}</noinclude>
  | text    = <!--
  -->'''This is a {{#switch: {{SUBJECTSPACE}}
    | Template = template
    | Module = module
    | user = user page
    | #default = page }} <!--
  -->documentation [[mw:Help:Subpages|subpage]] for {{{1|[[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}.'''<br /><!--
  -->It contains usage information, [[Wikipedia:Help:Categories|categories]], <!--
  ** Interlanguage is currently not supported by this wiki **
  [[w:Help:Interlanguage links|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}}}}}}}}.<!--
-->}}<!-- end of Ambox.
 
--><includeonly><!--
  ** Only including a documentation category to the /doc subpage, preventing this inclusion from happening on the template/module page itself. **
  -->{{#ifeq: {{SUBPAGENAME}}
    | doc
    |  
 
[[Category:{{#switch: {{SUBJECTSPACE}}
      | Template = Template
      | Module = Module
      | User = User
      | #default = Page }} documentation]]
    |}}<!--
--></includeonly><!--
--><noinclude>{{Documentation}}</noinclude>

Revision as of 02:29, 1 May 2023

Template documentation (for the above template, sometimes hidden or invisible) [view] [edit] [history] [refresh]

Usage

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

Other parameters

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, 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: Template:Foo, for example, would be sorted as "Foo", i.e. under "F".
The above text is transcluded from Template:Documentation subpage/doc; you can change it or view its history. (How does this work?)
If you're done making changes, please refresh the text. (Why?)
You can experiment in this template's sandbox (create | mirror ) and testcases (create) pages.
Please add categories and interwikis to Template:Documentation subpage/doc. (View all subpages of this page.)