Template:Stronggood/doc: Difference between revisions
(→Template:Stronggood: Important to show; keeping with the std in other template families (e.g. Template:String-handling templates)) |
m (1 revision imported: initial setup) |
(No difference)
|
Latest revision as of 09:01, 25 August 2024
This is a documentation subpage for Template:Stronggood. It contains usage information, categories and other content that is not part of the original Template page. |
Usage
This template should not be used in mainspace (the article namespace). |
This template is used to insert a quick and easy positive notice with high visibility (because it is green) on project and discussion pages (like the following sentence). Only use this template on non-article pages. (It cannot actually be used in articles; it will generate an error.) 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). It is the opposite of the {{strongbad}} template.
{{stronggood|important text}}
or, if the important text contains an equals sign:
{{stronggood|1=important text}}
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 Template:Strong#Optional parameters.
See also
- {{strong}} – same but not green (same color as surrounding text, usually black)
- {{strongbad}} – same but red
- {{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 alsostrikes through the text - {{dcr}} inline
strongly deprecated or deleted material; {{dc2}} variant hasstrikethrough(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 mono-spaced font - {{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.