Template:Table cell templates/doc: Difference between revisions

From CivWiki
Jump to navigation Jump to search
Content added Content deleted
VisualWikitext
(→‎Templates: updated doc for Runner-up)
(←Blanked the page)
Line 1: Line 1:
<noinclude>{{Documentation subpage}}</noinclude>
{{#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 [[:Category:Comparisons|comparison tables]].

For example, {{Tlc|yes}} makes a cell with a green background. The text in the cell is taken from the [[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>

== Templates ==
<div style="overflow:auto;">
{| class="wikitable" style="text-align: left; width: auto;"
|+ Table cell templates
! Class<ref name="table-cell-templates-table-css">The HTML class of table cell templates may be referenced in a [[m:help:User style|user stylesheet]] to change appearance.</ref> !! Default syntax !! Preview (default) !! Customized syntax !! Preview (customized)
|-
|rowspan=2| <code>table-rh</code>
| {{tl|rh}} {{!}} Row header<ref name="table-cell-templates-table-after+pipe" /> || {{rh}} | Row header || {{tlp|rh|2=align=right}} {{!}} Row header || {{rh|align=right}} | Row header
|-
| {{tl|rh2}} {{!}} Row header<ref name="table-cell-templates-table-after+pipe">Does not take a parameter; the content should be placed after the template call, separated by a pipe (|) character.</ref> || {{rh2}} {{!}} Row header || {{tlp|rh2|2=align=right}} | Row header || {{rh2|align=right}} | Row header
|-
|rowspan=3| <code>table-yes</code>
| {{tl|yes}} || {{yes}} || {{tlp|yes|<nowiki>customized [[plain text|text]]</nowiki>}} ||{{yes|customized [[plain text|text]]}}
|-
| {{tl|yes C}} || {{yes C}} || {{tlp|yes C|}} ||{{yes C|}}
|-
| {{tl|yes O}} || {{yes O}} || {{tlp|yes O|}} ||{{yes O|}}
|-
| <code>table-maybe</code>
| {{tl|maybe}} || {{maybe}} || {{tlp|maybe|<nowiki>customized [[plain text|text]]</nowiki>}} ||{{maybe|customized [[plain text|text]]}}
|-
|rowspan=7| <code>table-no</code>
| {{tl|no}} || {{no}} || {{tlp|no|<nowiki>customized [[plain text|text]]</nowiki>}} || {{no|customized [[plain text|text]]}}
|-
| {{tl|no O}} || {{no O}} || {{tlp|no O|}} || {{no O|}}
|-
| {{tl|no X}} || {{no X}} || {{tlp|no X|}} || {{no X|}}
|-
| {{tl|eliminated}} || {{eliminated}} || {{tlp|eliminated|dropped out}} || {{eliminated|dropped out}}
|-
| {{tlp|active fire|12%}} || {{active fire|12%}} || ||
|-
| {{tl|lost}} || {{lost}} || {{tlp|lost|missing}} || {{lost|missing}}
|-
| {{tl|safe}} || {{safe}} || {{tlp|safe|protected}} || {{safe|protected}}
|-
| <code>table-active</code>
| {{tl|active}} || {{active}} || {{tlp|active|live}} || {{active|live}}
|-
|rowspan=2| <code>table-siteactive</code>
| {{tl|site active}} || {{site active}} || {{tlp|site active|up}} || {{site active|up}}
|-
| {{tl|coming soon}} || {{coming soon}} || {{tlp|coming soon|second half of the year}} || {{coming soon|second half of the year}}
|-
| <code>table-siteinactive</code>
| {{tl|site inactive}} || {{site inactive}} || {{tlp|site inactive|down}} || {{site inactive|down}}
|-
|rowspan=11| <code>table-yes2</code>
| {{tl|good}} || {{good}} || {{tlp|good|A}} || {{good|A}}
|-
| {{tl|yes2}} || {{yes2}} || {{tlp|yes2|text}} || {{yes2|text}}
|-
| {{tl|ya}} || {{ya}} || {{tlp|ya|text{{=}}ya}} || {{ya|text=ya}}
|-
| {{tlp|ya|Ya}} || {{ya|Ya}} || {{tlp|ya|text|link{{=}}WP:ALT}} || {{ya|text|link=WP:ALT}}
|-
| {{tl|won}} || {{won}} || {{tlp|won|text{{=}}white|color{{=}}darkblue|winner}} || {{won|text=white|color=darkblue|winner}}
|-
| {{tlp|won|place{{=}}1}} || {{won|place=1}} || {{tlp|won|place{{=}}gold}} || {{won|place=gold}}
|-
| {{tlp|won|place{{=}}2}} || {{won|place=2}} || {{tlp|won|place{{=}}silver}} || {{won|place=silver}}
|-
| {{tlp|won|place{{=}}3}} || {{won|place=3}} || {{tlp|won|place{{=}}bronze}} || {{won|place=bronze}}
|-
| {{tl|WinDL}} || {{WinDL}} || {{tlp|WinDL|win}} || {{WinDL|win}}
|-
| {{tlp|WinDL|res{{=}}D}} || {{WinDL|res=D}} || {{tlp|WinDL|res{{=}}draw}} || {{WinDL|res=draw}}
|-
| {{tlp|WinDL|res{{=}}L}} || {{WinDL|res=L}} || {{tlp|WinDL|res{{=}}loss}} || {{WinDL|res=loss}}
|-
|rowspan=7| <code>table-no2</code>
| {{tl|no2}} || {{no2}} || {{tlp|no2|text}} || {{no2|text}}
|-
| {{tl|na}} || {{na}} || {{tlp|na|text{{=}}na}} || {{na|text=na}}
|-
| {{tlp|na|Na}} || {{na|Na}} || {{tlp|na|text|link{{=}}WP:ALT}} || {{na|text|link=WP:ALT}}
|-
| {{tl|nom}} || {{nom}} || {{tlp|nom|5}} || {{nom|5}}
|-
| {{tl|sho}} || {{sho}} || {{tlp|sho|proposed}} || {{sho|proposed}}
|-
| {{tl|longlisted}} || {{longlisted}} || {{tlp|longlisted|rejected}} || {{longlisted|rejected}}
|-
| {{tl|TBA}} || {{TBA}} || {{tlp|TBA|to be announced}} || {{TBA|to be announced}}
|-
| rowspan=2 |<code>table-success</code>
| {{tl|success}} || {{success}} || {{tlp|success|mission complete}} || {{success|mission complete}}
|-
| {{tl|operational}} || {{operational}} || {{tlp|operational|returning data}} || {{operational|returning data}}
|-
| <code>table-failure</code>
| {{tl|failure}} || {{failure}} || {{tlp|failure|wrong orbit}} || {{failure|wrong orbit}}
|-
| rowspan=16| <code>table-partial</code>
| {{tl|partial}} || {{partial}} || {{tlp|partial|almost done}} ||{{partial|almost done}}
|-
| {{tl|Regional}} || {{Regional}} || {{tlp|Regional|Uyghur}} || {{Regional|Uyghur}}
|-
| {{tl|MaybeCheck}} || {{MaybeCheck}} || {{tlp|MaybeCheck|text{{=}}possibly}} || {{MaybeCheck|text=possibly}}
|-
| {{tlp|MaybeCheck|possibly}} || {{MaybeCheck|possibly}} || {{tlp|MaybeCheck|text|link{{=}}WP:ALT}} || {{MaybeCheck|text|link=WP:ALT}}
|-
| {{tl|partial success}} || {{partial success}} || {{tlp|partial success|reached orbit and returned pictures}} || {{partial success|reached orbit and returned pictures}}
|-
| {{tl|partial failure}} || {{partial failure}} || {{tlp|partial failure|<nowiki>[[Cubesat]] not deployed</nowiki>}} || {{partial failure|[[Cubesat]] not deployed}}
|-
| {{tl|okay}} || {{okay}} || {{tlp|okay|C}} || {{okay|C}}
|-
| {{tl|Yes-No}} || {{Yes-No}} || {{tlp|Yes-No|yes with an if; no with a but}} || {{Yes-No|yes with an if; no with a but}}
|-
| {{tl|some}} || {{some}} || {{tlp|some|many}} || {{some|many}}
|-
| {{tl|nonpartisan}} || {{nonpartisan}} || {{tlp|nonpartisan|impartial}} || {{nonpartisan|impartial}}
|-
| {{tl|pending}} || {{pending}} || {{tlp|pending|awaiting}} || {{pending|awaiting}}
|-
| {{tl|unofficial}} || {{unofficial}} || {{tlp|unofficial|<nowiki>''de facto''</nowiki>}} || {{unofficial|''de facto''}}
|-
| {{tl|unofficial2}} || {{unofficial2}} || {{tlp|unofficial2|<nowiki>''de facto''</nowiki>}} || {{unofficial2|''de facto''}}
|-
| {{tl|usually}} || {{usually}} || {{tlp|usually|commonly}} || {{usually|commonly}}
|-
| {{tl|rarely}} || {{rarely}} || {{tlp|rarely|seldom}}|| {{rarely|seldom}}
|-
| {{tl|sometimes}} || {{sometimes}} || {{tlp|sometimes|occasionally}} || {{sometimes|occasionally}}
|-
| <code>table-noAttempt</code>
| {{tl|No attempt}} || {{No attempt}} || {{tlp|No attempt|No landing attempted}} || {{No attempt|No landing attempted}}
|-
| <code>table-any</code>
| {{tl|any}} || {{any}} || {{tlp|any|anyone}}|| {{any|anyone}}
|-
|rowspan=6| <code>table-na</code>
| {{tl|n/a}} || {{n/a}} || {{tlp|n/a|unavailable}}|| {{n/a|unavailable}}
|-
| {{tl|varies}} || {{varies}} || {{tlp|varies|differs}}|| {{varies|differs}}
|-
| {{tl|sdash}} || {{sdash}} || {{tlp|sdash|<nowiki>[[File:Dash.svg|13px|link=|dash icon]]</nowiki>}}|| {{sdash|[[File:Dash.svg|13px|link=|dash]]}}
|-
| {{tl|BLACK}} || {{BLACK}} || {{tlp|BLACK|banned}} || {{BLACK|banned}}
|-
| {{tl|non-album single}} || {{non-album single}} || {{tlp|non-album single|EP}} || {{non-album single|EP}}
|-
| {{tl|unreleased}} || {{unreleased}} || {{tlp|unreleased|shelved}} || {{unreleased|shelved}}
|-
|rowspan=2| <code>table-unknown</code>
| {{tl|unknown}} || {{Unknown}} || {{tlp|unknown|?}} || {{unknown|?}}
|-
| {{tl|dunno}} || {{Dunno}} || {{tlp|dunno|not sure}} || {{dunno|not sure}}
|-
| <code>table-automatic</code>
| {{tl|perhaps}} || {{perhaps}} || {{tlp|perhaps|maybe}} || {{perhaps|maybe}}
|-
| <code>table-depends</code>
| {{tl|depends}} || {{depends}} || {{tlp|depends|vendor-defined}} || {{depends|vendor-defined}}
|-
| <code>table-included</code>
| {{tl|included}} || {{included}} || {{tlp|included|incorporated}} || {{included|incorporated}}
|-
|rowspan=2| <code>table-dropped</code>
| {{tl|dropped}} || {{dropped}} || {{tlp|dropped|discontinued}} || {{dropped|discontinued}}
|-
| {{tl|terminated}} || {{terminated}} || {{tlp|terminated|fired}} || {{terminated|fired}}
|-
|rowspan=9| <code>table-software</code>
| {{tl|beta}} || {{beta}} || {{tlp|beta|preview}} || {{beta|preview}}
|-
| {{tl|table-experimental}} || {{table-experimental}} || {{tlp|table-experimental|lab}} || {{table-experimental|lab}}
|-
| {{tl|open source}} || {{open source}} || {{tlp|open source|software libre}} || {{open source|software libre}}
|-
| {{tl|free}} || {{free}} || {{tlp|free|empty}} || {{free|empty}}
|-
| {{tl|proprietary}} || {{proprietary}} || {{tlp|proprietary|custom extension}} || {{proprietary|custom extension}}
|-
| {{tl|nonfree}} || {{nonfree}} || {{tlp|nonfree|paid}} || {{nonfree|paid}}
|-
| {{tl|needs}} || {{needs}} || {{tlp|needs|req.}} || {{needs|req.}}
|-
| {{tl|nightly}} || {{nightly}} || {{tlp|nightly|dev}} || {{nightly|dev}}
|-
| {{tl|release-candidate}} || {{release-candidate}} || {{tlp|release-candidate|RC}} || {{release-candidate|RC}}
|-
| <code>table-draw</code>
| {{tl|draw}} || {{draw}} || {{tlp|draw|1:1}} || {{draw|1:1}}
|-
| <code>table-planned</code>
| {{tl|planned}} || {{planned}} || {{tlp|planned|July 2028}} || {{planned|July 2028}}
|-
| <code>table-scheduled</code>
| {{tl|scheduled}} || {{scheduled}} || {{tlp|scheduled|3 March 2027}} || {{scheduled|3 March 2027}}
|-
| <code>incorrect</code>
| {{tl|incorrect}} || {{incorrect}} || {{tlp|incorrect|wrong}} || {{incorrect|wrong}}
|-
| <code>noresult</code>
| {{tl|no result}} || {{no result}} || {{tlp|no result|NR}} || {{no result|NR}}
|-
| rowspan=8 | <code>table-debate</code>
| {{tl|D-P}} || {{D-P}} || {{tlp|D-P|present}} || {{D-P|present}}
|-
| {{tl|D-A}} || {{D-A}} || {{tlp|D-A|absent}} || {{D-A|absent}}
|-
| {{tl|D-I}} || {{D-I}} || {{tlp|D-I|invited}} || {{D-I|invited}}
|-
| {{tl|D-O}} || {{D-O}} || {{tlp|D-O|invited to other debate}} || {{D-O|invited to other debate}}
|-
| {{tl|D-N}} || {{D-N}} || {{tlp|D-N|not invited}} || {{D-N|not invited}}
|-
| {{tl|D-Nv}} || {{D-Nv}} || {{tlp|D-Nv|not voting}} || {{D-Nv|not voting}}
|-
| {{tl|D-W}} || {{D-W}} || {{tlp|D-W|withdrawn}} || {{D-W|withdrawn}}
|-
| {{tl|D-Out}} || {{D-Out}} || {{tlp|D-Out|out of race}} || {{D-Out|out of race}}
|-
|rowspan=14| <code>table-cast</code>
| {{tl|CMain}} || {{CMain}} || {{tlp|CMain|text}} || {{CMain|text}}
|-
| {{tl|CAlso starring}} || {{CAlso starring}} || {{tlp|CAlso starring|costar}} || {{CAlso starring|costar}}
|-
| {{tl|CRecurring}} || {{CRecurring}} || {{tlp|CRecurring|regular guest}} || {{CRecurring|regular guest}}
|-
| {{tl|CGuest}} || {{CGuest}} || {{tlp|CGuest|victim}} || {{CGuest|victim}}
|-
| {{tl|COther}} || {{COther}} || {{tlp|COther|ensemble}} || {{COther|ensemble}}
|-
| {{tl|CNone}} || {{CNone}} || {{tlp|CNone|cast}} || {{CNone|cast}}
|-
| {{tl|CEmpty}} || {{CEmpty}} || ||
|-
| {{tl|CRemoved}} || {{CRemoved}} || {{tlp|CRemoved|edited}} || {{CRemoved|edited}}
|-
| {{tl|CFinalist}} || {{CFinalist}} || {{tlp|CFinalist|text{{=}}white|color{{=}}darkblue|contender}} || {{CFinalist|text=white|color=darkblue|contender}}
|-
| {{tlp|CFinalist|place{{=}}3rd Place}} || {{CFinalist|place=3rd Place}} || {{tlp|CFinalist|place{{=}}third place}} || {{CFinalist|place=third place}}
|-
| {{tl|exempt}} || {{exempt}} || {{tlp|Black Exempt}} || {{Black Exempt}}
|-
| {{tl|nocontest}} || {{nocontest}} || {{tlp|nocontest|rescheduled}} || {{nocontest|rescheduled}}
|-
| {{tl|Runner-up}} || {{Runner-up}} || {{tlp|Runner-up|2nd Place}} || {{Runner-up|2nd Place}}
|-
| {{tl|Quit}} || {{Quit}} || {{tlp|Quit|left}} || {{Quit|left}}
|-
|rowspan=6| ''no class''
| {{tl|not yet}} || {{not yet}} || {{tlp|not yet|NY}} || {{not yet|NY}}
|-
| {{tl|optional}} || {{optional}} || {{tlp|optional|non-mandatory}} || {{optional|non-mandatory}}
|-
| {{tlp|shade|100}}% || {{shade|100}}% || {{tlp|shade|r{{=}}0|g{{=}}100|b{{=}}255|100}}% || {{shade|r=0|g=100|b=255|100}}%
|-
| {{tlp|shade|75}}% || {{shade|75}}% || {{tlp|shade|r{{=}}0|g{{=}}100|b{{=}}255|75}}% || {{shade|r=0|g=100|b=255|75}}%
|-
| {{tlp|shade|25}}% || {{shade|25}}% || {{tlp|shade|r{{=}}0|g{{=}}100|b{{=}}255|25}}% || {{shade|r=0|g=100|b=255|25}}%
|-
| {{tlp|shade|0}}% || {{shade|0}}% || {{tlp|shade|r{{=}}0|g{{=}}100|b{{=}}255|0}}% || {{shade|r=0|g=100|b=255|0}}%
|}</div>

== 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 ==
* {{tl|Change}} – calculates, displays and color-codes changes between two values
* {{tl|BSD-lic}} – specialized redirect for {{tlf|free}}
* {{tl|GPL-lic}} – specialized redirect for {{tlf|free}}
* {{tl|LGPL-lic}} – specialized redirect for {{tlf|free}}

== Notes ==
{{reflist}}

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

}}}}</includeonly>

Revision as of 19:05, 1 February 2021

Retrieved from "https://civwiki.org/wiki/Template:Table_cell_templates/doc?oldid=34228"