View source for Template:BugNotice/Doc

<noinclude>{{doc/subpage}}</noinclude>
{{Shortcut|bug}}
{{clr}}
__NOTOC__
{{Inline note templates}}
<!-- Please place categories where indicated at the bottom of this page -->
== Translations ==
Some translations are located in [[Template:Dictionary/notices]] strings subpage.

== 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]].
* {{Param|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 {{param|hidetested}} (shortcut for hidetested param use: {{T|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 {{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]].
** {{Note|Currently has experimental support for engine branches.}}
* {{param|since}} - Since which game (abbreviation) does this bug exist? If blank or undefined, defaults to <code>css</code> (Counter-Strike: Source).
** {{Note|Currently has experimental support for engine branches.}}
* {{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.
** {{Note|Currently has experimental support for engine branches.}}
{{{otherparams|}}}

=== Examples ===
{| border=1 style="border-collapse:collapse; background:none" cellpadding=8
!colspan=2| Wikitext !! {{Dictionary/common|Desc}} / {{Dictionary/Note/{{pagelang}}}} !! Result
|-
|style=white-space:nowrap| {{code|<nowiki>{{</nowiki>Bug{{!}}This is an example text.<nowiki>}}</nowiki>}}
| →
|
| {{ Bug |This is an example text.| nocat=1 }}
|-
|style=white-space:nowrap| {{code|<nowiki>{{</nowiki>Bug{{!}} hidetested{{=}}1 {{!}}<br># Enum<br># Eration<br><nowiki>}}</nowiki>}}
| →
|
| {{ Bug | hidetested=1 |
# Enum
# Eration
|nocat=1
}}
|-
| {{code|<nowiki><text here></nowiki><br><nowiki>{{Bug|<text here>}}</nowiki><br><nowiki><text here></nowiki>}}
| →
|
|{{Lorem ipsum}}
{{ Bug | nocat=1 | {{Lorem ipsum}} }}
{{Lorem ipsum}}
|-
| {{code|<nowiki>{{Bug|A Hammer bug.|only=|tested=Hammer 3.5}}</nowiki>}}
| →
|
| {{Bug|A Hammer bug.|only=|tested=Hammer 3.5}}
|-
| {{code|<nowiki>{{Bug|Nasty Witch bug.|only=l4ds|tested=l4d2}}</nowiki>}}
| →
|
| {{Bug|Nasty Witch bug.|only=l4ds|tested=l4d2}}
|-
| {{code|<nowiki>{{Bug|Bug that affects all Source games.|since=}}</nowiki>}}
| →
| 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=}}
|-
| {{code|<nowiki>{{Bug|Issue patched in {{hl2ep1}}.|fixed=hl2ep1}}</nowiki>}}
| →
| 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}}
|-
| {{code|<nowiki>{{Bug|Affected {{as}} and {{portal2}}.|since=as|fixed=csgo}}</nowiki>}}
| →
| 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}}
{{{otherexamples|}}}
|}
{{Clr}}
{{{othersections|}}} <!-- such as Tracking category -->

=== Issue ===
When trying to use {{T|Expand}} inside bug that's indented using {{Code|{{colon}}}} stuff breaks. (This issue applies to all the other notices too)
 <nowiki>:{{Bug|{{Expand|}}}}</nowiki> becomes
:{{Bug|{{Expand|}}}}

as workaround you can use <code>dd</code> tag
 <nowiki><dd>{{Bug|{{Expand|}}}}</dd></nowiki>
<dd>{{Bug|{{Expand|}}}}</dd>

<includeonly>{{sandbox other||
<!-- Categories below this line, please -->
[[Category:Inline note templates|{{PAGENAME}}]]
[[Category:Notice templates|{{PAGENAME}}]]
}}</includeonly>