Module:CsvUtils/doc

Overview
The CsvUtils module loads, processes, and returns data that is stored in CSV format in wiki templates. This module also provides a parsing method to convert well-structured CSV data into a Lua table.

Requirements
The CSV data must be well structured. The header row cannot have empty names, and all lines must end with a comma.

There can be documentation in the template, and this module will automatically remove it, provided it is enclosed in a  block. The CSV data itself must be wrapped in a  block in order to protect line breaks. The  block will also be removed.

Usage
The standard way of using this module is a call like the following:

dataTable, headerLookupTable = CsvUtils.extractTables(DATA_TEMPLATE_NAME)

This is a shortcut method for the other two:  and. The  method loads the template and removes all surrounding documentation. It returns a very long string of CSV data, including newlines. The  method takes that string and parses it, splitting it into a header row and data rows, and each row into fields. It returns the data itself and a lookup table with header names, allowing constant time lookup of indexes in the data table from string names of the headers. In other words, if you know the column has the header "constructionTime", then if the data at index 10 stores the value for constructionTime, 45s:

headerLookupTable"constructionTime" = 10 dataTable10 = 45

The data table has the following structure:

dataTable = { [1] = {        [1] = "header1Name", [2] = "header2Name", [3] = "header3Name", ...   },    [2] = {        [1] = {            dataRow1field1, dataRow1field2, dataRow1field3, ...       },        [2] = {            dataRow2field1, ...       },        [3] = {            dataRow3field1, ...       },        ...    } }

The header lookup table has the following structure:

headerLookupTable = { "header1Name" = 1, "header2Name" = 2, "header3Name" = 3, ... }