Module:Data Table/Documentation

This is the main module for the following templates:

• Template:Data Table
• Template:Data Table Copy
• Template:Data Table/Store

In addition, this module exports the following functions.

Main

{{#invoke:Data Table|Main|game=|columns=|optionalColumns=}}

In addition to being the main invocation of Template:Data Table, this function can be used to create templates with fixed values for the parameters columns and/or game, e.g. Template:Goddess Cubes, Template:Gold Skulltulas, Template:Other Names, etc.

Parameters

Parameter	Status	Description
game	optional	See Template:Data Table
columns	optional	See Template:Data Table
optionalColumns	optional	See printTable

parseRows

parseRows(cells)

Allows other templates to use Template:Data Table's table-like syntax. Used by Module:Wares, for example.

Returns

• A list of rows.

Examples

#	Input	Output
1	parseRows({ "-", "cell1", "cell2", "-", "cell3", "cell4", "-", })	{ { cells = {"cell1", "cell2"}, }, { cells = {"cell3", "cell4"}, }, }

printTable

printTable(rows, args, [postFormatHook])

Parameters

• rows

  [cells]

• args

  Template:Data Table arguments, plus optionalColumns for other table templates.

  [game]

  columns

  [optionalColumns]

  List of indices referring to optional columns. If multiple columns are marked as optional but some are provided in the table, columns are omitted in the order specified by this list.

  [caption]

  [responsiveModeEnabled]

  [sortable]

  [stretch]

• [postFormatHook]

  Advanced usage - allows other modules to further customize a data table before printing it. Used by Module:Armor, for example.

Returns

• A data table.

Examples

#	Input	Result
2	printTable( { { cells = {"Blue Chu Jelly", "Blue Potion"}, }, { cells = {"Red Chu Jelly", "Red Potion"}, }, }, { game = "TWWHD", columns = {"Chu Jelly [Term]", "Potion [Term]"}, } )	Chu Jelly Potion Blue Chu Jelly Blue Potion Red Chu Jelly Red Potion
The optionalColumns property allows columns to be omitted
3	printTable( { { cells = {"Treasure Chest", "Small Key"}, }, { cells = {"Treasure Chest", "Red Rupee"}, }, }, { game = "PH", optionalColumns = {3}, columns = { "Treasure Chest [Image:Model:50x50px][Term]", "Contents [Image:Model:50x50px][Term]", "Coordinates", }, } )	Treasure Chest Contents Treasure Chest Small Key Treasure Chest Red Rupee