Template

Difference between revisions of "Documentation subpage"

From Joomla! Documentation

m (1 revision(s))
m (updating)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<includeonly><!-- only show on documentation subpages -->
+
<noinclude>
{{#ifeq: {{lc:{{SUBPAGENAME}}}} | {{{override|doc}}} |
+
<!-- only show on documentation subpages -->
</includeonly><div class="messagebox" id="template_doc_page_viewed_directly" style="text-align: center">
+
{{ #ifeq: {{SUBPAGENAME}} | sandbox
This subpage contains [[Project:Template documentation|documentation]], [[Project:Categories|categories]] and other content that is not part of the template.<br /><span style="font-size:0.9em;">To view the {{lc:{{NAMESPACE}}}} page itself, see {{{1|[[{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}.</span></div>
+
  | {{Template sandbox notice}}
{{DEFAULTSORT:{{PAGENAME}}}}{{#if:{{{inhibit|}}}|<!-- skip -->|[[Category:Documentation subpages<noinclude>| </noinclude>]]}}
+
  | {{pp-template|small=yes}}
<includeonly>}}</includeonly><noinclude>
+
}}
 +
----
 +
</noinclude><includeonly>{{
 +
  #ifeq: {{lc:{{SUBPAGENAME}}}} | {{{override|doc}}}
 +
  | <!-- doc page -->
 +
</includeonly>{{
 +
    #ifeq: {{{doc-notice|show}}} | show
 +
    | <!-- doc-notice show --><div class="panel radius" id="template_doc_page_viewed_directly">'''This is a [[Project:Template documentation|documentation]] subpage for {{{1|[[{{SUBJECTSPACE}}:{{BASEPAGENAME}}]]}}}.'''<br />It contains usage information, [[Project:Categories|categories]] and other content that is not part of the original {{ #if: {{SUBJECTSPACE}} |{{lc:{{SUBJECTSPACE}}}} page|article}}.<br /><span style="font-size: 0.9em;">To view the {{ #if: {{SUBJECTSPACE}} |{{lc:{{SUBJECTSPACE}}}} page|article}} itself, see {{{1|[[{{ #if: {{SUBJECTSPACE}} |{{SUBJECTSPACE}}:}}{{BASEPAGENAME}}]]}}}.</span></div>
 +
    | <!-- doc-notice hide -->
 +
  }}{{DEFAULTSORT:{{PAGENAME}}}}{{
 +
    #if: {{{inhibit|}}}
 +
    | <!-- skip -->
 +
    | [[Category:{{
 +
      #if: {{SUBJECTSPACE}}
 +
      | {{SUBJECTSPACE}}
 +
      | Article
 +
    }} documentation<noinclude>|{{{order|!}}}</noinclude>]]
 +
  }}<includeonly>
 +
  |<!-- not doc -->
 +
}}</includeonly><noinclude>
 
{{documentation}}
 
{{documentation}}
 
<!-- Add categories and interwikis to the /doc subpage, not here! -->
 
<!-- Add categories and interwikis to the /doc subpage, not here! -->
 
</noinclude>
 
</noinclude>

Latest revision as of 19:26, 2 September 2013


This is a documentation subpage for Template:Documentation subpage.
It contains usage information, categories and other content that is not part of the original template page.
To view the template page itself, see Template:Documentation subpage.

[view] [edit] [history]

Template-info.pngTemplate documentation

Provides the header message on documentation subpages as featured in the {{documentation}} template.

Functions/Features[edit]

If used on a "/sandbox" subpage the template transcludes {{template sandbox notice}} otherwise {{pp-semi-template}} is transcluded by default. Like it's mother template, {{documentation}}, it is not restricted to the Template namespace.

Usage[edit]

Should be present on any documentation subpage.

{{documentation subpage}}

Parameters[edit]

Parameter Name Parameter Description req./opt.
override=otherpage to use another "documentation" page than /doc Optional
doc-notice=non-empty-value any value other then show (the default) will prevent display of the box message "This is a documentation subpage for..."" Optional
inhibit=non-empty-value any value provided will categorise the documentation page into [[Category:{{SUBJECTSPACE}} documentation]] or (for Main articles) into [[Category:Article documentation]] Optional

Stylesheet[edit]

CSS rules to include in [[MediaWiki::commons.js]] or [[MediaWiki::monobook.js]]

div.messagebox
#template_doc_page_viewed_directly