Template:Table cell templates/doc

    From Ricochet Wiki

    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[edit source]

    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
    {{available}} Available {{available|Unused}} Unused
    {{contained}} Contained
    table-maybe {{maybe}} Maybe {{maybe|Customized [[Plain text|text]]}} Customized text
    table-no {{no}} No {{no|Customized [[Plain text|text]]}} Customized text
    {{bad}} Bad {{bad|F}} F
    {{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}} Yes {{ya|text=Ya}} Ya
    {{ya|Ya}} Ya {{ya|text|link=WP:ALT}} 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
    {{na}} No {{na|text=Na}} Na
    {{na|Na}} Na {{na|text|link=WP:ALT}} text
    {{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}} Operational {{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}} Maybe {{MaybeCheck|text=Possibly}} Possibly
    {{MaybeCheck|Possibly}} Possibly {{MaybeCheck|text|link=WP:ALT}} text
    {{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}} Yes/No {{Yes-No|Yes with an if; no with a but}} Yes with an if; no with a but
    {{some}} Some {{some|Many}} Many
    {{nonpartisan}} Nonpartisan {{nonpartisan|Impartial}} Impartial
    {{pending}} Pending {{pending|Awaiting}} Awaiting
    {{unofficial}} Unofficial {{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 {{n/a|Unavailable}} Unavailable
    {{varies}} Varies {{varies|Differs}} Differs
    {{sdash}} {{sdash|[[File:Dash.svg|13px|link=|dash icon]]}} dash
    {{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}} Terminated {{terminated|Fired}} Fired
    table-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|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.
    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
    {{CNone}} Does not appear {{CNone|Customized [[Plain text|text]]}} Customized text
    {{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

    Code[edit source]

    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:

    {{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[edit source]

    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

    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[edit source]

    • {{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[edit source]

    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.