Difference between revisions of "Documentation"
m (Spacing) |
m (Spacing) |
||
Line 5: | Line 5: | ||
== Usage: == | == Usage: == | ||
{{{usageContent}}} | {{{usageContent}}} | ||
− | + | ||
<div class="code"> | <div class="code"> | ||
{{{usageExample}}} | {{{usageExample}}} | ||
</div> | </div> | ||
− | + | ||
The above would render the following: | The above would render the following: | ||
<div class="usageResult">{{{usageResult}}}</div> | <div class="usageResult">{{{usageResult}}}</div> |
Latest revision as of 19:41, 28 November 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... | usageResult }}
The above would render the following:
Putting the actual stuff here kinda breaks the page...
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 |