Template:BugNotice/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (→‎Examples: clean up)
Line 23: Line 23:
|-
|-
| {{code|<nowiki>{{</nowiki>{{ROOTPAGENAME}}<nowiki>}}</nowiki>}}
| {{code|<nowiki>{{</nowiki>{{ROOTPAGENAME}}<nowiki>}}</nowiki>}}
| &rarr;
|
|
|
| {{ {{ROOTPAGENAME}} | nocat=1}}
| {{ {{ROOTPAGENAME}} | nocat=1}}
|-
|-
|style=white-space:nowrap| {{code|<nowiki>{{</nowiki>{{ROOTPAGENAME}}{{!}}This is an example text.<nowiki>}}</nowiki>}}
|style=white-space:nowrap| {{code|<nowiki>{{</nowiki>{{ROOTPAGENAME}}{{!}}This is an example text.<nowiki>}}</nowiki>}}
| &rarr;
|
|
|
| {{ {{ROOTPAGENAME}} |This is an example text.| nocat=1 }}
| {{ {{ROOTPAGENAME}} |This is an example text.| nocat=1 }}
|-
|-
|style=white-space:nowrap| {{code|<nowiki>{{</nowiki>{{ROOTPAGENAME}}{{!}}<br>Enumeration<br># Enum<br># Eration<br><nowiki>}}</nowiki>}}
|style=white-space:nowrap| {{code|<nowiki>{{</nowiki>{{ROOTPAGENAME}}{{!}}<br>Enumeration<br># Enum<br># Eration<br><nowiki>}}</nowiki>}}
| &rarr;
|
|
|
| {{ {{ROOTPAGENAME}} |
| {{ {{ROOTPAGENAME}} |
Line 43: Line 43:
|-
|-
| {{code|<nowiki><text here></nowiki><br><nowiki>{{Bug|<text here>}}</nowiki><br><nowiki><text here></nowiki>}}
| {{code|<nowiki><text here></nowiki><br><nowiki>{{Bug|<text here>}}</nowiki><br><nowiki><text here></nowiki>}}
| &rarr;
|
|
|
|{{Lorem ipsum}}
|{{Lorem ipsum}}
Line 50: Line 50:
|-
|-
| {{code|<nowiki>{{Bug|A Hammer bug.|only=}}</nowiki>}}
| {{code|<nowiki>{{Bug|A Hammer bug.|only=}}</nowiki>}}
| &rarr;
|
|
|
| {{Bug|A Hammer bug.|only=}}
| {{Bug|A Hammer bug.|only=}}
|-
|-
| {{code|<nowiki>{{Bug|Nasty Witch bug.|only=l4ds}}</nowiki>}}
| {{code|<nowiki>{{Bug|Nasty Witch bug.|only=l4ds}}</nowiki>}}
| &rarr;
|
|
|
| {{Bug|Nasty Witch bug.|only=l4ds}}
| {{Bug|Nasty Witch bug.|only=l4ds}}
|-
|-
| {{code|<nowiki>{{Bug|Bug that affects all Source games.|since=}}</nowiki>}}
| {{code|<nowiki>{{Bug|Bug that affects all Source games.|since=}}</nowiki>}}
| &rarr;
|
| With {{param|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.
| With {{param|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.|since=}}
| {{Bug|Bug that affects all Source games.|since=}}
|-
|-
| {{code|<nowiki>{{Bug|Issue patched in {{hl2ep1}}.|fixed=hl2ep1}}</nowiki>}}
| {{code|<nowiki>{{Bug|Issue patched in {{hl2ep1}}.|fixed=hl2ep1}}</nowiki>}}
| &rarr;
|
| With {{param|fixed}} parameters specified, the page will be added into a category.<br>This example shown here, will add the page from previous affected titles (such as {{hl2|4}}, or {{src04|4}}, which goes to [[:Category:Pages with Half-Life 2 bugs|Category:Pages with Half-Life 2 bugs]]), if {{hl2ep1|4}} have this bug fixed, [[:Category:Pages with Half-Life 2: Episode One bugs|Category:Pages with Half-Life 2: Episode One bugs]] won't be added.
| With {{param|fixed}} parameters specified, the page will be added into a category.<br>This example shown here, will add the page from previous affected titles (such as {{hl2|4}}, or {{src04|4}}, which goes to [[:Category:Pages with Half-Life 2 bugs|Category:Pages with Half-Life 2 bugs]]), if {{hl2ep1|4}} have this bug fixed, [[:Category:Pages with Half-Life 2: Episode One bugs|Category:Pages with Half-Life 2: Episode One bugs]] won't be added.
| {{Bug|Issue patched in {{hl2ep1}}.|fixed=hl2ep1}}
| {{Bug|Issue patched in {{hl2ep1}}.|fixed=hl2ep1}}
|-
|-
| {{code|<nowiki>{{Bug|Affected {{as}} and {{portal2}}.|since=as|fixed=csgo}}</nowiki>}}
| {{code|<nowiki>{{Bug|Affected {{as}} and {{portal2}}.|since=as|fixed=csgo}}</nowiki>}}
| &rarr;
|
| With both {{param|as}} and {{param|fixed}} specified, the page will be added into a category.<br>This example shown here, will add the page to [[:Category:Pages with Alien Swarm bugs|Category:Pages with Alien Swarm bugs]] and [[:Category:Pages with Portal 2 bugs|Category:Pages with Portal 2 bugs]].
| With both {{param|as}} and {{param|fixed}} specified, the page will be added into a category.<br>This example shown here, will add the page to [[:Category:Pages with Alien Swarm bugs|Category:Pages with Alien Swarm bugs]] and [[:Category:Pages with Portal 2 bugs|Category:Pages with Portal 2 bugs]].
| {{Bug|Affected {{as}} and {{portal2}}.|since=as|fixed=csgo}}
| {{Bug|Affected {{as}} and {{portal2}}.|since=as|fixed=csgo}}

Revision as of 02:20, 12 January 2024

Edit-copy.png
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.
Inline note templates
Template Pages using it
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.

Usage

Parameters

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.pngNote: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.pngNote: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.pngNote:Currently has experimental support for engine branches.


Examples

Wikitext Description /

Preview English (en)Deutsch (de)Esperanto (eo)Español (es)Français (fr)Suomi (fi)Hrvatski (hr)Magyar (hu)Italiano (it)日本語 (ja)한국어 (ko)Nederlands (nl)Polski (pl)Português (pt)Português do Brasil (pt-br)Русский (ru)Slovenčina (sk)Svenska (sv)Türkçe (tr)Українська (uk)Tiếng Việt (vi)中文 (zh)中文(臺灣) (zh-tw)

Note

Todo

Warning

Deprecated

Bug

Tip

Code

Code Fix

Fix

Important

Confirm

Workaround

Risk of Confusion

Example

How

Placement Tip

Idea

Translate

English (en) Finished notices: 17 / 17 Translate


Deutsch (de) Finished notices: 17 / 17 Translate


Esperanto (eo) Finished notices: 17 / 17 Translate


Español (es) Finished notices: 17 / 17 Translate


Français (fr) Finished notices: 13 / 17 Translate


Suomi (fi) Finished notices: 17 / 17 Translate


Hrvatski (hr) Finished notices: 17 / 17 Translate


Magyar (hu) Finished notices: 6 / 17 Translate


Italiano (it) Finished notices: 7 / 17 Translate


日本語 (ja) Finished notices: 1 / 17 Translate


한국어 (ko) Finished notices: 12 / 17 Translate


Nederlands (nl) Finished notices: 4 / 17 Translate


Polski (pl) Finished notices: 5 / 17 Translate


Português (pt) Finished notices: 7 / 17 Translate


Português do Brasil (pt-br) Finished notices: 17 / 17 Translate


Русский (ru) Finished notices: 17 / 17 Translate


Slovenčina (sk) Finished notices: 17 / 17 Translate


Svenska (sv) Finished notices: 5 / 17 Translate


Türkçe (tr) Finished notices: 3 / 17 Translate


Українська (uk) Finished notices: 6 / 17 Translate


Tiếng Việt (vi) Finished notices: 14 / 17 Translate


中文 (zh) Finished notices: 17 / 17 Translate


中文(臺灣) (zh-tw) Finished notices: 11 / 17 Translate


Note.pngNote:If wanting to create translation for new language simply create page like this Category:<language shortcut>/Dictionary/Notices and save it with following content {{subst:Category:En/Dictionary/Notices}}

See Also

!! Result
{{BugNotice}}
Icon-Bug.pngBug:  [todo tested in ?]
{{BugNotice|This is an example text.}}
Icon-Bug.pngBug:This is an example text.  [todo tested in ?]
{{BugNotice|
Enumeration
# Enum
# Eration
}}
Icon-Bug.pngBug:

Enumeration

  1. Enum
  2. Eration
  [todo tested in ?]
<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.
Icon-Bug.pngBug: 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=}}
Icon-Bug.pngBug:A Hammer bug.  [todo tested in ?]
{{Bug|Nasty Witch bug.|only=l4ds}}
Icon-Bug.pngBug:Nasty Witch bug.  [todo tested in ?]
{{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.
Icon-Bug.pngBug: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 Half-Life 2, or Source 2004 Source 2004, which goes to Category:Pages with Half-Life 2 bugs), if Half-Life 2: Episode One Half-Life 2: Episode One have this bug fixed, Category:Pages with Half-Life 2: Episode One bugs won't be added.
Icon-Bug.pngBug:Issue patched in Half-Life 2: Episode One.  [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.
Icon-Bug.pngBug:Affected Alien Swarm and Portal 2.  [todo tested in ?]