Template:Rh2/doc

The {{Rh2}} row header template is usually for a discontinued or inactive thing (software, company, etc.). It does not take a parameter; the content should be placed after the template call, separated by a pipe (|) character.

You may put a list of {{legend}} in the article where {{Rh}} and {{Rh2}} are used. For example:

*{{legend|#ececec|Development status: current, or active}}
*{{legend|{{Rh2/bgcolor}}|Development status: inactive}}

shows

  •   Development status: current, or active
  •   Development status: inactive

The documentation for the templates series is shown below:



The templates in this series are designed to be used in a table to make a cell with text in that cell, with an appropriately colored background. They are commonly used in comparison tables. Most of these templates should not be used simply to produce a background color, use them according to their meaning.

For example, {{yes}} makes a cell with a green background. The text in the cell is taken from the first parameter; {{yes|Sure}} would output "Sure" otherwise it defaults to "Yes". Most templates allow authors to override the default text in this way, some require text put after the template call and some also need a vertical bar in between: {{table cell template}} text or {{table cell template}} | text. This information, the colors and default texts are found in the table below.

If you want to use other attributes for the table cells, e.g. colspan, rowspan, or style, they need to be put before the template call, and there must be no vertical bar (aka pipe) | in-between them:

Yes No
Yes/No
...
!{{Yes}} ||{{No}} ||rowspan=2 {{n/a}}
|-
|colspan=2 style="border:solid 3px Maroon" {{Yes-No}}
...

Templates[edit]

Table cell templates
Class[1] Default Customized
Syntax Preview Syntax Preview
table-rh {{rh}} | Row header[2] Row header {{rh|align=right}} | Row header Row header
{{rh2}} | Row header[2] Row header {{rh2|align=center}} | Row header Row header
table-yes {{yes}} Yes {{yes|customized [[Main_Page|text]]}} customized text
table-maybe {{maybe}} Maybe {{maybe|customized [[Main_Page|text]]}} customized text
table-no {{no}} No {{no|customized [[Main_Page|text]]}} customized text
table-active {{active}} Active {{active|live}} live
{{coming soon}} Coming soon {{coming soon|second half of the year}} second half of the year
table-success {{success}} Success {{success|mission complete}} mission complete
{{operational}} Operational {{operational|returning data}} returning data
table-failure {{failure}} Failure {{failure|wrong orbit}} wrong orbit
table-partial {{partial}} Partial {{partial|almost done}} almost done
{{MaybeCheck}} Maybe {{MaybeCheck|text=possibly}} possibly
{{okay}} Neutral {{okay|C}} C
{{Yes-No}} Yes/No {{Yes-No|yes with an if; no with a but}} yes with an if; no with a but
{{pending}} Pending {{pending|awaiting}} awaiting
{{unofficial}} Unofficial {{unofficial|''de facto''}} de facto
table-na {{n/a}} {{n/a|unavailable}} unavailable
{{unreleased}} Unreleased {{unreleased|shelved}} shelved
{{BLACK}} N/A {{BLACK|N/A}} N/A
table-planned {{planned}} Planned {{planned|July 2028}} July 2028
table-scheduled {{scheduled}} Scheduled {{scheduled|3 March 2027}} 3 March 2027
table-depends {{depends}} Depends {{depends|vendor-defined}} vendor-defined
table-dropped {{dropped}} Dropped {{dropped|discontinued}} discontinued
no class {{shade|100}}% 100% {{shade|color=blue|100}}% 100%
{{shade|75}}% 75% {{shade|color=blue|75|73–78}}% 73–78%
{{shade|25}}% 25% {{shade|color=blue|25|{{val|25|2|u=%}}}} 25%±2%
{{shade|0}}% 0% {{shade|color=blue|0}}% 0%
{{ColorCell}} {{ColorCell|Blank}} Blank
{{ColorCell|type=lred}} {{ColorCell|type=lred|Red}} Red
{{ColorCell|type=lgreen}} {{ColorCell|type=lgreen|Green}} Green

Code[edit]

Common code to most if not all the templates in this series:

style="background: #abcdef; color: black; vertical-align: middle; text-align: {{{align|center}}}; {{{style|text-transform: capitalize;}}}" class="automatic table-automatic"| {{{1|text}}}

Code specific to this template:

style="background: #F4E3FF; color: black; vertical-align: middle; text-align: left; font-weight: bolder; " scope="row" class="rh heading table-rh"

Creating new templates[edit]

To make a new table cell template you can use:

{{subst:Table cell templates|text= default text |bg= background color |class= a class name without prefix |align= standard horizontal alignment}}

You should leave out the align parameter and often the class parameter is unnecessary, too.

Add the new template to the table in the common documentation afterwards. Please consider reusing one of the other templates and please choose the color sensibly.

If you find a table cell template that does not take a parameter and you want to be able to change the text in the cell, do not duplicate the template! Instead, edit the template and change the text to a default parameter substitution. For example, if a template's text is Dropped, change that to {{{1|Dropped}}}.

style="background: #abcdef; color: black; vertical-align: middle; text-align: {{{align|center}}}; {{{style|}}}" class="automatic table-automatic"| {{{1|text}}}

Choosing a color[edit]

When changing or creating a new template, follow the Color when choosing the background color and, sometimes, the text color. Many of these templates can be used with links to other articles or references, so the links should be clearly identifiable against the background color. You can check contrast level using the WebAIM contrast checker by setting the foreground color to the blue link color. Contrast should be at the minimum WCAG AA level and, whenever possible, at WCAG AAA level. Help:Color/Accessibility has a set of colors that comply with WCAG AAA and WCAG AA for unvisited links and normal text.

Color subpage[edit]

All templates should either have a /bgcolor subpage that contains nothing but a valid CSS color code, possibly wrapped in nowiki tags, e.g. #BFD, which can be included with background: {{/bgcolor}}; in the style attribute, or they should reference another template's subpage, e.g. background: {{Template:Yes2/bgcolor}};. Alternatively, the /bgcolor subpage may redirect to another color code subpage: #REDIRECT [[yes2/bgcolor]].

This way, pages that are using these templates may also use {{legend}} and similar templates which can reference the actual color: {{legend|{{yes2/bgcolor}}|supported}}

TemplateData[edit]

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools.

TemplateData for Rh2

One of several templates for styling individual table cells with standard contents and colors.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
text1

text to be displayed instead of the default; if this doesn't work put the text after the template, possibly with a vertical bar | in between

Default
(template dependent)
Contentoptional
horizontal alignalign

text alignment inside the cell, either 'left', 'right', 'center' or 'justified'

Default
center
Stringoptional
stylestyle

a semicolon-separated list of additional CSS rules to be applied to the table cell

Default
(template dependent)
Stringoptional
background colorcolor

a valid CSS color value or name to override the standard cell background, only available with some templates

Default
(template dependent)
Lineoptional

See also[edit]

  • {{Change2}} – calculates, displays and color-codes changes between two values

Notes[edit]

  1. The HTML class of table cell templates may be referenced in a user stylesheet to change appearance.
  2. 2.0 2.1 Does not take a parameter; the content should be placed after the template call, separated by a pipe (|) character.