Difference between revisions of "Template:Documentation subpage"

From PortlandWiki
Jump to: navigation, search
m (127 revisions: Source: http://meta.wikimedia.org/wiki/Template:If)
(fix categorisation)
Line 1: Line 1:
<includeonly>{{ #ifeq:{{SUBPAGENAME}}|{{ #ifeq: {{{1}}}|override|{{SUBPAGENAME}}|doc}}|</includeonly><!-- show on doc pages only
+
<includeonly>{{#ifeq: {{lc:{{SUBPAGENAME}}}} | {{{override|doc}}}
--><div class="messagebox" style="text-align:center">
+
  | <!-- doc page -->
This [[template:documentation|documentation subpage]] contains instructions, categories, or other information for [[w:Project:Transclusion costs and benefits|technical reasons]].<br /><small>To view the {{SUBJECTSPACE}} page itself, see {{{1|[[{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}.</small>
+
</includeonly>{{
</div>{{{category|[[Category:Template documentation|<noinclude> </noinclude><includeonly>{{PAGENAME}}</includeonly>]]}}}
+
    #ifeq: {{{doc-notice|show}}} | show
<includeonly>}}</includeonly><noinclude><!--
+
    | {{mbox
-->
+
      | type = notice
 +
      | image = [[File:Edit-copy green.svg|40px]]
 +
      | text =
 +
'''This is a [[Wikipedia:Template documentation|documentation]] [[Wikipedia:Subpages|subpage]] for {{{1|[[:{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}'''.<br />It contains usage information, [[Wikipedia:Categorization|categories]], [[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}}}}}}}}.  
 +
      }}
 +
    }}{{DEFAULTSORT:{{{defaultsort|{{PAGENAME}}}}}}}{{
 +
    #if: {{{inhibit|}}}
 +
    | <!-- skip -->
 +
    | <includeonly>{{#ifexist:{{NAMESPACE}}:{{BASEPAGENAME}}|[[Category:{{
 +
      #switch: {{SUBJECTSPACE}}
 +
      | Template = Template
 +
      | User      = User
 +
      | #default  = Wikipedia
 +
    }} documentation pages]]|[[Category:Documentation subpages without corresponding pages]]}}</includeonly>
 +
  }}<includeonly>
 +
| <!-- if not on a /doc subpage, do nothing -->
 +
}}</includeonly><noinclude>
 
{{documentation}}
 
{{documentation}}
<!--
+
<!-- Add categories and interwikis to the /doc subpage, not here! -->
--></noinclude>
+
</noinclude>

Revision as of 00:52, 19 December 2011

[edit] [history] [purge] 50px Template documentation

Usage

{{documentation subpage}}

OR

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

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), it notes that the documentation is transcluded from a subpage.

Functions

In addition to the output message, the template categorizes pages to Category:Template documentation. 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').

See also

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.