Template:Documentation: Difference between revisions
Jump to navigation
Jump to search
Draculea8302 (talk | contribs) No edit summary |
Draculea8302 (talk | contribs) (Undo revision 325 by Draculea8302 (talk)) Tag: Undo |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
< | <!-- DO NOT CHANGE THIS PAGE --> | ||
< | <!-- | ||
< | Automatically add {{template sandbox notice}} when on a /sandbox page. | ||
-->{{#ifeq: {{SUBPAGENAME}} | sandbox | |||
< | | <div style="clear: both;"></div>{{template sandbox notice}} | ||
< | }}<!-- | ||
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 | |||
| content = {{{content|}}} | |||
| link box = {{{link box|}}} <!--So "link box=off" works--> | |||
<!--Some namespaces must have the /doc, /sandbox and /testcases | |||
in talk space--> | in talk space--> | ||
| docspace = {{documentation/Docspace}} | | docspace = {{documentation/Docspace}} | ||
Latest revision as of 15:19, 27 March 2025
[Edit] [] 
Template Doc
Template DocDescription
This template is used to insert descriptions on template pages.
Syntax
Add <noinclude>{{documentation}}</noinclude> at the end of the template page.
Usage
On the Template page
This is the normal format when used:
TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}</noinclude>
If your template is not a completed div or table, you may need to close the tags just before {{documentation}} is inserted (within the noinclude tags).
A line break right before {{documentation}} can also be useful as it helps prevent the documentation template "running into" previous code.
On the Template/doc page
Normally, you will want to write something like the following on the documentation page:
==Description==
This template is used to do something.
==Syntax==
Type <code>{{t|templatename}}</code> somewhere.
==Samples==
<code><nowiki>{{templatename|input}}</nowiki></code>
results in...
{{templatename|input}}
<includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or other sections.
Note that the above example also uses the Template:T and Template:T/piece templates.
| Docs ahead is from Template:Documentation/doc。(Edit | History) Editors could goto this templatesandbox (Create) and testcases (Create) page for experimention Please goto /docpage to add category. Child page of this page。 |