Template:WikiProject U.S. Roads/doc

This is a documentation subpage for Template:WikiProject U.S. Roads.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 34,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:WikiProject banner (sandbox)

This is the WikiProject banner used by WikiProject U.S. Roads to keep track of articles within its scope.

Basic usage

Place this on the talk page of relevant articles: {{WikiProject U.S. Roads |state= |type= |class= |importance= |needs-jctint= |needs-map= }}

Full usage

It is usual to remove any unused parameters from the template call. <syntaxhighlight lang="wikitext">

U.S. Roads NA‑class High‑importance

Lua error in mw.title.lua at line 346: bad argument #2 to 'title.new' (unrecognized namespace name 'Portal').This template is within the scope of the U.S. Roads WikiProject, an attempt to build a comprehensive and detailed guide to state highways and other major roads in the United States. If you would like to participate, you can edit the article attached to this page, or visit the project page, where you can join the project and/or contribute to the discussion.U.S. Roadswikipedia:WikiProject U.S. RoadsTemplate:WikiProject U.S. RoadsU.S. road transport articles

NA This article has been rated as NA-class on the project's quality scale.

High This article has been rated as High-importance on the project's importance scale.

This article has been marked as needing immediate attention.

This article's map has been marked as needing attention. Please work with the Maps department to correct it.

This article does not have a map. Please work with the Maps department to create and add a file for this article.

This article has a map. If the file has an error, please work with the Maps department to correct it.

This template does not require a map.

This article may or may not have a map. Please check, then add |needs-map= to this template accordingly.

This article's junction list has been marked as needing attention.

This article should have its junction list converted to the {{Jctint}} series of templates.

This article does not have a junction list.

This article has a bulleted junction list.

This template does not require a junction list.

This article has a junction list compliant with the Manual of Style on road junction lists.

This article may or may not contain a junction list. Please check, then add |needs-jctint= to this template accordingly.

This article does not have a KML file. Please work with the Maps department to create and add a file for this article.

This template has a KML file. If the file has an error, please work with the Maps department to correct it.

This template does not require a KML file.

This template has a KML file. If the file has an error, please work with the Maps department to correct it.

This article does not have a KML file. Please work with the Maps department to create and add a file for this article.

Article issues:
/
	This article has been automatically rated by a bot or other tool because one or more other projects use this class. Please ensure the assessment is correct before removing the `\|auto=` parameter.
	Follow this link and fill out the details in the edit window to initiate an A-Class Review
	This article has been flagged for assessment.
	An editor has suggested that this article should be merged with [[{{{merge}}}]].
	This article has been marked as needing an infobox.
	This article is missing at least one route marker. Please work with the Shields department to create and add shields to this article.
	An editor has requested that an image or photograph be added to this article.

This WikiProject banner template uses Module:WikiProject banner, a meta-template for easily creating and maintaining project banners. Please report any errors or feature requests to Module talk:WikiProject banner. Information or warnings about the template are below:

This project has opted out of project-independent quality assessments and is using a custom class mask.
The 7 notes in this template will automatically collapse if more than 5 of them are activated. To change this setting, set or update the |COLLAPSED= parameter.
This project banner specifies a non-existent assessment page Wikipedia:WikiProject U.S. Roads/Assessment. Please update or remove the |ASSESSMENT_LINK= parameter to fix this problem.
This banner template includes a link to Portal:U.S. roads, but this portal does not exist - you may have defined |PORTAL= incorrectly or the portal may have been deleted.
Automatic parameter checking is enabled. Create the tracking category to track invalid parameters.

Some of the assessment categories required for U.S. Roads do not currently exist, and should to be created to avoid redlinks appearing on talk pages. Alternatively, you may need to set or update the |ASSESSMENT_CAT= parameter in this template.

The following categories are required for the banner to work correctly. Please either create these categories or adjust the banner so that they are not required.

</syntaxhighlight>

Parameters

state – valid values are the two-letter postal abbreviation for each state. Use |state=AL for Alabama. Use |state1= |state2= |...|state20= for multiple states.

The parameter |state1= is recognised as an alias for |state=. If both |state= and |state1= are present, |state1= is ignored.
type – valid values are I, US, SH, CR, Trail, Junction, or US66. Use |type1= |type2= |...|type5= for multiple types.

The parameter |type1= is recognised as an alias for |type=. If both |type= and |type1= are present, |type1= is ignored.
class – valid values are listed in the custom class mask. See the project's quality scale for details. Setting an explicit value of NA is rarely necessary; for this, either leave |class= blank or omit the parameter.
importance – valid values are: top, high, mid, low, na (case-insensitive). See the project's importance scale for details. Setting an explicit value of NA is rarely necessary; for this, either leave |importance= blank or omit the parameter.

Optional parameters

listas – This parameter, which is the equivalent of the DEFAULTSORT sortkey that should be placed on all biographical articles, is a sortkey for the article talk page (e.g. for Dwight D. Eisenhower, use |listas=Eisenhower, Dwight D. so that the talk page will show up in the E's and not the D's of the various assessment and administrative categories). This is important because it is one source used by those who set DEFAULTSORT on the article; consider also setting the DEFAULTSORT for the article when setting this parameter. For more information about this, please see Wikipedia:Categorization of people § Ordering names in a category.
If the article is using {{WikiProject banner shell}} then it is preferable to add |listas= to that template instead of a project banner template. Putting the parameter on more than one template is not required.

The parameter |sort= is recognised as an alias for |listas=. If both |listas= and |sort= are present, |sort= is ignored.
auto – This parameter is for the use of bots and indicates that the article has been automatically rated:
- |auto=length – based on the length of the article
- |auto=inherit – because one or more other projects use this class
- |auto=yes (or |auto=stub), in conjunction with |class=stub – as Stub-Class because it uses a stub template
  - Use of the above values (or value combinations) with this parameter populates Category:Automatically assessed U.S. road transport articles.
category – set |category=no if, and only if, a banner is being used for demonstration or testing purposes, to prevent unnecessary or undesirable categorization. Otherwise, omit this parameter.

Notes and alerts

attention – set |attention=yes if the article needs immediate attention from experienced editors. Use only if another parameter does not cover the need for attention; this should be used sparingly. It is strongly encouraged to also add a section to the talk page explaining what needs attention.
- This parameter populates Category:U.S. road articles needing attention.
needs-infobox – set |needs-infobox=yes if the article needs an infobox. Remember that infoboxes are not suitable for all articles, and can overwhelm short articles.
- This parameter populates Category:U.S. road articles without infoboxes.
needs-map – set |needs-map= depending if the article has a map or not:

|needs-map=yes if the article has no map at all. Output: This article does not have a map. Please work with the Maps department to create and add a map to this article.

This value populates Category:U.S. Roads project articles needing maps.

|needs-map=no if the article has a map. Output: None.
|needs-map=NA if the article does not require a map. Output: This article does not require a map.
|needs-map= the default behavior. Output: This article may or may not have a map. Please check, then add |needs-map= to this template accordingly.

This value populates Category:U.S. Roads project articles without needs-map.

needs-jctint – set |needs-jctint= depending if the article has a properly-formatted junction list or not:

|needs-jctint=yes if the article has a hard-coded junction list. Output: This article's junction list should be converted to the {{jctint}} series of templates.

This value populates Category:U.S. Roads project articles with a hardcoded junction list

|needs-jctint=no if the article has a properly-formatted junction list. Output: None.
|needs-jctint=missing if the article is missing a junction list. Output: This article does not currently have a junction list.

This value populates Category:U.S. Roads project articles needing a junction list.

|needs-jctint=bulleted if the article has a bulleted junction list. Output: This article has a bulleted junction list.

This value populates Category:U.S. Roads project articles with a bulleted junction list.

|needs-jctint=NA if the article does not require a junction list. Output: This article does not require a junction list.
|needs-jctint= the default behavior. Output: This article may or may not contain a hardcoded junction list. Please check, then add |needs-jctint= to this template accordingly.

This value populates Category:U.S. Roads project articles without needs-jctint.

needs-kml – set |needs-kml=yes if the KML file would not be in the default location. This template automatically checks if the KML file is located at Template:Attached_KML/</nowiki>WikiProject U.S. Roads/doc</nowiki>:

|needs-kml=yes if the article has a KML file. Output: This article does not have a KML file. Please work with the Maps department to create and add a file for this article.
|needs-kml=no if the article has a KML file. Output: None.
|needs-kml=NA if the article does not require a KML file. Output: This article does not require a KML file.
|needs-kml= the default behavior. Output: This article does not have a KML file. Please work with the Maps department to create and add a file for this article.

This parameter populates Category:U.S. road articles needing KML.

needs-shield – set |needs-shield=yes if the article is missing at least one route marker.
- This parameter populates Category:U.S. Roads project articles needing shields.

The parameter |needs-shields= is recognised as an alias for |needs-shield=. If both |needs-shield= and |needs-shields= are present, |needs-shields= is ignored.
ACR – set |ACR=yes and follow the directions to initiate an A-Class Review at WikiProject Highways/Assessment/A-Class Review
photo – set |photo=<Location> to populate Category:Wikipedia requested photographs in Location.
attention-rjl – set |attention-rjl=yes if the article's junction list needs immediate attention from experienced editors.
- This parameter populates Category:U.S. road articles with a junction list needing attention.
attention-mtf – set |attention-mtf=yes if the article's map needs immediate attention from experienced editors.
- This parameter populates Category:U.S. road articles with a map needing attention.
reassess – set |reassess=yes to nominate the article for reassessment
- This parameter populates Category:U.S. Roads project articles needing reassessment.

Article recognition parameters

PUSRD-SA – set |PUSRD-SA=<Month Year> to indicate the article is a current or former selected article of the U.S. Roads Portal.
- This parameter populates Category:U.S. Roads portal selected articles.
PUSRD-SA – set |PUSRD-SA=<Month Year> to indicate the article is a current or former selected picture of the U.S. Roads Portal.
- This parameter populates Category:U.S. Roads portal selected pictures.
PUSRD-DYK – set |PUSRD-DYK=<Month Year> to indicate a fact from the article was featured in the U.S. Roads Portal's Did you know? section.
CASH-SA – set |CASH-SA=<Month Year> to indicate the article is a current or former selected article of the California task force.
- This parameter populates Category:WikiProject U.S. Roads subproject selected articles.
MISH-SA – set |MISH-SA=<Month Year> to indicate the article is a current or former selected article of the Michigan Highways Portal.
- This parameter populates Category:WikiProject U.S. Roads subproject selected articles.
MISH-SP – set |MISH-SP=<Month Year> to indicate the article is a current or former selected article of the Michigan Highways Portal.
- This parameter populates Category:WikiProject U.S. Roads subproject selected articles.
NJSCR-SA – set |NJSCR-SA=<Month Year> to indicate the article is a current or former selected article of the New Jersey task force.
- This parameter populates Category:WikiProject U.S. Roads subproject selected articles.
PNYRD-SA – set |PNYRD-SA=<Month Year> to indicate the article was a selected article of the New York Roads Portal.
- This parameter populates Category:WikiProject U.S. Roads subproject selected articles.
PARD-SA – set |PARD-SA=<Month Year> to indicate the article is a current or former selected article of the Pennsylvania task force.
- This parameter populates Category:WikiProject U.S. Roads subproject selected articles.

Adding or removing topics

If the need arises to add or remove topics, the appropriate entries must be added or removed to these templates:

Template:WikiProject U.S. Roads/shield – controls the topic image
Template:WikiProject U.S. Roads/link – points to the correct U.S. Roads WikiProject subpage
Template:WikiProject U.S. Roads/names – controls the topic name displayed in the template
Template:WikiProject U.S. Roads/collapsed – controls the topic name displayed when the project is nested within {{WPBS}}
Template:WikiProject U.S. Roads/overcat – points to the correct topic category (i.e. the U.S. road transport in Category:U.S. road transport articles)
Template:WikiProject U.S. Roads/categories – nearly identical to overcat, but New York is different
Template:WikiProject U.S. Roads/cat – points to the correct |needs-kml= category
Template:WikiProject U.S. Roads/map – points to the correct |needs-map= category

No description.

Template parameters
Parameter		Description	Type	Status
state	`state` `state1`	no description	Unknown	suggested
type	`type` `type1`	no description	Unknown	suggested
needs-map	`needs-map`	no description	Unknown	suggested
needs-jctint	`needs-jctint`	no description	Unknown	suggested