User:Haus/5/doc

This is a documentation subpage for User:Haus/5.
It may contain usage information, categories and other content that is not part of the original user template page.

This user page employs intricate features of template syntax.

You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages.
You can conduct experiments, and should test all major changes, in either , the general template sandbox, or your user space before changing anything here.

Project banner

The {{WPTRANSPORT}} 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. Note that task force parameters have two versions: a long form ("Fooish-task-force=") and a short form ("Fooish="), which are completely interchangeable. Note also that the template accepts permutations such as "Yes", "YeS", etc, "Y", "y", "1", "No", "NO", "nO", "N", "n" and "0" in addition to "yes" and "no". The full syntax is as follows:

Medium-length version

This version is useful for most articles below good-article on the quality scale.

{{WPTRANSPORT|class=|B1=|B2=|B3=|B4=|B5=|importance=}}

Full version

{{WPTRANSPORT
|small=
|class=
|importance=
|A-Class= 
|peer-review= 
|old-peer-review= 
|no-task-force=
<!-- B-Class 5-criteria checklist -->
| B1 <!-- Referencing and citations --> = y/n
| B2 <!-- Coverage and accuracy --> = y/n
| B3 <!-- Structure --> = y/n
| B4 <!-- Grammar and style --> = y/n
| B5 <!-- Supporting materials --> = y/n
<!-- Portals -->
|portal1-name=
|portal1-link=
|portal2-name=
|portal2-link=
|portal3-name=
|portal3-link=
|portal4-name=
|portal4-link=
|portal5-name=
|portal5-link=
<!-- Task forces (general topics) -->
|Maritime= 
}}

General parameters:

small – "yes" if the banner should be rendered in its miniature size; this should be used sparingly and only on crowded talk pages for the time being.
class – a rating of the article's quality; see the assessment department for more details.
A-Class – indicates the status of the article's A-Class review, if any; see the review department for more details.
peer-review – "yes" if the article is currently listed for peer review by the project; see the review department for more details.
old-peer-review – "yes" if the article was previously listed for peer review by the project; see the review department for more details.
no-task-force – "yes" if no existing task force includes the article in its scope.

B-Class checklist (available only for articles rated as "Start-Class" or "B-Class", and must be completed to allow a "B-Class" rating—see the assessment department for more details):

B-Class-1 (or B1) – "yes" if the article meets criterion #1 for B-Class status; "no" if it does not.
B-Class-2 (or B2) – "yes" if the article meets criterion #2 for B-Class status; "no" if it does not.
B-Class-3 (or B3) – "yes" if the article meets criterion #3 for B-Class status; "no" if it does not.
B-Class-4 (or B4) – "yes" if the article meets criterion #4 for B-Class status; "no" if it does not.
B-Class-5 (or B5) – "yes" if the article meets criterion #5 for B-Class status; "no" if it does not.

Portals:

portalX-name – if the article has been selected for use on a portal, the name of that portal. The name should be given without any formatting or namespace prefixes; thus, Portal:United States Merchant Marine is given as "|portal1-name=United States Merchant Marine". Up to five different portals may be specified, via the parameters portal1-name through portal5-name.
portalX-link – the portal subpage location where the article may be found on the corresponding portal. This should be given as a pure unlinked subpage name; thus, Portal:United States Merchant Marine/Selected article/1 is given as "|portal1-link=Selected article/1".

Task forces (general topics):

Maritime-task-force (or Maritime) – "yes" if the article is supported by the Maritime transport task force.

Note: To avoid needlessly cluttering up talk pages, it is usually appropriate to remove any unused parameters from the template.