Template:Documentation/doc: Difference between revisions
(Created page with "{{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 pa...") |
No edit summary |
||
| Line 2: | Line 2: | ||
This red documentation template is normally used to explain templates that are usually only for administrator/moderator use, but this page is using it to differentiate this box from the template box above to reduce confusion. | This red documentation template is normally used to explain templates that are usually only for administrator/moderator use, but this page is using it to differentiate this box from the template box above to reduce confusion. | ||
All of these documentation templates (commonly seen as just "doc" in the page links) will be categorized on the [[:Category:Doc_templates|documentation templates]] 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 | |<pre>{{documentation | ||
Latest revision as of 03:16, 22 November 2021
Note: The ABOVE box is the actual template. THIS red 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.
This red documentation template is normally used to explain templates that are usually only for administrator/moderator use, but this page is using it to differentiate this box from the template box above to reduce confusion.
All of these documentation templates (commonly seen as just "doc" in the page links) will be categorized on the documentation templates page.
The syntax of this template is formatted as follows: {{documentation|<DESCRIPTION>|<SYNTAX>|<EXAMPLE>}}
{{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.}}