Difference between revisions of "Module:Track gauge/autodocument/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>DePiep
blackwiki>DePiep
Line 44: Line 44:
  
 
==Parser limits (expensive functions)==
 
==Parser limits (expensive functions)==
Module:RailGauge/autodocument uses ''expensive function'' calls (especially the <code>documentGauge</code> listing). The wiki parser only allows 500 such calls in one page. As of May 2014, this number is almost reached in (488 in [[Template:RailGauge/doc/input options/sandbox]]). For this, the number of entries in RailGauge/data plus RailGauge/extra is decisive. When, after adding new entries to /data or /extra, the number is reached, a "Script error" will show. This can be solved by: adding content category names to /extra (all) and /data, even if they have default name pattern: <code>["contentcat"] = "5 ft 3 in gauge railways"</code>. This way, these category pages are not checked for existence (existence is assumed blindly).
+
Module:RailGauge/autodocument uses ''expensive function'' calls (especially the <code>documentGauge</code> listing). The wiki parser only allows 500 such calls in one page. As of July 2014, this number is almost reached in (~475 in [[Template:RailGauge/doc/input options]]). When, after adding new entries to /data or /extra, the number is reached, a "Script error" will show.  
 +
 
 +
Best practice is to prevent this error: adding content category name to the /data, even if they have default name pattern or do not exist:
 +
:<syntaxhighlight lang="Lua">["contentcat"] = "5 ft 3 in gauge railways",</syntaxhighlight>
 +
:<syntaxhighlight lang="Lua">["contentcat"] = "",</syntaxhighlight>
 +
 
 +
This way, these category pages are not checked for existence.
  
 
==See also==
 
==See also==

Revision as of 15:41, 2 July 2014

This module has several options to document the RailGauge/data data page of {{RailGauge}}.

Gauges

Can list in complete tableform one, multiple or all gauges listed in the /data page. Gauges defined in both metric and imperial are grouped into one row.

Per gauge size a link to the category:Articles that mentions this gauge ... is added.

RailGauge documentation templates

#invoke functions

checkData
documentGauge
catContent
catMentions
createCatMentions
documentGaugeSizeFromTitle
catSortFromTitle

Parameters

|1= alias
|1= (datafile to check)
|n=all (list)
|displaynotfound=
|docto=
|docfrom=
|doctitle=
|docstate=
|docstats=
|docsortlabel=
|docreturnargs=

Parser limits (expensive functions)

Module:RailGauge/autodocument uses expensive function calls (especially the documentGauge listing). The wiki parser only allows 500 such calls in one page. As of July 2014, this number is almost reached in (~475 in Template:RailGauge/doc/input options). When, after adding new entries to /data or /extra, the number is reached, a "Script error" will show.

Best practice is to prevent this error: adding content category name to the /data, even if they have default name pattern or do not exist:

["contentcat"] = "5 ft 3 in gauge railways",
["contentcat"] = "",

This way, these category pages are not checked for existence.

See also