Template:Documentation/doc: Difference between revisions
m 1 revision imported: Template |
m 1 revision imported: some changes are needed ; like removing link to UTRS |
||
| Line 1: | Line 1: | ||
{{ | {{Lua|Module:Documentation}} | ||
<!-- Categories where indicated at the bottom of this page, please --> | |||
This is the {{ | This is the {{tlf|Documentation}} template, used on almost every template page to contain that template's documented instructions and information. | ||
For detailed instructions on how and when to use this template, see [[w:Wikipedia:Template documentation]]. | |||
This template displays a green documentation box like you are seeing now and automatically loads the content from a /doc subpage. It can also load the content from other places if instructed to. | This template displays a green documentation box like you are seeing now and automatically loads the content from a /doc subpage. It can also load the content from other places if instructed to. | ||
This template is intended for documenting templates and other pages that are [[ | This template is intended for documenting templates and other pages that are [[w:Wikipedia:Transclusion|transcluded]] onto other pages. It can be used in the [[w:Wikipedia:Template namespace|template namespace]] and most other [[w:Wikipedia:Namespace|namespace]]s. | ||
Use of this template allows templates to be [[ | Use of this template allows templates to be [[w:Wikipedia:Protection policy|protected]] where necessary, while allowing anyone to edit the documentation and categories. | ||
===Usage=== | ===Usage=== | ||
Normally this template is used without any parameters, placed at the bottom of the template or page being documented, within a | Normally this template is used without any parameters, placed at the bottom of the template or page being documented, within a {{tag|noinclude}} container: | ||
<syntaxhighlight lang="xml+smarty"> | <syntaxhighlight lang="xml+smarty"> | ||
| Line 41: | Line 43: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
When the | When the {{para|content}} parameter is used, the doc box normally does not show the [edit] [purge] links in the top right corner. Note that if the /doc page exists, a link to it is still shown in the link box below the doc box. | ||
Parameter | Parameter {{para|1}} and the {{para|content}} parameter can also be combined, like this: | ||
<syntaxhighlight lang="xml+smarty"> | <syntaxhighlight lang="xml+smarty"> | ||
| Line 53: | Line 55: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Then the pagename fed as parameter 1 is used for the [edit] [purge] links and for the /doc link in the link box below the doc box. But the '''content''' parameter is used for the content shown in the doc box. The above code means that the content is transcluded as {{ | Then the pagename fed as parameter 1 is used for the [edit] [purge] links and for the /doc link in the link box below the doc box. But the '''content''' parameter is used for the content shown in the doc box. The above code means that the content is transcluded as {{tnull|Template:Any page/doc{{!}}parameters}}. In this example a parameter is also fed to the /doc page being loaded. | ||
=== Shortcut === | === Shortcut === | ||
| Line 61: | Line 63: | ||
===Best practice=== | ===Best practice=== | ||
The code should be added at the bottom of the template code, with no space before | The code should be added at the bottom of the template code, with no space before {{Tag|noinclude|o}} (which would cause extra space on pages where the template is used). | ||
Categories that apply to the template itself should be added to the bottom of the /doc subpage, inside | Categories that apply to the template itself should be added to the bottom of the /doc subpage, inside {{Tag|includeonly}} tags. Interwiki links that apply to the template should be listed at [[d:|Wikidata]] (more at [[w:Wikipedia:Wikidata|wp:Wikidata]]). For more complex cases, see [[w:Wikipedia:Template documentation#Categories and interwiki links]]. | ||
If the documentation page contains | If the documentation page contains {{tag|includeonly|o}} or {{tag|noinclude|o}} tags as part of the visible documentation text, replace the "<code><</code>" with "<code>&lt;</code>" or use [[Template:tag]]. | ||
===Heading=== | ===Heading=== | ||
| Line 92: | Line 94: | ||
To hide the link box, add the parameter | To hide the link box, add the parameter | ||
: | : {{para|link box|off}}. | ||
You can also insert customised text into the link box, by setting the | You can also insert customised text into the link box, by setting the {{para|link box}} parameter. For example: | ||
<pre style="width:auto; overflow:scroll"> | <pre style="width:auto; overflow:scroll"> | ||
|link box=This documentation is automatically generated by [[w:Template:Country showdata]] | |link box=This documentation is automatically generated by [[w:Template:Country showdata]] | ||
| Line 101: | Line 103: | ||
===Automatic functions=== | ===Automatic functions=== | ||
If the documentation page does not exist, the [create] link includes a [[mw:Manual:Creating pages with preloaded text|preload]] page so that clicking it will pre-fill the edit form with the basic documentation page format. Preload text is also used for the /sandbox and /testcases [create] links. | If the documentation page does not exist, the [create] link includes a [[mw:Manual:Creating pages with preloaded text|preload]] page so that clicking it will pre-fill the edit form with the basic documentation page format. Preload text is also used for the /sandbox and /testcases [create] links. | ||
When this template is on a protected template page it now automatically adds {{tl|pp-template}}, which shows the grey or red padlock in the top right corner. So no need to manually add {{tlf|pp-template}} to templates that use {{tl|Documentation}}. | |||
When this template is on a /sandbox subpage it automatically adds the {{tl|Template sandbox notice}}. | |||
===Subject namespaces vs. talk namespaces=== | ===Subject namespaces vs. talk namespaces=== | ||
Terminology: ''Subject namespaces'' are the opposite of ''talk namespaces''. For instance "Template:" is the subject space of "Template talk:". | Terminology: ''Subject namespaces'' are the opposite of ''talk namespaces''. For instance "Template:" is the subject space of "Template talk:". | ||
This template is usually placed in a subject namespace, within | This template is usually placed in a subject namespace, within {{tag|noinclude|o}} tags. But in some cases this template needs to be on the talk page: | ||
* In the Mediawiki namespace, since | * In the Mediawiki namespace, since {{tag|noinclude|o}} often does not work in system messages, and since the Mediawiki namespace needs to be kept clean for performance reasons. | ||
When placed on talk pages, this template usually is placed near the top of the page and without | When placed on talk pages, this template usually is placed near the top of the page and without {{tag|noinclude}} tags. | ||
The /doc, /sandbox and /testcases pages should normally be in the subject namespace, except in the namespaces that do not have the MediaWiki [[w:m:Help:Link#Subpage feature|subpage feature]] enabled: Main, File, Mediawiki and Category. (But currently we only show the /sandbox and /testcases links from User, User talk, Template and Template talk namespaces.) There are also a whole bunch of other technical reasons why the /doc page must be stored under the talk page for those (but only those) namespaces. | The /doc, /sandbox and /testcases pages should normally be in the subject namespace, except in the namespaces that do not have the MediaWiki [[w:m:Help:Link#Subpage feature|subpage feature]] enabled: Main, File, Mediawiki and Category. (But currently we only show the /sandbox and /testcases links from User, User talk, Template and Template talk namespaces.) There are also a whole bunch of other technical reasons why the /doc page must be stored under the talk page for those (but only those) namespaces. | ||
| Line 117: | Line 123: | ||
===Technical details=== | ===Technical details=== | ||
The preload page for the /doc [create] link is [[Template:Documentation/preload]]. The preload pages for the /sandbox and /testcases [create] links are [[Template:Documentation/preload-sandbox]] and [[Template:Documentation/preload-testcases]]. The preload page for the /sandbox [mirror] link is [[Template:Documentation/mirror]]. | The preload page for the /doc [create] link is [[Template:Documentation/preload]]. The preload pages for the /sandbox and /testcases [create] links are [[Template:Documentation/preload-sandbox]] and [[Template:Documentation/preload-testcases]]. The preload page for the /sandbox [mirror] link is [[Template:Documentation/mirror]]. | ||
For more details, see the [[Template talk:Documentation|talk page]]. | |||
====Full syntax==== | ====Full syntax==== | ||
| Line 136: | Line 144: | ||
===See also=== | ===See also=== | ||
* {{tl|Documentation subpage}}, a notice placed at the top of a /doc subpage explaining its role and including a link to the page it documents. | * {{tl|Documentation subpage}}, a notice placed at the top of a /doc subpage explaining its role and including a link to the page it documents. | ||
* {{tl|Barnstar documentation}}, a variant of {{tl|Documentation}} for use with [[w:Wikipedia:Barnstars|barnstar]] templates. | |||
* {{tl|Documentation/color scheme}} presents the color scheme used by {{tl|Documentation}}. | |||
* [[w:Wikipedia:Template documentation]] is a how-to guide to template documentation. | * [[w:Wikipedia:Template documentation]] is a how-to guide to template documentation. | ||
* [[w:Wikipedia:Template sandbox and test cases]] explains the use of /sandbox and /testcases subpages and includes more information about template testing. | * [[w:Wikipedia:Template sandbox and test cases]] explains the use of /sandbox and /testcases subpages and includes more information about template testing. | ||
< | <!-- Categories below this line, please --> | ||
[[Category:Template documentation pages| ]] | |||