Module:DPLlua/doc

This is a documentation subpage for Module:DPLlua. It contains usage information, categories, and other content that is not part of the original module page.

Module:DPLlua requires Module:LibraryUtil.

Module:DPLlua requires Module:Paramtest.

Module:DPLlua is required by Module:DependencyList.

Uses Module:DPLlua/Helper to make it possible to include all parameters of a template while maintaining good performance.

This module is a helper module to be used by other modules; it may not designed to be invoked directly. See GSWiki:Lua/Helper modules for a full list and more information.

Module	Function	Type	Use
DPLlua	ask( ... )	tables	ask takes a series of tables each containing the settings for a DPL query; it will return the same number of result tables as input tables. All formatting settings are stripped from the config. If the config does not contains include, the result will be a simple list of page names. { <pagename#1>, <pagename#2>, <pagename#3>, } A query with an include of the form include = '{template#1}:1:2:param1:param2, {template#2}:3:param1, %0' will give a result like { ['include'] = { ['template#1'] = { [1] = val#1, [2] = val#2, ['param1'] = val#3, ['param2'] = val#4, }, ['template#2'] = { [3] = val#5, ['param1'] = val#6, }, ['%0'] = val#7 }, ['title'] = <pagename> } You can also do include = '{some template}' which will include all parameters of that template in their unexpanded form (templates are not expanded but some content in parser tags is placed in strip markers). If a template appears multiple times on the same page then val#1 of the above example will be be a table like {val#1 of template 1, val#1 of template 2, ...}, etc. If the config value count is larger than 500 it will automatically generate multiple DPL queries with offsets and their outputs will be combined in the returned result. The output contains a time field so you don't need to use %DPLTIME%. If the DPL throws an error it will be available in the error field of the output. Differences with normal DPL: All formatting options are ignored Using include = '{template}' will include all the arguments of that template instead of expanding the template The parameter count can go higher than 500 When the value of a parameter is a table it will be expanded into multiple lines. E.g. doing notcategory = {val#1, val#2} will expand into |notcategory = val#1 |notcategory = val#2 Note, if you include a whole template (e.g. include = '{some template}'), content inside strip markers (not nowiki) can't be cleaned up inside lua so pipe characters (|) will be replaced with § characters and the { and } characters are replaced by ❴ (U+2774) and ❵ (U+2775). Use include = '{some template}, {some template}:1:2:3' instead for the problem parameters.