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

From blackwiki
Jump to navigation Jump to search
blackwiki>DePiep
blackwiki>DePiep
Line 1: Line 1:
This module implements the {{tl|Track gauge}} template. Please see the template page for documentation on how to use the main RailGauge function.
+
This module implements the {{tl|Track gauge}} template. Please see the template page for documentation on how to use the main TrackGauge function.
  
 
=== Gauge data ===
 
=== Gauge data ===
Line 6: Line 6:
 
This module includes a function that checks the data page for errors. It is used with the following code:
 
This module includes a function that checks the data page for errors. It is used with the following code:
  
{{pre|<nowiki>{{#invoke:RailGauge/autodocument|checkData|</nowiki>''name of data page''<nowiki>}}</nowiki>}}
+
{{pre|<nowiki>{{#invoke:Track gauge/autodocument|checkData|</nowiki>''name of data page''<nowiki>}}</nowiki>}}
  
The first positional parameter is the name of the data page that you want to be checked. If this is omitted, the module checks [[Module:RailGauge/data]].
+
The first positional parameter is the name of the data page that you want to be checked. If this is omitted, the module checks [[Module:Track gauge/data]].

Revision as of 15:40, 3 September 2014

This module implements the {{Track gauge}} template. Please see the template page for documentation on how to use the main TrackGauge function.

Gauge data

The gauge information is stored at Module:RailGauge/data; to add new gauges, see the instructions there.

Data checks

This module includes a function that checks the data page for errors. It is used with the following code:

{{#invoke:Track gauge/autodocument|checkData|name of data page}}

The first positional parameter is the name of the data page that you want to be checked. If this is omitted, the module checks Module:Track gauge/data.