Template:Documentation: Difference between revisions
m (colour adjustments) |
m (update colors to use css variables instead) |
||
| (10 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
<includeonly><onlyinclude><!-- | <includeonly><onlyinclude><!-- | ||
--><div style="clear: both; border: | --><div style="clear: both; border: var(--border-mw);"><!-- | ||
--><div style="padding: 0.5em; background: | --><div style="padding: 0.5em; background:var(--background-mw-heading); border-bottom: var(--border-mw);"><!-- | ||
--><span class="plainlinks">[[{{fullurl: | --><span style="font-size:80%;" class="plainlinks">[[{{fullurl:{{FULLPAGENAME}}/doc}} <span title="view the documentation">view</span>]] [[{{fullurl:{{FULLPAGENAME}}/doc|action=edit}} <span title="edit the documentation">edit</span>]] [[{{fullurl:{{FULLPAGENAME}}/doc|action=history}} <span title="documentation history">history</span>]] [[{{fullurl:{{FULLPAGENAME}}|action=purge}} <span title="purge this page">purge</span>]]</span><!-- | ||
--> '''Template documentation'''<!-- | --> '''Template documentation'''<!-- | ||
--></div><!-- | --></div><!-- | ||
--><div style="margin: 0; padding: 10px; background: | --><div style="margin: 0; padding: 10px; background:var(--background-mw)"><!-- | ||
-->{{#ifexist: | -->{{#ifexist: {{FULLPAGENAME}}/doc<!-- | ||
-->| | -->| | ||
{{: | {{:{{FULLPAGENAME}}/doc}}<!-- | ||
-->| '''This template doesn't have any documentation yet!''' Help out by <span class="plainlinks">[{{fullurl: | -->| '''This template doesn't have any documentation yet!''' Help out by <span class="plainlinks">[{{fullurl:{{FULLPAGENAMEE}}/doc|action=edit&preload=Template:Documentation/preload}} writing some]</span>.<!-- | ||
-->[[Category:Templates without documentation|{{PAGENAME}}]]<!-- | -->[[Category:Templates without documentation|{{PAGENAME}}]]<!-- | ||
| Line 20: | Line 20: | ||
--></div><!-- | --></div><!-- | ||
--><div style="background: | --><div style="background:var(--background-mw-heading); text-align: right; padding: 0.5em; border-top: var(--border-mw);">''Documentation transcluded from [[{{FULLPAGENAME}}/doc]].<br>Editors can experiment in this template's sandbox ([[{{FULLPAGENAME}}/sandbox|create]])''</div><!-- | ||
--></div><!-- | --></div><!-- | ||
--></onlyinclude></includeonly> | --></onlyinclude></includeonly> | ||
{{ | {{Deprecated|Documentation/sandbox}} | ||
{{Documentation}} | |||
[[Category:Template documentation| ]] | [[Category:Template documentation| ]] | ||
Latest revision as of 07:45, 30 March 2024
This template is deprecated.
This template will eventually be removed. Please use Template:Documentation/sandbox instead.
The
{{Documentation}} template is used to contain the documented information and instructions of a certain template from a /doc subpage.
Usage
To use this template, {{Documentation}} should be added to the template inside a <noinclude> tag, so the documentation isn't transcluded along with the template. Then add the documentation to the /doc page, and it will be added to the template. The documentation page should include the {{Documentation subpage}} template, so it is added to the appropriate documentation category.
Example
<!--Last line of your template code--><noinclude>
{{Documentation}}
</noinclude>
See also
Documentation transcluded from Template:Documentation/doc.
Editors can experiment in this template's sandbox (create)
Editors can experiment in this template's sandbox (create)