Module:Track gauge/autodocument/doc

This is a documentation subpage for Module:Track gauge/autodocument.
It may contain usage information, categories and other content that is not part of the original module page.

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

Gauges

{{RailGauge/document gauge}}, using documentGauge

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

{{RailGauge/gaugesize from title}}
{{RailGauge/preload-categorypage-railgauge-mentionings}}
{{RailGauge/categorypage mentionings header}}
{{RailGauge/talk useful links}} -- talk page support

#invoke functions

checkData
documentGauge
catContent
catMentions
createCatMentions
documentGaugeSizeFromTitle
catSortFromTitle
debugReturnArgs

Parameters

|1= alias
|1= (datafile to check)
|n=all (list)
|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 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: ["contentcat"] = "5 ft 3 in gauge railways". This way, these category pages are not checked for existence (existence is assumed blindly).

Gauges

RailGauge documentation templates

#invoke functions

Parameters

Parser limits (expensive functions)

See also