Module:Tabular data/doc
 | This is a documentation subpage for Module:Tabular data. It may contain usage information, categories and other content that is not part of the original module page. |
This module provides basic functions for interacting with tabular data on Wikimedia Commons.
cell
Returns the value of the cell at the given row index and column name.
Usage: {{#invoke:Tabular data|cell|Page name.tab|output_row=Index of row to output|output_column=Name of column to output}}
A row index of 1 refers to the first row in the table. A row index of -1 refers to the last row in the table. It is an error to specify a row index of 0.
Example getting the latest death toll in c:Data:COVID-19 Cases in Santa Clara County, California.tab (regardless of when the table was last updated):
Lua error in Module:Tabular_data at line 35: attempt to index local 'data' (a boolean value).
lookup
Returns the value of the cell in the given output column of the row matching the search key and column.
This function is reminiscent of LOOKUP() macros in popular spreadsheet applications, except that the search key must match exactly. (On the other hand, this means the table does not need to be sorted.)
Usage: {{#invoke:Tabular data|lookup|Page name.tab|search_value=Value to find in column|search_column=Name of column to search in|output_column=Name of column to output}}
Example getting the total confirmed case count in c:Data:COVID-19 Cases in Santa Clara County, California.tab on the day that the county issued a stay-at-home order:
Lua error in Module:Tabular_data at line 97: attempt to index local 'data' (a boolean value).
wikitable
Returns the entire data table as a (rather plain) table.
Usage: {{#invoke:Tabular data|wikitable|Page name.tab}}
Example
|
|---|
|
Lua error in Module:Tabular_data at line 153: attempt to index local 'data' (a boolean value). |
The implementation of this function incorporates {{n/a}} (to represent null values), {{yes}} (true), and {{no}} (false). The templates themselves cannot be reused because they are incompatible with the mw.html library, which builds the table using an HTML DOM instead of pure wikitext.
Internationalization
You can most likely port this template to a wiki in another language without making major modifications. The wikitable function automatically localizes the table's description, column titles, and license name into the wiki's content language. It also formats numbers according to the content language. However, you should localize the cells representing true, false, and null by changing the values in the messages, bgColors, and colors variables to match the wiki's own {{yes}}, {{no}}, and {{n/a}} templates, respectively.
See also
- {{Json2table}} and {{#invoke:Json2table|json2table}}