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.

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 or rowspan, they need to be put before the template call and there must be no vertical bar | in between them:

Yes	No	—
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	Row header	{{rh|align=right}} | Row header	Row header
	{{rh2}} | Row header	Row header	{{rh2|align=right}} | Row header	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
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
	{{active fire|12%}}	Active (12%)
	{{lost}}	Lost	{{lost|Missing}}	Missing
	{{safe}}	Safe	{{safe|Protected}}	Protected
table-active	{{active}}	Active	{{active|Lively}}	Lively
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-yes2	{{good}}	Good	{{good|A}}	A
	{{yes2}}		{{yes2|Text}}	Text
	{{ya}}		{{ya|text=Ya}}	Ya
	{{ya|Ya}}		{{ya|text|link=WP:ALT}}
	{{won}}	Won	{{won|text=white|color=darkblue}}	Won
	{{won|place=1}}	1	{{won|place=Gold}}	Gold
	{{won|place=2}}	2	{{won|place=Silver}}	Silver
	{{won|place=3}}	3	{{won|place=Bronze}}	Bronze
	{{WinDL}}	W	{{WinDL|Win}}	Win
	{{WinDL|res=D}}	D	{{WinDL|res=Draw}}	Draw
	{{WinDL|res=L}}	L	{{WinDL|res=Loss}}	Loss
table-no2	{{no2}}		{{no2|Text}}	Text
	{{na}}		{{na|text=Na}}	Na
	{{na|Na}}		{{na|text|link=WP:ALT}}
	{{nom}}	Nominated	{{nom|5}}	5
	{{sho}}	Shortlisted	{{sho|Proposed}}	Proposed
	{{longlisted}}	Longlisted	{{longlisted|Rejected}}	Rejected
	{{TBA}}	TBA	{{TBA|To be announced}}	To be announced
table-success	{{success}}	Success	{{success|Mission complete}}	Mission complete
	{{operational}}	Success	{{operational|Returning data}}	Returning data
table-failure	{{failure}}	Failure	{{failure|Wrong orbit}}	Wrong orbit
table-partial	{{partial}}	Partial	{{partial|Almost done}}	Almost done
	{{Regional}}	Regional	{{Regional|Uyghur}}	Uyghur
	{{MaybeCheck}}		{{MaybeCheck|text=Possibly}}	Possibly
	{{MaybeCheck|Possibly}}		{{MaybeCheck|text|link=WP:ALT}}
	{{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}}	Template:Yes-No	{{Yes-No|Yes with an if; no with a but}}	Template:Yes-No
	{{some}}	Template:Some	{{some|Many}}	Template:Some
	{{nonpartisan}}	Nonpartisan	{{nonpartisan|Impartial}}	Impartial
	{{pending}}	Pending	{{pending|Awaiting}}	Awaiting
	{{unofficial}}	Pending	{{unofficial|''De facto''}}	De facto
	{{unofficial2}}	Unofficial	{{unofficial2|''De facto''}}	De facto
	{{usually}}	Usually	{{usually|Commonly}}	Commonly
	{{rarely}}	Rarely	{{rarely|Seldom}}	Seldom
	{{sometimes}}	Sometimes	{{sometimes|Occasionally}}	Occasionally
table-any	{{any}}	Any	{{any|Anyone}}	Anyone
table-na	{{n/a}}	—	{{n/a|Unavailable}}	Unavailable
	{{varies}}	Varies	{{varies|Differs}}	Differs
	{{sdash}}	—	{{sdash|[[File:Dash.svg|13px|link=|dash icon]]}}
	{{BLACK}}	N/A	{{BLACK|Banned}}	Banned
	{{non-album single}}	non-album single	{{non-album single|Customized [[Plain text|text]]}}	non-album single
	{{unreleased}}	Unreleased	{{unreleased|Customized [[Plain text|text]]}}	Customized text
table-unknown	{{unknown}}	Unknown	{{unknown|?}}	?
	{{dunno}}	?	{{dunno|Not sure}}	Not sure
table-automatic	{{perhaps}}	Perhaps	{{perhaps|Customized [[Plain text|text]]}}	Customized text
table-depends	{{depends}}	Depends	{{depends|Customized [[Plain text|text]]}}	Customized text
table-included	{{included}}	Included	{{included|Incorporated}}	Incorporated
table-dropped	{{dropped}}	Dropped	{{dropped|Discontinued}}	Discontinued
	{{terminated}}	Template:Terminated	{{terminated|Fired}}	Template:Terminated
table-beta	{{beta}}	Beta	{{beta|Preview}}	Preview
table-experimental	{{table-experimental}}	Experimental	{{table-experimental|Customized [[Plain text|text]]}}	Customized text
table-free	{{free}}	Free	{{free|Customized [[Plain text|text]]}}	Customized text
table-proprietary	{{proprietary}}	Proprietary	{{proprietary|Customized [[Plain text|text]]}}	Customized text
table-nonfree	{{nonfree}}	Non-free	{{nonfree|Customized [[Plain text|text]]}}	Customized text
table-needs	{{needs}}	Needs	{{needs|Customized [[Plain text|text]]}}	Customized text
table-nightly	{{nightly}}	Nightly build	{{nightly|Customized [[Plain text|text]]}}	Customized text
table-release-candidate	{{release-candidate}}	Release candidate	{{release-candidate|Customized [[Plain text|text]]}}	Customized text
table-draw	{{draw}}		{{draw|Text}}	Text
table-planned	{{planned}}	Planned	{{planned|July 2018}}	July 2018
table-scheduled	{{scheduled}}	Scheduled	{{scheduled|3 March 2017}}	3 March 2017
incorrect	{{incorrect}}	Incorrect	{{incorrect|Customized [[Plain text|text]]}}	Customized text
noresult	{{no result}}	No result	{{no result|N.R.}}	N.R.
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|Invited to other debate}}	Invited to 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
no class	{{CMain}}	Main	{{CMain|Customized [[Plain text|text]]}}	Customized text
	{{CAlso starring}}	Also starring	{{CAlso starring|Customized [[Plain text|text]]}}	Customized text
	{{CRecurring}}	Recurring	{{CRecurring|Customized [[Plain text|text]]}}	Customized text
	{{CGuest}}	Guest	{{CGuest|Customized [[Plain text|text]]}}	Customized text
	{{COther}}	Template:COther	{{COther|Customized [[Plain text|text]]}}	Template:COther
	{{CNone}}	Does not appear	{{CNone|Customized [[Plain text|text]]}}	Customized text
	{{CEmpty}}
	{{nocontest}}		{{nocontest|Customized [[Plain text|text]]}}	Customized text
	{{not yet}}	Not Yet	{{not yet|Customized [[Plain text|text]]}}	Customized text
	{{optional}}	Optional	{{optional|Customized [[Plain text|text]]}}	Customized text
	{{Runner-up}}	Runner-up	{{Runner-up|Customized [[Plain text|text]]}}	Customized text
	{{CRemoved}}	Removed	{{CRemoved|Customized [[Plain text|text]]}}	Customized text
	{{Quit}}	Quit	{{Quit|Customized [[Plain text|text]]}}	Customized text
	{{CFinalist}}	Finalist	{{CFinalist|text=white|color=darkblue}}	Finalist
	{{CFinalist|place=3rd Place}}	3rd Place	{{CFinalist|place=Third Place}}	Third Place
	{{Enroute}}	Enroute	{{Enroute|Customized text}}	Customized text

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: #ddffdd; color: black; vertical-align: middle; text-align: center; "|Optional

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; see the monthly error report for this template.

TemplateData for Optional

<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": "content", "default": "(template dependent)", "required": false,

           "suggested": false

}, "align": { "label": "horizontal align", "description": "text alignment inside the cell, either 'left', 'right', 'center' or 'justified'", "default": "center", "inherits": "1", "type": "string",

           "suggested": false

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

           "suggested": false

}, "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", "type": "line",

           "suggested": false

} }, "format": "inline" }</templatedata>

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

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.