Vorlage:Rh/doc
This is a documentation subpage for Vorlage:Rh. It contains usage information, categories and other content that is not part of the original vorlage page. |
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
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 |
table-yes |
{{yes}} | Yes | {{yes|Customized text}} | Customized text |
{{ya}} | {{ya|Customized alt text|link=WP:ALT}} | |||
table-no |
{{no}} | No | {{no|Customized text}} | Customized text |
{{na}} | {{na|Customized alt text|link=WP:ALT}} | |||
table-partial |
{{yes-No}} | Yes/No | ||
table-na |
{{n/a}} | N/A |
Code
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|}}}" class="automatic table-automatic"| {{{1|text}}}
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}}}
.
Notes
- ↑ The HTML class of table cell templates may be referenced in a user stylesheet to change appearance.
- ↑ Does not take a parameter; the content should be placed after the template call, separated by a pipe (|) character.