Template:Optional

Optional

Template documentation[view] [edit] [history] [purge]

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.

 Important: 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	rowspan=2 data-sort-value="" style="background: #ececec; color: #2C2C2C; vertical-align: middle; text-align: center; " class="table-na" | —
Yes/No

...
!{{Yes}} ||{{No}} ||rowspan=2 {{n/a}}
|-
|colspan=2 style="border:solid 3px Maroon" {{Yes-No}}
...

Templates

Table cell templates

Class	Default		Customized
	Syntax	Preview	Syntax	Preview
table-rh	{{rh}} | Row header || style="background: #ececec; color: black; font-weight: bold; vertical-align: middle; text-align: left; " class="table-rh" | Row header || {{rh|align=right}} | Row header	style="background: #ececec; color: black; font-weight: bold; vertical-align: middle; text-align: right; " class="table-rh" | Row header
	{{rh2}} | Row header || style="background: #F4E3FF; color: black; vertical-align: middle; text-align: left; font-weight: bolder; " scope="row" class="rh heading table-rh" | Row header || {{rh2|align=center}} | Row header	style="background: #F4E3FF; color: black; vertical-align: middle; text-align: center; font-weight: bolder; " scope="row" class="rh heading table-rh" | Row header
table-yes	{{yes}}	Yes	{{yes|customized [[Plain text|text]]}}	customized text
	{{yes C}}	Yes	{{yes C|customized [[Plain text|text]]}}	customized text
	{{yes O}}	Yes	{{yes O|customized [[Plain text|text]]}}	customized text
	{{yes N}}	Yes	{{yes N|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
	{{no O}}	No	{{no O|customized [[Plain text|text]]}}	customized text
	{{no X}}	No	{{no X|customized [[Plain text|text]]}}	customized text
	{{eliminated}}	Eliminated	{{eliminated|dropped out}}	dropped out
	{{lost}}	Lost	{{lost|missing}}	missing
	{{active fire}}	Active ()	{{active fire|12%}}	Active (12%)
	{{safe}}	Safe	{{safe|protected}}	protected
	{{no Y}}	No	{{no Y|customized [[plain text|text]]}}	customized text
table-active	{{active}}	Active	{{active|live}}	live
table-siteactive	{{site active}}	Active	{{site active|up}}	up
	{{coming soon}}	Coming soon	{{coming soon|second half of the year}}	second half of the year
table-siteinactive	{{site inactive}}	Inactive	{{site inactive|down}}	down
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-yes2	{{yes2}}		{{yes2|text}}	text
	{{good}}	Good	{{good|A}}	A
	{{ya}}		{{ya|text ya}} || data-sort-value="Yes" style="background: #DFD; vertical-align: middle; text-align: center; " class="table-yes2" |ya
	{{ya|Ya}}		{{ya|text|link WP:ALT}} || data-sort-value="Yes" style="background: #DFD; vertical-align: middle; text-align: center; " class="table-yes2" |
	{{yan}}		{{yan|text ya}} || data-sort-value="Yes" style="vertical-align: middle; text-align: center; " class="table-yes2" |ya
	{{won}}	Won	{{won|text white|color darkblue|winner}} || style="background: darkblue; color: white; vertical-align: middle; text-align: center; " class="yes table-yes2 notheme"|winner
	{{won|place 1}} || style="background: #FFD700; color: #000; vertical-align: middle; text-align: center; " class="yes table-yes2 notheme"|1 || {{won|place gold}} || style="background: #FFD700; color: #000; vertical-align: middle; text-align: center; " class="yes table-yes2 notheme"|gold
	{{won|place 2}} || style="background: #C0C0C0; color: #000; vertical-align: middle; text-align: center; " class="yes table-yes2 notheme"|2 || {{won|place silver}} || style="background: #C0C0C0; color: #000; vertical-align: middle; text-align: center; " class="yes table-yes2 notheme"|silver
	{{won|place 3}} || style="background: #E2B740; color: #000; vertical-align: middle; text-align: center; " class="yes table-yes2 notheme"|3 || {{won|place bronze}} || style="background: #E2B740; color: #000; vertical-align: middle; text-align: center; " class="yes table-yes2 notheme"|bronze
	{{WinDL}}	W	{{WinDL|win}}	win
	{{WinDL|res D}} || style="background: #FFC; vertical-align: middle; text-align: center; " class="yes table-yes2"|D || {{WinDL|res draw}} || style="background: #FFC; vertical-align: middle; text-align: center; " class="yes table-yes2"|draw
	{{WinDL|res L}} || style="background: #FFE3E3; vertical-align: middle; text-align: center; " class="yes table-yes2"|L || {{WinDL|res loss}} || style="background: #FFE3E3; vertical-align: middle; text-align: center; " class="yes table-yes2"|loss
table-no2	{{no2}}		{{no2|text}}	text
	{{na}}		{{na|text na}} || data-sort-value="No" style="background: #FFE3E3; vertical-align: middle; text-align: center; " class="table-no2" | na
	{{na|Na}}		{{na|text|link WP:ALT}} || data-sort-value="No" style="background: #FFE3E3; vertical-align: middle; text-align: center; " class="table-no2" |
	{{nan}}		{{nan|text na}} || data-sort-value="No" style="vertical-align: middle; text-align: center; " class="table-no2" | na
	{{nom}}	Nominated	{{nom|5}}	5
	{{notnom}}	Not nominated	{{notnom|not selected}}	not selected
	{{sho}}	Shortlisted	{{sho|proposed}}	proposed
	{{longlisted}}	Longlisted	{{longlisted|rejected}}	rejected
	{{TBA}}	TBA	{{TBA|to be announced}}	to be announced
table-partial	{{partial}}	Partial	{{partial|almost done}}	almost done
	{{Regional}}	Regional	{{Regional|Uyghur}}	Uyghur
	{{MaybeCheck}}		{{MaybeCheck|text possibly}} || style="background: #FFB; vertical-align: middle; text-align: center; " class="partial table-partial" |possibly
	{{MaybeCheck|possibly}}		{{MaybeCheck|text|link WP:ALT}} || style="background: #FFB; vertical-align: middle; text-align: center; " class="partial table-partial" |
	{{partial success}}	Partial success	{{partial success| reached orbit and returned pictures}}	reached orbit and returned pictures
	{{partial failure}}	Partial failure	{{partial failure|[[Cubesat]] not deployed}}	Cubesat not deployed
	{{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
	{{some}}	Some	{{some|many}}	many
	{{pending}}	Pending	{{pending|awaiting}}	awaiting
	{{sometimes}}	Sometimes	{{sometimes|occasionally}}	occasionally
	{{rarely}}	Rarely	{{rarely|seldom}}	seldom
	{{usually}}	Usually	{{usually|commonly}}	commonly
	{{unofficial}}	Unofficial	{{unofficial|''de facto''}}	de facto
	{{unofficial2}}	Unofficial	{{unofficial2|''de facto''}}	de facto
	{{nonpartisan}}	Nonpartisan	{{nonpartisan|impartial}}	impartial
table-any	{{any}}	Any	{{any|anyone}}	anyone
table-automatic	{{perhaps}}	Perhaps	{{perhaps|maybe}}	maybe
table-draw	{{draw}}		{{draw|1:1}}	1:1
table-noAttempt	{{No attempt}}	No attempt	{{No attempt|No landing attempted}}	No landing attempted
table-na	{{n/a}}	—	{{n/a|unavailable}}	unavailable
	{{varies}}	Varies	{{varies|differs}}	differs
	{{non-album single}}	Non-album single	{{non-album single|EP}}	Non-album single
	{{unreleased}}	Unreleased	{{unreleased|shelved}}	shelved
	{{BLACK}}	N/A	{{BLACK|banned}}	banned
	{{sdash}}	—	{{sdash|[[File:Dash.svg|13px|dash icon]]}}
	{{vacant}}	Vac­ant	{{vacant|missing}}	missing
table-unknown	{{unknown}}	Un­known	{{unknown|?}}	?
	{{dunno}}	??	{{dunno|not sure}}	??
table-included	{{included}}	Included	{{included|incorporated}}	incorporated
noresult	{{no result}}	No result	{{no result|NR}}	NR
table-planned	{{planned}}	Planned	{{planned|July 2028}}	July 2028
table-scheduled	{{scheduled}}	Scheduled	{{scheduled|3 March 2027}}	3 March 2027
table-software	{{beta}}	Beta	{{beta|preview}}	preview
	{{table-experimental}}	Experimental	{{table-experimental|lab}}	lab
	{{nightly}}	Nightly build	{{nightly|dev}}	dev
	{{release-candidate}}	Release candidate	{{release-candidate|RC}}	RC
	{{open source}}	Open source	{{open source|software libre}}	software libre
	{{free}}	Free	{{free|empty}}	empty
	{{proprietary}}	Proprietary	{{proprietary|custom extension}}	custom extension
	{{nonfree}}	Non-free	{{nonfree|paid}}	paid
	{{needs}}	Needs	{{needs|req.}}	req.
table-depends	{{depends}}	Depends	{{depends|vendor-defined}}	vendor-defined
table-dropped	{{dropped}}	Dropped	{{dropped|discontinued}}	discontinued
	{{terminated}}	Terminated	{{terminated|fired}}	fired
incorrect	{{incorrect}}	Incorrect	{{incorrect|wrong}}	wrong
table-debate	{{D-P}}	P	{{D-P|present}}	present
	{{D-A}}	A	{{D-A|absent}}	absent
	{{D-I}}	I	{{D-I|invited}}	invited
	{{D-O}}	O	{{D-O|other debate}}	other debate
	{{D-N}}	N	{{D-N|not invited}}	not invited
	{{D-Nv}}	NV	{{D-Nv|not voting}}	not voting
	{{D-W}}	W	{{D-W|withdrawn}}	withdrawn
	{{D-Out}}	Out	{{D-Out|out of race}}	out of race
table-cast	{{CMain}}	Main	{{CMain|text}}	text
	{{CAlso starring}}	Also starring	{{CAlso starring|costar}}	costar
	{{CRecurring}}	Recurring	{{CRecurring|regular guest}}	regular guest
	{{CGuest}}	Guest	{{CGuest|victim}}	victim
	{{COther}}	Does not appear	{{COther|ensemble}}	ensemble
	{{CNone}}	Does not appear	{{CNone|cast}}	cast
	{{CRemoved}}	removed	{{CRemoved|edited}}	edited
	{{CFinalist}}	Finalist	{{CFinalist|contender}}	contender
	{{CFinalist|place 3rd Place}} || style="background: #FFD; vertical-align: middle; text-align: center;" class="table-cast"|3rd Place || {{CFinalist|place third place}} || style="background: #FFD; vertical-align: middle; text-align: center;" class="table-cast"|third place
	{{exempt}}	exempt	{{exempt|exe}}	exe
	{{Black Exempt}}	B.Exempt	{{Black Exempt|lack}}	lack
	{{nocontest}}		{{nocontest|rescheduled}}	rescheduled
	{{Runner-up}}	Runner-up	{{Runner-up|2nd Place}}	2nd Place
	{{Quit}}	Quit	{{Quit|left}}	left
no class	{{not yet}}	Not yet	{{not yet|NY}}	NY
	{{optional}}	Optional	{{optional|non-mandatory}}	non-mandatory
	{{shade|100}}%	100 %	{{shade|color blue|100}}% || rowspan="1" style="background:#;vertical-align:middle;text-align:center;"|100 %
	{{shade|75}}%	75 %	{{shade|color blue|75|73–78}}% || rowspan="1" style="background:#;vertical-align:middle;text-align:center;"|73–78 %
	{{shade|25}}%	25 %	{{shade|color blue|25|{{val|25|2|u=%}}}} || rowspan="1" style="background:#;vertical-align:middle;text-align:center;"|
	{{shade|0}}%	0 %	{{shade|color blue|0}}% || rowspan="1" style="background:#;vertical-align:middle;text-align:center;"|0 %
	{{CellCategory|1}}	style="background: #FFF2AE "|	{{CellCategory|1|Group A}}	style="background: #FFF2AE "|Group A
	{{CellCategory|2}}	style="background: #E6F5C9 "|	{{CellCategory|2|Group B|align tc}} || style="background: #E6F5C9 vertical-align top; text-align: center;"|Group B
	{{CellCategory|3}}	style="background: #FEE7D6 "|	{{CellCategory|3|Group C|align tr}} || style="background: #FEE7D6 vertical-align top; text-align: right;"|Group C

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|text-transform: capitalize;}}}" class="automatic table-automatic"| {{{1|text}}}

Code specific to this template:

style="background: #DFD; vertical-align: middle; text-align: center; "|Optional

Creating new 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: {{{align|center}}}; {{{style|}}}" class="automatic table-automatic"| {{{1|text}}}

Choosing a color

When changing or creating a new template, follow the use of colour guidelines and the color accessibility guidelines 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. Wikipedia:Manual of Style/Accessibility/Colors has a set of colors that comply with WCAG AAA and WCAG AA for unvisited links and normal text.

Color subpage

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

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Optional in articles based on its TemplateData.

TemplateData for Optional

Unexpected property "params.align.suggestedvalues".

See also

• {{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}}
• {{Active}} / {{No result}} / {{Eliminated}} for comparison tables

Notes

The above documentation is transcluded from Template:Table cell templates/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Subpages of this template.