Teamplaid:Stronggood/documentation
This is a documentation subpage for Teamplaid:Stronggood. It contains usage information, categories and other content that is not part of the original teamplaid page. |
Ùsaid - Usage
[deasaich]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.
Paramadairean - Parameters
[deasaich]See Teamplaid:Strong#Optional parameters.
Faic cuideachd - Also see
- {{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 {{Deprecated code}} and its variants below - {{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>
)
- {{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
- {{Deprecated code}} 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>
)
- {{Xtn}} inline neutral example text, with no color change, when none of the above applies; used for "permissible" examples neither favored nor deprecated
- {{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.: {{Strongbad|Not for use in mainspace.}}