Module:Dump/doc - Revision history

Warudo: Added the page to :Category:Module documentation pages

2024-08-29T21:10:45Z

Added the page to Category:Module documentation pages

← Previous revision		Revision as of 21:10, 29 August 2024
Line 178:		Line 178:
	If wanted, the width of each indented column can be set, for example to 2 spaces:		If wanted, the width of each indented column can be set, for example to 2 spaces:
	:<code><nowiki>{{#invoke:dump\|testcase\|G\|indent=2}}</nowiki></code>		:<code><nowiki>{{#invoke:dump\|testcase\|G\|indent=2}}</nowiki></code>
			<noinclude>
			[[Category:Module documentation pages]]
			</noinclude>

Johnuniq: args function

2021-06-10T07:55:48Z

args function

@@ Line 129: / Line 129: @@
 }}
 </pre>
 == Dump of parameters ==

Johnuniq: document indent=tab

2021-02-28T01:34:47Z

document indent=tab

← Previous revision		Revision as of 01:34, 28 February 2021
Line 11:		Line 11:
	To do that, edit [[Special:MyPage/sandbox\|your sandbox]] and replace its contents with the above line, then click Show preview. [[Module talk:Dump]] shows this example.		To do that, edit [[Special:MyPage/sandbox\|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 2 spaces:		If wanted, the width of each indented column can be set, for example to two spaces or to use tab characters:
	:<code><nowiki>{{#invoke:dump\|wikidata\|Q833639\|indent=2}}</nowiki></code>		:<code><nowiki>{{#invoke:dump\|wikidata\|Q833639\|indent=2}}</nowiki></code>
			:<code><nowiki>{{#invoke:dump\|wikidata\|Q833639\|indent=tab}}</nowiki></code>

	A property such as {{Q\|P2386}} can also be displayed:		A property such as {{Q\|P2386}} can also be displayed:

Johnuniq: document parameters and structured data

2020-09-07T11:21:16Z

document parameters and structured data

@@ Line 21: / Line 21: @@
 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 function main()
+local p = {}
 	local example = {
 		link = true,
@@ Line 30: / Line 31: @@
 	return dump(example, 'example')
 end
 </syntaxhighlight>
@@ Line 128: / Line 128: @@
 }}
 </pre>
 == Global table _G ==

WOSlinker: change source to syntaxhighlight

2020-07-07T13:25:09Z

change source to syntaxhighlight

← Previous revision		Revision as of 13:25, 7 July 2020
Line 20:		Line 20:

	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.		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.
	<~~source~~ lang="Lua">		<syntaxhighlight lang="Lua">
	local function main()		local function main()
	local example = {		local example = {
Line 32:		Line 32:

	return { main = main }		return { main = main }
			</syntaxhighlight>
	</source>

	With the above code in Module:Example, the result could be displayed by previewing:		With the above code in Module:Example, the result could be displayed by previewing:
Line 44:		Line 44:
	A module can use [[:mw:Extension:Scribunto/Lua reference manual#HTML library\|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.		A module can use [[:mw:Extension:Scribunto/Lua reference manual#HTML library\|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.

	<~~source~~ lang="Lua">		<syntaxhighlight lang="Lua">
	local function main()		local function main()
	local tbl = mw.html.create('table')		local tbl = mw.html.create('table')
Line 67:		Line 67:

	return { main = main }		return { main = main }
			</syntaxhighlight>
	</source>

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

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

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

Johnuniq: dumping a navbox

2017-03-10T07:16:23Z

dumping a navbox

@@ Line 96: / Line 96: @@
 </source>
-In that case, the result could be displayed by previewing:
+In that case, the result could be displayed by previewing the following (the <code>1=</code> is needed if the text contains "<code>=</code>"):
-:<code><nowiki>{{#invoke:dump|dumphtml|{{#invoke:example|main}}}}</nowiki></code>
+:<code><nowiki>{{#invoke:dump|dumphtml|1={{#invoke:example|main}}}}</nowiki></code>
 == Global table _G ==

Johnuniq: add dumphtml

2016-10-18T09:28:22Z

add dumphtml

@@ Line 1: / Line 1: @@
-This module can dump a table by displaying its contents as text. That may help develop other modules.
+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 <code>mw.dumpObject()</code> 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.
@@ Line 16: / Line 17: @@
 :<code><nowiki>{{#invoke:dump|wikidata|P2386}}</nowiki></code>
-== Dump of table for another module ==
+== 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.
@@ Line 36: / Line 37: @@
 :<code><nowiki>{{#invoke:example|main}}</nowiki></code>
 The module contains a complex table for testing. The table can be displayed by previewing:
 :<code><nowiki>{{#invoke:dump|testcase}}</nowiki></code>
 == Global table _G ==
 In Lua, <code>_G</code> is a global variable which is a table holding information about all global variables. The <code>_G</code> table can be displayed by previewing (both <code>G</code> and <code>_G</code> work):
 :<code><nowiki>{{#invoke:dump|testcase|G}}</nowiki></code>

Johnuniq: how to dump a table from a module

2016-10-17T06:51:47Z

how to dump a table from a module

@@ Line 15: / Line 15: @@
 A property such as {{Q|P2386}} can also be displayed:
 :<code><nowiki>{{#invoke:dump|wikidata|P2386}}</nowiki></code>
 == Complex table example ==

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

2016-05-25T11:51:20Z

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

← Previous revision		Revision as of 11:51, 25 May 2016
Line 12:		Line 12:
	If wanted, the width of each indented column can be set, for example to 2 spaces:		If wanted, the width of each indented column can be set, for example to 2 spaces:
	:<code><nowiki>{{#invoke:dump\|wikidata\|Q833639\|indent=2}}</nowiki></code>		:<code><nowiki>{{#invoke:dump\|wikidata\|Q833639\|indent=2}}</nowiki></code>

			A property such as {{Q\|P2386}} can also be displayed:
			:<code><nowiki>{{#invoke:dump\|wikidata\|P2386}}</nowiki></code>

	== Complex table example ==		== Complex table example ==

Johnuniq: most usage details

2016-05-24T02:50:51Z

most usage details

← Previous revision		Revision as of 02:50, 24 May 2016
Line 1:		Line 1:
			This module can dump a table by displaying its contents as text. That may help develop other modules.
	'''See [[Module talk:Dump]] for an example which displays the Lua table for a Wikidata entity.'''

			An alternative is to use <code>mw.dumpObject()</code> 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:
			:<code><nowiki>{{#invoke:dump\|wikidata\|Q833639}}</nowiki></code>
			To do that, edit [[Special:MyPage/sandbox\|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 2 spaces:
			:<code><nowiki>{{#invoke:dump\|wikidata\|Q833639\|indent=2}}</nowiki></code>

			== Complex table example ==
			The module contains a complex table for testing. The table can be displayed by previewing:
			:<code><nowiki>{{#invoke:dump\|testcase}}</nowiki></code>

			== Global table _G ==
			In Lua, <code>_G</code> is a global variable which is a table holding information about all global variables. The <code>_G</code> table can be displayed by previewing (both <code>G</code> and <code>_G</code> work):
			:<code><nowiki>{{#invoke:dump\|testcase\|G}}</nowiki></code>

			If wanted, the width of each indented column can be set, for example to 2 spaces:
			:<code><nowiki>{{#invoke:dump\|testcase\|G\|indent=2}}</nowiki></code>