Difference between revisions of "Documentation"
(Created a documentation section) |
(Added example) |
||
| Line 3: | Line 3: | ||
<tr> | <tr> | ||
<th> | <th> | ||
| − | <i style="font-size: 3em; color: lightblue;">{{#fas:info-circle}}</i> {{{title | + | <i style="font-size: 3em; color: lightblue;">{{#fas:info-circle}}</i> {{{title}}} |
</th> | </th> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td> | <td> | ||
| − | {{{introduction | + | {{{introduction}}} |
</td> | </td> | ||
</tr> | </tr> | ||
| Line 14: | Line 14: | ||
<td> | <td> | ||
Usage: | Usage: | ||
| − | {{{usageContent | + | {{{usageContent}}} |
<code> | <code> | ||
| − | {{{usageExample | + | {{{usageExample}}} |
</code> | </code> | ||
| − | + | </td> | |
| − | < | + | </tr> |
| + | <tr> | ||
| + | <td> | ||
| + | Parameters: | ||
<templatedata> | <templatedata> | ||
{ | { | ||
| Line 25: | Line 28: | ||
"title": { | "title": { | ||
"label": "Title", | "label": "Title", | ||
| − | "description": "The | + | "description": "The template title", |
"type": "string", | "type": "string", | ||
"required": true | "required": true | ||
| Line 31: | Line 34: | ||
"introduction": { | "introduction": { | ||
"label": "Introduction", | "label": "Introduction", | ||
| − | "description": "Explains the motivation for this | + | "description": "Explains the motivation for this template", |
"type": "content", | "type": "content", | ||
"required": true | "required": true | ||
}, | }, | ||
"usageContent": { | "usageContent": { | ||
| − | |||
"description": "The usage section", | "description": "The usage section", | ||
"type": "unbalanced-wikitext", | "type": "unbalanced-wikitext", | ||
| Line 47: | Line 49: | ||
"required": true | "required": true | ||
} | } | ||
| − | } | + | }, |
| + | "format": "inline" | ||
} | } | ||
</templatedata> | </templatedata> | ||
| − | + | </td> | |
| − | |||
</tr> | </tr> | ||
</table> | </table> | ||
</includeonly> | </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 | ||
| + | | usageExample = A wikitext example of how to use the template. This would get very meta if I included more here... | ||
| + | }} | ||
| + | </nowiki> | ||
| + | }} | ||
| + | </noinclude> | ||
Revision as of 22:39, 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).
|
|||||||||||||||||||||||||
Parameters: No description.
|
|||||||||||||||||||||||||