Template:Tracked/doc: Difference between revisions

Revision as of 23:39, 20 February 2015

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:Tracked.

العربية ∙ asturianu ∙ Boarisch ∙ беларуская (тарашкевіца) ∙ български ∙ বাংলা ∙ català ∙ čeština ∙ dansk ∙ Deutsch ∙ Zazaki ∙ Ελληνικά ∙ English ∙ Esperanto ∙ español ∙ eesti ∙ euskara ∙ فارسی ∙ suomi ∙ français ∙ galego ∙ עברית ∙ हिन्दी ∙ hrvatski ∙ magyar ∙ Bahasa Indonesia ∙ italiano ∙ 日本語 ∙ ქართული ∙ 한국어 ∙ кыргызча ∙ Lëtzebuergesch ∙ македонски ∙ മലയാളം ∙ ဘာသာမန် ∙ Bahasa Melayu ∙ Mirandés ∙ မြန်မာဘာသာ ∙ norsk bokmål ∙ Plattdüütsch ∙ Nederlands ∙ norsk ∙ polski ∙ português ∙ português do Brasil ∙ русский ∙ sicilianu ∙ Scots ∙ slovenščina ∙ српски / srpski ∙ svenska ∙ ไทย ∙ Türkçe ∙ українська ∙ اردو ∙ oʻzbekcha / ўзбекча ∙ Tiếng Việt ∙ 中文 ∙ 中文（简体） ∙ 中文（繁體） ∙ 中文（臺灣） ∙ +/−

Phabricator tickets

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|T123}} (where T123 is the identifier of the task).

Sample output:

Tracked in Phabricator Task T123 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|T123|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:

Tracked in Phabricator Task T123 RESOLVED 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

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:

Tracked in Phabricator Task T2300 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)

If you need the Phabricator task for a migrated Bugzilla ticket, add 2000 to the BZ bug number and prefix with T, e.g., T2300 replaced bugzilla:300.

Link box to a bug report

Template parameters
Parameter		Description	Type	Status
Bug id.	`1`	Tasknumber T123 or old bugzilla number	String	required
Status	`2`	resolved, stalled, invalid, ...	String	optional
float	`float`	CSS float+clear right, left, none, both, inherit Default right	String	optional

@@ Line 1: / Line 1: @@
-{{TemplateBox
+{{Documentation subpage}}
-|1
+<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
-|1d=Bug number on Phabricator (<code>T''nnn''</code>) or Bugzilla (<code>''nnn''</code>)
-|1stat=required
+<!-- should have a "== Usage ==" section, probably? -->
-|2
+== Phabricator tickets ==
-|2d=Status of the bug; possible values:
-* <code>open</code>
+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:
-* <code>resolved</code>, this was <code>fixed</code> on Bugzilla
-* <code>invalid</code>
-* <code>stalled</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
-|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.
-|namespace=all
-|usergroup=all
-|placement=
-|usage-notes=
-|type=
-|example=
-|i18n-method=
-|seealso={{tl|Rsvg bug}}, [[mw:]] {{tl|tracked||mw}}
-}}
-== Examples ==
-Imagine we see a comment like the following:
 <div style="margin-left:4em;">
 {| class="wikitable" width="500px"
@@ Line 35: / Line 15: @@
 </div>
-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: <code><nowiki>{{tracked|300}}</nowiki></code> (where 300 is the number of the bug).
+Now let's say we want to note that there's a task on Phabricator for this. We'll add the following code: <code><nowiki>{{tracked|T123}}</nowiki></code> (where T123 is the identifier of the task).
 <div style="margin-left:4em;">
 '''Sample output:'''
-{| class="wikitable" width="500px"
+{| class="wikitable" style="width: 500px;"
 |-
 |
-{{Tracked|300}}
+{{Tracked|T123}}
 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. --[[Special:Mypage|Dogmaster3000]] 01:17, 14 December 2011 (PST)
 |}
 </div>
-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 <code><nowiki>{{tracked|300|fixed}}</nowiki></code>. In addition to <code>fixed</code>, we support <code>wontfix</code>, <code>later</code> and <code>invalid</code> resolution. (Style note: We're not using big scary red colors for the resolution to avoid scaring or annoying the reporter.) Example with the <code>fixed</code> keyword:
+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 <code><nowiki>{{tracked|T123|resolved}}</nowiki></code>. In addition to <code>resolved</code>, we support <code>invalid</code>, <code>duplicate</code>, <code>declined</code>, <code>stalled</code> and <code>open</code>. (Style note: We're not using big scary red colors for the status to avoid scaring or annoying the reporter.) Example with the <code>resolved</code> keyword:
 <div style="margin-left:4em;">
@@ Line 54: / Line 34: @@
 |-
 |
-{{Tracked|300|fixed}}
+{{tracked|T123|resolved}}
 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. --[[Special:Mypage|Dogmaster3000]] 01:17, 14 December 2011 (PST)
 |}
 </div>
-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: <code><nowiki>{{Tracked|300|critical}}</nowiki></code>
+Of course, feel free to avoid using this template if tracking a comment is not useful.
 <div style="margin-left:4em;">
-'''Sample output:'''
 {| class="wikitable" width="500px"
 |-
 |
-{{Tracked|300|critical}}
 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. --[[Special:Mypage|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. --[[Special:Mypage|GNUnicorn]] 01:38, 14 December 2011 (PST)
 |}
 </div>
-Of course, feel free to avoid using this template if tracking a comment is not useful.
+==Bugzilla tickets==
+For backwards compatibility, this template also accepts the number of a Bugzilla ticket as first parameter, and the following resolutions: <code>fixed</code>, <code>wontfix</code>, <code>later</code>, <code>invalid</code>. 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: <code><nowiki>{{Tracked|300|critical}}</nowiki></code>
 <div style="margin-left:4em;">
+'''Sample output:'''
 {| class="wikitable" width="500px"
 |-
 |
+{{Tracked|300|critical}}
 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. --[[Special:Mypage|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. --[[Special:Mypage|GNUnicorn]] 01:38, 14 December 2011 (PST)
 |}
 </div>
-If you need the new [[phabricator:|Phabricator]] status codes for a migrated Bugzilla ticket, add 2000 to its number with prefix '''T''' to get the task, e.g., [[phabricator:T2300|T2300]] replaced [[bugzilla:300]].
+If you need the [[phabricator:|Phabricator]] task for a migrated Bugzilla ticket, add 2000 to the BZ bug number and prefix with '''T''', e.g., [[phabricator:T2300|T2300]] replaced [[bugzilla:300]].
-----
-<includeonly>[[Category:Maintenance templates]]</includeonly><templatedata>
+<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
-{	"description": "Link box to a bug report",
+<!-- Categories go here and interwikis go in Wikidata. -->
+[[Category:Maintenance templates]][[Category:Templates using an unknown approach for internationalisation]]
+}}</includeonly>
+<templatedata>
+{
+	"description": "Link box to a bug report",
 	"params": {
 		"1": {
@@ Line 103: / Line 90: @@
 			"type": "string",
 			"default": "right"
-}	}	}</templatedata>
+		}
+	}
+}
+</templatedata>

commons>Be..anyone

Revision as of 23:39, 20 February 2015

Phabricator tickets

Bugzilla tickets