Actions

User

Difference between revisions of "QDP2012/29"

From The RadioReference Wiki

< User:QDP2012
m (.)
m (.)
Line 1: Line 1:
 
{{User:QDP2012/pages}}
 
{{User:QDP2012/pages}}
 
.
 
.
 +
----
 +
----
 +
==Documentation Sub-page for Template:Text_CatStateOther==
 +
===Scope of Use===
 +
====Purpose====
 +
*'''<nowiki>[[:</nowiki>Template:(template_name)<nowiki>]]</nowiki>''' should be used to build ... (explain here what this template builds, creates, or displays)
 +
*'''<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====
 +
*'''<nowiki>[[:</nowiki>Template:(template_name)<nowiki>]]</nowiki>''' should be directly invoked only by...(describe which specific articles, categories, and/or templates should invoke this template).
 +
 +
====Not Intended For====
 +
*'''<nowiki>[[:</nowiki>Template:(template_name)<nowiki>]]</nowiki>''' should not be directly invoked by...(describe which specific articles, categories, and/or templates should not invoke this template).
 +
 +
===Parameters===
 +
*Specified values will override default values.
 +
*Specified values and Default values are all case-sensitive.
 +
 +
{| {{table}} width="100%"
 +
|- bgcolor="lightgrey" |
 +
! Parameter Name !! Parameter Description !! Expected Value(s) !! Default Value !! Notes
 +
|-
 +
| '''(first parameter)'''<br/><br/>(list only one parameter per table-row) || (parameter description if parameter name is not clear; otherwise leave table-cell blank) ||
 +
*unspecified or
 +
*specified with no value or
 +
*specified value(s) (without quotes)
 +
**"value 1"
 +
**"value 2"
 +
**etc.
 +
||
 +
*list the default value, if one is used; otherwise leave table-cell blank
 +
|| {{color|red|A value is Required}} (clearly indicate whether a value is required; use red font sparingly)<br/><br/>(list other notes here regarding this row'sparameter)
 +
|-
 +
| '''(second parameter)''' ||  ||  ||  ||
 +
|-
 +
| '''(add additional row for each additional 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)====
 +
*<nowiki>{{template_name|required parameters and values}}</nowiki>
 +
----
 +
=====Result=====
 +
.(either show the verbatim result, or describe it in sufficient detail)
 +
----
 +
----
 +
 +
====How to invoke this template for ...(idea 2)====
 +
*<nowiki>{{template_name|required parameters and different values}}</nowiki>
 +
----
 +
=====Result=====
 +
.(either show the verbatim result, or describe it in sufficient detail)
 +
----
 +
----
 +
 +
====How to invoke this template for ...(idea 3)====
 +
*<nowiki>{{template_name|required parameters and values that override defaults}}</nowiki>
 +
----
 +
=====Result=====
 +
.(either show the verbatim result, or describe it in sufficient detail)
 +
----
 +
----
 +
 +
====How to invoke this template for ...(idea 4)====
 +
*<nowiki>{{template_name|all parameters and values in more complex or advanced configuration}}</nowiki>
 +
----
 +
=====Result=====
 +
.(either show the verbatim result, or describe it in sufficient detail)
 +
----
 +
----
 +
 +
====How to invoke this template for ...(idea 5)====
 +
*<nowiki>{{template_name|parameters and values that produce unexpected but useful result}}</nowiki>
 +
----
 +
=====Result=====
 +
.(either show the verbatim result, or describe it in sufficient detail)
 +
----
 +
----
 +
====How to avoid common error(s) while invoking this template for ...(idea 6)====
 +
*<nowiki>{{template_name|parameters and values to show how not to invoke this template}}</nowiki>
 +
----
 +
=====Result=====
 +
.(either show the verbatim result, or describe it in sufficient detail)
 +
----
 +
----
 +
 +
 +
 +
 +
 +
 +
 +
Return to: <nowiki>[[:Template:(template_name)]]</nowiki>
 +
 +
<nowiki>[[Category:Documentation]]</nowiki>

Revision as of 02:37, 19 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

InfoBox project related:
Template:ForTestingOnly
OLD: NEW:






.



Documentation Sub-page for Template:Text_CatStateOther

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 specific articles, categories, and/or templates should invoke this template).

Not Intended For

  • [[:Template:(template_name)]] should not be directly invoked by...(describe which specific articles, categories, and/or templates should not invoke this template).

Parameters

  • 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)
  • unspecified or
  • specified with no value or
  • specified value(s) (without quotes)
    • "value 1"
    • "value 2"
    • etc.
  • list the default value, if one is used; otherwise leave table-cell blank
A value is Required (clearly indicate whether a value is required; use red font sparingly)

(list other notes here regarding this row'sparameter)
(second parameter)
(add additional row for each additional 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

.(either show the verbatim result, or describe it in sufficient detail)



How to invoke this template for ...(idea 2)

  • {{template_name|required parameters and different values}}

Result

.(either show the verbatim result, or describe it in sufficient detail)



How to invoke this template for ...(idea 3)

  • {{template_name|required parameters and values that override defaults}}

Result

.(either show the verbatim result, or describe it in sufficient detail)



How to invoke this template for ...(idea 4)

  • {{template_name|all parameters and values in more complex or advanced configuration}}

Result

.(either show the verbatim result, or describe it in sufficient detail)



How to invoke this template for ...(idea 5)

  • {{template_name|parameters and values that produce unexpected but useful result}}

Result

.(either show the verbatim result, or describe it in sufficient detail)



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

.(either show the verbatim result, or describe it in sufficient detail)






Return to: [[:Template:(template_name)]]

[[Category:Documentation]]