View source for Template:Table cell templates/doc

<noinclude>{{Documentation subpage}}</noinclude>{{Commons Import}}
{{#ifeq:{{FULLPAGENAME}}|Template:BLACK|{{For|the text color template|Template:Black}}|{{#ifeq:{{FULLPAGENAME}}|Template:Ya|{{For|the template with a smaller tick and no green background|Template:Aye}}|{{#ifeq:{{FULLPAGENAME}}|Template:Maybe|{{For|the yellow tick template|Template:Mby}}}}}}}}
The templates in this series are designed to be used in a [[Help:Table|table]] to make a cell with text in that cell, with an appropriately colored background.  They are commonly used in [[Wikipedia:Category:Comparisons|comparison tables]].

For example, {{Tlc|yes}} makes a cell with a green background. The text in the cell is taken from the [[Wikipedia:Help:Template‏‎ #Parameters|first parameter]]; <code><nowiki>{{</nowiki>yes|Sure}}</code> 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: <code><nowiki>{{</nowiki>''table cell template''}} ''text''</code> or <code><nowiki>{{</nowiki>''table cell template''}} | ''text''</code>. This information, the colors and default texts are found in the table below.

{{Warnsign|Important:}} If you want to use other attributes for the table cells, ''e.g.'' <code>colspan</code>, <code>rowspan</code>, or <code>style</code>, they need to be put before the template call, and there must be '''no vertical bar (aka pipe) <code>|</code>''' in-between them:

{| class=wikitable align=right
!{{Yes}} ||{{No}} ||rowspan=2 {{n/a}}
|-
|colspan=2 {{Yes-No}}
|}
<pre>...
!{{Yes}} ||{{No}} ||rowspan=2 {{n/a}}
|-
|colspan=2 style="border:solid 3px Maroon" {{Yes-No}}
...
</pre>

== Code ==
Common code to most if not all the templates in this series:
:<code>{{Table cell templates|class=''automatic''|text=''text''|bg=#''abcdef''}}</code>
<includeonly>{{#switch:{{SUBPAGENAME}}|doc|sandbox=|#default=
Code specific to this template:
:<code>{{ {{FULLPAGENAME}} }}</code>
{{{doc|}}}
}}</includeonly>

== Creating new templates ==
To make a new table cell template you can use:
:<syntaxhighlight lang=text inline>{{subst:Table cell templates|text= default text |bg= background color |class= a class name without prefix |align= standard horizontal alignment}}</syntaxhighlight>

You should leave out the <code>align</code> parameter and often the <code>class</code> parameter is unnecessary, too.

Add the new template to the table in the [[Template:Table cell templates/doc|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 <code>Dropped</code>, change that to <code><nowiki>{{{1|Dropped}}}</nowiki></code>.

:<syntaxhighlight lang=text inline>style="background: #abcdef; color: black; vertical-align: middle; text-align: {{{align|center}}}; {{{style|}}}" class="automatic table-automatic"| {{{1|text}}}</syntaxhighlight>

== Color subpage ==
All templates should either have a <code>/bgcolor</code> subpage that contains nothing but a valid CSS color code, possibly wrapped in ''nowiki'' tags, e.g. <code><nowiki>#BFD</nowiki></code>, which can be included with <code><nowiki>background: {{/bgcolor}};</nowiki></code> in the <code>style</code> attribute, or they should reference another template's subpage, e.g. <code><nowiki>background: {{Template:Yes2/bgcolor}};</nowiki></code>. Alternatively, the <code>/bgcolor</code> subpage may redirect to another color code subpage: <code><nowiki>#REDIRECT [[yes2/bgcolor]]</nowiki></code>.


This way, pages that are using these templates may also use {{tl|legend}} and similar templates which can reference the actual color: <code><nowiki>{{legend|{{yes2/bgcolor}}|supported}}</nowiki></code>

== TemplateData ==
{{TemplateData header}}
<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 ==
For more detail see wikipedia page [[wikipedia:Template:Table cell templates]]

== Notes ==
{{reflist}}

<includeonly>{{Sandbox other||{{#switch:{{SUBPAGENAME}}|doc=|#default=
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Unified table cell templates]]

}}}}</includeonly>