Template:Table cell templates/doc

{{#invoke:Hatnote|hatnote}} 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:

Template:Yes	Template:No	N/A
colspan=2 Template:Yes-No

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

Templates

Table cell templates

Class	Default syntax	Preview (default)	Customized syntax	Preview (customized)
table-rh	{{rh}} | Row header	Template:Rh | Row header	{{rh|align=right}} | Row header	Template:Rh | Row header
	{{rh2}} | Row header	Template:Rh2 | Row header	{{rh2|align=right}} | Row header	Template:Rh2 | Row header
table-yes	{{yes}}	Template:Yes	{{yes|Customized [[Plain text|text]]}}	Template:Yes
	{{ya}}	Template:Ya	{{ya|Customized alt text|link=WP:ALT}}	Template:Ya
table-no	{{no}}	Template:No	{{no|Customized [[Plain text|text]]}}	Template:No
	{{na}}	Template:Na	{{na|Customized alt text|link=WP:ALT}}	Template:Na
	{{coming soon}}	Template:Coming soon
	{{bad}}	Template:Bad	{{bad|F}}	Template:Bad
	{{eliminated}}	Template:Eliminated
table-siteactive	{{site active}}	Template:Site active
table-siteinactive	{{site inactive}}	Template:Site inactive
table-yes2	{{good}}	Template:Good	{{good|A}}	Template:Good
	{{yes2}}	Template:Yes2	{{yes2|Text}}	Template:Yes2
	{{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
	{{nom}}	Template:Nom	{{nom|5}}	Template:Nom
	{{sho}}	Template:Sho
	{{TBA}}	Template:TBA	{{TBA|To be announced}}	Template:TBA
table-partial	{{partial}}	Template:Partial	{{partial|Almost done}}	Template:Partial
	{{yes-No}}	Template:Yes-No
	{{okay}}	Template:Okay	{{okay|C}}	Template:Okay
	{{some}}	Template:Some
table-any	{{any}}	Template:Any
table-na	{{n/a}}	N/A
	{{BLACK}}	Template:BLACK
table-unknown	{{dunno}}	Template:Dunno	{{dunno|Custom text}}	Template:Dunno
	{{unknown}}	Template:Unknown	{{unknown|?}}	Template:Unknown
table-depends	{{depends}}	Template:Depends	{{depends|Customized [[Plain text|text]]}}	Template:Depends
table-included	{{included}}	Template:Included
table-dropped	{{dropped}}	Template:Dropped
	{{terminated}}	Template:Terminated
table-beta	{{beta}}	Template:Beta
	{{table-experimental}}	Template:Table-experimental	{{table-experimental|Customized [[Plain text|text]]}}	Template:Table-experimental
table-maybe	{{maybe}}	Template:Maybe	{{maybe|Customized [[Plain text|text]]}}	Template:Maybe
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
no class	{{draw}}	Template:Draw	{{draw|Text}}	Template:Draw
no class	{{incorrect}}	Template:Incorrect	{{incorrect|Customized [[Plain text|text]]}}	Template:Incorrect
no class	{{no result}}	Template:No result	{{no result|N.R.}}	Template:No result
no class	{{pending}}	Template:Pending
no class	{{unofficial}}	Template:Unofficial
no class	{{usually}}	Template:Usually
no class	{{rarely}}	Template:Rarely
no class	{{sometimes}}	Template:Sometimes
no class	{{CMain}}	Template:CMain
no class	{{CRecurring}}	Template:CRecurring
no class	{{CGuest}}	Template:CGuest

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:

{{#invoke:Hatnote|hatnote}} 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, <code>{{yes}}</code> makes a cell with a green background. The text in the cell is taken from the first parameter; <code>{{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:

Template:Yes	Template:No	N/A
colspan=2 Template:Yes-No

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

Templates

Table cell templates

Class	Default syntax	Preview (default)	Customized syntax	Preview (customized)
table-rh	{{rh}} | Row header	Template:Rh | Row header	{{rh|align=right}} | Row header	Template:Rh | Row header
	{{rh2}} | Row header	Template:Rh2 | Row header	{{rh2|align=right}} | Row header	Template:Rh2 | Row header
table-yes	{{yes}}	Template:Yes	{{yes|Customized [[Plain text|text]]}}	Template:Yes
	{{ya}}	Template:Ya	{{ya|Customized alt text|link=WP:ALT}}	Template:Ya
table-no	{{no}}	Template:No	{{no|Customized [[Plain text|text]]}}	Template:No
	{{na}}	Template:Na	{{na|Customized alt text|link=WP:ALT}}	Template:Na
	{{coming soon}}	Template:Coming soon
	{{bad}}	Template:Bad	{{bad|F}}	Template:Bad
	{{eliminated}}	Template:Eliminated
table-siteactive	{{site active}}	Template:Site active
table-siteinactive	{{site inactive}}	Template:Site inactive
table-yes2	{{good}}	Template:Good	{{good|A}}	Template:Good
	{{yes2}}	Template:Yes2	{{yes2|Text}}	Template:Yes2
	{{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
	{{nom}}	Template:Nom	{{nom|5}}	Template:Nom
	{{sho}}	Template:Sho
	{{TBA}}	Template:TBA	{{TBA|To be announced}}	Template:TBA
table-partial	{{partial}}	Template:Partial	{{partial|Almost done}}	Template:Partial
	{{yes-No}}	Template:Yes-No
	{{okay}}	Template:Okay	{{okay|C}}	Template:Okay
	{{some}}	Template:Some
table-any	{{any}}	Template:Any
table-na	{{n/a}}	N/A
	{{BLACK}}	Template:BLACK
table-unknown	{{dunno}}	Template:Dunno	{{dunno|Custom text}}	Template:Dunno
	{{unknown}}	Template:Unknown	{{unknown|?}}	Template:Unknown
table-depends	{{depends}}	Template:Depends	{{depends|Customized [[Plain text|text]]}}	Template:Depends
table-included	{{included}}	Template:Included
table-dropped	{{dropped}}	Template:Dropped
	{{terminated}}	Template:Terminated
table-beta	{{beta}}	Template:Beta
	{{table-experimental}}	Template:Table-experimental	{{table-experimental|Customized [[Plain text|text]]}}	Template:Table-experimental
table-maybe	{{maybe}}	Template:Maybe	{{maybe|Customized [[Plain text|text]]}}	Template:Maybe
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
no class	{{draw}}	Template:Draw	{{draw|Text}}	Template:Draw
no class	{{incorrect}}	Template:Incorrect	{{incorrect|Customized [[Plain text|text]]}}	Template:Incorrect
no class	{{no result}}	Template:No result	{{no result|N.R.}}	Template:No result
no class	{{pending}}	Template:Pending
no class	{{unofficial}}	Template:Unofficial
no class	{{usually}}	Template:Usually
no class	{{rarely}}	Template:Rarely
no class	{{sometimes}}	Template:Sometimes
no class	{{CMain}}	Template:CMain
no class	{{CRecurring}}	Template:CRecurring
no class	{{CGuest}}	Template:CGuest

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:

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

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

Table cell templates/doc

<templatedata>{ "description": "One of several templates for styling individual table cells with standard contents and colors.", "params": { "1": {

 "label": "text",
 "description": "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",
 "type": "string/line",
 "default": "(template dependent)",
 "required": false

}, "align": {

 "label": "horizontal align",
 "description": "text alignment inside the cell, either ‘left’, ‘right’, ‘center’ or ‘justified’",
 "default": "center",
 "inherits": "1" 

}, "style": {

 "label": "style",
 "description": "a semicolon separated list of additional CSS rules to be applied to the table cell",
 "default": "",
 "inherits": "1" 

}, "color": {

 "label": "background color",
 "description": "a valid CSS color value or name to override the standard the cell background, only available with some templates",
 "inherits": "1" 

} }}</templatedata>

See also

• {{change}}: Calculates, displays and color-codes changes between two values
• {{GPL-lic}}: Specialized redirect for {{Free}}
• {{LGPL-lic}}: Specialized redirect for {{Free}}

Notes

</code>

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

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

Table cell templates/doc

<templatedata>{ "description": "One of several templates for styling individual table cells with standard contents and colors.", "params": { "1": {

 "label": "text",
 "description": "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",
 "type": "string/line",
 "default": "(template dependent)",
 "required": false

}, "align": {

 "label": "horizontal align",
 "description": "text alignment inside the cell, either ‘left’, ‘right’, ‘center’ or ‘justified’",
 "default": "center",
 "inherits": "1" 

}, "style": {

 "label": "style",
 "description": "a semicolon separated list of additional CSS rules to be applied to the table cell",
 "default": "",
 "inherits": "1" 

}, "color": {

 "label": "background color",
 "description": "a valid CSS color value or name to override the standard the cell background, only available with some templates",
 "inherits": "1" 

} }}</templatedata>

See also

• {{change}}: Calculates, displays and color-codes changes between two values
• {{GPL-lic}}: Specialized redirect for {{Free}}
• {{LGPL-lic}}: Specialized redirect for {{Free}}