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

From blackwiki
Jump to navigation Jump to search
blackwiki>DePiep
m (DePiep moved page Module:RailGauge/autodocument/doc to Module:Track gauge/autodocument/doc: follow template & parent module move (see Talk:Track gauge))
blackwiki>DePiep
Line 1: Line 1:
 
<!--{{module rating|<!-- Insert rating or delete if not needed. Values: "pre-alpha", "alpha", "beta", "release" or "protected". -xx->}}-->
 
<!--{{module rating|<!-- Insert rating or delete if not needed. Values: "pre-alpha", "alpha", "beta", "release" or "protected". -xx->}}-->
 
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
 
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
This module has several options to document the [[module:RailGauge/data|RailGauge/data]] data page of {{tl|Track gauge}}.
+
This module has several options to document the [[module:Track gauge/data|Track gauge/data]] data page of {{tl|Track gauge}}.
  
 
==Gauges==
 
==Gauges==
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 July 2014, this number is almost reached in (~475 in [[Template:Track gauge/doc/input options]]). When, after adding new entries to /data or /extra, the number is reached, a "Script error" will show.  
+
Module:Track gauge/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:Track gauge/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:  
 
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:  
Line 57: Line 57:
 
* [[:Category:Articles that mention a specific rail gauge]]
 
* [[:Category:Articles that mention a specific rail gauge]]
 
* {{tl|Track gauge}}
 
* {{tl|Track gauge}}
* [[module:RailGauge]]
+
* [[module:Track gauge]]
* [[module:RailGauge/data]]
+
* [[module:Track gauge/data]]
  
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
  
 
}}</includeonly>
 
}}</includeonly>

Revision as of 23:31, 3 September 2014

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

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.

Track gauge documentation templates

#invoke functions

checkData
documentGauge
catContent
catMentions
createCatMentions
documentGaugeSizeFromTitle
catSortFromTitle

Parameters

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

Parser limits (expensive functions)

Module:Track gauge/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:Track gauge/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",
 -- or
 ["contentcat"] = "",

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

See also