Module:Dump/doc

This module can dump a table by displaying its contents as text. It can also display formatted html text. That may help develop other modules.

An alternative is to use mw.dumpObject() but the result from this module is clearer and is close to valid Lua source.

Dump of a Wikidata entity

When working with Wikidata, it can be useful to examine a table representing an entity.

For example, Southern African Large Telescope is d:Q833639. That entity can be viewed as a Lua table by previewing:

{{#invoke:dump|wikidata|Q833639}}

To do that, edit your sandbox and replace its contents with the above line, then click Show preview. Module talk:Dump shows this example.

If wanted, the width of each indented column can be set, for example to two spaces or to use tab characters:

{{#invoke:dump|wikidata|Q833639|indent=2}}

{{#invoke:dump|wikidata|Q833639|indent=tab}}

A property such as Template:Q can also be displayed:

{{#invoke:dump|wikidata|P2386}}

Dump of a table for another module

If there is a problem debugging a module, it can be helpful to use a sandbox copy of the module to display the contents of a table to confirm that it contains expected data. The following shows how a module can dump a table. <syntaxhighlight lang="Lua"> local p = {} function p.main(frame) local example = { link = true, fruit = { yellow = 'bannana', red = 'cherry' }, 11, 22, 33, } local dump = require('Module:Dump')._dump return dump(example, 'example') end return p </syntaxhighlight>

With the above code in Module:Example, the result could be displayed by previewing:

{{#invoke:example|main}}

The module contains a complex table for testing. The table can be displayed by previewing:

{{#invoke:dump|testcase}}

Dump of a formatted html string

A module can use mw.html to generate html. For testing, it may be useful to display the formatted result. The following shows how a module can create and dump html text.

<syntaxhighlight lang="Lua"> local function main() local tbl = mw.html.create('table') tbl :addClass('wikitable') :tag('caption'):wikitext('Table demonstration'):done() :tag('tr') :tag('th'):wikitext('Month'):done() :tag('th'):wikitext('Amount'):done() :done() :tag('tr') :tag('td'):wikitext('January'):done() :tag('td'):wikitext('$100
loss'):done() :done() :tag('tr') :tag('td'):wikitext('February'):done() :tag('td'):wikitext('$200') local html = tostring(tbl) local dumphtml = require('Module:Dump')._dumphtml return dumphtml(html) end

return { main = main } </syntaxhighlight>

With the above code in Module:Example, the result could be displayed by previewing:

{{#invoke:example|main}}

The result is:

<table class="wikitable">
    <caption>Table demonstration</caption>
    <tr>
        <th>Month</th>
        <th>Amount</th>
    </tr>
    <tr>
        <td>January</td>
        <td>$100<br>loss</td>
    </tr>
    <tr>
        <td>February</td>
        <td>$200</td>
    </tr>
</table>

The main() function in the code above could be modified to return the html table by replacing the last two lines with: <syntaxhighlight lang="Lua"> return html </syntaxhighlight>

In that case, the result could be displayed by previewing the following (the 1= is needed if the text contains "="):

{{#invoke:dump|dumphtml|1={{#invoke:example|main}}}}

Dumping a navbox

Previewing the following examples in a sandbox may be useful to examine the results of a template, such as {{navbox}}, that generates html.

{{#invoke:dump|dumphtml|1=
  {{navbox/sandbox
  |group1 = Group1
  |list1 = List1
  |group2 = Group2
  |list2 = List2
  |group3 = Group3
  |list3 = List3
  }}
}}

The dumphtml procedure only works reliably with valid html. In the following example, extra text (<div>) is inserted at the start because the output from a subgroup (child) navbox starts with </div>.

{{#invoke:dump|dumphtml|1=<div>
  {{navbox/sandbox|subgroup
  |group1 = Group1
  |list1 = List1
  |group2 = Group2
  |list2 = List2
  |group3 = Group3
  |list3 = List3
  }}
}}

Dump of arguments

Special:ExpandTemplates is useful if there is a need to view the wikitext returned by a template or module. However, ExpandTemplates does not always show exactly what a module would receive. For example, the following template gives the output shown in ExpandTemplates, but the wikitext passed to a module would actually contains strip markers.

{{convert|1+2/3<ref>Example</ref>|ft|in}}

ExpandTemplates output, rearranged on multiple lines for clarity:

<span class="frac" role="math">1<span class="sr-only">+</span>

<span class="num">2</span>⁄<span class="den">3</span></span>

<ref>Example</ref>

feet (20 in)

The args function shows what a module receives in its arguments.

{{#invoke:dump|args|1={{convert|1+2/3<ref>Example</ref>|ft|in}}}}

The output follows. For clarity, it has been rearranged on multiple lines and each delete character has been replaced with ♢.

♢'"`UNIQ--templatestyles-00000002-QINU`"'♢

<span class="frac" role="math">1<span class="sr-only">+</span>

<span class="num">2</span>⁄<span class="den">3</span></span>

♢'"`UNIQ--ref-00000001-QINU`"'♢

feet (20 in)

Dump of parameters

A template might invoke the main function in the example above. Any parameters passed to the template or the module can be displayed for debugging. That would be to investigate an unexpected result in a page, for example, Albedo. To see what parameters are received by a module used in that article, edit the module and insert the following line at the start of the main function: <syntaxhighlight lang="Lua"> if true then return require('Module:Dump').parameters(frame) end </syntaxhighlight> Do not save the changes. Instead, enter the name of the article (for example, Albedo) in the box under "Preview page with this module", then click Show preview. Any parameters passed to the module in its frame and parent frame are displayed where the result from the module would normally appear.

Dump of structured data

A Lua program could execute <syntaxhighlight lang="Lua"> local data = mw.ext.data.get('Wikipedia statistics/data.tab') </syntaxhighlight> to read a table of data from c:Data:Wikipedia statistics/data.tab.

An edit in a sandbox can be previewed to see what data the program would receive. To do that, preview the following wikitext:
{{#invoke:dump|Wikipedia statistics/data.tab}}

The dump module accepts any text as the parameter and will apply special processing if the text is recognized. Structured data is identified as text ending with .tab.

Global table _G

In Lua, _G is a global variable which is a table holding information about all global variables. The _G table can be displayed by previewing (both G and _G work):

{{#invoke:dump|testcase|G}}

If wanted, the width of each indented column can be set, for example to 2 spaces:

{{#invoke:dump|testcase|G|indent=2}}