m (try fix inclusion tags appearing in use) |
(remove NOTOC, a toc can be useful in most scenarios + add suggestion for categories) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<includeonly><! | <includeonly><!</includeonly>-- This preload is based off the original documentation template's own documentation. You do not have to follow it exactly. --<includeonly>></includeonly> | ||
==Description== | ==Description== | ||
<!-- | <!--Summary of what the main function of the template is--> | ||
This template can be used to... | This template can be used to... | ||
==Usage== | ==Usage== | ||
| Line 20: | Line 16: | ||
==Parameters== | ==Parameters== | ||
<includeonly><templatedata>{ "description": "","params": { | <includeonly><templatedata>{ "description": "SHORT DESCRIPTION HERE","params": { | ||
"parameter1": { | "parameter1": { | ||
"label": "Fancy_Name", | "label": "Fancy_Name", | ||
| Line 51: | Line 47: | ||
"inherits": "put another parameter name here to copy its properties (gets overwritten by new ones)", | "inherits": "put another parameter name here to copy its properties (gets overwritten by new ones)", | ||
IMPORTANT, the text < }, > must be removed from the very first parameter you list. Also, the last option you have for every parameter must not end with a comma (so for example if <"default"> was the last one you need to do <"default": "Default_If_Static"> - notice the lack of a comma)--> | IMPORTANT, the text < }, > must be removed from the very first parameter you list. Also, the last option you have for every parameter must not end with a comma (so for example if <"default"> was the last one you need to do <"default": "Default_If_Static"> - notice the lack of a comma)--> | ||
==Sample== | ==Sample== | ||
The following input: | The following input: | ||
<pre>{{Example|param=value|pa..}}</pre> | <pre>{{Example|param=value|pa..}}</pre> | ||
Produces: | Produces: | ||
Example here | |||
<includeonly><</includeonly>noinclude> | <includeonly><</includeonly>noinclude><includeonly>[[Category:Template documentation]]</includeonly><includeonly><</includeonly>/noinclude> | ||
<includeonly><</includeonly>includeonly>__NOEDITSECTION__<includeonly><</includeonly>/includeonly> | <includeonly><</includeonly>includeonly>__NOEDITSECTION__ | ||
<includeonly>[[Category:Templates]]</includeonly> | |||
<includeonly><</includeonly>/includeonly><noinclude>[[Template:Documentation]] | |||
[[Category:Preload]]</noinclude> | |||
Latest revision as of 00:21, 31 July 2024
-- This preload is based off the original documentation template's own documentation. You do not have to follow it exactly. --
Description
This template can be used to...
Usage
Parameters
Sample
The following input:
{{Example|param=value|pa..}}
Produces: Example here
noinclude>/noinclude> includeonly>
/includeonly>Template:Documentation