Template:Rh2/doc

From Hârn
Jump to navigation Jump to search

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/Active}}
*{{legend|{{Rh2/bgcolor}}|Development status: Inactive}}

shows

  •   Development status: Current/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.

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 or rowspan, they need to be put before the template call and there must be no vertical bar | in between them:

Yes No N/A
Yes/No
...
!{{Yes}} ||{{No}} ||rowspan=2 {{n/a}}
|-
|colspan=2 {{Yes-No}}
...

Templates[edit source]

Table cell templates
Class[1] Default syntax Preview (default) Customized syntax Preview (customized)
table-rh {{rh}} | Row header[2] Row header {{rh|align=right}} | Row header Row header
{{rh2}} | Row header[2] Row header {{rh2|align=right}} | Row header Row header
table-yes {{yes}} Yes {{yes|Customized [[Plain text|text]]}} Customized text
table-maybe {{maybe}} Maybe {{maybe|Customized [[Plain text|text]]}} Customized text
table-no {{no}} No {{no|Customized [[Plain text|text]]}} Customized text
{{eliminated}} Eliminated {{eliminated|Dropped out}} Dropped out
{{active fire|12%}} Active (12%)
{{lost}} Lost {{lost|Missing}} Missing
{{safe}} Safe {{safe|Protected}} Protected
table-active {{active}} Template:Active {{active|Lively}} Template:Active
table-siteactive {{site active}} Template:Site active {{site active|Up}} Template:Site active
{{coming soon}} Template:Coming soon {{coming soon|Second half of the year}} Template:Coming soon
table-siteinactive {{site inactive}} Template:Site inactive {{site inactive|Down}} Template:Site inactive
table-yes2 {{good}} Template:Good {{good|A}} Template:Good
{{yes2}} Template:Yes2 {{yes2|Text}} Template:Yes2
{{ya}} Template:Ya {{ya|text=Ya}} Template:Ya
{{ya|Ya}} Template:Ya {{ya|text|link=WP:ALT}} Template:Ya
{{won}} Template:Won {{won|text=white|color=darkblue}} Template:Won
{{won|place=1}} Template:Won {{won|place=Gold}} Template:Won
{{won|place=2}} Template:Won {{won|place=Silver}} Template:Won
{{won|place=3}} Template:Won {{won|place=Bronze}} Template:Won
table-no2 {{no2}} Template:No2 {{no2|Text}} Template:No2
{{na}} Template:Na {{na|text=Na}} Template:Na
{{na|Na}} Template:Na {{na|text|link=WP:ALT}} Template:Na
{{nom}} Template:Nom {{nom|5}} Template:Nom
{{sho}} Template:Sho {{sho|Proposed}} Template:Sho
{{longlisted}} Template:Longlisted {{longlisted|Rejected}} Template:Longlisted
{{TBA}} Template:TBA {{TBA|To be announced}} Template:TBA
table-success {{success}} Template:Success {{success|Mission complete}} Template:Success
{{operational}} Template:Operational {{operational|Returning data}} Template:Operational
table-failure {{failure}} Template:Failure {{failure|Wrong orbit}} Template:Failure
table-partial {{partial}} Template:Partial {{partial|Almost done}} Template:Partial
{{Regional}} Template:Regional {{Regional|Uyghur}} Template:Regional
{{MaybeCheck}} Template:MaybeCheck {{MaybeCheck|text=Possibly}} Template:MaybeCheck
{{MaybeCheck|Possibly}} Template:MaybeCheck {{MaybeCheck|text|link=WP:ALT}} Template:MaybeCheck
{{partial success}} Template:Partial success {{partial success|Reached orbit and returned pictures}} Template:Partial success
{{partial failure}} Template:Partial failure {{partial failure|[[Cubesat]] not deployed}} Template:Partial failure
{{okay}} Template:Okay {{okay|C}} Template:Okay
{{Yes-No}} Yes/No {{Yes-No|Yes with an if; no with a but}} Yes with an if; no with a but
{{some}} Template:Some {{some|Many}} Template:Some
{{nonpartisan}} Template:Nonpartisan {{nonpartisan|Impartial}} Template:Nonpartisan
{{pending}} Template:Pending {{pending|Awaiting}} Template:Pending
{{unofficial}} Template:Unofficial {{unofficial|''De facto''}} Template:Unofficial
{{unofficial2}} Template:Unofficial2 {{unofficial2|''De facto''}} Template:Unofficial2
{{usually}} Template:Usually {{usually|Commonly}} Template:Usually
{{rarely}} Template:Rarely {{rarely|Seldom}} Template:Rarely
{{sometimes}} Template:Sometimes {{sometimes|Occasionally}} Template:Sometimes
table-any {{any}} Template:Any {{any|Anyone}} Template:Any
table-na {{n/a}} N/A {{n/a|Unavailable}} Unavailable
{{varies}} Template:Varies {{varies|Differs}} Template:Varies
{{sdash}} Template:Sdash {{sdash|[[File:Dash.svg|13px|link=|dash icon]]}} Template:Sdash
{{BLACK}} N/A {{BLACK|Banned}} Banned
{{non-album single}} Template:Non-album single {{non-album single|Customized [[Plain text|text]]}} Template:Non-album single
{{unreleased}} Template:Unreleased {{unreleased|Customized [[Plain text|text]]}} Template:Unreleased
table-unknown {{unknown}} Template:Unknown {{unknown|?}} Template:Unknown
{{dunno}} Template:Dunno {{dunno|Not sure}} Template:Dunno
table-automatic {{perhaps}} Template:Perhaps {{perhaps|Customized [[Plain text|text]]}} Template:Perhaps
table-depends {{depends}} Template:Depends {{depends|Customized [[Plain text|text]]}} Template:Depends
table-included {{included}} Template:Included {{included|Incorporated}} Template:Included
table-dropped {{dropped}} Template:Dropped {{dropped|Discontinued}} Template:Dropped
{{terminated}} Template:Terminated {{terminated|Fired}} Template:Terminated
table-beta {{beta}} Template:Beta {{beta|Preview}} Template:Beta
table-experimental {{table-experimental}} Template:Table-experimental {{table-experimental|Customized [[Plain text|text]]}} Template:Table-experimental
table-free {{free}} Template:Free {{free|Customized [[Plain text|text]]}} Template:Free
table-proprietary {{proprietary}} Template:Proprietary {{proprietary|Customized [[Plain text|text]]}} Template:Proprietary
table-nonfree {{nonfree}} Template:Nonfree {{nonfree|Customized [[Plain text|text]]}} Template:Nonfree
table-needs {{needs}} Template:Needs {{needs|Customized [[Plain text|text]]}} Template:Needs
table-nightly {{nightly}} Template:Nightly {{nightly|Customized [[Plain text|text]]}} Template:Nightly
table-release-candidate {{release-candidate}} Template:Release-candidate {{release-candidate|Customized [[Plain text|text]]}} Template:Release-candidate
table-draw {{draw}} Template:Draw {{draw|Text}} Template:Draw
table-planned {{planned}} Template:Planned {{planned|July 2018}} Template:Planned
table-scheduled {{scheduled}} Template:Scheduled {{scheduled|3 March 2017}} Template:Scheduled
incorrect {{incorrect}} Template:Incorrect {{incorrect|Customized [[Plain text|text]]}} Template:Incorrect
noresult {{no result}} Template:No result {{no result|N.R.}} Template:No result
no class {{CMain}} Main {{CMain|Customized [[Plain text|text]]}} Customized text
{{CAlso starring}} Also starring {{CAlso starring|Customized [[Plain text|text]]}} Customized text
{{CRecurring}} Recurring {{CRecurring|Customized [[Plain text|text]]}} Customized text
{{CGuest}} Guest {{CGuest|Customized [[Plain text|text]]}} Customized text
{{CNone}} Does not appear {{CNone|Customized [[Plain text|text]]}} Customized text
{{nocontest}} {{nocontest|Customized [[Plain text|text]]}} Customized text
{{not yet}} Not Yet {{not yet|Customized [[Plain text|text]]}} Customized text
{{optional}} Optional {{optional|Customized [[Plain text|text]]}} Customized text

Code[edit source]

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

Template:Table cell templates

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: center; " class="automatic table-automatic"| text

TemplateData[edit source]

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly error report for this template.

TemplateData for Rh2

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

Template 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)
Lineoptional
horizontal alignalign

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

Default
center
Lineoptional
stylestyle

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

Default
Lineoptional
background colorcolor

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

Default
(template dependent)
Lineoptional

See also[edit source]

  • {{Change}} – calculates, displays and color-codes changes between two values
  • {{BSD-lic}} – specialized redirect for {{free}}
  • {{GPL-lic}} – specialized redirect for {{free}}
  • {{LGPL-lic}} – specialized redirect for {{free}}

Notes[edit source]

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

External links[edit source]



External links[edit source]