Template:Table cell templates/doc

From The Freestyle Knowledge Base
Revision as of 17:45, 10 March 2016 by Admin (talk | contribs) (Created page with "<noinclude>{{Documentation subpage}}</noinclude> {{#ifeq:{{FULLPAGENAME}}|Template:BLACK|{{For|the text color template|Template:Black}}}} The templates in this series are desi...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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, Template:Tlc 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 No rowspan=2 Template:N/a
colspan=2 Template:Yes-No
...
!{{Yes}} ||{{No}} ||rowspan=2 {{n/a}}
|-
|colspan=2 {{Yes-No}}
...

Templates

Table cell templates
Class[1] Default syntax Preview (default) Customized syntax Preview (customized)
table-rh {{rh}} | Row header[2] Template:Rh | Row header Template:Tlp | Row header Template:Rh | Row header
{{rh2}} | Row header[2] Template:Rh2 | Row header Template:Tlp | Row header Template:Rh2 | Row header
table-yes {{yes}} Template:Yes Template:Tlp Template:Yes
table-no {{no}} No Template:Tlp Customized text
{{coming soon}} Template:Coming soon
{{bad}} Template:Bad Template:Tlp Template:Bad
{{eliminated}} Template:Eliminated
table-siteactive {{site active}} Template:Site active
table-siteinactive {{site inactive}} Template:Site inactive
table-yes2 {{good}} Template:Good Template:Tlp Template:Good
{{yes2}} Template:Yes2 Template:Tlp Template:Yes2
{{ya}} Template:Ya Template:Tlp Template:Ya
{{won}} Template:Won Template:Tlp Template:Won
Template:Tlp Template:Won Template:Tlp Template:Won
Template:Tlp Template:Won Template:Tlp Template:Won
Template:Tlp Template:Won Template:Tlp Template:Won
table-no2 {{no2}} Template:No2 Template:Tlp Template:No2
{{na}} Template:Na Template:Tlp Template:Na
{{nom}} Template:Nom Template:Tlp Template:Nom
{{sho}} Template:Sho
{{TBA}} Template:TBA Template:Tlp Template:TBA
table-partial {{partial}} Template:Partial Template:Tlp Template:Partial
{{yes-No}} Template:Yes-No
{{okay}} Template:Okay Template:Tlp Template:Okay
{{some}} Template:Some
table-any {{any}} Template:Any
table-na {{n/a}} Template:N/a
{{BLACK}} Template:BLACK
table-unknown {{dunno}} Template:Dunno Template:Tlp Template:Dunno
{{unknown}} Template:Tlp
table-depends {{depends}} Template:Depends Template:Tlp 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 Template:Tlp Template:Table-experimental
table-maybe {{maybe}} Template:Maybe Template:Tlp Template:Maybe
table-free {{free}} Template:Free Template:Tlp Template:Free
table-proprietary {{proprietary}} Template:Proprietary Template:Tlp Template:Proprietary
table-nonfree {{nonfree}} Template:Nonfree Template:Tlp Template:Nonfree
table-needs {{needs}} Template:Needs Template:Tlp Template:Needs
table-nightly {{nightly}} Template:Nightly Template:Tlp Template:Nightly
table-release-candidate {{release-candidate}} Template:Release-candidate Template:Tlp Template:Release-candidate
no class {{draw}} Template:Draw Template:Tlp Template:Draw
no class {{incorrect}} Template:Incorrect Template:Tlp Template:Incorrect
no class {{no result}} Template:No result Template:Tlp 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 Template:Tlp Template:CMain
no class {{CRecurring}} Template:CRecurring Template:Tlp Template:CRecurring
no class {{CGuest}} Template:CGuest Template:Tlp Template:CGuest
no class {{active fire}} Template:Active fire
no class {{contained}} Template:Contained

Code

Common code to most if not all the templates in this series:

Template:Table cell templates

Code specific to this template:

Template:Table cell 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: center; " class="automatic table-automatic"| text

TemplateData

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

TemplateData for Table cell templates

One of several templates for styling individual table cells with standard contents and colors.

Template parameters[Edit template data]

ParameterDescriptionTypeStatus
text1

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

Default
(template dependent)
Lineoptional
horizontal alignalign

text alignment inside the cell, either ‘left’, ‘right’, ‘center’ or ‘justified’

Default
center
Lineoptional
stylestyle

a semicolon separated list of additional CSS rules to be applied to the table cell

Default
Lineoptional
background colorcolor

a valid CSS color value or name to override the standard the cell background, only available with some templates

Default
(template dependent)
Lineoptional

See also

Notes

Template:Reflist


  1. The HTML class of table cell templates may be referenced in a user stylesheet to change appearance.
  2. 2.0 2.1 Does not take a parameter; the content should be placed after the template call, separated by a pipe (|) character.