Template:USR/doc
From TrainSpottingWorld, for Rail fans everywhere
| This template employs some extremely complicated or esoteric features of template syntax. Please do not attempt to alter it unless you are certain that you understand the setup and are prepared to repair/revert any consequent collateral damage if the results are unexpected. Any experiments should be conducted in the template sandbox or your user space. |
Usage
This template should be added (not substed) onto talk pages for articles related to rail transport in the United States.
Parameters to this template are as follows:
{{USR
| nested =
| small =
| class =
| importance =
| unref =
| imageneeded =
| imagedetails =
| mapneeded =
| mapdetails =
| portaldykdate =
| portalSAmonth =
| portalSImonth =
| locos =
}}
Template display formatting parameters:
- nested - display an abbreviated version listing only the project name and a [show] link to display the uncompressed banner.
- small - display a small version of the complete banner.
Assessment parameters:
- class - the article quality rating, or if it is not an article, the page type; valid values are (case insensitive)
FA
FA - Featured article; adds articles to Category:FA-Class US railways articles A A - A-Class; adds articles to Category:A-Class US railways articles B B - B-Class; adds articles to Category:B-Class US railways articles Start Start - Start-Class; adds articles to Category:Start-Class US railways articles Stub Stub - Stub-Class; adds articles to Category:Stub-Class US railways articles FL
FL - Featured list; adds articles to Category:FL-Class US railways articles List List - List-Class; adds articles to Category:List-Class US railways articles ??? (blank) - default for existing articles; adds articles to Category:Unassessed-Class US railways articles Needed Needed or (blank) - default for unwritten articles; adds articles to Category:Needed-Class US railways articles Portal Portal - portal subpage; adds pages to Category:Portal-Class US railways pages Disambig Dab or Disambig - disambiguation page; adds pages to Category:Dab-Class US railways pages Redirect Redir or Redirect - redirect page; adds pages to Category:Redirect-Class US railways pages Template Tpl or Template - template; adds pages to Category:Template-Class US railways pages Category Cat or Category - category; adds pages to Category:Cat-Class US railways pages Image Img or Image - image; adds pages to Category:Image-Class US railways pages NA NA - the page is not an article or one of the predefined types of pages listed above; adds pages to Category:NA-Class US railways pages
- importance - the importance of the subject with respect to rail transport in the United States; valid values are (case insensitive):
Top Top - the article describes one of the core topics about rail transport in the United States and is considered required reading for understanding it; adds articles to Category:Top-importance US railways articles High High - the article describes a vital part of rail transport in the United States, but it is not considered required reading to understanding it; adds articles to Category:High-importance US railways articles Mid Mid - the article describes a topic that has a strong but not vital role in rail transport in the United States; adds articles to Category:Mid-importance US railways articles Low Low - the article describes a topic that is not required for a broad understanding of rail transport in the United States; adds articles to Category:Low-importance US railways articles No No - the page does not describe a topic that is directly related to rail transport in the United States (templates, disambiguation and redirect pages will normally fall into this importance rating); adds pages to Category:No-importance US railways articles ??? (blank) - default for unknown importance pages; adds pages to Category:Unknown-importance US railways articles
Article open task parameters (set them to yes to include them; display is suppressed if nested=yes, but the categories are still used):
- unref - indicates that the article needs more and/or better referencing; adds articles to Category:US railways articles lacking sources
- imageneeded - indicates that an image is needed on the article; adds articles to Category:US railways articles lacking images
- imagedetails (only used if imageneeded is set to yes) - notes about the image that is needed
- mapneeded - indicates that a geographical map or route diagram is needed in the article; adds articles to Category:US railways articles lacking maps
- mapdetails (only used if mapneeded is set to yes) - notes about the map that is needed
Portal appearance parameters:
- portaldykdate - the date when a fact from the associated article appeared in the "Did you know" section of Portal:US Railways.
- portalSAmonth - the month name and year when the article appeared in the "Selected article" section.
- portalSImonth - the month name and year when the image appeared in the "Selected picture" section.
Task force parameters (set them to "yes" to activate them):
- locos - for articles within the scope of Workforce:US railways/Locomotives task force.
To avoid needlessly cluttering up talk pages, it is usually appropriate to remove any unused parameters from the template.
