Difference between revisions of "QDP2012/29"
From The RadioReference Wiki
< User:QDP2012
m (.) |
m (.) |
||
Line 1: | Line 1: | ||
{{User:QDP2012/pages}} | {{User:QDP2012/pages}} | ||
. | . | ||
+ | ---- | ||
+ | ---- | ||
+ | {{Templates-List/pages}}<br/> | ||
+ | __TOC__ | ||
+ | ==Template Documentation== | ||
+ | *Templates are documented either in the template itself (when the template is short and simple), or in a "/doc" sub-page. The "/doc" sub-page link will be found at the bottom of the template, and will be the template's name with "/doc" appended to it (without quotes). Example: [[:Template:Cat_State]]'s documentation is located at: [[:Template:Cat_State/doc]] | ||
+ | |||
+ | ==Templates List== | ||
+ | *Template-names have been chosen with the purpose of them sorting alphabetically in such a way that templates with similar purposes will naturally sort together in the list. | ||
+ | |||
+ | ==What to Consider When Creating or Documenting a Template== | ||
+ | ===Template Name Selection=== | ||
+ | *Template Names must be chosen with these ideas in mind: | ||
+ | **Template Names should be short and concise, not long and verbose. Abbreviations are often appropriate. | ||
+ | **Template Names should clearly reflect the purpose of the template. | ||
+ | **Template Names should be chosen so that they sort together with similar-purpose templates. | ||
+ | **Template Names should follow the standard naming convention so that the name begins with a broader description and ends with a more specific description | ||
+ | ***Example: Cat_StateFireSvcsFreq | ||
+ | ****Cat = the template is related to the Wiki's categories | ||
+ | ****State = the template is related to state-specific categories | ||
+ | ****FireSvcs = the template is related to state-specific fire-services categories | ||
+ | ****Freq = the template is related to state-specific fire-services categories that list frequencies. | ||
+ | |||
+ | ===Template Documentation Style=== | ||
+ | *Template Documentation will vary based upon Template-Type. | ||
+ | **A "Text..." template which uses no parameters, and only displays boilerplate text, probably will only require brief documentation at the bottom of the template itself. | ||
+ | **An "InfoBox..." template which uses several parameters, will likely deserve a separate "/doc" sub-page so that the template's documentation does not clutter and oversize the template itself. | ||
+ | |||
+ | ===Template Documentation Content=== | ||
+ | *What to Include in the Template Documentation: | ||
+ | **Template's Name | ||
+ | **Template's Purpose -- give a clear but concise explanation | ||
+ | **Template's Parameters, if any are used | ||
+ | ***Parameter Name | ||
+ | ***Parameter Description, if Parameter Name is not perfectly clear | ||
+ | ***Expected Value(s) of the parameter -- this includes unspecified, specified with no value, and specific expected values | ||
+ | ***Default Value of the parameter, if default value is used | ||
+ | ***Is a parameter-value required? | ||
+ | *** | ||
+ | |||
+ | ==How to Document a Short Simple Template== | ||
+ | * | ||
+ | |||
+ | ==How to Document a Template using a "/doc" Sub-Page== | ||
+ | * | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | {{Templates-List/pages}}<br/> | ||
+ | |||
+ | [[Category:Documentation]] |
Revision as of 22:55, 11 September 2015
Home | Prompts | Move | TRVA | Cat Tree | Links | CECC | Pgmg | Templates |
Tasks: Art, Cat, Tmp, DB 10, 13, 27, 29, 30/1 32, 43, 44, 193,194 | Conv&Stds Sandbox Edit PrfxIdx | ..WRRR ..USBR 1 ..USBR 76 ..PHT | Cat List Custom Avoid Unused 35, 36, 37, 38, CT (C E S N) SC | Categories to be DELETED Templates to be DELETED Pages to be DELETED TL (G IB C S D) | B, C, D, F, I Tk, Tb, Ct, Tx. M, S, TO Avoid Unused | |||
.
Pages: Templates-List: General Use Only, Infobox-Related, Categories-Related, Sets of Related Pages, Doc. |
Contents
Template Documentation
- Templates are documented either in the template itself (when the template is short and simple), or in a "/doc" sub-page. The "/doc" sub-page link will be found at the bottom of the template, and will be the template's name with "/doc" appended to it (without quotes). Example: Template:Cat_State's documentation is located at: Template:Cat_State/doc
Templates List
- Template-names have been chosen with the purpose of them sorting alphabetically in such a way that templates with similar purposes will naturally sort together in the list.
What to Consider When Creating or Documenting a Template
Template Name Selection
- Template Names must be chosen with these ideas in mind:
- Template Names should be short and concise, not long and verbose. Abbreviations are often appropriate.
- Template Names should clearly reflect the purpose of the template.
- Template Names should be chosen so that they sort together with similar-purpose templates.
- Template Names should follow the standard naming convention so that the name begins with a broader description and ends with a more specific description
- Example: Cat_StateFireSvcsFreq
- Cat = the template is related to the Wiki's categories
- State = the template is related to state-specific categories
- FireSvcs = the template is related to state-specific fire-services categories
- Freq = the template is related to state-specific fire-services categories that list frequencies.
- Example: Cat_StateFireSvcsFreq
Template Documentation Style
- Template Documentation will vary based upon Template-Type.
- A "Text..." template which uses no parameters, and only displays boilerplate text, probably will only require brief documentation at the bottom of the template itself.
- An "InfoBox..." template which uses several parameters, will likely deserve a separate "/doc" sub-page so that the template's documentation does not clutter and oversize the template itself.
Template Documentation Content
- What to Include in the Template Documentation:
- Template's Name
- Template's Purpose -- give a clear but concise explanation
- Template's Parameters, if any are used
- Parameter Name
- Parameter Description, if Parameter Name is not perfectly clear
- Expected Value(s) of the parameter -- this includes unspecified, specified with no value, and specific expected values
- Default Value of the parameter, if default value is used
- Is a parameter-value required?
How to Document a Short Simple Template
How to Document a Template using a "/doc" Sub-Page
Pages: Templates-List: General Use Only, Infobox-Related, Categories-Related, Sets of Related Pages, Doc. |