Wikipedia:Conditional tables

From Wikipedia, the free encyclopedia

 This page is a how-to guide detailing a practice or process on the English Wikipedia.
Shortcut:
WP:CTB

ParserFunctions allow for the conditional display of table rows, columns or cells (and really, just about anything else). The method is fairly straightforward, but has some limitations which are worth explaining.

Contents

[edit] Basic use

The following example shows a basic use for #if:

{{#if:{{{variable_foo|}}}
|foo is set to '''{{{variable_foo}}}'''
|foo is ''blank''}}

Here, {{{variable_foo}}} is checked to see if it is defined with a non-blank value. The table below shows the output from a template call (we'll call the template {{if_example_1}}) with different values for {{{variable_foo}}}:

Template call Result
{{if_example_1}} foo is blank
{{if_example_1|variable_foo=}} foo is blank
{{if_example_1|variable_foo=value}} foo is set to value

Positional parameters {{{1}}} etc. work like named parameters:

{{#if:{{{1|}}}
|1st parameter is '''{{{1}}}'''
|1st parameter is ''blank''}}
Template call Result
{{if_example_1/b| |bar}} 1st parameter is blank
{{if_example_1/b|foo|bar}} 1st parameter is foo
{{if_example_1/b|[[m:|not empty]]}} 1st parameter is not empty
{{if_example_1/b|bad=idea}} 1st parameter is blank
{{if_example_1/b|1=ok=yes}} 1st parameter is ok=yes

Note how the pipe symbol (vertical bar) in the link works as is, it's not quite that easy within Wiki tables, see below.

[edit] Hiding rows entirely

It's also possible to hide rows of data within a table, however, there are issues you should be aware of.

[edit] Incorrect usage

Unfortunately #if and the MediaWiki table syntax do not work together well. For example, the following is invalid and will not work:

{| class="infobox"
{{#if:{{{variable_foo|}}}
|
|-
! Foo
| {{{variable_foo}}}
}}
|-
! Bar
| {{{variable_bar}}}
|}

The code above is in {{if_example_2}}. The table below demonstrates the effect when it's used:

Template call Result
{{if_example_2}} -
Foo
Bar {{{variable_bar}}}
{{if_example_2|variable_foo=}} -
Foo
Bar {{{variable_bar}}}
{{if_example_2|variable_foo=|variable_bar=bar}} -
Foo
Bar bar
{{if_example_2|variable_foo=value}}
Bar {{{variable_bar}}}
{{if_example_2|variable_foo=value|variable_bar=bar}}
Bar bar

The problem is with the usage of the pipe character (|). This character, in template calls, is used to separate parameters and so is invalid.

[edit] Correct usage

[edit] Plan A

One method of hiding rows in tables (or other structures within tables) utilizes HTML directly. HTML is more complicated than MediaWiki table syntax, but not much more so. In general, there are only a handful of HTML tags you need to be aware of

  • <tr> - this tag creates a new row (similar to |- in MediaWiki table syntax)
  • <th> - this tag creates a new header cell within a row (similar to ! in MediaWiki table syntax)
  • <td> - this tag creates a new cell within a row (similar to | in MediaWiki table syntax)
  • <caption> - this tag creates a caption (similar to |+ in MediaWiki table syntax)

Working from the invalid template example above, by switching to HTML we end up with the following code:

{| class="infobox"
{{#if:{{{variable_foo|}}}
|<tr><th>Foo</th><td>{{{variable_foo}}}</td></tr>}}
|-
! Bar
| {{{variable_bar}}}
|}

The code above is in {{if_example_2a}}. As before, the table below demonstrates the effect when it's used:

Template call Result
{{if_example_2a}}
Bar {{{variable_bar}}}
{{if_example_2a|variable_foo=}}
Bar {{{variable_bar}}}
{{if_example_2a|variable_foo=|variable_bar=bar}}
Bar bar
{{if_example_2a|variable_foo=value}}
Foo value
Bar {{{variable_bar}}}
{{if_example_2a|variable_foo=value|variable_bar=bar}}
Foo value
Bar bar

[edit] Plan B

As noted above the only problem is the vertical bar or pipe symbol within a template. Often it's good enough to replace problematic characters by numeric references, e.g. "{" by &#123;, "|" by &#124;, and "}" by &#125;. But for Wiki tables a real "|" delimiter is required — using &#124; doesn't work as delimiter.

A simple trick allows to protect the "|" in template parameter values while still arriving as real "|" delimiter in the Wiki table, see Template:! (edit talk links history). Note that "!" (exclamation mark) has no problems with templates, it's the other delimiter used in Wiki tables. Here's the code for plan B:

{| class="infobox"
{{#if:{{{foo|}}}|
{{!}}-
! Foo
{{!}} {{{foo}}}
}}
|-
! Bar
| {{{bar}}}
|}

The code above is in {{if_example_2b}}. As before, the table below demonstrates the effect when it's used:

Template call Result
{{if_example_2b|bar=nobar}}
Bar {{{bar}}}
{{if_example_2b|foo=|bar=vbar}}
Bar vbar
{{if_example_2b|foo=value}}
Foo value
Bar {{{bar}}}
{{if_example_2b|foo=value|bar=vbar}}
Foo value
Bar vbar

[edit] Getting help

If you find yourself unable to get a template to behave how you like, you can try asking on Village pump, placing a request at Requested templates, or contacting one of the editors listed below.



[edit] See also

For avoiding blank rows in the case of successive optional rows, see m:Help:Table#Conditional_table_row.

For more information on #if (and other # functions), see:

The following help topics deal with templates:

This help topic deals with table design (since most templates use tables, this may be useful):

And finally: