![]() | This is a documentation subpage for Template:US-railway-routemap. It may contain usage information, categories and other content that is not part of the original template page. |
This template should be added to all Route Diagram Templates of United States railways, unless a more-specific category or template is appropriate.
It will automatically include the diagram in Category:Templates for railway lines of the United States.
Adding an optional parameter will include the railway name as a link, for example,
((US-railway-routemap|Atchison, Topeka and Santa Fe Railway))
will change the first line of the template to:
The optional named parameter |type=
will change “a United States railway” to “a United States alternate text”. For example,
((US-railway-routemap|type=light rail line))
will change the first line of the template to:
and,
((US-railway-routemap|BMT Broadway Line|type=subway))
will change the first line of the template to:
The optional named parameter |display=
will replace the text of the article link. If display
is set to either I
or i
the article link will automatically be italicized. This is useful for named train services. For example,
((US-railway-routemap|Heartland Flyer|display=''Heartland Flyer''|cat=AM))
and((US-railway-routemap|Heartland Flyer|display=i|cat=AM))
will both change the first line of the template to:
The optional named parameter |the=
anything will omit the word “the” before the linked page. For example,
((US-railway-routemap|the=x|Washington Union Station|cat=STN))
will change the first line of the template to:
The optional named parameter |place=
will change “a United States railway” to “a(n) alternate text railway”. For example,
((US-railway-routemap|place=[[Atlanta]]))
will change the first line of the template to:
and,
((US-railway-routemap|Metra Electric District|place=Chicago|type=[[commuter line]]))
will change the first line of the template to:
By default the template will be included in Category:Templates for railway lines of the United States. However, adding the optional named parameter |cat=
provides a shortcut for other categories, and changes the default type description, as shown in this table:
Note that this parameter is not case sensitive: i.e. |cat=NO
produces the same result as |cat=no
.
The optional named parameter |name=
or |catidx=
will change the category sorting name for the page. The default is the page name, but since some route diagrams start with the system name, this is a simple way to change the sort key to the line or route name.