Template:Documentation: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 8: | Line 8: | ||
</div> | </div> | ||
<noinclude> | <noinclude> | ||
<br>{{documentation|This template should be used in doc pages for all other templates. This provides an explanation, as well as the syntax with examples of any template. This template will be used on all "doc" templates explaining all other templates. For example, if there's a template with the page name of "Template:Bluebox", there should be another page titled "Template:Bluebox/doc" that uses this very template. The template within the "/doc" page will in turn be used on the actual template page. | <br>{{documentation|'''''Note: The ABOVE box is the actual template. THIS box is just a description of how the template works.<br><br>This template should be used in doc pages for all other templates. This provides an explanation, as well as the syntax with examples of any template. This template will be used on all "doc" templates explaining all other templates. For example, if there's a template with the page name of "Template:Bluebox", there should be another page titled "Template:Bluebox/doc" that uses this very template. The template within the "/doc" page will in turn be used on the actual template page. | ||
|The syntax of this template is formatted as follows: <code><nowiki>{{documentation|<DESCRIPTION>|<SYNTAX>|<EXAMPLE>}}</nowiki></code> | |The syntax of this template is formatted as follows: <code><nowiki>{{documentation|<DESCRIPTION>|<SYNTAX>|<EXAMPLE>}}</nowiki></code> | ||
| | |<pre>{{documentation | ||
|This is where the template's description will be. | |||
|This is the syntax of the template. It's best to use <pre>, <code> and/or <nowiki> tags when typing out the template's syntax. | |||
|This is where any examples of how to use the template would be.</pre>}} | |||
[[Category:Templates]] | [[Category:Templates]] | ||
</noinclude> | </noinclude> | ||
Revision as of 22:48, 18 November 2021
Description
{{{1}}}
Syntax
{{{2}}}
Examples
{{{3}}}
Description
Note: The ABOVE box is the actual template. THIS box is just a description of how the template works.
This template should be used in doc pages for all other templates. This provides an explanation, as well as the syntax with examples of any template. This template will be used on all "doc" templates explaining all other templates. For example, if there's a template with the page name of "Template:Bluebox", there should be another page titled "Template:Bluebox/doc" that uses this very template. The template within the "/doc" page will in turn be used on the actual template page.
Syntax
The syntax of this template is formatted as follows: {{documentation|<DESCRIPTION>|<SYNTAX>|<EXAMPLE>}}
Examples
{{documentation
|This is where the template's description will be.
|This is the syntax of the template. It's best to use <pre>, <code> and/or <nowiki> tags when typing out the template's syntax.
|This is where any examples of how to use the template would be.