Template:Routelist row/sandbox

This is the template sandbox page for Template:Routelist row (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

This template uses Lua:

Module:Routelist row (sandbox)

This template creates a row in a standard U.S. highway list. Use it in conjunction with {{routelist top}} and {{routelist bottom}} to create a table of highway routes.

Usage

{{routelist row
|state=
|type=
|route=
|dab=
|length_mi=
|length_km=
|length_ref=
|terminus_a=
|terminus_b=
|beltway=
|local=
|established=
|established_ref=
|circa_established=
|decommissioned=
|decommissioned_ref=
|circa_decommissioned=
|notes=
|noshield=
}}

state: the postal abbreviation for the state this route lies in
type: the type prefix for the highway (e.g. US, SH, CR). All types that are accepted by {{jct}} for the selected state are accepted by this template.
route: the route number of the highway.
dab: disambiguation, if needed.
length_mi: the length of the highway in miles. Must contain a number value (passing a string will result in an error). Converts the given length to kilometers and fills in the "Length (km)" column.^[1]
length_km: the length of the highway in kilometers. Must contain a number value (no strings). Converts the given length to miles and fills in the "Length (mi)" column.^[1]
length_ref: reference for the length value.
terminus_a: west or south terminus.
terminus_b: north or east terminus.
beltway: if present, overrides terminus_a and terminus_b, displaying its argument in a single cell that spans both columns.
local: any local names the highway has. Usually restricted to lists of county-level scope (i.e. lists of highways by county, county routes, etc.). Any list which includes this column must call this template with {{routelist row|local|(parameters...) for each instance of the template in order to generate the column, or the local parameter will be ignored.
established: date that the highway designation was established. Must be a date value (passing a value that does not validate as a date will result in an error). Only the year will be displayed in the "Formed" column, though exact dates will be used for sortkey purposes. Inserting "proposed" here colors the row yellow and displays "—" in the "Removed" column. If omitted, "—" will be displayed in the "Formed" column.
decommissioned: takes either "yes" or the date that the highway designation was removed from service. Only the year will be displayed in the "Removed" column, though exact dates will be used for sortkey purposes. Past dates color the row gray. If omitted, "current" will be displayed in the Removed column (unless established=proposed). Inserting "yes" here colors the row gray and displays "—" in the "Removed" column.
established_ref, decommissioned_ref: reference for the established and decommissioned values.
circa_established, circa_decommissioned: if "yes", the corresponding column will be marked as an approximate (circa) date.
notes: content to be displayed in the "Notes" column. If omitted, no cell will be produced. If passed the value "none", a blank cell will be produced.
noshield: set to anything to disable the shield

Template data

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Routelist row in articles based on its TemplateData.

TemplateData for Routelist row

This template creates a row in a standard U.S. highway list.

Template parameters[Edit template data]
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
State	`state`	The postal abbreviation of the state the route is located in Example OK	String	required
Highway type	`type`	The type of the highway, as defined in the Module:Road data/strings family of modules. Example SH	String	required
Route number	`route`	The number of the route Example 21	String	suggested
Disambiguation	`dab`	Any necessary disambiguation (city, etc.) Example Tulsa	String	optional
Length (miles)	`length_mi`	The length of the route in miles. Example 22.3	Number	optional
Length (kilometers)	`length_km`	The length of the route in kilometers. Example 42.1	Number	optional
Length reference	`length_ref`	Reference for the length value.	Unknown	suggested
Starting terminus	`terminus_a`	The western or southern terminus of the route.	String	suggested
Finishing terminus	`terminus_b`	The eastern or northern terminus of the route.	String	suggested
Beltway	`beltway`	Substitute for terminus arguments.	String	optional

Usage notes

^ ^a ^b Only one of length_mi and length_km are required; the template will automatically calculate the missing value. If neither value is provided, "—" will be displayed in both columns.

The above documentation is transcluded from Template:Routelist row/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.

[length-1] Only one of length_mi and length_km are required; the template will automatically calculate the missing value. If neither value is provided, "—" will be displayed in both columns.

[1]