Module:Road data/doc: Difference between revisions
Content deleted Content added
BrandonXLF (talk | contribs) →String modules: Link to /doc |
BrandonXLF (talk | contribs) Exclude testcases |
||
| Line 9: | Line 9: | ||
Submodules of Module:Road data are used to display the road data stored in the modules listed at [[#Data modules]]. |
Submodules of Module:Road data are used to display the road data stored in the modules listed at [[#Data modules]]. |
||
{{Clickable button|Special:Search/-intitle:"/doc" -intitle:"/sandbox" -intitle:"/styles.css" -intitle:"/strings/" -intitle:"/banners/" -intitle:"/masks/" prefix:Module:Road data/|View submodules}} |
{{Clickable button|Special:Search/-intitle:"/doc" -intitle:"/sandbox" -intitle:"/testcases" -intitle:"/styles.css" -intitle:"/strings/" -intitle:"/banners/" -intitle:"/masks/" prefix:Module:Road data/|View submodules}} |
||
== Data modules == |
== Data modules == |
||
| Line 16: | Line 16: | ||
String modules are used to store type data for use with several road templates, including {{tl|jct}} and {{tl|routelist row}}. |
String modules are used to store type data for use with several road templates, including {{tl|jct}} and {{tl|routelist row}}. |
||
{{Clickable button|Special:Search/-intitle:"/doc" -intitle:"/sandbox" -intitle:"/styles.css" prefix:Module:Road data/strings/|View string modules}} |
{{Clickable button|Special:Search/-intitle:"/doc" -intitle:"/sandbox" -intitle:"/testcases" -intitle:"/styles.css" prefix:Module:Road data/strings/|View string modules}} |
||
=== Banner modules === |
=== Banner modules === |
||
Banner modules store data about banners that should be shown. For example, [[Module:Road data/banners/USA]] defines the "TO" banner shown when {{tl|jct}} is used with a {{para|to}} parameter in the United States i.e. {{jct|state=NY|I|82|to1=y}}. |
Banner modules store data about banners that should be shown. For example, [[Module:Road data/banners/USA]] defines the "TO" banner shown when {{tl|jct}} is used with a {{para|to}} parameter in the United States i.e. {{jct|state=NY|I|82|to1=y}}. |
||
{{Clickable button|Special:Search/-intitle:"/doc" -intitle:"/sandbox" -intitle:"/styles.css" prefix:Module:Road data/banners/|View banner modules}} |
{{Clickable button|Special:Search/-intitle:"/doc" -intitle:"/sandbox" -intitle:"/testcases" -intitle:"/styles.css" prefix:Module:Road data/banners/|View banner modules}} |
||
=== Mask modules === |
=== Mask modules === |
||
Mask modules store masks that can be hooked into by [[#String modules]]. See [[Module:Road data/strings#Hooks]] and [[Module:Road data/parser/hooks#mask]]. |
Mask modules store masks that can be hooked into by [[#String modules]]. See [[Module:Road data/strings#Hooks]] and [[Module:Road data/parser/hooks#mask]]. |
||
{{Clickable button|Special:Search/-intitle:"/doc" -intitle:"/sandbox" -intitle:"/styles.css" prefix:Module:Road data/masks/|View mask modules}} |
{{Clickable button|Special:Search/-intitle:"/doc" -intitle:"/sandbox" -intitle:"/testcases" -intitle:"/styles.css" prefix:Module:Road data/masks/|View mask modules}} |
||
<includeonly>{{Sandbox other|| |
<includeonly>{{Sandbox other|| |
||
Revision as of 13:32, 16 August 2024
 | This Lua module is used on approximately 18,000 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them. |
Usage
{{#invoke:Road data|function_name}}
Submodules
Submodules of Module:Road data are used to display the road data stored in the modules listed at #Data modules.
Data modules
String modules
String modules are used to store type data for use with several road templates, including {{jct}} and {{routelist row}}.
Banner modules
Banner modules store data about banners that should be shown. For example, Module:Road data/banners/USA defines the "TO" banner shown when {{jct}} is used with a |to= parameter in the United States i.e. 
To I-82.
Mask modules
Mask modules store masks that can be hooked into by #String modules. See Module:Road data/strings#Hooks and Module:Road data/parser/hooks#mask.