No edit summary |
m (Copy from mediawiki Template:Documentation) |
||
| Line 1: | Line 1: | ||
{{ | <includeonly><!-- | ||
| heading = {{{heading|¬}}} | Automatically add {{template sandbox notice}} when on a /sandbox page. | ||
-->{{#ifeq: {{SUBPAGENAME}} | sandbox | | |||
<div style="clear:both" /> | |||
{{Template sandbox notice|{{{livepage|}}}}} | |||
}}<!-- | |||
Start of green doc box. | |||
-->{{Documentation/start box2 | |||
| preload = {{{preload|}}}<!-- Allow custom preloads --> | |||
| heading = {{{heading|¬}}}<!-- Empty but defined means no header --> | |||
| heading-style = {{{heading-style|}}} | | heading-style = {{{heading-style|}}} | ||
| content = {{{content|}}} | | content = {{{content|}}} | ||
| | | docspace = {{documentation/docspace}}<!-- Some namespaces must have the /doc, /sandbox and /testcases in talk space --> | ||
| 1 = {{{1|}}}<!-- Other docname, if fed --> | |||
<!--Some namespaces must have the /doc, /sandbox and /testcases | | lang = {{{lang|}}} | ||
| template page = {{documentation/template page}}<!-- The namespace is added in /start box2 --> | |||
| | }}<!-- | ||
{{#switch: {{ | Start load the /doc content: | ||
Note: The line break between this comment and the next line is necessary | |||
so an "=== Heading ===" at start of doc subpage is correctly interpreted. | |||
--> | |||
{{#switch: {{#if:{{{content|}}}|1|0}}{{#if:{{{1|}}}|1|0}}{{#ifexist:{{{1|}}}|1|0}}{{#ifexist:{{Documentation/docspace}}:{{Documentation/template page}}/doc|1|0}} | |||
| 0000 | 0100 | 0010 | 0101 = <!-- currently no content to transclude --> | |||
| 0001 | 0011 = {{ {{Documentation/docspace}}:{{Documentation/template page}}/doc }} | |||
| 0110 | 0111 = {{ {{{1|}}} }} | |||
| | | 1000 | 1001 | 1010 | 1011 | 1100 | 1101 | 1110 | 1111 = {{{content|}}} | ||
}}<!-- | |||
<!-- | End load the /doc content: | ||
| | Note: The line break between this comment and the next line is necessary | ||
so an "=== Heading ===" at end of doc subpage is correctly interpreted. | |||
--> | |||
{{Documentation/end box2 | |||
| preload = {{{preload|}}}<!-- Allow custom preloads --> | |||
| content = {{{content|}}} | |||
| link box = {{{link box|}}}<!-- So "link box=off" works --> | |||
}}<!--End of green doc box--><noinclude> | | docspace = {{Documentation/docspace}}<!-- Some namespaces must have the /doc, /sandbox and /testcases in talk space --> | ||
| 1 = {{{1|}}}<!-- Other docname, if fed --> | |||
| lang = {{{lang|}}} | |||
| template page = {{Documentation/template page}}<!-- The namespace is added in /end box2 --> | |||
}}<!-- | |||
End of green doc box | |||
--></includeonly><noinclude> | |||
{{Documentation}} | |||
<!-- Add categories and interwikis to the /doc subpage, not here! --> | <!-- Add categories and interwikis to the /doc subpage, not here! --> | ||
</noinclude> | </noinclude> | ||
Revision as of 15:09, 16 November 2013
This template automatically displays a documentation box like you are seeing now, of which the content is transcluded from another page. It is intended for pages which are transcluded in other pages, i.e. templates, whether in the template namespace or not.
Usage
Normal
<noinclude>{{documentation}}</noinclude>
- or -
<noinclude>{{doc}}</noinclude>
- or -
<noinclude>{{documentation|template:any page/doc}}</noinclude>
This code should be added at the bottom of the template code, with no extra space before "<noinclude>" (which would cause extra space on pages where the template is used). The parameter can be used as shown above to transclude an arbitrary documentation page.
Add categories and interwiki links to the documentation page inside <includeonly> tags.
If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "<", and the ">" with ">.
Customizing display
Overrides exist to customize the output in special cases:
{{documentation|heading=}}: change the text of the "documentation" heading. If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.{{documentation|content=}}: for extremely simple documentation notes, enter the message desired with the|content=parameter. The text provided with this parameter appears in a box similar to the doc subpage, without any other notations in the boxes. For more complex documentation descriptions, use a full doc subpage.
Functions
If the documentation page doesn't exist, the "edit" link includes a preload parameter so that clicking it will pre-fill the edit form with the basic documentation page format.
Rationale
This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation, categories, and interwiki links. It also reduces server resources by circumventing a technical limitation of templates (see a developer's explanation).
 |
The above documentation is transcluded from Template:Documentation/doc. Please add categories to the /doc subpage. Subpages of this template. |