Module:Road data/parser/doc

This is a documentation subpage for Module:Road data/parser.
It may contain usage information, categories and other content that is not part of the original module page.

This module is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing.

This Lua module is used on approximately 42,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.

This module exports the parser function, which can be used from within Lua to fetch an entry from the appropriate string module.

See the comment for the p.parser function for the function's parameters. The only parameter worth explaining (beyond the code comments) is args, known to have the following nullable keys:

state / province (string): Used by getModuleName.
country (string): Used by getModuleName.
ignoreifexists (boolean): Elide the existence check even if it is asked for by the data entry (1 expensive function call). If disabled, just assume that it exists. Otherwise there is a fallback process.

Special:PrefixIndex/Module:Road data is potentially helpful.