Template:Tracked/doc: Difference between revisions
More actions
phabricator: bug IDs begin with a T (task) |
updated codes based on mw:Template:Tracked/doc |
||
| Line 1: | Line 1: | ||
{{TemplateBox | {{TemplateBox | ||
|1 | |1 | ||
|1d=Bug number | |1d=Bug number on Phabricator (<code>T''nnn''</code>) or Bugzilla (<code>''nnn''</code>) | ||
|1stat=required | |1stat=required | ||
|2 | |2 | ||
|2d=Status of the bug; possible values: | |2d=Status of the bug; possible values: | ||
* fixed | * <code>open</code> (default) | ||
* wontfix | * <code>resolved</code>, this was <code>fixed</code> on Bugzilla | ||
* later | * <code>invalid</code> | ||
* | * <code>needsinfo</code> (Phabricator) | ||
* <code>duplicate</code> (Phabricator) | |||
* <code>declined</code>, this was <code>wontfix</code> on Bugzilla | |||
* <code>later</code> (Bugzilla only) | |||
* <code>critical</code> (Bugzilla only) | |||
|name=Tracked | |name=Tracked | ||
|desc=This template is intended to be used on feedback pages and talk pages for software deployments. It floats right-aligned next to whichever content it precedes. | |desc=This template is intended to be used on feedback pages and talk pages for software deployments. It floats right-aligned next to whichever content it precedes. | ||
Revision as of 12:43, 9 October 2014
This template is intended to be used on feedback pages and talk pages for software deployments. It floats right-aligned next to whichever content it precedes.
Usage
{{Tracked |1= |2= }}
Template parameters
| Parameter | Description | Default | Status | |
|---|---|---|---|---|
1 | Bug number on Phabricator (Tnnn) or Bugzilla (nnn) | empty | required | |
2 | Status of the bug; possible values:
| empty | optional | |
Additional information
The template is intended to be used in the following namespaces: all namespaces
The template is intended to be used by the following user groups: all users
See also
{{Rsvg bug}} - used for bugs with (librsvg) SVG renderer (file desc.)
Examples
Imagine we see a comment like the following:
|
Your software is broken. It doesn't even work on Windows ME. When I try to load it, Bill Gates appears on my screen and laughs manically. --Dogmaster3000 01:17, 14 December 2011 (PST) |
Now let's say we want to note that there's a bug in the bug tracker for this. We'll add the following code: {{tracked|300}} (where 300 is the number of the bug).
Sample output:
|
Your software is broken. It doesn't even work on Windows ME. When I try to load it, Bill Gates appears on my screen and laughs manically. --Dogmaster3000 01:17, 14 December 2011 (PST) |
We can leave it at that. If we'd like to note the fact that the bug's been fixed, we can note its status, via {{tracked|300|fixed}}. In addition to fixed, we support wontfix, later and invalid resolution. (Style note: We're not using big scary red colors for the resolution to avoid scaring or annoying the reporter.) Example with the fixed keyword:
Sample output:
|
Your software is broken. It doesn't even work on Windows ME. When I try to load it, Bill Gates appears on my screen and laughs manically. --Dogmaster3000 01:17, 14 December 2011 (PST) |
Last but not least, we can mark a bug as critical. We deliberately aren't using this keyword for bugs which are resolved one way or another -- the point of adding this to the template is to note to all readers of the page that the seriousness of a bug has been critical. This keyword should only be used if the bug has also been marked as critical in Bugzilla. Example usage: {{Tracked|300|critical}}
Sample output:
|
Your software is broken. It doesn't even work on Windows ME. When I try to load it, Bill Gates appears on my screen and laughs manically. --Dogmaster3000 01:17, 14 December 2011 (PST) |
Of course, feel free to avoid using this template if tracking a comment is not useful.
|
Your software is broken. It doesn't even work on Windows ME. When I try to load it, Bill Gates appears on my screen and laughs manically. --Dogmaster3000 01:17, 14 December 2011 (PST)
|