Template:Strong bad/doc

From Bharatpedia, an open encyclopedia
No relation to {{Homestar Runner}}.

Usage

This template is used to insert a quick and easy warning or negative notice with high visibility (because it is red) on project and discussion pages (like the following sentence). This template cannot be used in articles. In situations where color is not relevant (color blindness, screen readers, etc.), it renders exactly the same as {{strong}} (to which it is a CSS-styled call). This template is only for use in template documentation, guidelines, and other Bharatpedia-internal purposes. It is the opposite of the {{stronggood}} template.

{{strongbad|important text}}

Parameters

With the exception of alttext, the named parameters are toggles that are either omitted (default in most cases) or activated (by being assigned a value such as "on", "yes", "true", "include", etc.). They may be included in any order (see Examples below). Certain templates have the parameter "on" by default; see the main table for all alternate options. If a row renders identically to a previous row, it means the current template does not support that option and {{tlg}} needs to be used instead.

Parameter Action Use with
{{example}}
Default active
Default (without accessory parameters) example
brace Include braces as part of the template link example {{tlw}}/{{tn}}
braceinside Include innermost braces as part of the template link example
bold Renders the template link/name in bold example {{tlb}}, {{tlxb}}
code Display output using HTML <code>...</code> tags (monospaced font) example {{tlc}}, {{Template link expanded}}, etc.
italic Display any parameters accompanying the template link/name in italics example {{tlxi}}
kbd Display output using HTML <kbd>...</kbd> tags (monospaced font) example
nolink Don't render the template name as a link example {{tlf}}, {{tnull}}
nowrap Prevent the insertion of line breaks (word wrap) in the output example {{tlp}}
nowrapname Prevent word wrapping in the output of template name/link (parameters will wrap if needed) example
plaincode Uses <code style="border:none; background:transparent;">...</code> example {{tltss}}
subst Include a subst: prefix before the template link/name example {{tls}}, {{tlxs}}, etc
alttext=[text] Replace [text] with the actual label to be displayed for the template link example {{tla}}
_show_result Will also display the result of the template Min
_expand Will add a link to the expanded template page Min
a will add an asterisk before the template code Min

Unnamed (Positional)

This template can take any number of unnamed parameters as parameters accompanying the template link (or name); see Examples below.

Examples

Use the displayed value in the code column, not the underlying source code.

Note
On the source sister projects, en.wikipedia and Meta, X0, X1, X2, ..., X9 are sandbox templates for experimentation on involved templates that need be in template space. An auto-cleansing software facility exists that might be used to duplicate the facility on other Sister projects.
Code Output Remarks
{{strongbad|Banner}} Banner Template:Banner does not exist. (Non-existent template is redlinked.)
{{strongbad|Abc}} Abc Template:Abc exists.
{{strongbad|abC}} abC Template names are case-sensitive
{{strongbad|abc}} abc (but the first letter is case-insensitive).
{{strongbad|x0}} x0 no parameters
{{strongbad|x1|one}} x1 one parameter
{{strongbad|x2|one|two}} x2 two parameters
{{strongbad|x2|2=one=1|3=two=2}} x2 two parameters, assigned values
{{strongbad|x3|1|2|3|4|5|6|7|8|9|10}} x3 ten parameters
{{strongbad|convert|14|m|ftin|abbr=out|sp=us}} convert Unlimited parameters, as one <nowiki>...</nowiki> string.
{{strongbad|x2||two||}} x2 Empty parameters are discarded.
{{strongbad|x0|code=on}} x0 <code> style
{{strongbad|x0|plaincode=on}} x0 plaincode style
{{strongbad|x0|kbd=on}} x0 <kbd> style
{{strongbad|x0|bold=on}} x0 bold link/name
{{strongbad|x1|one|italic=on}} x1 parameter(s) in italics
{{strongbad|x0|nolink=on}} x0
{{strongbad|x0|subst=on}} x0
{{strongbad|x0|brace=on}} x0 all braces in link
{{strongbad|x0|braceinside=on}} x0 inside braces in link
{{strongbad|x0|alttext=x0 link}} x0
{{strongbad|x0|bold=on|code=on|brace=on}} x0 Combine multiple parameter settings.
{{strongbad|abc|{{spaces}}one{{spaces}}}} abc Using {{spaces}} before and after a parameter.
{{strongbad|x2|bold=on|code=on|one|two}} x2 Can combine named and anonymous parameters ...
{{strongbad|x2|one|two|bold=on|code=on}} x2 ... in any order ...
{{strongbad|x2|one|code=on|two|bold=on|three}} x2 ... even intermixed ...
{{strongbad|x2|one|code=on|two|bold=on|three|italic=on}} x2 ... with many configurations.
{{strongbad|x1}} x1 = won't work
{{strongbad|x1|x=u}} x1 &#61; is okay
{{strongbad|x1|x=u}} x1 {{=}} is okay (see Template:=)
{{strongbad|x1|x=u}} x1 Sticky nowiki is okay.
{{strongbad|x2|3=two|2=one}} x2
Right-to-left is okay
{{strongbad}} strongbad With no arguments, it emits the current page name without braces.
{{strongbad|x2|3=one|4=two}} x2 Null parameter stops parsing.
Wrapping of long names (default)
Code Output
{{strongbad|long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}} long template name that would wrap to new line
Wrapping of long names (nowrap=on)
Code Output
{{strongbad|nowrap=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} long template name that would wrap to new line
Wrapping of long names (nowrapname=on)
Code Output
{{strongbad|nowrapname=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} long template name that would wrap to new line

See also

General-purpose formatting

Comparison of template-linking templates according to the styles of generated text and link produced
Text style ↓ {{tlg}} options[note 1]
to achieve text style
Link style
Linked Unlinked Linked with subst Linked including braces Linked with alternative text
{{tlg}} options[note 1]
to achieve link style
N/A DEFAULT nolink=yes subst=yes braceinside=yes alttext=Foo
2=Foo
normal DEFAULT {{tlg}}[note 1]
{{tl}}
{{tlp|1|2|...}}[note 2]
{{Template:tlu}}[note 3]
{{tlf}}[note 2]
<template link>
{{subst:tls}}
{{subst:Template:tlsu}}[note 3]
{{tn}} {{tla}}
code code=yes {{tl2}}
{{tlx}}
{{Template:tlxu}}3[note 3]
{{tlc}}[note 2]
<template link>
{{tnull}}<template link>
{{subst:tlxs}} N/A
monospace plaincode=yes[note 4] N/A {{subst:tltss}}[note 5]
kbd kbd=yes[note 5]
bold bold=yes {{tlb}} N/A
bold+code bold=yes|code=yes {{tlxb}}
italic+code italic=yes|code=yes {{tlxi}}
  1. 1.0 1.1 1.2 {{tlg}} is the most general template, allowing any combination of text style and/or link style options.
  2. 2.0 2.1 2.2 Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.
  3. 3.0 3.1 3.2 Allows links to templates in any namespace.
  4. {{tlg|plaincode=yes}} uses <code style="border:none; background-color:transparent;">...</code>.
  5. 5.0 5.1 Displays monospaced font using <span style="font-family:monospace;">...</span>.

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters
Code example Effect Notes
{{tl2|Hatnote|lang=fr}} {{hatnote}} Supports linking to sister projects (e.g., fr:Hatnote)
{{tlu|User:Ahunt/SSHFS}} {{User:Ahunt/SSHFS}} Supports linking to any namespace
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}
{{hatnote|lang=fr|Some text}}

Shows code and example
{{xpd|Hatnote|Some hatnote text}} "{{hatnote|Template:Xpd/w}}" gives "" Template:Xpd/url%7D%7D%22 Shows code, example and a link to expand the template code
{{tln|Hatnote}} Template:Hatnote Produces a normal link to the template
{{elc|Template:Hatnote}}
{{elc|Template:Hatnote|Hatnote}}
[[Template:Hatnote]]
[[Template:Hatnote|Hatnote]]
Formats wikilink, with optional piped link text and blended suffix
{{ml|Example|hello}} {{#invoke:Example|hello}} Counterpart to {{tl}} for linking to Lua modules
{{mlx|Example|hello}} {{#invoke:Example|hello}} Counterpart to {{tlx}} for linking to Lua modules
{{para|title|<var>book title</var>}} |title=book title Formats template parameters for display, with or without values
{{sclx|LASTING}} [[BP:LASTING]] Takes a shortcut suffix in project namespace and displays it with brackets and the BP: alias in a <code>...</code> tag.
{{tag|ref}}
{{xtag|templatedata}}
<ref>...</ref>
<templatedata>
Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
{{dtl|Ping project}} {{d:Ping project}} Wikidata counterpart to {{tl}}
{{pf|if}}
{{pf|if|{{{1}}}|true|false}}
{{#if}}
{{#if:{{{1}}}|true|false}}
Parser function equivalent to {{tl}}
{{magic word|uc:}} {{uc:}} Magic word links

With utility links

Templates producing utility links for a given template (Hatnote used here as example)
Code example Effect
{{lt|Hatnote}} Template:Hatnote (edit | talk | history | links | watch | logs)
{{lts|Hatnote}} Template:Hatnote(edit talk links history)
{{t links|Hatnote}} Hatnote (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test)
{{tfd links|Hatnote}} Script error: No such module "Tfd links".
{{tetl|Hatnote}} {{Hatnote}}
links talk edit
{{tsetl|Hatnote}} {{subst:Hatnote}}
 links talk edit
{{ti|Hatnote}} Template:Hatnote (talk · links · edit)
{{tic|Hatnote}} Template:Hatnote (talk links edit)
{{tim|Hatnote}} m:Template:Hatnote (backlinks edit)
{{tiw|Hatnote}} Template:Hatnote (backlinks edit)
{{tlt|Hatnote}} {{Hatnote}} (talk)
{{ttl|Hatnote}} {{Hatnote}} (t/l)
{{twlh|Hatnote}} Template:Hatnote (links, talk)


or, if the important text contains an equals sign:

{{strongbad|1=important text}}

Parameters

With the exception of alttext, the named parameters are toggles that are either omitted (default in most cases) or activated (by being assigned a value such as "on", "yes", "true", "include", etc.). They may be included in any order (see Examples below). Certain templates have the parameter "on" by default; see the main table for all alternate options. If a row renders identically to a previous row, it means the current template does not support that option and {{tlg}} needs to be used instead.

Parameter Action Use with
{{example}}
Default active
Default (without accessory parameters) example
brace Include braces as part of the template link example {{tlw}}/{{tn}}
braceinside Include innermost braces as part of the template link example
bold Renders the template link/name in bold example {{tlb}}, {{tlxb}}
code Display output using HTML <code>...</code> tags (monospaced font) example {{tlc}}, {{Template link expanded}}, etc.
italic Display any parameters accompanying the template link/name in italics example {{tlxi}}
kbd Display output using HTML <kbd>...</kbd> tags (monospaced font) example
nolink Don't render the template name as a link example {{tlf}}, {{tnull}}
nowrap Prevent the insertion of line breaks (word wrap) in the output example {{tlp}}
nowrapname Prevent word wrapping in the output of template name/link (parameters will wrap if needed) example
plaincode Uses <code style="border:none; background:transparent;">...</code> example {{tltss}}
subst Include a subst: prefix before the template link/name example {{tls}}, {{tlxs}}, etc
alttext=[text] Replace [text] with the actual label to be displayed for the template link example {{tla}}
_show_result Will also display the result of the template Min
_expand Will add a link to the expanded template page Min
a will add an asterisk before the template code Min

Unnamed (Positional)

This template can take any number of unnamed parameters as parameters accompanying the template link (or name); see Examples below.

Examples

Use the displayed value in the code column, not the underlying source code.

Note
On the source sister projects, en.wikipedia and Meta, X0, X1, X2, ..., X9 are sandbox templates for experimentation on involved templates that need be in template space. An auto-cleansing software facility exists that might be used to duplicate the facility on other Sister projects.
Code Output Remarks
{{strongbad|Banner}} Banner Template:Banner does not exist. (Non-existent template is redlinked.)
{{strongbad|Abc}} Abc Template:Abc exists.
{{strongbad|abC}} abC Template names are case-sensitive
{{strongbad|abc}} abc (but the first letter is case-insensitive).
{{strongbad|x0}} x0 no parameters
{{strongbad|x1|one}} x1 one parameter
{{strongbad|x2|one|two}} x2 two parameters
{{strongbad|x2|2=one=1|3=two=2}} x2 two parameters, assigned values
{{strongbad|x3|1|2|3|4|5|6|7|8|9|10}} x3 ten parameters
{{strongbad|convert|14|m|ftin|abbr=out|sp=us}} convert Unlimited parameters, as one <nowiki>...</nowiki> string.
{{strongbad|x2||two||}} x2 Empty parameters are discarded.
{{strongbad|x0|code=on}} x0 <code> style
{{strongbad|x0|plaincode=on}} x0 plaincode style
{{strongbad|x0|kbd=on}} x0 <kbd> style
{{strongbad|x0|bold=on}} x0 bold link/name
{{strongbad|x1|one|italic=on}} x1 parameter(s) in italics
{{strongbad|x0|nolink=on}} x0
{{strongbad|x0|subst=on}} x0
{{strongbad|x0|brace=on}} x0 all braces in link
{{strongbad|x0|braceinside=on}} x0 inside braces in link
{{strongbad|x0|alttext=x0 link}} x0
{{strongbad|x0|bold=on|code=on|brace=on}} x0 Combine multiple parameter settings.
{{strongbad|abc|{{spaces}}one{{spaces}}}} abc Using {{spaces}} before and after a parameter.
{{strongbad|x2|bold=on|code=on|one|two}} x2 Can combine named and anonymous parameters ...
{{strongbad|x2|one|two|bold=on|code=on}} x2 ... in any order ...
{{strongbad|x2|one|code=on|two|bold=on|three}} x2 ... even intermixed ...
{{strongbad|x2|one|code=on|two|bold=on|three|italic=on}} x2 ... with many configurations.
{{strongbad|x1}} x1 = won't work
{{strongbad|x1|x=u}} x1 &#61; is okay
{{strongbad|x1|x=u}} x1 {{=}} is okay (see Template:=)
{{strongbad|x1|x=u}} x1 Sticky nowiki is okay.
{{strongbad|x2|3=two|2=one}} x2
Right-to-left is okay
{{strongbad}} strongbad With no arguments, it emits the current page name without braces.
{{strongbad|x2|3=one|4=two}} x2 Null parameter stops parsing.
Wrapping of long names (default)
Code Output
{{strongbad|long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}} long template name that would wrap to new line
Wrapping of long names (nowrap=on)
Code Output
{{strongbad|nowrap=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} long template name that would wrap to new line
Wrapping of long names (nowrapname=on)
Code Output
{{strongbad|nowrapname=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}} long template name that would wrap to new line

See also

General-purpose formatting

Comparison of template-linking templates according to the styles of generated text and link produced
Text style ↓ {{tlg}} options[note 1]
to achieve text style
Link style
Linked Unlinked Linked with subst Linked including braces Linked with alternative text
{{tlg}} options[note 1]
to achieve link style
N/A DEFAULT nolink=yes subst=yes braceinside=yes alttext=Foo
2=Foo
normal DEFAULT {{tlg}}[note 1]
{{tl}}
{{tlp|1|2|...}}[note 2]
{{Template:tlu}}[note 3]
{{tlf}}[note 2]
<template link>
{{subst:tls}}
{{subst:Template:tlsu}}[note 3]
{{tn}} {{tla}}
code code=yes {{tl2}}
{{tlx}}
{{Template:tlxu}}3[note 3]
{{tlc}}[note 2]
<template link>
{{tnull}}<template link>
{{subst:tlxs}} N/A
monospace plaincode=yes[note 4] N/A {{subst:tltss}}[note 5]
kbd kbd=yes[note 5]
bold bold=yes {{tlb}} N/A
bold+code bold=yes|code=yes {{tlxb}}
italic+code italic=yes|code=yes {{tlxi}}
  1. 1.0 1.1 1.2 {{tlg}} is the most general template, allowing any combination of text style and/or link style options.
  2. 2.0 2.1 2.2 Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.
  3. 3.0 3.1 3.2 Allows links to templates in any namespace.
  4. {{tlg|plaincode=yes}} uses <code style="border:none; background-color:transparent;">...</code>.
  5. 5.0 5.1 Displays monospaced font using <span style="font-family:monospace;">...</span>.

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters
Code example Effect Notes
{{tl2|Hatnote|lang=fr}} {{hatnote}} Supports linking to sister projects (e.g., fr:Hatnote)
{{tlu|User:Ahunt/SSHFS}} {{User:Ahunt/SSHFS}} Supports linking to any namespace
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}
{{hatnote|lang=fr|Some text}}

Shows code and example
{{xpd|Hatnote|Some hatnote text}} "{{hatnote|Template:Xpd/w}}" gives "" Template:Xpd/url%7D%7D%22 Shows code, example and a link to expand the template code
{{tln|Hatnote}} Template:Hatnote Produces a normal link to the template
{{elc|Template:Hatnote}}
{{elc|Template:Hatnote|Hatnote}}
[[Template:Hatnote]]
[[Template:Hatnote|Hatnote]]
Formats wikilink, with optional piped link text and blended suffix
{{ml|Example|hello}} {{#invoke:Example|hello}} Counterpart to {{tl}} for linking to Lua modules
{{mlx|Example|hello}} {{#invoke:Example|hello}} Counterpart to {{tlx}} for linking to Lua modules
{{para|title|<var>book title</var>}} |title=book title Formats template parameters for display, with or without values
{{sclx|LASTING}} [[BP:LASTING]] Takes a shortcut suffix in project namespace and displays it with brackets and the BP: alias in a <code>...</code> tag.
{{tag|ref}}
{{xtag|templatedata}}
<ref>...</ref>
<templatedata>
Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
{{dtl|Ping project}} {{d:Ping project}} Wikidata counterpart to {{tl}}
{{pf|if}}
{{pf|if|{{{1}}}|true|false}}
{{#if}}
{{#if:{{{1}}}|true|false}}
Parser function equivalent to {{tl}}
{{magic word|uc:}} {{uc:}} Magic word links

With utility links

Templates producing utility links for a given template (Hatnote used here as example)
Code example Effect
{{lt|Hatnote}} Template:Hatnote (edit | talk | history | links | watch | logs)
{{lts|Hatnote}} Template:Hatnote(edit talk links history)
{{t links|Hatnote}} Hatnote (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test)
{{tfd links|Hatnote}} Script error: No such module "Tfd links".
{{tetl|Hatnote}} {{Hatnote}}
links talk edit
{{tsetl|Hatnote}} {{subst:Hatnote}}
 links talk edit
{{ti|Hatnote}} Template:Hatnote (talk · links · edit)
{{tic|Hatnote}} Template:Hatnote (talk links edit)
{{tim|Hatnote}} m:Template:Hatnote (backlinks edit)
{{tiw|Hatnote}} Template:Hatnote (backlinks edit)
{{tlt|Hatnote}} {{Hatnote}} (talk)
{{ttl|Hatnote}} {{Hatnote}} (t/l)
{{twlh|Hatnote}} Template:Hatnote (links, talk)


These both render as:

important text

It is safest to always use the |1= syntax.

This template puts intentional and explicit <strong>...</strong> (importance, seriousness, or urgency) HTML markup around the text provided as the first parameter.

Because some people are color blind, and some use screen readers, this template should not be used in a manner in which only the color indicates the difference between the content being marked up and other content; it's simply a visual aid for those who can use it.

Parameters

See also

  • {{strong}} – same but not red (same color as surrounding text, usually black)
  • {{stronggood}} – same but green
  • {{em}} – for italic rather than bold semantic emphasis
     
  • {{xt}} inline positive example text, in green, with serif font
  • {{xt2}} same as {{xt}} but for blocks of text
  • {{bxt}} same as {{xt}} but uses bold instead of serif font
  • {{mxt}} same as {{xt}} but uses mono-spaced font (especially useful in source code)
     
  • {{!xt}} inline negative example text, in red, with serif font
  • {{!xt2}} same as {{!xt}} but for blocks (i.e., same as {{xt2}} but red)
  • {{!bxt}} same as {{!xt}} but uses boldface
  • {{!mxt}} same as {{!xt}} but uses mono-spaced font; used for incorrect or strongly deprecated code/output/input examples and should usually be wrapped in <code>, <samp>, or <kbd> as appropriate; see also {{dc}} and its variants below
  • {{!xts}} same as {{!xt}} but also strikes through the text
  • {{dcr}} inline strongly deprecated or deleted material; {{dc2}} variant has strikethrough (they both use the <del> element, and do not add monospace font on their own; can be used in mainspace (articles), and where necessary wrapped in <code>, <samp>, or <kbd>); see also {{dc}} below
     
  • {{xtd}} inline deprecated (or uncertain, unavailable, lorem, etc.) example text, in grey
  • {{bxtd}} same as {{xtd}} but uses boldface
  • {{mxtd}} same as {{xtd}} but uses Template:Mxtd
  • {{dc}} inline deprecated or deleted material; (uses the <del> element, and does not add monospace font on it own; can be used in mainspace (articles), and where necessary wrapped in <code>, <samp>, or <kbd>); see also {{dcr}} above
     
  • {{xtn}} inline neutral example text, with no color change, when none of the above applies; used for "permissible" examples neither favored nor deprecated
  • {{xtn2}} same as {{xtn}} but for blocks of text
  • {{bxtn}} same as {{xtn}} but uses boldface; it still applies a CSS class, so it's not simply boldfacing
  • {{mxtn}} same as {{xtn}} but uses mono-spaced font; this is a good template to use when the shaded box formatting of <code>...</code> might be undesirable, or the semantics of it is incorrect in the context
  • {{strongbad}} – for introducing something as deprecated or issuing some other warning in documentation, e.g.: Not for use in mainspace.