Template:WikiProject Trains/doc
This is a documentation subpage for Template:WikiProject Trains. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 147,000 pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
This template uses Lua: |
Usage
[edit]The {{WikiProject Trains}} project banner template should be added (not subst:ed) to the talk page of every article within the scope of the project. While the template does not require any additional parameters, it has a number of optional ones that add various extra features to the banner. To avoid needlessly cluttering up talk pages, it is usually appropriate to remove any unused parameters from the template. The full syntax is as follows:
{{WikiProject Trains
| class =
| importance =
| listas =
| portaldykdate =
| portalSAweek =
| portalSIweek =
| needs-infobox =
| unref =
| mapneeded =
| mapdetails =
| imageneeded =
| imagedetails =
| refimprove =
| stations =
| subway =
| subway-importance =
| NYPT =
| NYPT-importance =
| Japan =
| UK =
| UK-importance =
| UKTrams =
| UKTrams-importance =
| Scotland =
| Scotland-importance =
| Underground =
| LUL-importance =
| NZR =
| NZR-importance =
| WashingtonMetro =
| WashingtonMetro-importance =
| India =
| India-importance =
| streetcars =
| streetcars-importance =
| SovMetro =
| Thomas =
| Thomas-importance =
| DE =
| DE-importance =
| maint =
| bycountry =
| images =
| locos =
| maps =
| monorail =
| operations =
| passenger =
| timelines =
| portal =
| model =
}}
It is important that the capitalisation shown above be used. For example, using |Streetcars=yes
by mistake for |streetcars=yes
will fail to place the article within WikiProject Streetcars; similarly, using |underground=yes
instead of |Underground=yes
will not add the article to WikiProject London Transport.
Assessment
[edit]Parameters
[edit]- General
- 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. - 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 Richard Trevithick, use
|listas=Trevithick, Richard
so that the talk page will show up in the T's and not the R'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. - 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:Rail transport articles needing infoboxes.
- unref – set
|unref=yes
if the article lacks references- This parameter populates Category:Unreferenced rail transport articles.
- mapneeded – set
|mapneeded=yes
if the article needs a map.- mapdetails (appears only if mapneeded is set to yes) - Additional details to specify the kind of map information that is needed.
- This parameter populates Category:Rail transport articles needing maps.
- imageneeded – set
|imageneeded=yes
The article needs an image (other than a map). When any one or more of the following five are true:- when
|DE=yes
is set, adds articles to Category:Wikipedia requested images of rail transport in Germany; - when
|locos=yes
is set, adds articles to Category:Wikipedia requested images of locomotives; - when
|NYCS=yes
or|NYPT=yes
is set, adds articles to Category:Wikipedia requested images of New York City public transportation; - when
|stations=yes
is set, adds articles to Category:Wikipedia requested images of train stations; - when
|UK=yes
is set, adds articles to Category:Wikipedia requested images of rail transport in the United Kingdom.
- imagedetails (appears only if imageneeded is set to yes) - Additional details to describe the image that is requested.
- This parameter populates Category:Wikipedia requested images of rail transport.
- when
- refimprove – set
|refimprove=yes
if the article has some references, but does not have enough, or lacks sufficient footnotes to bibliographical citations. Adds articles to Category:New York City public transportation articles needing additional references if|NYPT=yes
, and to Category:Scotland Transport articles needing additional references if|Scotland=yes
.- This parameter populates Category:Rail transport articles needing additional references.
- 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.
- Portal appearance
- portaldykdate - the date when a fact from the associated article appeared in the "Did you know" section of Portal:Trains.
- portalSAweek - the week number and year when the article appeared in the "Selected article" section
- portalSIweek - the week number and year when the image appeared in the "Selected picture" section
- Task forces
Subproject maintenance parameters (set them to "yes" to include them; note that these are not mutually exclusive):
- stations – set
|stations=yes
if the article is supported by WikiProject Stations.- This parameter populates Category:WikiProject Stations articles, and the relevant subcategory of Category:Stations articles by quality based upon the
|class=
parameter.
- This parameter populates Category:WikiProject Stations articles, and the relevant subcategory of Category:Stations articles by quality based upon the
- subway – set
|subway=yes
if the article is supported by WikiProject Rapid transit.- This parameter populates Category:WikiProject Rapid transit articles, and the relevant subcategory of Category:Rapid transit articles by quality based upon the
|class=
parameter. - subway-importance (only used if
|subway=yes
is set; uses the same values as|importance=
) – Importance rating within WikiProject Rapid transit- This importance rating populates the relevant subcategory of Category:Rapid transit articles by importance.
- This parameter populates Category:WikiProject Rapid transit articles, and the relevant subcategory of Category:Rapid transit articles by quality based upon the
- NYPT – set
|NYPT=yes
if the article is supported by WikiProject New York City Public Transportation.- This parameter populates Category:All New York City public transportation articles, and the relevant subcategory of Category:New York City public transportation articles by quality based upon the
|class=
parameter. - NYPT-importance (only used if
|NYPT=yes
is set; uses the same values as|importance=
) – Importance rating within WikiProject New York City Public Transportation- This importance rating populates the relevant subcategory of Category:New York City public transportation articles by importance.
- This parameter populates Category:All New York City public transportation articles, and the relevant subcategory of Category:New York City public transportation articles by quality based upon the
- Japan – set
|Japan=yes
if the article is supported by WikiProject Trains in Japan.- This parameter populates the relevant subcategory of Category:WikiProject Trains in Japan articles by quality based upon the
|class=
parameter.
- This parameter populates the relevant subcategory of Category:WikiProject Trains in Japan articles by quality based upon the
- UK – set
|UK=yes
if the article is supported by WikiProject UK Railways.- This parameter populates the relevant subcategory of Category:UK Railways articles by quality based upon the
|class=
parameter. - UK-importance (only used if
|UK=yes
is set; uses the same values as|importance=
) – Importance rating within WikiProject UK Railways- This importance rating populates the relevant subcategory of Category:UK Railways articles by importance.
- This parameter populates the relevant subcategory of Category:UK Railways articles by quality based upon the
- UKTrams – set
|UKTrams=yes
if the article is supported by WikiProject UK Trams.- This parameter populates the relevant subcategory of Category:UK Trams articles by quality based upon the
|class=
parameter. - UKTrams-importance (only used if
|UKTrams=yes
is set; uses the same values as|importance=
) – Importance rating within WikiProject UK Trams- This importance rating populates the relevant subcategory of Category:UK Trams articles by importance.
- This parameter populates the relevant subcategory of Category:UK Trams articles by quality based upon the
- Scotland – set
|Scotland=yes
if the article is supported by WikiProject Transport in Scotland.- This parameter populates the relevant subcategory of Category:Scotland Transport articles by quality based upon the
|class=
parameter. - Scotland-importance (only used if
|Scotland=yes
is set; uses the same values as|importance=
) – Importance rating within WikiProject Transport in Scotland- This importance rating populates the relevant subcategory of Category:Scotland Transport articles by importance.
- This parameter populates the relevant subcategory of Category:Scotland Transport articles by quality based upon the
- Underground – set
|Underground=yes
if the article is supported by WikiProject London Transport.- This parameter populates Category:WikiProject London Transport articles, and the relevant subcategory of Category:London Transport articles by quality based upon the
|class=
parameter. - LUL-importance (only used if
|Underground=yes
is set; uses the same values as|importance=
) – Importance rating within WikiProject London Transport- This importance rating populates the relevant subcategory of Category:London Transport articles by importance.
- This parameter populates Category:WikiProject London Transport articles, and the relevant subcategory of Category:London Transport articles by quality based upon the
- NZR – set
|NZR=yes
if the article is supported by WikiProject New Zealand Railways.- This parameter populates the relevant subcategory of Category:New Zealand Railways articles by quality based upon the
|class=
parameter. - NZR-importance (only used if
|NZR=yes
is set; uses the same values as|importance=
) – Importance rating within WikiProject New Zealand Railways- This importance rating populates the relevant subcategory of Category:New Zealand Railways articles by importance.
- This parameter populates the relevant subcategory of Category:New Zealand Railways articles by quality based upon the
- WashingtonMetro – set
|WashingtonMetro=yes
if the article is supported by WikiProject Washington Metro.- This parameter populates Category:WikiProject Washington Metro articles, and the relevant subcategory of Category:Washington Metro articles by quality based upon the
|class=
parameter. - WashingtonMetro-importance (only used if
|WashingtonMetro=yes
is set; uses the same values as|importance=
) – Importance rating within WikiProject Washington Metro- This importance rating populates the relevant subcategory of Category:Washington Metro articles by importance.
- This parameter populates Category:WikiProject Washington Metro articles, and the relevant subcategory of Category:Washington Metro articles by quality based upon the
- India – set
|India=yes
if the article is supported by WikiProject Indian railways.- This parameter populates Category:WikiProject Indian railways articles, and the relevant subcategory of Category:Indian railways articles by quality based upon the
|class=
parameter. - India-importance (only used if
|India=yes
is set; uses the same values as|importance=
) – Importance rating within WikiProject Indian railways- This importance rating populates the relevant subcategory of Category:Indian railways articles by importance.
- This parameter populates Category:WikiProject Indian railways articles, and the relevant subcategory of Category:Indian railways articles by quality based upon the
- streetcars – set
|streetcars=yes
if the article is supported by WikiProject Streetcars.- This parameter populates Category:WikiProject Streetcars articles, and the relevant subcategory of Category:Streetcars articles by quality based upon the
|class=
parameter. - streetcars-importance (only used if
|streetcars=yes
is set; uses the same values as|importance=
) – Importance rating within WikiProject Streetcars- This importance rating populates the relevant subcategory of Category:Streetcars articles by importance.
- This parameter populates Category:WikiProject Streetcars articles, and the relevant subcategory of Category:Streetcars articles by quality based upon the
- SovMetro – set
|SovMetro=yes
if the article is supported by WikiProject Metros of the former Soviet Union.- This parameter populates the relevant subcategory of Category:Metros of the former Soviet Union articles by quality based upon the
|class=
parameter.
- This parameter populates the relevant subcategory of Category:Metros of the former Soviet Union articles by quality based upon the
- Thomas – set
|Thomas=yes
if the article is supported by WikiProject Thomas.- This parameter populates the relevant subcategory of Category:Thomas articles by quality based upon the
|class=
parameter. - Thomas-importance (only used if
|Thomas=yes
is set; uses the same values as|importance=
) – Importance rating within WikiProject Thomas- This importance rating populates the relevant subcategory of Category:Thomas articles by importance.
- This parameter populates the relevant subcategory of Category:Thomas articles by quality based upon the
- DE – set
|DE=yes
if the article is supported by the Rail transport in Germany task force.- This parameter populates Category:Rail transport in Germany task force articles, and the relevant subcategory of Category:Rail transport in Germany articles by quality based upon the
|class=
parameter. - DE-importance (only used if
|DE=yes
is set; uses the same values as|importance=
) – Importance rating within the Rail transport in Germany task force- This importance rating populates the relevant subcategory of Category:Rail transport in Germany articles by importance.
- This parameter populates Category:Rail transport in Germany task force articles, and the relevant subcategory of Category:Rail transport in Germany articles by quality based upon the
- Task force maintenance
- maint – set
|maint=yes
if the article is supported by the Article maintenance task force.- This parameter populates Category:Article maintenance task force articles.
- bycountry – set
|bycountry=yes
if the article is supported by the By country series task force.- This parameter populates Category:Rail transport by country series task force articles.
- images – set
|images=yes
if the article is supported by the Images task force. - locos – set
|locos=yes
if the article is supported by the Locomotives task force.- This parameter populates Category:Locomotives task force articles.
- maps – set
|maps=yes
if the article is supported by the Maps task force.- This parameter populates Category:Trains project maps task force articles.
- monorail – set
|monorail=yes
if the article is supported by the Monorail task force.- This parameter populates Category:Monorail task force articles.
- operations – set
|operations=yes
if the article is supported by the Operations task force.- This parameter populates Category:Operations task force articles.
- passenger – set
|passenger=yes
if the article is supported by the Passenger trains task force.- This parameter populates Category:Passenger trains task force articles.
- timelines – set
|timelines=yes
if the article is supported by the Timelines task force.- This parameter populates Category:Rail transport timelines task force articles.
- portal – set
|portal=yes
if the article is supported by the Portal task force.- This parameter populates Category:Trains portal task force articles.
- model – set
|model=yes
if the article is supported by the Rail transport modelling task force.- This parameter populates Category:Rail transport modelling task force articles.
Aliases
[edit]- The parameter
|imagedetails=
is recognised as an alias for|Imagedetails=
. If both|Imagedetails=
and|imagedetails=
are present,|imagedetails=
is ignored.
- The parameter
|needs-infobox=
is recognised as an alias for|infoboxneeded=
. If both|infoboxneeded=
and|needs-infobox=
are present,|needs-infobox=
is ignored.
- The parameter
|Locos=
is recognised as an alias for|locos=
. If both|locos=
and|Locos=
are present,|Locos=
is ignored.
- The parameter
|Underground=
is recognised as an alias for|LT=
. If both|LT=
and|Underground=
are present,|Underground=
is ignored.
- The parameter
|LUL-importance=
is recognised as an alias for|LT-importance=
. If both|LT-importance=
and|LUL-importance=
are present,|LUL-importance=
is ignored.
- The parameter
|mapdetails=
is recognised as an alias for|Mapdetails=
. If both|Mapdetails=
and|mapdetails=
are present,|mapdetails=
is ignored.
- The parameters
|map-needed=
,|map-requested=
,|map=
and|Mapneeded=
are recognised as aliases for|needs-map=
. If more than one is present, the order of precedence, from highest to lowest, is:|needs-map=
→|map-needed=
→|map-requested=
→|map=
→|Mapneeded=
→|mapneeded=
. Parameters with lower precedence are ignored.
- The parameters
|needs-image=
,|image-needed=
,|photo-needed=
and|image-requested=
are recognised as aliases for|needs-photo=
. If more than one is present, the order of precedence, from highest to lowest, is:|needs-photo=
→|needs-image=
→|image-needed=
→|photo-needed=
→|image-requested=
→|Imageneeded=
. Parameters with lower precedence are ignored.
- The parameter
|NYCS=
is recognised as an alias for|NYPT=
. If both|NYPT=
and|NYCS=
are present,|NYCS=
is ignored.
- The parameter
|NYCS-importance=
is recognised as an alias for|NYPT-importance=
. If both|NYPT-importance=
and|NYCS-importance=
are present,|NYCS-importance=
is ignored.
- The parameter
|Passenger=
is recognised as an alias for|passenger=
. If both|passenger=
and|Passenger=
are present,|Passenger=
is ignored.
- The parameter
|Stations=
is recognised as an alias for|stations=
. If both|stations=
and|Stations=
are present,|Stations=
is ignored.
- The parameter
|Subway=
is recognised as an alias for|subway=
. If both|subway=
and|Subway=
are present,|Subway=
is ignored.
- The parameter
|subway-importance=
is recognised as an alias for|Subway-importance=
. If both|Subway-importance=
and|subway-importance=
are present,|subway-importance=
is ignored.
- The parameter
|Timelines=
is recognised as an alias for|timelines=
. If both|timelines=
and|Timelines=
are present,|Timelines=
is ignored.
- The parameter
|uk=
is recognised as an alias for|UK=
. If both|UK=
and|uk=
are present,|uk=
is ignored.
- The parameter
|uk-importance=
is recognised as an alias for|UK-importance=
. If both|UK-importance=
and|uk-importance=
are present,|uk-importance=
is ignored.
Tracking category
[edit]