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

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.

Gauges

RailGauge documentation templates

#invoke functions

Parameters

Parser limits (expensive functions)

See also