Template:Tracked/doc

From Wikisource
Jump to navigation Jump to search

Phabricator tickets[edit]

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. 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 task on Phabricator for this. We'll add the following code: {{tracked|T1234}} (where T1234 is the identifier of the task).

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 task's been resolved, we can note its status, via {{tracked|T1234|resolved}}. In addition to resolved, we support invalid, duplicate, declined, stalled and open. (Style note: We're not using big scary red colors for the status to avoid scaring or annoying the reporter.) Example with the resolved 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)

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)

You appear to be running the new IE toolbar. This is expected behavior. However, if you upgrade, it will show the angry dancing Ballmer instead. --GNUnicorn 01:38, 14 December 2011 (PST)

Bugzilla tickets[edit]

For backwards compatibility, this template also accepts the number of a Bugzilla ticket as first parameter, and the following resolutions: fixed, wontfix, later, invalid. 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)


TemplateData[edit]

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Tracked

A template for tracking tasks in Wikimedia's Phabricator instance

Template parameters

ParameterDescriptionTypeStatus
Bug number1

The number of the task that is being tracked.

Stringrequired
Status2

The status of the task. Options are 'fixed' ,'wontfix', 'invalid', 'later' and 'critical'.

Stringoptional
Float positionfloat

(Not for general use) The float position of the template.

Default
right
Stringoptional

See also[edit]