Difference between revisions of "QDP2012/30/1/1"
From The RadioReference Wiki
< User:QDP2012 | 30 | 1
m |
m |
||
Line 3: | Line 3: | ||
---- | ---- | ||
---- | ---- | ||
− | ==Documentation Sub-page for Template:( | + | ==Documentation Sub-page for Template:(template_name)== |
===Scope of Use=== | ===Scope of Use=== | ||
====Purpose==== | ====Purpose==== | ||
− | *'''<nowiki>[[:</nowiki>Template:( | + | *'''<nowiki>[[:</nowiki>Template:(template_name)<nowiki>]]</nowiki>''' should be used to build ... (explain here what this template builds, creates, or displays) |
− | *'''<nowiki>[[:</nowiki>Template:( | + | *'''<nowiki>[[:</nowiki>Template:(template_name)<nowiki>]]</nowiki>''' is designed to be a ("general-use" or "categories" or "set-of-related-pages")-template that... (describe this template's purpose with respect to commonality and/or uniformity of on-screen text, of categories assigned, of navigation-related links, of external resource links, etc.) |
====Directly Invoked By==== | ====Directly Invoked By==== | ||
− | *'''<nowiki>[[:</nowiki>Template:( | + | *'''<nowiki>[[:</nowiki>Template:(template_name)<nowiki>]]</nowiki>''' should be directly invoked only by...(describe which articles, categories, and/or templates that do/should invoke this template). |
====Not Intended For==== | ====Not Intended For==== | ||
− | *'''<nowiki>[[:</nowiki>Template:( | + | *'''<nowiki>[[:</nowiki>Template:(template_name)<nowiki>]]</nowiki>''' should not be directly invoked by...(describe which articles, categories, and/or templates that do/should not invoke this template). |
===Paramaters=== | ===Paramaters=== |
Revision as of 14:13, 12 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 | |||
.
Contents
- 1 Documentation Sub-page for Template:(template_name)
- 1.1 Scope of Use
- 1.2 Paramaters
- 1.3 Examples
- 1.3.1 How to invoke this template for ...(idea 1)
- 1.3.2 How to invoke this template for ...(idea 2)
- 1.3.3 How to invoke this template for ...(idea 3)
- 1.3.4 How to invoke this template for ...(idea 4)
- 1.3.5 How to invoke this template for ...(idea 5)
- 1.3.6 How to avoid common error(s) while invoking this template for ...(idea 6)
Documentation Sub-page for Template:(template_name)
Scope of Use
Purpose
- [[:Template:(template_name)]] should be used to build ... (explain here what this template builds, creates, or displays)
- [[:Template:(template_name)]] is designed to be a ("general-use" or "categories" or "set-of-related-pages")-template that... (describe this template's purpose with respect to commonality and/or uniformity of on-screen text, of categories assigned, of navigation-related links, of external resource links, etc.)
Directly Invoked By
- [[:Template:(template_name)]] should be directly invoked only by...(describe which articles, categories, and/or templates that do/should invoke this template).
Not Intended For
- [[:Template:(template_name)]] should not be directly invoked by...(describe which articles, categories, and/or templates that do/should not invoke this template).
Paramaters
- Specified values will override default values.
- Specified values and Default values are all case-sensitive.
Parameter Name | Parameter Description | Expected Value(s) | Default Value | Notes |
---|---|---|---|---|
(first parameter) (list only one parameter per table-row) |
(parameter description if parameter name is not clear; otherwise leave table-cell blank) |
|
|
A value is Required (other notes) |
(second parameter) |
Examples
- The horizontal lines below separate examples for clarity and do not appear when template is invoked.
How to invoke this template for ...(idea 1)
- {{template_name|required parameters and values}}
Result
.
How to invoke this template for ...(idea 2)
- {{template_name|required parameters and different values}}
Result
.
How to invoke this template for ...(idea 3)
- {{template_name|required parameters and values that override defaults}}
Result
.
How to invoke this template for ...(idea 4)
- {{template_name|all parameters and values in more complex or advanced configuration}}
Result
.
How to invoke this template for ...(idea 5)
- {{template_name|parameters and values that produce unexpected but useful result}}
Result
.
How to avoid common error(s) while invoking this template for ...(idea 6)
- {{template_name|parameters and values to show how not to invoke this template}}
Result
.
Return to: [[:Template:template_name]]
[[Category:Documentation]]