Template:WikiProject Ships/doc
{{Template shortcut|WPSHIPS}}
{{Documentation subpage}}
{{High-use|80994}}
Usage
The {{Template link general|WikiProject Ships|bold=yes|plaincode=yes}} 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 {{Var|Y}} or {{Var|y}} in addition to {{Var|yes}} for boolean parameters; likewise {{Var|N}} and {{Var|n}} are treated as aliases of the value {{Var|no}}. The full syntax is:
{{WikiProject Ships|class=
|needs-infobox=
|listas=
|category=
}}
A more compact version with the most commonly used parameters is:
{{WikiProject Ships|class=}}
= 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:
- {{Var|yes}} – if the article is missing an appropriate infobox
- {{Var|new}} – if it has an old or subst:'d infobox that need to be replaced with the current one
- {{Var|no}} – if it has the appropriate infobox
{{WPBannerDoc|listas|first=Wreck of the|last=Edmund Fitzgerald}}
{{WPBannerDoc|category}}
= Multiple projects =
If there are multiple project banners for an article, use {{Template link general|WikiProject banner shell|brace=yes|bold=yes|plaincode=yes}} to encapsulate all the project banners as seen below. Also, if the article is considered a biography of a living person, add the {{Para|living|yes}} parameter before {{Para|1}}.
{{WikiProject Military history|class=|Maritime=yes}}
{{WikiProject Ships|class=}}
{{WikiProject Shipwrecks|class=|importance=}}
}}
TemplateData
{{Collapse top|TemplateData used by TemplateWizard, VisualEditor and other tools.}}
{{Format TemplateData|1=
"description": "Includes the page in WikiProject Ships",
"format": "inline",
"paramOrder": [
"class",
"needs-infobox",
"listas",
"category"
],
"params": {
"category": {
"label": "Category inclusion",
"type": "boolean",
"default": "yes",
"autovalue": "yes",
"description": "Set to no if this banner is being used for demonstration or testing purposes to prevent unnecessary or undesirable categorization, otherwise omit. Set to one of: ['yes', 'no']"
},
"listas": {
"label": "Sort as",
"type": "line",
"description": "The equivalent of the DEFAULTSORT sortkey, it allows the page to be listed in categories as though its title was this value and not its actual name",
"example": "Edmund Fitzgerald, The Wreck of"
},
"class": {
"label": "Quality assessment class",
"example": "Stub",
"type": "line",
"suggested": true,
"description": "An evaluation of the article's quality; see the WikiProject Ships quality scale for more details. Set to one of: ['FA', 'FL', 'A', 'GA', 'B', 'C', 'Start', 'Stub', 'List', 'Category', 'Disambig', 'File', 'Portal', Project', 'Redirect', 'Template', 'NA']",
"suggestedvalues": [
"FA",
"FL",
"A",
"GA",
"B",
"C",
"Start",
"Stub",
"List",
"Category",
"Disambig",
"File",
"Portal",
"Project",
"Redirect",
"Template",
"NA"
]
},
"needs-infobox": {
"label": "Infobox needed",
"type": "line",
"suggestedvalues": [
"yes",
"new",
"no"
],
"default": "no",
"autovalue": "yes",
"description": "Used if the article either has no infobox or has an outdated or subst:'d one, omitted if neither apply. Set to one of: ['yes', 'new', 'no']"
}
}
}}}
{{Collapse bottom}}
{{Sandbox other||
}}