| Line 39: |
Line 39: |
| | Methods 2 and 3 are useful if the template itself is locked from editing, as it still allows the documentation itself to be edited by any editor. | | Methods 2 and 3 are useful if the template itself is locked from editing, as it still allows the documentation itself to be edited by any editor. |
| | | | |
| − | The following two templates should be placed on the documentation page of all templates. In some cases, these two templates are all that is required, but often other information should be added also. | + | The following templates should be placed on the documentation page of all templates. In some cases, these two templates are all that is required, but often other information should be added also. |
| | * {{tl|TemplateDoc}} This is a brief description of the template. | | * {{tl|TemplateDoc}} This is a brief description of the template. |
| | * {{tl|Parms}} This is a container for a list of parameters. If there are no parameters, just place <nowiki>{{Parms|}}</nowiki> on the page. | | * {{tl|Parms}} This is a container for a list of parameters. If there are no parameters, just place <nowiki>{{Parms|}}</nowiki> on the page. |
| | * {{tl|Parm}} This comprises the details of a single parameter. Use one of these for each parameter in the template, with all of them comprising the one parameter required for the {{tl|Parms}} macro. | | * {{tl|Parm}} This comprises the details of a single parameter. Use one of these for each parameter in the template, with all of them comprising the one parameter required for the {{tl|Parms}} macro. |
| | ** Note that in a few cases with many straight-forward parameters which are obvious from the template itself, it is not necessary to list each one of them individually. See {{tl|planet}} for an example. | | ** Note that in a few cases with many straight-forward parameters which are obvious from the template itself, it is not necessary to list each one of them individually. See {{tl|planet}} for an example. |
| | + | * {{tl|TemplateCopy}} This is a box for text the editor can copy and paste to the page using the template. It is only recommended if the template has more than a few named parameters. |
| | | | |
| | To make it easier, simply copy the following text to the documentation page of a template, then fill in the details. If you are not placing this on the template page itself, omit the <nowiki><noinclude></nowiki> tags. | | To make it easier, simply copy the following text to the documentation page of a template, then fill in the details. If you are not placing this on the template page itself, omit the <nowiki><noinclude></nowiki> tags. |