Module:LoadData/doc: Difference between revisions

Content deleted Content added

Inline

Revision as of 18:50, 28 April 2021

A more complex version of Module:Data with more options and the ability to select indexes with an inequality operator.

{{#invoke:LoadData|Module name|index1|2 lteq=index2 limit|...|}}

Zeroth parameter is the name of the data module to read, without Module:, e.g. Example/data
Next parameters, for an index N starting at one, are called |N= for the exact index you need, coerced to number if possible, |N lteq= to select the highest numerical index less than or equal to the argument, or |N gteq= for the opposite.
|template= is a printf-style string to interpolate the resulting value(s) into, e.g. <b>%s</b>.
|preprocess= is like |template= except that frame:preprocess is run on it; this makes e.g. template transclusions work.
|if nil= is the string to return if the result is nil. Default is nil, which comes out as the empty string.

@@ Line 7: / Line 7: @@
 <code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|''Module name''|index1|2 lteq=index2 limit|...|}}</code>
+* Zeroth parameter is the name of the data module to read, without ''Module:'', e.g. <code>Example/data</code>
+* Next parameters, for an index {{var|N}} starting at one, are called {{para|{{var|N}}}} for the exact index you need, coerced to number if possible, {{para|{{var|N}} lteq}} to select the highest numerical index less than or equal to the argument, or {{para|{{var|N}} gteq}} for the opposite.
+* {{para|template}} is a ''printf''-style string to interpolate the resulting value(s) into, e.g. <code><nowiki><b>%s</b></nowiki></code>.
+* {{para|preprocess}} is like {{para|template}} except that <code>frame:preprocess</code> is run on it; this makes e.g. template transclusions work.
+* {{para|if nil}} is the string to return if the result is nil. Default is nil, which comes out as the empty string.
 <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |