Template:BugNotice/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Blanked see if its fixes anything.)
Tag: Blanking
(Imported from Template:Note/doc but slightly modified with some params added from ClassicBug. This is to avoid template loop.)
Line 1: Line 1:
{{doc/subpage}}
{{Inline note templates}}
<!-- Please place categories where indicated at the bottom of this page -->
== Usage ==
=== Parameters ===
* {{Param}} – The text to show on the right. The characters <code>=</code> and <code>|</code> can break this template because they are special characters in template calls. Use <code>[[Template:=|<nowiki>{{</nowiki>=}}]]</code> and <code>[[Template:!|<nowiki>{{</nowiki>!}}]]</code> instead; See [[:Category:Templates for within templates]].
The following parameters are used to categorize the bug by affected Source games. Parameter {{para|only}} cannot be used together with {{para|since}} and/or {{para|fixed}}.


* {{param|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]].
* {{param|since}} - Since which game (abbreviation) does this bug exist? If blank or undefined, defaults to <code>css</code> (Counter-Strike: Source).
* {{param|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.
{{{otherparams|}}}
=== Examples ===
{| border=1 style="border-collapse:collapse; background:none" cellpadding=8
!colspan=2| Wikitext !! Result
|-
| {{code|<nowiki>{{</nowiki>{{ROOTPAGENAME}}<nowiki>}}</nowiki>}}
| &rarr;
| {{ {{ROOTPAGENAME}} | nocat=1}}
|-
|style=white-space:nowrap| {{code|<nowiki>{{</nowiki>{{ROOTPAGENAME}}|This is an example text.}}}}
| &rarr;
| {{ {{ROOTPAGENAME}} |This is an example text.| nocat=1 }}
|-
|style=white-space:nowrap| {{code|<nowiki>{{</nowiki>{{ROOTPAGENAME}}|<br>Enumeration<br># Enum<br># Eration<br>}}}}
| &rarr;
| {{ {{ROOTPAGENAME}} |
Enumeration
# Enum
# Eration
|nocat=1
}}
|-
| {{code|<nowiki><text here></nowiki><br><nowiki>{{Bug|<text here>}}</nowiki><br><nowiki><text here></nowiki>}}
| &rarr;
|{{Lorem ipsum}}
{{ {{ROOTPAGENAME}} | nocat=1 | {{Lorem ipsum}} }}
{{Lorem ipsum}}
|-
| {{code|<nowiki>{{Bug|A Hammer bug.|only=}}</nowiki>}}
| &rarr;
| {{Bug|A Hammer bug.|only=}}
|-
| {{code|<nowiki>{{Bug|Nasty Witch bug.|only=l4ds}}</nowiki>}}
| &rarr;
| {{Bug|Nasty Witch bug.|only=l4ds}}
|-
| {{code|<nowiki>{{Bug|Bug that affects all Source games.|since=}}</nowiki>}}
| &rarr;
| {{Bug|Bug that affects all Source games.|since=}}
|-
| {{code|<nowiki>{{Bug|Issue patched in {{hl2ep1}}.|fixed=hl2ep1}}</nowiki>}}
| &rarr;
| {{Bug|Issue patched in {{hl2ep1}}.|fixed=hl2ep1}}
|-
| {{code|<nowiki>{{Bug|Affected {{as}} and {{portal2}}.|since=as|fixed=csgo}}</nowiki>}}
| &rarr;
| {{Bug|Affected {{as}} and {{portal2}}.|since=as|fixed=csgo}}
{{{otherexamples|}}}
|}
{{Clr}}
{{{othersections|}}} <!-- such as Tracking category -->
<includeonly>{{sandbox other||
<!-- Categories below this line, please -->
[[Category:Inline note templates|{{PAGENAME}}]]
[[Category:Notice templates|{{PAGENAME}}]]
}}</includeonly>

Revision as of 21:28, 14 August 2023

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

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.
  • {{{since}}} - Since which game (abbreviation) does this bug exist? If blank or undefined, defaults to css (Counter-Strike: Source).
  • {{{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.


Examples

Wikitext Result
{{BugNotice}} →
Icon-Bug.pngBug:  [todo tested in ?]
{{BugNotice}} →
Icon-Bug.pngBug:This is an example text.  [todo tested in ?]
{{BugNotice}} →
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=}} →
Icon-Bug.pngBug:Bug that affects all Source games.  [todo tested in ?]
{{Bug|Issue patched in {{hl2ep1}}.|fixed=hl2ep1}} →
Icon-Bug.pngBug:Issue patched in Half-Life 2: Episode One.  [todo tested in ?]
{{Bug|Affected {{as}} and {{portal2}}.|since=as|fixed=csgo}} →
Icon-Bug.pngBug:Affected Alien Swarm and Portal 2.  [todo tested in ?]


Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Template:BugNotice/doc&oldid=338390"