Template:Tracked/doc: Difference between revisions

Latest revision as of 11:57, 2 December 2024

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 ∙ 中文 ∙ 中文（简体） ∙ 中文（繁體） ∙ 中文（臺灣） ∙ +/−

This template uses TemplateStyles:

Template:Tracked/styles.css

TNT

This template uses Module:TNT for localisation:

I18n/Tracked.tab

Redirects:

{{Phabricator}}
{{Phab}}

Link box to a bug report

Usage

Template parameters

Parameter	Description		Default	Status
`1`	Task number	Phabricator task number, in the form T1234. Bugzilla bug numbers are automatically converted to Phabricator tasks.	empty	required
`2`	Status	Current status of the task on Phabricator. One of resolved/invalid/duplicate/declined/open	empty	optional
`float`	float	Sets CSS float and clear properties	right	optional
`style`	style	Adds additional CSS to the box	empty	optional

Template data

Parameter text is empty

TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Wikipedia's help about TemplateData • Commons-specific information

Link box to a bug report

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Task number	`1`	Phabricator task number, in the form T1234. Bugzilla bug numbers are automatically converted to Phabricator tasks.	Line	required
Status	`2`	Current status of the task on Phabricator. One of resolved/invalid/duplicate/declined/open Suggested values `resolved` `invalid` `duplicate` `declined` `open`	Line	optional
float	`float`	Sets CSS float and clear properties Suggested values `right` `left` `none` `both` `inherit` Default right	Line	optional
style	`style`	Adds additional CSS to the box	Unknown	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

Relies on:
{{Tracked/layout}}

Examples

{{Tracked|T1234|resolved}}

renders as:

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

{{Tracked|T2001}}

renders as:

Tracked in Phabricator
Task T2001

Localization

This template is localized using Module:TNT. These translations are stored in Data:I18n/Tracked.tab.

@@ Line 1: / Line 1: @@
+<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
 {{TemplateBox
-|1
+| mbox =
-|1d=Bug number in Bugzilla
+<div style="float:right">
-|1stat=required
+{{Uses TemplateStyles|Template:Tracked/styles.css}}
-|2
+{{Uses TNT|Tracked|nocat=1}}
-|2d=Status of the bug; possible values:
-* fixed
-* wontfix
-* later
-* invalid
-* critical
-|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=
-}}
-== Examples ==
-Imagine we see a comment like the following:
-<div style="margin-left:4em;">
-{| class="wikitable" width="500px"
-|-
-|
-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>
+{{tsh|Phabricator|Phab}}
-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).
+  |1        =1
+  |1label   =Task number<!-- A (very) brief name for the parameter. -->
+  |1d-en    =Phabricator task number, in the form T1234. Bugzilla bug numbers are automatically converted to Phabricator tasks.
+  |1aliases =<!-- List of aliases, separated by / (a slash) -->
+  |1type    =line
+  |1def     =<!-- default value for the parameter -->
+  |1stat    =required
-<div style="margin-left:4em;">
+  |2        =2
-'''Sample output:'''
+  |2label   =Status
-{| class="wikitable" width="500px"
+  |2d-en    =Current status of the task on Phabricator. One of resolved/invalid/duplicate/declined/open
-|-
+  |2aliases =
-|
+  |2type    =line
-{{Tracked|300}}
+  |2def     =
-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)
+  |2stat    =optional
-|}
+  |2sv      = resolved/invalid/duplicate/declined/open
-</div>
+  |3        =float
+  |3label   =float
+  |3d-en    =Sets CSS float and clear properties
+  |3aliases =
+  |3type    =line
+  |3def     =right
+  |3stat    =optional-
+  |3sv      =right/left/none/both/inherit
-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:
+  |4        =style
+  |4label   =style
+  |4d-en    =Adds additional CSS to the box
+  |4aliases =
+  |4type    =
+  |4def     =
+  |4stat    =optional-
-<div style="margin-left:4em;">
+  |name               =Tracked
-'''Sample output:'''
+  |desc               =Link box to a bug report
-{| class="wikitable" width="500px"
+  |namespace          =all
-|-
+  |usergroup          =all
-|
+  |placement          =
-{{Tracked|300|fixed}}
+  |mustbesubst        =
+| relieson = {{tld|Tracked/layout}}
+  |useTemplateData    = 1
+  |usage-notes        =
+  |shorthand          =
+  |setscats           =
+  |seealso            = [[Template:Tracked github]]
+  |type               =
+  |i18n-desc          =
+  |i18n-mediawiki-msg =
+| i18n-method = TNT
+  |example            =T1234{{!}}resolved
+  |example-value      ={{Tracked|T1234|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)
-|}
+  |example2           =T2001
-</div>
+  |print              =
+}}
-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>
+<includeonly>{{Sandbox other||
+<!-- Categories below this line; interwikis at Wikidata -->
-<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)
-|}
-</div>
-Of course, feel free to avoid using this template if tracking a comment is not useful.
-<div style="margin-left:4em;">
-{| class="wikitable" width="500px"
-|-
-|
-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>
 [[Category:Maintenance templates]]
+}}</includeonly>