|
|
| Line 1: |
Line 1: |
| ==Description==
| | {{Documentation/Header}} |
| This template is used to insert descriptions on template pages. | | {{Lua|Documentation}} |
| | {{CSS}} |
| | This template is used to insert documentation to template pages. |
|
| |
|
| ==Syntax== | | ==Syntax== |
| * '''1:''' documentation page - optional alternative doc page instead of /doc | | * {{T|Documentation}} will produce the documentation template. |
| * '''type:''' optional template type. Will add category in the form of <code><nowiki>[[Category:{type} templates]]</nowiki></code>.
| | * {{T|Documentation|foo}} will fill in the documentation from the "<code>foo</code>" template. |
| * '''type2:''' optional template type. Will add category in the form of <code><nowiki>[[Category:{type2} templates]]</nowiki></code>.
| | * {{T|Documentation|p1=content=This template does something}} will fill in the documentation with the content "<code>This template does something</code>." (not recommended except for very, very short documentation) |
| * '''draft:''' set to 1 if this documentation is for a draft template | | * {{T|Documentation|p1=heading=Important information}} will replace the default heading with "<code>Important information</code>". |
| | | * {{T|Documentation|p1=type=category}} will add the "<code>category Templates</code>" category. |
| Add <code><nowiki><noinclude></nowiki>{{t|Documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page.
| |
| | |
| Add <code><nowiki><noinclude></nowiki>{{t|Documentation|documentation page}}<nowiki></noinclude></nowiki></code> to transclude an alternative page from the /doc subpage.
| |
| | |
| ==Usage==
| |
| | |
| ===On the Template page===
| |
| This is the normal format when used: | |
| | |
| <pre>
| |
| TEMPLATE CODE
| |
| <includeonly>Any categories to be inserted into articles by the template</includeonly>
| |
| <noinclude>{{Documentation}}</noinclude>
| |
| </pre>
| |
| | |
| ''If your template is not a completed div or table, you may need to close the tags just before <code><nowiki>{{Documentation}}</nowiki></code> is inserted (within the noinclude tags).''
| |
| | |
| ''A line break right before <code><nowiki>{{Documentation}}</nowiki></code> can also be useful as it helps prevent the documentation template "running into" previous code.''
| |
| | |
| ===On the documentation page===
| |
| The documentation page is usually located on the /doc subpage for a template, but a different page can be specified with the first parameter of the template (see [[#Syntax|Syntax]]).
| |
| | |
| Normally, you will want to write something like the following on the documentation page:
| |
| | |
| <pre>
| |
| ==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]]</noinclude>
| |
| </pre>
| |
| | |
| 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]] template.
| |
|
| |
|
| ==Template Data== | | ==Template Data== |
| <templatedata> | | <templatedata> |
| { | | { |
| | "description": { |
| | "en": "This template is used to insert descriptions on template pages." |
| | }, |
| | "format": "inline", |
| "params": { | | "params": { |
| "1": { | | "1": { |
| "label": "Alternative doc page", | | "label": { |
| "description": "Optional alternative page for documentation instead of Template:{name}/doc. Unless if there's a specific reason to not use the default doc page, you shouldn't use an alternative.", | | "en": "Custom Documentation Page" |
| | }, |
| | "description": { |
| | "en": "Page containing the documentation" |
| | }, |
| | "default": "{{FULLPAGENAME}}/doc", |
| | "type": "wiki-page-name" |
| | }, |
| | "heading": { |
| | "label": { |
| | "en": "Heading" |
| | }, |
| | "description": { |
| | "en": "Custom heading" |
| | }, |
| | "default": { |
| | "en": "[[File:Template-icon.svg|50px|link=|alt=Documentation icon]] Documentation" |
| | }, |
| | "type": "line" |
| | }, |
| | "preload": { |
| | "label": { |
| | "en": "Preload Page" |
| | }, |
| | "description": { |
| | "en": "The page to preload if the `/doc` subpage doesn't exist." |
| | }, |
| | "default": "Template:Documentation/preload", |
| "type": "wiki-page-name" | | "type": "wiki-page-name" |
| }, | | }, |
| "draft": { | | "content": { |
| "label": "Is draft", | | "label": { |
| "description": "Set to 1 if this is for a draft template.", | | "en": "Content", |
| "type": "boolean" | | "tr": "İçerik" |
| | }, |
| | "description": { |
| | "en": "Custom documentation content, prevents transclusion of `/doc` subpage." |
| | }, |
| | "type": "content" |
| }, | | }, |
| "type": { | | "type": { |
| "label": "Type", | | "label": "Type", |
| "description": "Optional template type.. Do not include \"Templates\" suffix.", | | "description": "Category to categorize template in.", |
| "example": "Infobox",
| |
| "type": "string", | | "type": "string", |
| "suggested": true | | "suggested": true |
| },
| |
| "type2": {
| |
| "label": "Type 2",
| |
| "description": "Optional template type. Do not include \"Templates\" suffix.",
| |
| "example": "Infobox",
| |
| "type": "string"
| |
| } | | } |
| }, | | } |
| "paramOrder": [
| |
| "type",
| |
| "type2",
| |
| "draft",
| |
| "1"
| |
| ],
| |
| "description": "This template is used to insert descriptions on template pages."
| |
| } | | } |
| </templatedata> | | </templatedata> |
| <includeonly>[[Category:Documentation Templates]]</includeonly><noinclude>[[Category:Template Documentation]]</noinclude>
| |
