Difference between revisions of "Template:Documentation"
(+ "Documentation" id for section linking) |
WikiMaster (Talk | contribs) m (1 revision: Import from source: http://en.wikipedia.org/wiki/Template:Box-header) |
||
| (87 intermediate revisions by 51 users not shown) | |||
| Line 1: | Line 1: | ||
| − | < | + | <!-- |
| − | < | + | Automatically add {{template sandbox notice}} when on a /sandbox page. |
| − | + | -->{{#ifeq: {{SUBPAGENAME}} | sandbox | |
| − | + | | <div style="clear: both;"></div>{{template sandbox notice|{{{livepage|}}}}} | |
| − | + | }}<!-- | |
| + | Automatically add {{pp-template}} to protected templates. | ||
| + | -->{{template other | ||
| + | | {{#ifeq: {{PROTECTIONLEVEL:move}} | sysop | ||
| + | | {{pp-template|docusage=yes}} | ||
| + | | {{#if: {{PROTECTIONLEVEL:edit}} | ||
| + | | {{pp-template|docusage=yes}} | ||
| + | | <!--Not protected, or only semi-move-protected--> | ||
| + | }} | ||
| + | }} | ||
| + | }}<!-- | ||
| + | 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|}}} | ||
| + | | content = {{{content|}}} | ||
| + | |||
| + | <!--Some namespaces must have the /doc, /sandbox and /testcases | ||
| + | in talk space--> | ||
| + | | docspace = {{documentation/docspace}} | ||
| + | |||
| + | | 1 = {{{1|}}} <!--Other docname, if fed--> | ||
| + | |||
| + | <!--The namespace is added in /start box2--> | ||
| + | | template page = {{documentation/template page}} | ||
| + | |||
| + | }}<!-- Start content --><!-- | ||
| + | Start load the /doc content: | ||
| + | Note: The line breaks between this comment and the next line are necessary | ||
| + | so "=== Headings ===" at the start and end of docs are interpreted. | ||
| + | --> | ||
| + | {{#switch: {{#if:{{{content|}}}|1|0}}{{#if:{{{1|}}}|1|0}}{{#ifexist:{{{1|}}}|1|0}}{{#ifexist:{{documentation/docspace}}:{{documentation/template page}}/doc|1|0}} | ||
| + | | 1000 | 1001 | 1010 | 1011 | 1100 | 1101 | 1110 | ||
| + | | 1111 = {{{content|}}} | ||
| + | | 0110 | 0111 = {{ {{{1}}} }} | ||
| + | | 0001 | 0011 = {{ {{documentation/docspace}}:{{documentation/template page}}/doc }} | ||
| + | | 0000 | 0100 | 0010 | 0101 = | ||
| + | }} | ||
| + | <!-- | ||
| + | End load the /doc content: | ||
| + | Note: The line breaks between this comment and the previous line are necessary | ||
| + | so "=== Headings ===" at the start and end of docs are interpreted. | ||
| + | -->{{documentation/end box2 | ||
| + | | preload = {{{preload|}}} <!--Allow custom preloads--> | ||
| + | | content = {{{content|}}} | ||
| + | | link box = {{{link box|}}} <!--So "link box=off" works--> | ||
| + | |||
| + | <!--Some namespaces must have the /doc, /sandbox and /testcases | ||
| + | in talk space--> | ||
| + | | docspace = {{documentation/docspace}} | ||
| + | |||
| + | | 1 = {{{1|}}} <!--Other docname, if fed--> | ||
| + | |||
| + | <!--The namespace is added in /end box2--> | ||
| + | | template page = {{documentation/template page}} | ||
| + | |||
| + | }}<!-- | ||
| + | End of green doc box | ||
| + | --><noinclude> | ||
| + | |||
| + | <!-- Add categories and interwikis to the /doc subpage, not here! --> | ||
| + | </noinclude> | ||
Latest revision as of 19:10, 20 March 2012
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.
Contents
Usage
Normal
<noinclude>{{documentation}}</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 "<".
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.
Caption1
Caption2
<ref> tag;
refs with no name must have content
</gallery>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.
Advantages
Transclusion of a documentation page makes it possible to protect the page of the template itself while allowing anyone to edit the template's documentation, categories, and interwiki links.
Use of msgnw to show the content of a template is less cluttered with wikitext from the noinclude-part.
Disadvantages, substitution as alternative
Transclusion of a documentation page increases its expansion depth, for which a limit applies. In particular a demo showing an example within the limits and one exceeding them should itself not be transcluded.
Another disadvantage is that when applying WhatLinksHere to a page the documentation links to, both the template page and the documentation page is listed, which clutters the list somewhat.
To avoid the disadvantages, yet get the same lay-out for the resulting template page, substitute Template:Docsubst by putting {{subst:docsubst}} inside <noinclude> tags. If the documentation page already exists, subsititute it and remove the text and links which are no longer applicable, or do like above, and copy the relevant content from the existing documentation page to the noinclude part of the template page.
See also
| The above documentation is transcluded from Template:Documentation/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. |
