Difference between revisions of "Module:Track gauge/doc"
Jump to navigation
Jump to search
blackwiki>Mr. Stradivarius (create) |
blackwiki>Mr. Stradivarius (add info about the checkData function) |
||
| Line 1: | Line 1: | ||
| − | This module implements the {{tl|RailGauge}} template. Please see the template page for documentation. The gauge information is stored at [[Module:RailGauge/data]]; | + | This module implements the {{tl|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. 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>}} | ||
| + | |||
| + | 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]]. | ||
Revision as of 18:39, 31 July 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. 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.