Difference between revisions of "Template:Table cell templates/doc"

From Wikispooks
Jump to navigation Jump to search
m (1 revision)
 
m (1 revision imported)
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
<noinclude>{{Documentation subpage}}</noinclude>
 
<noinclude>{{Documentation subpage}}</noinclude>
−
{{For|the text color template|Template:Black}}
+
{{#ifeq:{{FULLPAGENAME}}|Template:BLACK|{{For|the text color template|Template:Black}}}}
 
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 [[:Category:Comparisons|comparison tables]].
 
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 [[:Category:Comparisons|comparison tables]].
  
Line 30: Line 30:
 
|rowspan=2| <code>table-yes</code> || {{Tl|yes}} || {{yes}} || {{Tlp|yes|<nowiki>Customized [[Plain text|text]]</nowiki>}} ||{{yes|Customized [[Plain text|text]]}}
 
|rowspan=2| <code>table-yes</code> || {{Tl|yes}} || {{yes}} || {{Tlp|yes|<nowiki>Customized [[Plain text|text]]</nowiki>}} ||{{yes|Customized [[Plain text|text]]}}
 
|-
 
|-
−
| {{tl|Ya}} || {{Ya}} || {{tlp|Ya|Customized alt text|link{{=}}WP:ALT}} || {{Ya|Customized alt text|link=WP:ALT}}
+
| {{tl|ya}} || {{Ya}} || {{tlp|ya|Customized alt text|link{{=}}WP:ALT}} || {{Ya|Customized alt text|link=WP:ALT}}
 
|-
 
|-
 
|rowspan=5| <code>table-no</code> || {{Tl|no}} || {{no}} || {{Tlp|no|<nowiki>Customized [[Plain text|text]]</nowiki>}} || {{no|Customized [[Plain text|text]]}}
 
|rowspan=5| <code>table-no</code> || {{Tl|no}} || {{no}} || {{Tlp|no|<nowiki>Customized [[Plain text|text]]</nowiki>}} || {{no|Customized [[Plain text|text]]}}
 
|-
 
|-
−
| {{tl|Na}} || {{Na}} || {{tlp|Na|Customized alt text|link{{=}}WP:ALT}} || {{Na|Customized alt text|link=WP:ALT}}
+
| {{tl|na}} || {{Na}} || {{tlp|na|Customized alt text|link{{=}}WP:ALT}} || {{Na|Customized alt text|link=WP:ALT}}
 
|-
 
|-
 
| {{Tl|coming soon}} || {{coming soon}} || ||
 
| {{Tl|coming soon}} || {{coming soon}} || ||
Line 42: Line 42:
 
| {{Tl|eliminated}} || {{eliminated}} ||  ||
 
| {{Tl|eliminated}} || {{eliminated}} ||  ||
 
|-
 
|-
−
| <code>table-siteactive</code> || {{Tl|Site active}} || {{site active}} ||  ||
+
| <code>table-siteactive</code> || {{Tl|site active}} || {{site active}} ||  ||
 
|-
 
|-
−
| <code>table-siteinactive</code> || {{Tl|Site inactive}} || {{site inactive}} ||  ||
+
| <code>table-siteinactive</code> || {{Tl|site inactive}} || {{site inactive}} ||  ||
 
|-
 
|-
 
|rowspan=6| <code>table-yes2</code> || {{Tl|good}} || {{good}} || {{Tlp|good|A}} || {{good|A}}
 
|rowspan=6| <code>table-yes2</code> || {{Tl|good}} || {{good}} || {{Tlp|good|A}} || {{good|A}}
Line 50: Line 50:
 
| {{Tl|yes2}} || {{yes2}} || {{Tlp|yes2|Text}} || {{yes2|Text}}
 
| {{Tl|yes2}} || {{yes2}} || {{Tlp|yes2|Text}} || {{yes2|Text}}
 
|-
 
|-
−
| {{Tl|won}} || {{won}} || <nowiki>{{won|text=white|color=darkblue}}</nowiki> || {{won|text=white|color=darkblue}}
+
| {{Tl|won}} || {{won}} || {{Tlp|won|text{{=}}white|color{{=}}darkblue}} || {{won|text=white|color=darkblue}}
 
|-
 
|-
−
| <nowiki>{{won|place=1}}</nowiki> || {{won|place=1}} || <nowiki>{{won|place=Gold}}</nowiki> || {{won|place=Gold}}
+
| {{Tlp|won|place{{=}}1}} || {{won|place=1}} || {{Tlp|won|place{{=}}Gold}} || {{won|place=Gold}}
 
|-
 
|-
−
| <nowiki>{{won|place=2}}</nowiki> || {{won|place=2}} || <nowiki>{{won|place=Silver}}</nowiki> || {{won|place=Silver}}
+
| {{Tlp|won|place{{=}}2}} || {{won|place=2}} || {{Tlp|won|place{{=}}Silver}} || {{won|place=Silver}}
 
|-
 
|-
−
| <nowiki>{{won|place=3}}</nowiki> || {{won|place=3}} || <nowiki>{{won|place=Bronze}}</nowiki> || {{won|place=Bronze}}
+
| {{Tlp|won|place{{=}}3}} || {{won|place=3}} || {{Tlp|won|place{{=}}Bronze}} || {{won|place=Bronze}}
 
|-
 
|-
 
|rowspan=4| <code>table-no2</code> || {{Tl|no2}} || {{no2}} ||  {{Tlp|no2|Text}} || {{no2|Text}}
 
|rowspan=4| <code>table-no2</code> || {{Tl|no2}} || {{no2}} ||  {{Tlp|no2|Text}} || {{no2|Text}}
Line 66: Line 66:
 
| {{Tl|TBA}} || {{TBA}} || {{Tlp|TBA|To be announced}} || {{TBA|To be announced}}
 
| {{Tl|TBA}} || {{TBA}} || {{Tlp|TBA|To be announced}} || {{TBA|To be announced}}
 
|-
 
|-
−
|rowspan=4| <code>table-partial</code> || {{Tl|partial}} || {{partial}} || ||
+
|rowspan=4| <code>table-partial</code> || {{Tl|partial}} || {{partial}} || {{tlp|partial|Almost done}} ||{{partial|Almost done}}
 
|-
 
|-
 
| {{Tl|yes-No}} || {{Yes-No}} ||  ||
 
| {{Tl|yes-No}} || {{Yes-No}} ||  ||
Line 80: Line 80:
 
| {{Tl|BLACK}} || {{BLACK}} || ||
 
| {{Tl|BLACK}} || {{BLACK}} || ||
 
|-
 
|-
−
|rowspan=2| <code>table-unknown</code> || {{Tl|dunno}} || {{dunno}} || ||
+
|rowspan=2| <code>table-unknown</code> || {{Tl|dunno}} || {{dunno}} || {{Tlp|dunno|<nowiki>Custom [[Plain text|text]]</nowiki>}} || {{dunno|Custom [[Plain text|text]]}}
 
|-
 
|-
−
| {{Tl|Unknown}} || {{Unknown}} || ||
+
| {{Tl|unknown}} || {{Unknown}} || {{Tlp|unknown|?}} || {{unknown|?}}
 
|-
 
|-
−
| <code>table-depends</code> || {{Tl|Depends}} || {{Depends}} || {{Tlp|Depends|<nowiki>Customized [[Plain text|text]]</nowiki>}} || {{Depends|Customized [[Plain text|text]]}}
+
| <code>table-depends</code> || {{Tl|depends}} || {{Depends}} || {{Tlp|depends|<nowiki>Customized [[Plain text|text]]</nowiki>}} || {{Depends|Customized [[Plain text|text]]}}
 
|-
 
|-
−
| <code>table-included</code> || {{Tl|Included}} || {{Included}} ||  ||
+
| <code>table-included</code> || {{Tl|included}} || {{Included}} ||  ||
 
|-
 
|-
 
|rowspan=2| <code>table-dropped</code> || {{Tl|dropped}} || {{dropped}} || ||
 
|rowspan=2| <code>table-dropped</code> || {{Tl|dropped}} || {{dropped}} || ||
Line 95: Line 95:
 
|-
 
|-
 
| {{Tl|table-experimental}} || {{table-experimental}} || {{Tlp|table-experimental|<nowiki>Customized [[Plain text|text]]</nowiki>}} || {{table-experimental|Customized [[Plain text|text]]}}
 
| {{Tl|table-experimental}} || {{table-experimental}} || {{Tlp|table-experimental|<nowiki>Customized [[Plain text|text]]</nowiki>}} || {{table-experimental|Customized [[Plain text|text]]}}
 +
|-
 +
| <code>table-maybe</code> || {{Tl|maybe}} || {{maybe}} || {{Tlp|maybe|<nowiki>Customized [[Plain text|text]]</nowiki>}} || {{maybe|Customized [[Plain text|text]]}}
 
|-
 
|-
 
| <code>table-free</code> || {{Tl|free}} || {{free}} || {{Tlp|free|<nowiki>Customized [[Plain text|text]]</nowiki>}} || {{free|Customized [[Plain text|text]]}}
 
| <code>table-free</code> || {{Tl|free}} || {{free}} || {{Tlp|free|<nowiki>Customized [[Plain text|text]]</nowiki>}} || {{free|Customized [[Plain text|text]]}}
 +
|-
 +
| <code>table-proprietary</code> || {{Tl|proprietary}} || {{proprietary}} || {{Tlp|proprietary|<nowiki>Customized [[Plain text|text]]</nowiki>}} || {{proprietary|Customized [[Plain text|text]]}}
 
|-
 
|-
 
| <code>table-nonfree</code> || {{Tl|nonfree}} || {{nonfree}} || {{Tlp|nonfree|<nowiki>Customized [[Plain text|text]]</nowiki>}} || {{nonfree|Customized [[Plain text|text]]}}
 
| <code>table-nonfree</code> || {{Tl|nonfree}} || {{nonfree}} || {{Tlp|nonfree|<nowiki>Customized [[Plain text|text]]</nowiki>}} || {{nonfree|Customized [[Plain text|text]]}}
 
|-
 
|-
−
| <code>table-proprietary</code> || {{Tl|proprietary}} || {{proprietary}} || {{Tlp|proprietary|<nowiki>Customized [[Plain text|text]]</nowiki>}} || {{proprietary|Customized [[Plain text|text]]}}
+
| <code>table-needs</code> || {{Tl|needs}} || {{needs}} || {{Tlp|needs|<nowiki>Customized [[Plain text|text]]</nowiki>}} || {{needs|Customized [[Plain text|text]]}}
 +
|-
 +
| <code>table-nightly</code> || {{Tl|nightly}} || {{nightly}} || {{Tlp|nightly|<nowiki>Customized [[Plain text|text]]</nowiki>}} || {{nightly|Customized [[Plain text|text]]}}
 +
|-
 +
| <code>table-release-candidate</code> || {{Tl|release-candidate}} || {{release-candidate}} || {{Tlp|release-candidate|<nowiki>Customized [[Plain text|text]]</nowiki>}} || {{release-candidate|Customized [[Plain text|text]]}}
 
|-
 
|-
−
| <code>table-needs</code> || {{Tl|needs}} || {{needs}} || {{Tlp|needs|<nowiki>Customized [[Plain text|text]]</nowiki>}} || {{needs|Customized [[Plain text|text]]}}
+
| ''no class'' || {{Tl|draw}} || {{draw}} || {{Tlp|draw|Text}} || {{draw|Text}}
 
|-
 
|-
 
| ''no class'' || {{Tl|incorrect}} || {{incorrect}} || {{Tlp|incorrect|<nowiki>Customized [[Plain text|text]]</nowiki>}} || {{incorrect|Customized [[Plain text|text]]}}
 
| ''no class'' || {{Tl|incorrect}} || {{incorrect}} || {{Tlp|incorrect|<nowiki>Customized [[Plain text|text]]</nowiki>}} || {{incorrect|Customized [[Plain text|text]]}}
Line 109: Line 117:
 
|-
 
|-
 
| ''no class'' || {{Tl|pending}} || {{Pending}} ||  ||
 
| ''no class'' || {{Tl|pending}} || {{Pending}} ||  ||
−
|-
 
−
| <code>table-nightly</code> || {{Tl|nightly}} || {{nightly}} || {{Tlp|nightly|<nowiki>Customized [[Plain text|text]]</nowiki>}} || {{nightly|Customized [[Plain text|text]]}}
 
−
|-
 
−
| <code>table-release-candidate</code> || {{Tl|release-candidate}} || {{release-candidate}} || {{Tlp|release-candidate|<nowiki>Customized [[Plain text|text]]</nowiki>}} || {{release-candidate|Customized [[Plain text|text]]}}
 
−
|-
 
−
| ''no class'' || {{Tl|?}}<ref name="table-cell-templates-table-noparam">Does not take a parameter; not really a table cell template at all, but here for completeness</ref> || {{?}} ||  ||
 
 
|-
 
|-
 
| ''no class'' || {{Tl|unofficial}} || {{Unofficial}} ||  ||
 
| ''no class'' || {{Tl|unofficial}} || {{Unofficial}} ||  ||
Line 124: Line 126:
 
| ''no class'' || {{Tl|sometimes}} || {{Sometimes}} || ||
 
| ''no class'' || {{Tl|sometimes}} || {{Sometimes}} || ||
 
|-
 
|-
−
| ''no class'' || {{Tl|draw}} || {{draw}} || {{Tlp|draw|Text}} || {{draw|Text}}
+
| ''no class'' || {{Tl|CMain}} || {{CMain}} || ||
 +
|-
 +
| ''no class'' || {{Tl|CRecurring}} || {{CRecurring}} || ||
 +
|-
 +
| ''no class'' || {{Tl|CGuest}} || {{CGuest}} || ||
 +
|-
 +
| ''no class'' || {{Tl|active fire|12%}} || {{active fire|12%}} || ||
 +
|-
 +
| ''no class'' || {{Tl|contained}} || {{contained}} || ||
 +
|-
 
|}
 
|}
  
 
== Code ==
 
== Code ==
−
 
 
Common code to most if not all the templates in this series:
 
Common code to most if not all the templates in this series:
 
:<code>{{Table cell templates|class=''automatic''|text=''text''|bg=#''abcdef''}}</code>
 
:<code>{{Table cell templates|class=''automatic''|text=''text''|bg=#''abcdef''}}</code>
Line 145: Line 155:
  
 
style="background: #abcdef; color: black; vertical-align: middle; text-align: {{{align|center}}}; {{{style|}}}" class="automatic table-automatic"| {{{1|text}}}
 
style="background: #abcdef; color: black; vertical-align: middle; text-align: {{{align|center}}}; {{{style|}}}" class="automatic table-automatic"| {{{1|text}}}
−
== Usage ==
+
 
 +
== TemplateData ==
 +
{{TemplateDataHeader}}
 
<templatedata>{
 
<templatedata>{
 
"description": "One of several templates for styling individual table cells with standard contents and colors.",
 
"description": "One of several templates for styling individual table cells with standard contents and colors.",
Line 178: Line 190:
 
* {{Tl|change}}: Calculates, displays and color-codes changes between two values
 
* {{Tl|change}}: Calculates, displays and color-codes changes between two values
 
* {{Tl|GPL-lic}}: Specialized redirect for {{tlf|Free}}
 
* {{Tl|GPL-lic}}: Specialized redirect for {{tlf|Free}}
−
* {{T1|LGPL-lic}}: Specialized redirect for {{tlf|Free}}
+
* {{Tl|LGPL-lic}}: Specialized redirect for {{tlf|Free}}
  
 
== Notes ==
 
== Notes ==
−
{{Reflist}}
+
{{reflist}}
  
 
<includeonly>
 
<includeonly>

Revision as of 09:58, 2 December 2015

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:

Yes No N/A
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] Row header {{rh|align=right}} | Row header Row header
{{rh2}} | Row header[2] Row header {{rh2|align=right}} | Row header Row header
table-yes {{yes}} Yes {{yes|Customized [[Plain text|text]]}} Customized text
{{ya}} Yes {{ya|Customized alt text|link=WP:ALT}} Customized alt text
table-no {{no}} No {{no|Customized [[Plain text|text]]}} Customized text
{{na}} No {{na|Customized alt text|link=WP:ALT}} Customized alt text
{{coming soon}} Coming soon
{{bad}} Bad {{bad|F}} F
{{eliminated}} Eliminated
table-siteactive {{site active}} Active
table-siteinactive {{site inactive}} Inactive
table-yes2 {{good}} Good {{good|A}} A
{{yes2}} {{yes2|Text}} Text
{{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
table-no2 {{no2}} {{no2|Text}} Text
{{nom}} Nominated {{nom|5}} 5
{{sho}} Shortlisted
{{TBA}} TBA {{TBA|To be announced}} To be announced
table-partial {{partial}} Partial {{partial|Almost done}} Almost done
{{yes-No}} Yes/No
{{okay}} Neutral {{okay|C}} C
{{some}} Some
table-any {{any}} Any
table-na {{n/a}} N/A
{{BLACK}} N/A
table-unknown {{dunno}} ? {{dunno|Custom [[Plain text|text]]}} Custom text
{{unknown}} Unknown {{unknown|?}} ?
table-depends {{depends}} Depends {{depends|Customized [[Plain text|text]]}} Customized text
table-included {{included}} Included
table-dropped {{dropped}} Dropped
{{terminated}} Terminated
table-beta {{beta}} Beta
{{table-experimental}} Experimental {{table-experimental|Customized [[Plain text|text]]}} Customized text
table-maybe {{maybe}} Maybe {{maybe|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
no class {{draw}} {{draw|Text}} Text
no class {{incorrect}} Incorrect {{incorrect|Customized [[Plain text|text]]}} Customized text
no class {{no result}} No result {{no result|N.R.}} N.R.
no class {{pending}} Pending
no class {{unofficial}} Unofficial
no class {{usually}} Usually
no class {{rarely}} Rarely
no class {{sometimes}} Sometimes
no class {{CMain}} Main
no class {{CRecurring}} Recurring
no class {{CGuest}} Guest
no class {{active fire}} Active (12%)
no class {{contained}} Contained

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: white; color: black; vertical-align: middle; text-align: {{{align|center}}}; {{{style|}}}" class="Table cell templates table-Table cell templates"| {{{1|{{{text}}}}}}

To make a new table cell template you can use: <syntaxhighlight lang=text enclose="div">{{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 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 parameter usage report for this template.

TemplateData for Table cell templates

<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

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


Retrieved from "https://wikispooks.com/w/index.php?title=Template:Table_cell_templates/doc&oldid=76707"