Template:Feature tracking: Difference between revisions

From OLPC
Jump to navigation Jump to search
m (tweak the confusing-as-heck #if: tests)
(→‎Usage: mention obsolete name parameter)
 
(19 intermediate revisions by the same user not shown)
Line 1: Line 1:
<includeonly>
<includeonly>
Name={{{Name|Untitled feature}}} ''unused now''
{{Definition_table
{{Definition_table
|Feature subcategory|{{ #if: {{{Feature subcategory|}}} |[[Is part of::Category:{{{Feature subcategory}}}]] [[Category:{{{Feature subcategory}}}]] | <font color=#aaa>Please provide feature subcategory</font>}}
|Primary requester| {{ #if: {{{Primary requester|}}} | [[Primary requester::{{{Primary requester}}}]] | ''not indicated''}}
|Requesters | {{#arraymap:{{{Requesters|}}}|,|x|[[Requested by::x]]}} {{#if: {{{Requesters|}}}|OK|<font color=#aaa>Please indicate countries or engineers making the request</font>}}
|Requesters | {{#arraymap:{{{Requesters|}}}|,|x|[[Requested by::x]]}} {{#if: {{{Requesters|}}}||<font color=#aaa>Please indicate countries or engineers making the request</font>}}
|Requirements | {{{Requirements|<font color=#aaa>Please provide a short summary or bulleted list of user-level requirements</font>}}}
|Requirements | {{{Requirements|<font color=#aaa>Please provide a short summary or bulleted list of user-level requirements</font>}}}
|Specification | {{{Specification|<font color=#aaa>Please summarize designs, implementation details, and other references</font>}}}
|Specification | {{{Specification|<font color=#aaa>Please summarize designs, implementation details, and other references</font>}}}
|Owners | {{#arraymap:{{{Owners|}}}|,|x|[[Contact person::User:x]]}} {{#if: {{{Owners| }}}|OK|<font color=#aaa>Please indicate developers or champions supporting this request</font>}}
|Owners | {{#arraymap:{{{Owners|}}}|,|x|[[Contact person::User:x]]}} {{#if: {{{Owners| }}}||<font color=#aaa>Please indicate developers or champions supporting this request</font>}}
|Priority | {{ #if: {{{Priority|}}} | [[Priority::{{{Priority}}}]] | ''not indicated''}}
|Priority | {{ #if: {{{Priority|}}} | [[Priority::{{{Priority}}}]] | <font color=#aaa>''not indicated''</font>}}
|Helps deployability? | {{ #if: {{{Helps deployability|}}} | [[Helps deployability::{{{Helps deployability}}}]] | ''not indicated''}}
|Helps deployability? | {{ #if: {{{Helps deployability|}}} | [[Helps deployability::{{{Helps deployability}}}]] | <font color=#aaa>''not indicated''</font>}}
|Target for 9.1? | {{ #if: {{{Target for 9.1|}}} | [[Target for 9.1::{{{Target for 9.1}}}]] | ''not indicated''}}
|Target for 9.1? | {{ #if: {{{Target for 9.1|}}} | [[Target for 9.1::{{{Target for 9.1}}}]] | <font color=#aaa>''not indicated''</font>}}
}}</includeonly><noinclude>
}}</includeonly><noinclude>
{{SMW for software features}}
Used to display a feature and define its semantics for the [[Feature_roadmap]].

Displays a feature's values and also defines its semantics for the [[Feature_roadmap]].
It's based on {{tl|Feature request}} (will some day replace it), but displays several extra feature properties, and makes semantic annotations of them. Both templates use {{tl|Definition table}} to lay display


== Usage ==
== Usage ==


<pre>
<pre>
{{Feature_tracking
{{Feature_request
|Feature subcategory=A subcategory of [[Category:Software features]]
|Name=A brief, one-line summary of the feature, used as the title
|Requesters=Deployments, engineers, or both who support the request (separated by commas)


|Requirements=User-level requirement definition; Links to detailed wiki pages, mailing list threads, or other resources are welcome
|Requesters=Deployments, engineers, or both who support the request

|Requirements=User level requirement definition; Links to detailed wiki pages, mailing list threads, or other resources are welcome
*or
*or
*a
*a
Line 32: Line 33:
*of relevant links
*of relevant links


|Owners=Names of developers and/or champions of the request who will ensure that progress is made
|Owners=Names of developers and/or champions of the request who will ensure that progress is made (separated by commas)

|Priority=9 (9=unassigned 1 = Critical,2 = High,3 = Medium, 4 = Low, 5 = not needed)
|Helps deployability=yes or no
|Target for 9.1=yes or no
}}</pre>
}}</pre>

(The template used to have a ''Name'' parameter, but this is now unused. You can remove it from invocations of the template, though it doesn't hurt to leave it in.)


== Sample ==
== Sample ==


{{Feature_tracking
{{XFeature_request
|Feature subcategory=XTest feature
|Name=A brief, one-line summary of the feature, used as the title
|Requesters=Deployments, engineers, or both who support the request
|Requesters=User:St. NickN, OLPC Antarctica
|Requirements=User level requirement definition; Links to detailed wiki pages, mailing list threads, or other resources are welcome
|Requirements=User level requirement definition; Links to detailed wiki pages, mailing list threads, or other resources are welcome
*or
*or
Line 49: Line 56:
*or a list
*or a list
*of relevant links
*of relevant links
|Owners=John Doe, Jane Doe
|Owners=Names of developers and/or champions of the request who will ensure that progress is made

|Priority=4
|Helps deployability=no
|Target for 9.1=no
}}
}}


== Pre-filling ==
{{SMW for software features}}
Pages like [[Feature roadmap]] and [[Features-test]] can use <nowiki><inputbox</nowiki> to pre-fill a new page with the contents in [[{{FULLPAGENAME}}/Preload]] (which is the default text above. This helps less experienced editors to use [[Template:Feature tracking]] appropriately.

[[Category:Template]]
[[Category:Template]]
</noinclude>
</noinclude>

Latest revision as of 12:39, 21 December 2008

Enables a dynamic Feature roadmap — see Semantic MediaWiki#For software features.

Displays a feature's values and also defines its semantics for the Feature_roadmap. It's based on {{Feature request}} (will some day replace it), but displays several extra feature properties, and makes semantic annotations of them. Both templates use {{Definition table}} to lay display

Usage

{{Feature_tracking
|Feature subcategory=A subcategory of [[Category:Software features]]
|Requesters=Deployments, engineers, or both who support the request (separated by commas)

|Requirements=User-level requirement definition; Links to detailed wiki pages, mailing list threads, or other resources are welcome
*or
*a
*list
*of
*them

|Specification=Design and technical implementation ideas; Links to detailed wiki pages, mailing list threads, or other resources are welcome
*or a list
*of relevant links

|Owners=Names of developers and/or champions of the request who will ensure that progress is made (separated by commas)

|Priority=9 (9=unassigned 1 = Critical,2 = High,3 = Medium, 4 = Low, 5 = not needed)
|Helps deployability=yes or no
|Target for 9.1=yes or no
}}

(The template used to have a Name parameter, but this is now unused. You can remove it from invocations of the template, though it doesn't hurt to leave it in.)

Sample

Feature subcategory Is part of::Category:XTest feature
Requesters {{#arraymap:User:St. NickN, OLPC Antarctica|,|x|Requested by::x}}
Requirements User level requirement definition; Links to detailed wiki pages, mailing list threads, or other resources are welcome
  • or
  • a
  • list
  • of
  • them
Specification Design and technical implementation ideas; Links to detailed wiki pages, mailing list threads, or other resources are welcome
  • or a list
  • of relevant links
Owners {{#arraymap:John Doe, Jane Doe|,|x|Contact person::User:x}}
Priority Priority::4
Helps deployability? Helps deployability::no
Target for 9.1? Target for 9.1::no

Pre-filling

Pages like Feature roadmap and Features-test can use <inputbox to pre-fill a new page with the contents in Template:Feature tracking/Preload (which is the default text above. This helps less experienced editors to use Template:Feature tracking appropriately.