Template:Rh/doc

From LIMSWiki
Jump to navigationJump to search


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
colspan=2 Template:Yes-No
...
!{{Yes}} ||{{No}} ||rowspan=2 {{n/a}}
|-
|colspan=2 {{Yes-No}}
...

Templates in this series

Table cell templates
Class[1] Template Preview Preview, alternative
table-rh {{rh}} | Row header Row header
{{rh2}}[2] | Row header Template:Rh2 | Row header
table-yes {{yes}}, {{yes|Alternative [[Plain text|text]]}} Yes Alternative text
table-no {{no}}, {{no|Alternative [[Plain text|text]]}} No Alternative text
{{coming soon}} Template:Coming soon
{{bad}}, {{bad|F}} Template:Bad Template:Bad
table-siteactive {{Site active}} Template:Site active
table-siteinactive {{Site inactive}} Template:Site inactive
table-yes2 {{yes2}}[3] Text Text
{{won}}, {{won|5}} Template:Won Template:Won
{{won|place=1}} or =Gold Template:Won
{{won|place=2}} or =Silver Template:Won
{{won|place=3}} or =Bronze Template:Won
{{won|text=white|color=blue}} or =#1122CC Template:Won
{{good}}, {{good|A}} Good A
table-no2 {{no2}}[3] Text Template:No2 Text
{{nom}}, {{nom|5}} Template:Nom Template:Nom
{{sho}} Template:Sho
table-partial {{partial}} Template:Partial
{{yes-No}} Template:Yes-No
{{okay}}, {{okay|C}} Template:Okay Template:Okay
{{some}} Template:Some
table-any {{any}} Template:Any
table-na {{n/a}} N/A
{{BLACK}} Template:BLACK
table-unknown {{dunno}} Template:Dunno
{{Unknown}} Template:Unknown
table-depends {{Depends}}, {{Depends|Alternative [[Plain text|text]]}} Template:Depends Template:Depends
table-included {{Included}} Template:Included
table-dropped {{dropped}} Template:Dropped
{{terminated}} Template:Terminated
table-beta {{beta}} Template:Beta
{{table-experimental}}, {{table-experimental|Alternative [[Plain text|text]]}} Template:Table-experimental Template:Table-experimental
table-free {{free}}, {{free|Alternative [[Plain text|text]]}} Template:Free Template:Free
table-nonfree {{nonfree}}, {{nonfree|Alternative [[Plain text|text]]}} Template:Nonfree Template:Nonfree
table-proprietary {{proprietary}}, {{proprietary|Alternative [[Plain text|text]]}} Template:Proprietary Template:Proprietary
table-needs {{needs}}, {{needs|Alternative [[Plain text|text]]}} Template:Needs Template:Needs
no class {{incorrect}}, {{incorrect|Alternative [[Plain text|text]]}} Template:Incorrect Template:Incorrect
no class {{no result}}, {{no result|N.R.}} Template:No result Template:No result
no class {{pending}} Template:Pending
table-nightly {{nightly}}, {{nightly|Alternative [[Plain text|text]]}} Template:Nightly Template:Nightly
table-release-candidate {{release-candidate}}, {{release-candidate|Alternative [[Plain text|text]]}} Template:Release-candidate Template:Release-candidate
no class {{?}}[4] Template:?
no class {{unofficial}} Template:Unofficial
no class {{usually}} Template:Usually
no class {{rarely}} Template:Rarely

Code

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

Template:Table cell templates

Code specific to this template:

style="background: #ececec; color: black; font-weight: bold; vertical-align: middle; text-align: left; " class="table-rh"

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}}}.

See also

Notes

  1. The HTML class of table cell templates may be referenced in a user stylesheet to change appearance.
  2. Does not take a parameter; the content should be placed after the template call, separated by a pipe (|) character.
  3. 3.0 3.1 Does not take a parameter; the content should be placed after the template call.
  4. Does not take a parameter; not really a table cell template at all, but here for completeness