Template:BugNotice/doc: Difference between revisions

Latest revision as of 08:18, 24 January 2025

This is a documentation subpage for Template:BugNotice.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

Purge base's cache

Shortcut

bug

Inline note templates
Template	Pages using it
Template	28 August 2024
`{{note}}`	6,436
`{{warning}}`	1,253
`{{bug}}`	1,192
`{{tip}}`	1,516
`{{todo}}`	1,628
`{{inline note}}`	2,188
`{{confirm}}`	672
`{{question}}`	11
`{{fix}}`	170
`{{important}}`	459
`{{clarify}}`	169
`{{elaborate}}`	18
`{{main}}`	143
`{{distinguish}}`	85
`{{workaround}}`	122
`{{seealso}}`	145
`{{when}}`	1
`{{where}}`	0
`{{which}}`	2
`{{why}}`	38
`{{idea}}`	21
`{{placementTip}}`	13
`{{codenote}}`	21
`{{altnames}}`	35
`{{deprecated}}`	109
`{{how}}`	23
`{{example}}`	16
`{{confusion}}`	53
`{{thanks}}`	7
`{{code Fix}}`	9 + 7 (16)
`{{vote}}`	4

Translations

Some translations are located in Template:Dictionary/notices strings subpage.

For the [todo tested in ?], see this strings subpage.

Usage

Parameters

{{{1}}} – The text to show on the right. The characters = and | can break this template because they are special characters in template calls. Use {{=}} and {{!}} instead; See Category:Templates for within templates.
{{{tested}}} – Provide what game/software was the bug observed in. If this is a bug known to be present everywhere or it's a bug on a page about single game/software you can use {{{hidetested}}} (shortcut for hidetested param use: {{Bug*}}). The purpose of this being required parameter is to make it easier verifying/replicating noted bugs.

The following parameters are used to categorize the bug by affected Source games. Parameter |only= cannot be used together with |since= and/or |fixed=.

{{{only}}} - Abbreviation of the game or game series that has this bug. If blank, defaults to 'no game'. Do this to move pages with tool related or non-Source game bugs from Category:Pages with uncategorized bugs to Category:Pages with other bugs.
- Note:Currently has experimental support for engine branches.
{{{since}}} - Since which game (abbreviation) does this bug exist? If blank or undefined, defaults to css (Counter-Strike: Source).
- Note:Currently has experimental support for engine branches.
{{{fixed}}} - Since which game (abbreviation) is this bug fixed? If blank or undefined, defaults to 'none' which means that the bug was never fixed in Source.
- Note:Currently has experimental support for engine branches.

Examples

Wikitext		Description / Note	Result
{{Bug\|This is an example text.}}	→		Bug:This is an example text. [todo tested in ?]
{{Bug\| hidetested=1 \| # Enum # Eration }}	→		Bug: Enum Eration
<text here> {{Bug\|<text here>}} <text here>	→		Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Bug: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. [todo tested in ?] Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
{{Bug\|A Hammer bug.\|only=\|tested=Hammer 3.5}}	→		Bug:A Hammer bug. (tested in: Hammer 3.5)
{{Bug\|Nasty Witch bug.\|only=l4ds\|tested=l4d2}}	→		Bug:Nasty Witch bug. (tested in: l4d2)
{{Bug\|Bug that affects all Source games.\|since=}}	→	With `{{{since}}}` parameters specified as nothing, adds page to all "Pages with (game name) bugs" category^[confirm], if there's a bug in all Source engine games.	Bug:Bug that affects all Source games. [todo tested in ?]
{{Bug\|Issue patched in {{hl2ep1}}.\|fixed=hl2ep1}}	→	With `{{{fixed}}}` parameters specified, the page will be added into a category. This example shown here, will add the page from previous affected titles (such as Half-Life 2, or Source 2004, which goes to Category:Pages with Half-Life 2 bugs), if Half-Life 2: Episode One have this bug fixed, Category:Pages with Half-Life 2: Episode One bugs won't be added.	Bug:Issue patched in . [todo tested in ?]
{{Bug\|Affected {{as}} and {{portal2}}.\|since=as\|fixed=csgo}}	→	With both `{{{as}}}` and `{{{fixed}}}` specified, the page will be added into a category. This example shown here, will add the page to Category:Pages with Alien Swarm bugs and Category:Pages with Portal 2 bugs.	Bug:Affected and . [todo tested in ?]

Issue

When trying to use {{ExpandBox}} inside bug that's indented using : stuff breaks. (This issue applies to all the other notices too)

:{{Bug|{{ExpandBox|}}}}

Bug:

[todo tested in ?]

as workaround you can use dd tag

<dd>{{Bug|{{ExpandBox|}}}}</dd>

Bug:

[todo tested in ?]

{{Expand}} doesn't work in notice templates. Example:

:{{Bug|{{Expand|lorem}}}}

Bug: {| class="mw-collapsible mw-collapsed" style="background:rgba(0,0,0,0.05) ;float:no;margin-bottom:1em;margin-left:0;padding-right:0.5em;border:1px solid rgba(255,255,255,0.1); border-left:solid 1px #8bb9e0; padding-left:1em;"

|+ style="text-align:left; white-space:nowrap; font-weight:bold; color:#ddd; " | | lorem

|} [todo tested in ?]

{{Bug|{{Expand|lorem}}}}