Difference between revisions of "Template:Documentation"
Sirryan2002 (talk | contribs) m (fixed a bug) |
Sirryan2002 (talk | contribs) m |
||
| Line 93: | Line 93: | ||
| V12=Example | VD12= This is the code for the example. It should fully use the template. | | V12=Example | VD12= This is the code for the example. It should fully use the template. | ||
| Notes= This template should clearly explain and show how to use the template. Someone who has basic wiki knowledge should be able to look at the documentation and understand what every variable does and how to implement the template on their own wiki page. If an example won't fit well inside the documentation UI box then you should leave the example variable blank and instead place the code outside the documentation template below it. | | Notes= This template should clearly explain and show how to use the template. Someone who has basic wiki knowledge should be able to look at the documentation and understand what every variable does and how to implement the template on their own wiki page. If an example won't fit well inside the documentation UI box then you should leave the example variable blank and instead place the code outside the documentation template below it. | ||
| Warnings=This template should always be between <nowiki><noinclude> and < | | Warnings=This template should always be between <nowiki><noinclude> and </ noinclude></nowiki> tags to avoid the documentation being transcluded onto a page it's not intended to be on. If this template is used on a protected page then you will not be able to utilize the Edit button at the top unless you have the correct User Rights. <br> | ||
When using the closing <nowiki></pre></nowiki> you will need to replace the forward slash with <nowiki>/</nowiki> so that the wiki wont recognize the forward slash and accidentally close the pre block too early. You must always start with the first variable or else the section will not show up; This applies to V1 and ExamplePage1. | When using the closing <nowiki></pre></nowiki> you will need to replace the forward slash with <nowiki>/</nowiki> so that the wiki wont recognize the forward slash and accidentally close the pre block too early. You must always start with the first variable or else the section will not show up; This applies to V1 and ExamplePage1. | ||
| ExampleCode=View Source of this page | | ExampleCode=View Source of this page | ||
Revision as of 20:37, 23 January 2021
 Template:Documentation - Documentation
|
[Edit] [History] |
Implementation
Documentation | ImplementationCode= <pre> | Usage= | V1= | VD1= | V2= | VD2= | V3= | VD3= | V4= | VD4= | V5= | VD5= | V6= | VD6= | V7= | VD7= | V8= | VD8= | V9= | VD9= | V10= | VD10= | V11= | VD11= | V12= | VD12= | Notes= | Warnings= | ExampleCode=<pre> | Example= | ExamplePage1= | ExamplePage2= | ExamplePage3=
Usage
Variables
ImplementationCode = The exact code to implement this template without the parameters filled in. The Parameter you input for this variable should be surrounded by <pre> and </pre>. Don't use curly brackets to define the start and end of Implementation Code due to it breaking the documentation code.
Usage = This is what describes where your template should be used, where it should be placed, and in what scenarios it should/should not be used.
V1 = This is the name of your first variable
VD1 = This is the description of value that should be put into the first variable and what it does
V... = Name of Variable #N
VD... = Description of Variable #N
V15 = Name of the 15th Variable(maximum number of vars this template supports)
V15 = Description of the 15th Variable(maximum number of vars this template supports)
Notes = General Notes about your template. Can explain tips and tricks, how the template works on different types of pages/protections, general formatting nuances of the template, etc. Can also explain if categories are automatically applied by your template and if your template uses any other templates.
Warnings = General Warnings about using your template. Will your template break other templates code? Are there certain values you shouldn't apply to certain variables? Should your template be placed inside UI elements like Div, Tables, or Tabs? If something could break when using your template or you should not do something when using this template put it here.
ExampleCode = This is the code that the example in the example section uses. It should be surrounded by <pre></pre> tags so that readers can see it.
Example = This is the code for the example. It should fully use the template.
Notes
This template should clearly explain and show how to use the template. Someone who has basic wiki knowledge should be able to look at the documentation and understand what every variable does and how to implement the template on their own wiki page. If an example won't fit well inside the documentation UI box then you should leave the example variable blank and instead place the code outside the documentation template below it.
Warnings
This template should always be between <noinclude> and </ noinclude> tags to avoid the documentation being transcluded onto a page it's not intended to be on. If this template is used on a protected page then you will not be able to utilize the Edit button at the top unless you have the correct User Rights.
When using the closing </pre> you will need to replace the forward slash with / so that the wiki wont recognize the forward slash and accidentally close the pre block too early. You must always start with the first variable or else the section will not show up; This applies to V1 and ExamplePage1.
Example
View Source of this page
This page is the example.
Example Pages
To implement your own Documentation on another template page or to understand how to use the Documentation template, please see Template:Documentation