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

From blackwiki
Jump to navigation Jump to search
blackwiki>DePiep
(test the page)
blackwiki>DePiep
m (data is checked on the data page)
Line 2: Line 2:
  
 
=== Gauge data ===
 
=== Gauge data ===
The gauge information is stored at [[Module:RailGauge/data]]; to add new gauges, see the instructions there. This module includes a function that checks the data page for errors. It is used with the following code:
+
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:
  
 
{{pre|<nowiki>{{#invoke:RailGauge|checkData|</nowiki>''name of data page''<nowiki>}}</nowiki>}}
 
{{pre|<nowiki>{{#invoke:RailGauge|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:RailGauge/data]].
;Test current data page:
 
:{{#invoke:RailGauge|checkData}}
 

Revision as of 15:16, 3 August 2013

This module implements the {{RailGauge}} template. Please see the template page for documentation on how to use the main RailGauge 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:RailGauge|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:RailGauge/data.