Template:Documentation: Difference between revisions

From Songs of Syx Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 8: Line 8:
</div>
</div>
<noinclude>
<noinclude>
<br>{{documentation2|'''''Note: The ABOVE box is the actual template. THIS red 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.
<br>{{documentation2/doc}}[[Category:Templates]]</noinclude>
|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]]
</noinclude>

Revision as of 04:05, 22 November 2021

Description

{{{1}}}

Syntax

{{{2}}}

Examples

{{{3}}}


Description

This is an exact duplicate of the "documentation" template, instead it's red instead of green/cyan. This template is not to be used in normal circumstances, and only exists for very specific and experimental purposes, including templates that only administrators and moderators should use/edit. Please use the standard {{documentation}} for explaining templates.

Syntax

The syntax of the above (red) template is formatted as follows: {{documentation2|<DESCRIPTION>|<SYNTAX>|<EXAMPLE>}} - Note that the syntax is the exact same as the original documentation template, except there's a "2" in the word "documentation".

Examples
{{documentation2
|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.