 | This is a documentation subpage for Template:WikiProject Ships. It contains usage information, categories and other content that is not part of the original template page. |
 | This template is used on approximately 84,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. |
Usage
The {{WikiProject Ships}} banner template should be added (not subst:'d) 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 help WikiProject Ships evaluate the quality of articles. Note that the template accepts Y or y in addition to yes for boolean parameters; likewise N and n are treated as aliases of the value no. The full syntax is:
{{WikiProject Ships|class=
<!-- B-Class-1. It is suitably referenced, and all major points have appropriate inline citations. -->|b1=
<!-- B-Class-2. It reasonably covers the topic, and does not contain obvious omissions or inaccuracies. -->|b2=
<!-- B-Class-3. It has a defined structure, including a lead section and one or more sections of content. -->|b3=
<!-- B-Class-4. It is free from major grammatical errors. -->|b4=
<!-- B-Class-5. It contains appropriate supporting materials, such as an infobox, images, or diagrams. -->|b5=
|needs-infobox=
|listas=
|category=
}}
A more compact version with the most commonly used parameters is:
{{WikiProject Ships|class=|b1=|b2=|b3=|b4=|b5=}}
Parameters
Please review the WikiProject Ships assessment process.
- class – an evaluation of the article's quality; see the quality scale for more details. If an article has an existing quality rating by WikiProject Military history, you may copy that assessment, if you agree. (WikiProject Ships and WikiProject Military history each recognize the quality ratings assigned by the other.) Before copying the quality rating from WikiProjects other than WikiProject Military history, consider how they assess their articles. If you are not sure of the quality rating, you may leave it blank. Templates, categories, and files, along with pages in the Project, User, and Portal namespaces are automatically assessed by the template.
- needs-infobox – will display a notice on the article talk page if the article either has no infobox or has an outdated or subst:'d one. (See Infobox ship begin for the current infobox and usage information.) Valid values are:
- yes – if the article is missing an appropriate infobox
- new – if it has an old or subst:'d infobox that need to be replaced with the current one
- no – if it has the appropriate infobox
- 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 Wreck of the Edmund Fitzgerald, use
|listas=Edmund Fitzgerald, Wreck of theso that the talk page will show up in the E's and not the W'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.
It is not required if another WikiProject template on the same page has its own|listas=set, since it not only affects categories used by the banner in which it is set, but it also affects the sortkey of all other banners and templates. - category – set
|category=noif, and only if, a banner is being used for demonstration or testing purposes, to prevent unnecessary or undesirable categorization. Otherwise, omit this parameter.
B-Class checklist
This is applicable only for articles rated as "Start-Class", "C-Class", or "B-Class", and must be completed prior to assigning either a "C-Class" or "B-Class" rating—see the project's B-Class FAQ for more details):
|b1=yes if the article meets B-Class criterion #1: is suitably referenced, and all major points have appropriate inline citations; no if it does not.|b2=yes if the article meets B-Class criterion #2: reasonably covers the topic, and does not contain major omissions or inaccuracies; no if it does not.|b3=yes if the article meets B-Class criterion #3: has a defined structure, including a lead section and one or more sections of content; no if it does not.|b4=yes if the article meets B-Class criterion #4: is free from major grammatical errors; no if it does not.|b5=yes if the article meets B-Class criterion #5: contains appropriate supporting materials, such as an infobox, images, or diagrams; no if it does not.
At least one of the above criteria must be satisfied prior to an assessment of "Start-Class". Criteria Nos. 3–5 are required to be completed prior to the assignment of a "C-Class" assessment, and all five are required prior to the assignment of "B-Class".
B-Class parameter aliases
- The parameters
|B-Class-1=,|B-1=,|B1=and|b-1=are recognized as aliases for|b1=. If more than one of these are present, there may be unexpected results. - The parameters
|B-Class-2=,|B-2=,|B2=and|b-2=are recognized as aliases for|b2=. If more than one of these are present, there may be unexpected results. - The parameters
|B-Class-3=,|B-3=,|B3=and|b-3=are recognized as aliases for|b3=. If more than one of these are present, there may be unexpected results. - The parameters
|B-Class-4=,|B-4=,|B4=and|b-4=are recognized as aliases for|b4=. If more than one of these are present, there may be unexpected results. - The parameters
|B-Class-5=,|B-5=,|B5=and|b-5=are recognized as aliases for|b5=. If more than one of these are present, there may be unexpected results.
Removed parameters
|importance=– Importance ratings were disabled by the project in September 2009.
Multiple projects
If there are three or more project banners for an article, use {{WikiProject banner shell}} to encapsulate all the project banners as seen below. Also, if the article is considered a biography of a living person, add the |living=yes parameter before |1=.
{{WikiProject banner shell|1=
{{WikiProject Military history|class=|Maritime=yes}}
{{WikiProject Ships|class=|b1=|b2=|b3=|b4=|b5=}}
{{WikiProject Shipwrecks|class=|importance=}}
}}
TemplateData
|
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.
TemplateData for WikiProject Ships Includes the page in WikiProject Ships
| ||||||||||||||||||||||||||||||||||||||||||||||||||