Difference between revisions of "Documentation"
m (Fixed template data) |
(Fixed) |
||
Line 1: | Line 1: | ||
<includeonly> | <includeonly> | ||
− | + | <div class="documentation"> | |
− | + | == <i style="font-size: 3em; color: lightblue;">{{#fas:info-circle}}</i> {{{title}}} == | |
− | + | {{{introduction}}} | |
− | + | == Usage: == | |
− | + | {{{usageContent}}} | |
− | + | ||
− | + | <div class="code"> | |
− | + | {{{usageExample}}} | |
− | + | </div> | |
− | + | == Parameters: == | |
− | + | {{{parameters}}} | |
− | + | </div> | |
− | + | </includeonly> | |
− | + | <noinclude> | |
− | + | {{Documentation | |
− | + | | title = Documentation (Meta) | |
− | + | | introduction = This template should be used to add information about how to use templates (such as how it's being used here, meta!). | |
− | + | | usageContent = To use this template simply fill in the parameters (they are all mandatory). | |
− | + | | usageExample = | |
− | + | <nowiki>{{Documentation | |
− | < | + | | title = The documentation title |
− | + | | introduction = The introduction section | |
− | + | | usageContent = The section explaining how to use it | |
− | <templatedata> | + | | usageExample = A wikitext example of how to use the template. This would get very meta if I included more here... |
+ | }}</nowiki> | ||
+ | | parameters = <templatedata> | ||
{ | { | ||
"params": { | "params": { | ||
Line 47: | Line 49: | ||
"description": "Usage code block", | "description": "Usage code block", | ||
"type": "unbalanced-wikitext", | "type": "unbalanced-wikitext", | ||
+ | "required": true | ||
+ | }, | ||
+ | "parameters": { | ||
+ | "label": "Parameters", | ||
+ | "description": "The TemplateData", | ||
"required": true | "required": true | ||
} | } | ||
}, | }, | ||
− | "format": "block" | + | "format": "block", |
+ | "description": "Here you can put in information about parameters" | ||
} | } | ||
</templatedata> | </templatedata> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
}} | }} | ||
</noinclude> | </noinclude> |
Revision as of 23:06, 13 October 2020
Documentation (Meta)
This template should be used to add information about how to use templates (such as how it's being used here, meta!).
Usage:
To use this template simply fill in the parameters (they are all mandatory).
{{Documentation | title = The documentation title | introduction = The introduction section | usageContent = The section explaining how to use it | usageExample = A wikitext example of how to use the template. This would get very meta if I included more here... }}
Parameters:
Here you can put in information about parameters
Parameter | Description | Type | Status | |
---|---|---|---|---|
Title | title | The template title | String | required |
Introduction | introduction | Explains the motivation for this template | Content | required |
UsageContent | usageContent | The usage section | Unbalanced wikitext | required |
Code | usageExample | Usage code block | Unbalanced wikitext | required |
Parameters | parameters | The TemplateData | Unknown | required |