Difference between revisions of "Template:Table cell templates/doc"
m (Updating) |
m (updating) |
||
(6 intermediate revisions by the same user not shown) | |||
Line 23: | Line 23: | ||
{| class="wikitable" style="width:100%; text-align:left;" | {| class="wikitable" style="width:100%; text-align:left;" | ||
|+ Table cell templates | |+ Table cell templates | ||
− | ! rowspan=2 | Class<ref>The HTML class of table cell templates may be referenced in a [[ | + | ! rowspan=2 | Class<ref>The HTML class of table cell templates may be referenced in a [[mw:help:User style|user stylesheet]] to change appearance.</ref> |
! colspan=2 | Default | ! colspan=2 | Default | ||
! colspan=2 | Customized | ! colspan=2 | Customized | ||
Line 36: | Line 36: | ||
|- | |- | ||
|rowspan=1| <code>table-yes</code> | |rowspan=1| <code>table-yes</code> | ||
− | | {{tlx|yes}} || {{yes}} || {{tlx|yes|<nowiki>customized [[ | + | | {{tlx|yes}} || {{yes}} || {{tlx|yes|<nowiki>customized [[Main_Page|text]]</nowiki>}} ||{{yes|customized [[Main_Page|text]]}} |
|- | |- | ||
| <code>table-maybe</code> | | <code>table-maybe</code> | ||
− | | {{tlx|maybe}} || {{maybe}} || {{tlx|maybe|<nowiki>customized [[ | + | | {{tlx|maybe}} || {{maybe}} || {{tlx|maybe|<nowiki>customized [[Main_Page|text]]</nowiki>}} ||{{maybe|customized [[Main_Page|text]]}} |
|- | |- | ||
|rowspan=1| <code>table-no</code> | |rowspan=1| <code>table-no</code> | ||
− | | {{tlx|no}} || {{no}} || {{tlx|no|<nowiki>customized [[ | + | | {{tlx|no}} || {{no}} || {{tlx|no|<nowiki>customized [[Main_Page|text]]</nowiki>}} || {{no|customized [[Main_Page|text]]}} |
|- | |- | ||
− | | <code>table-active</code> | + | |rowspan=2| <code>table-active</code> |
| {{tlx|active}} || {{active}} || {{tlx|active|live}} || {{active|live}} | | {{tlx|active}} || {{active}} || {{tlx|active|live}} || {{active|live}} | ||
− | |||
− | |||
− | |||
|- | |- | ||
| {{tlx|coming soon}} || {{coming soon}} || {{tlx|coming soon|second half of the year}} || {{coming soon|second half of the year}} | | {{tlx|coming soon}} || {{coming soon}} || {{tlx|coming soon|second half of the year}} || {{coming soon|second half of the year}} | ||
− | |||
− | |||
− | |||
|- | |- | ||
| rowspan=2 |<code>table-success</code> | | rowspan=2 |<code>table-success</code> | ||
Line 63: | Line 57: | ||
| {{tlx|failure}} || {{failure}} || {{tlx|failure|wrong orbit}} || {{failure|wrong orbit}} | | {{tlx|failure}} || {{failure}} || {{tlx|failure|wrong orbit}} || {{failure|wrong orbit}} | ||
|- | |- | ||
− | |rowspan= | + | | rowspan=6| <code>table-partial</code> |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
| {{tlx|partial}} || {{partial}} || {{tlx|partial|almost done}} ||{{partial|almost done}} | | {{tlx|partial}} || {{partial}} || {{tlx|partial|almost done}} ||{{partial|almost done}} | ||
− | |||
− | |||
|- | |- | ||
| {{tlx|MaybeCheck}} || {{MaybeCheck}} || {{tlx|MaybeCheck|text{{=}}possibly}} || {{MaybeCheck|text=possibly}} | | {{tlx|MaybeCheck}} || {{MaybeCheck}} || {{tlx|MaybeCheck|text{{=}}possibly}} || {{MaybeCheck|text=possibly}} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| {{tlx|okay}} || {{okay}} || {{tlx|okay|C}} || {{okay|C}} | | {{tlx|okay}} || {{okay}} || {{tlx|okay|C}} || {{okay|C}} | ||
|- | |- | ||
| {{tlx|Yes-No}} || {{Yes-No}} || {{tlx|Yes-No|yes with an if; no with a but}} || {{Yes-No|yes with an if; no with a but}} | | {{tlx|Yes-No}} || {{Yes-No}} || {{tlx|Yes-No|yes with an if; no with a but}} || {{Yes-No|yes with an if; no with a but}} | ||
− | |||
− | |||
|- | |- | ||
| {{tlx|pending}} || {{pending}} || {{tlx|pending|awaiting}} || {{pending|awaiting}} | | {{tlx|pending}} || {{pending}} || {{tlx|pending|awaiting}} || {{pending|awaiting}} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| {{tlx|unofficial}} || {{unofficial}} || {{tlx|unofficial|<nowiki>''de facto''</nowiki>}} || {{unofficial|''de facto''}} | | {{tlx|unofficial}} || {{unofficial}} || {{tlx|unofficial|<nowiki>''de facto''</nowiki>}} || {{unofficial|''de facto''}} | ||
|- | |- | ||
− | + | |rowspan=3| <code>table-na</code> | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |rowspan= | ||
| {{tlx|n/a}} || {{n/a}} || {{tlx|n/a|unavailable}}|| {{n/a|unavailable}} | | {{tlx|n/a}} || {{n/a}} || {{tlx|n/a|unavailable}}|| {{n/a|unavailable}} | ||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| {{tlx|unreleased}} || {{unreleased}} || {{tlx|unreleased|shelved}} || {{unreleased|shelved}} | | {{tlx|unreleased}} || {{unreleased}} || {{tlx|unreleased|shelved}} || {{unreleased|shelved}} | ||
|- | |- | ||
− | | {{tlx|BLACK}} || {{BLACK}} || {{tlx|BLACK| | + | | {{tlx|BLACK}} || {{BLACK}} || {{tlx|BLACK|N/A}} || {{BLACK|N/A}} |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| <code>table-planned</code> | | <code>table-planned</code> | ||
Line 183: | Line 82: | ||
| <code>table-scheduled</code> | | <code>table-scheduled</code> | ||
| {{tlx|scheduled}} || {{scheduled}} || {{tlx|scheduled|3 March 2027}} || {{scheduled|3 March 2027}} | | {{tlx|scheduled}} || {{scheduled}} || {{tlx|scheduled|3 March 2027}} || {{scheduled|3 March 2027}} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| <code>table-depends</code> | | <code>table-depends</code> | ||
| {{tlx|depends}} || {{depends}} || {{tlx|depends|vendor-defined}} || {{depends|vendor-defined}} | | {{tlx|depends}} || {{depends}} || {{tlx|depends|vendor-defined}} || {{depends|vendor-defined}} | ||
|- | |- | ||
− | + | | <code>table-dropped</code> | |
| {{tlx|dropped}} || {{dropped}} || {{tlx|dropped|discontinued}} || {{dropped|discontinued}} | | {{tlx|dropped}} || {{dropped}} || {{tlx|dropped|discontinued}} || {{dropped|discontinued}} | ||
|- | |- | ||
− | + | |rowspan=7 | ''no class'' | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |rowspan= | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
| {{tlx|shade|100}}% || {{shade|100}}% || {{tlx|shade|color{{=}}blue|100}}% || {{shade|color=blue|100}}% | | {{tlx|shade|100}}% || {{shade|100}}% || {{tlx|shade|color{{=}}blue|100}}% || {{shade|color=blue|100}}% | ||
|- | |- | ||
Line 278: | Line 103: | ||
|- | |- | ||
| {{tlx|ColorCell|type{{=}}lgreen}} || {{ColorCell|type=lgreen}} || {{tlx|ColorCell|type{{=}}lgreen|Green}} || {{ColorCell|type=lgreen|Green}} | | {{tlx|ColorCell|type{{=}}lgreen}} || {{ColorCell|type=lgreen}} || {{tlx|ColorCell|type{{=}}lgreen|Green}} || {{ColorCell|type=lgreen|Green}} | ||
+ | |- | ||
|}</div> | |}</div> | ||
Line 301: | Line 127: | ||
== Choosing a color == | == Choosing a color == | ||
− | When changing or creating a new template, follow the [[Help:Color|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 [https://webaim.org/resources/contrastchecker/ WebAIM contrast checker] by setting the foreground color to the | + | When changing or creating a new template, follow the [[Help:Color|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 [https://webaim.org/resources/contrastchecker/ 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 == | == Color subpage == | ||
Line 350: | Line 176: | ||
== See also == | == See also == | ||
− | * {{tl| | + | * {{tl|Change2}} – calculates, displays and color-codes changes between two values |
− | |||
== Notes == | == Notes == |
Latest revision as of 13:52, 18 January 2024
This is a documentation subpage for Template:Table cell templates. It may contain usage information, categories and other content that is not part of the original template 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. 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}} ...
Contents
Templates[edit]
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}} |
{{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}}}
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]
TemplateData for Table cell templates
One of several templates for styling individual table cells with standard contents and colors.
Parameter | Description | Type | Status | |
---|---|---|---|---|
text | 1 | 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
| Content | optional |
horizontal align | align | text alignment inside the cell, either 'left', 'right', 'center' or 'justified'
| String | optional |
style | style | a semicolon-separated list of additional CSS rules to be applied to the table cell
| String | optional |
background color | color | a valid CSS color value or name to override the standard cell background, only available with some templates
| Line | optional |
See also[edit]
- {{Change2}} – calculates, displays and color-codes changes between two values
Notes[edit]
- ↑ The HTML class of table cell templates may be referenced in a user stylesheet to change appearance.
- ↑ 2.0 2.1 Does not take a parameter; the content should be placed after the template call, separated by a pipe (|) character.