Template:Vessel/doc

Jump to navigation Jump to search

Usage[edit source]

Syntax[edit source]

The base syntax of the template is:

{{vessel| hull_number | date | parameter1 | parameter2 }}

  • hull_number
    • class
  • date
    • class
  • parameter1
  • parameter2

Parameter options[edit source]

The following list are valid options to place in the parameter1 and/or parameter2 positions within the template string:

All-link[edit source]
  • all-link
displays
Both[edit source]
  • both
displays
  • both-all-link
displays
  • both-full-link
displays
  • both-link
displays
Class[edit source]
  • class
displays the ship classification code  (examples: CA, CH, FR )
  • class-link
displays the ship classification code as above; the link going to the article on the ship's class  (example: CH )
Classification[edit source]
  • classification
displays the ship classification code as above; the link going to the article on the ship's vessel classification (e.g. Cruiser, Heavy Cruise, Frigate)  (example: CH )
Classname[edit source]
  • classname
displays
Full[edit source]
  • full
displays
  • full-all-link
displays
  • full-link
displays
Fullname[edit source]
  • fullname
displays
Fullnumber[edit source]
  • fullnumber
displays
Link[edit source]
  • link
displays
Name[edit source]
  • name
displays
  • name-all-link
displays
  • name-full-link
displays
  • name-link
displays
Namelink[edit source]
  • namelink
Parameter1
When used as in the parameter1 position renders the vessel's name as a link to the article on the specific vessel for the specific target date.
This parameter can be used by itself in the parameter1 position or in combination with class, class-link or classification in parameter2 position.
Example: {{vessel|1701|May 5, 2261|namelink}} renders as  →  Enterprise
Example (class): {{vessel|1701|May 5, 2261|namelink|class}} renders as  →  Enterprise CH
Example (class-link): {{vessel|1701|May 5, 2261|namelink|class-link}} renders as  →  Enterprise CH
Example (classification): {{vessel|1701|May 5, 2261|namelink|classification}} renders as  →  Enterprise CH
Parameter2
This parameter can also be used in the parameter2 position in combination with class, class-link or classification in parameter1 position.
Example (class): {{vessel|1701|May 5, 2261|class|namelink}} renders as  →  CH Enterprise
Example (class-link): {{vessel|1701|May 5, 2261|class-link|namelink}} renders as  →  CH Enterprise
Example (classification): {{vessel|1701|May 5, 2261|classification|namelink}} renders as  →  CH Enterprise
Number[edit source]
  • number
When used as in the parameter2 position renders the registry registry number and variant suffix (if applicable) for the vessel's hull number on the given target date.
Note: this parameter only with in the parameter2 position and must be used only in conjunction with the name parameter in the parameter1 position.
Example: {{vessel|1701|December 10, 2291|name|number}} renders as  →  Enterprise 1701-A
  • number-all-link
This the similar to "number" described above, but can be used in conjunction with either the fullname or name parameter in the parameter1 position.
When used with fullname it renders the vessel registry number as separate link from that of the vessel's name. The link points to the article on the registry number for this vessel.
Example (fullname): {{vessel-test|1701|Dec 10, 2291|fullname|number-all-link}} renders as  →  USS Enterprise (NCC-1701-A)
When used with name it renders the vessel registry number as separate link from those of the vessel's full name or the registry number prefix, which have their own links. The link points to the article on the registry number for this vessel.
Example (name): {{vessel-test|1701|Dec 10, 2291|name|number-all-link}} renders as  →  Enterprise 1701-A
  • number-full-link
This the similar to two parameter options described above and can be used in conjunction with either the fullname or name parameter in the parameter1 position.
When used with fullname it renders the vessel registry number including the number prefix and variant (if applicable) as a link which points to the specific vessel's article.
Example (fullname): {{vessel-test|1701|Dec 10, 2291|fullname|number-full-link}} renders as  →  USS Enterprise (NCC 1701-A)
When used with name it adds the vessel registry number to the vessel's name link. The link points to the article on the specific vessel as defined by the hull number and target date.
Example (name): {{vessel-test|1701|Dec 10, 2291|name|number-full-link}} renders as  →  Enterprise 1701-A
  • number-link
This the same as number-full-link described above and can be used in conjunction with either the fullname or name parameter in the parameter1 position.
When used with fullname it renders the vessel registry number and variant (if applicable) excluding the number prefix as a link which points to the specific vessel's article.
Example (fullname): {{vessel-test|1701|Dec 10, 2291|fullname|number-link}} renders as  →  USS Enterprise (NCC-1701-A)
When used with name it adds the vessel registry number and variant (if applicable) after the vessel's name. The link points to the specific vessel's article.
Example (name): {{vessel-test|1701|Dec 10, 2291|name|number-link}} renders as  →  Enterprise 1701-A
Prefix[edit source]
  • prefix
When used as in the parameter2 position renders the registry prefix for the vessel's hull number as highlighted here: USS Intrepid. For most starfleet vessels, this is the "USS" prefix, which appears before the vessel's name. Some vessels may display "SS" or other prefixes which are not as common. On non-Federation vessels, like Klingon vessels, typically this will display "IKS" instead.
Note: this parameter can only be used with name in the parameter1 position.
Example: {{vessel|1701|December 10, 2291|name|prefix}} renders as  →  USS Enterprise
  • prefix-all-link
This the same as above, but it renders the vessel name, and the vessel's prefix as separate links. The link for the vessel's name will point to the article for all vessels with the shared main registry number. The prefix link points to the article on the registry prefix for this vessel.
Note: this parameter can only be used with name in the parameter1 position.
Example: {{vessel-test|1701|Dec 10, 2261|name|prefix-all-link}} renders as  →  USS Enterprise
  • prefix-full-link
This functions that same as both the previous parameters listed above, but it renders both the vessel name and the vessel's suffix as single link to the article for that specific hull number variant.
Note: this parameter can only be used with name in the parameter1 position.
Example: {{vessel|1701|Dec 10, 2261|name|prefix-full-link}} renders as  →  USS Enterprise
  • prefix-link
This the same as the previous "prefix" parameters listed above, but it only renders the vessel's prefix as link. The link points to the article on the registry prefix for this vessel on the target date.
Note: this parameter can only be used with name in the parameter1 position.
Example: {{vessel|1701|Dec 10, 2261|name|prefix-link}} renders as  →  USS Enterprise
Suffix[edit source]
  • suffix
When used as in the parameter2 position returns a registry number variant (if present) for the vessel highlighted here: Enterprise 1701-A
Note: this parameter can only be used with name in the parameter1 position.
Example: {{vessel|1701|Dec 7, 2291|name| suffix}} renders as  →  Enterprise-A
  • suffix-all-link
This the same as above, but it renders the vessel name, and the vessel's suffix as separate links. The link for the vessel's name will point to the article for all vessels with the shared main registry number. The variant link points to the article for the specific hull number variant for the given target date.
Note: this parameter can only be used with name in the parameter1 position.
Example: {{vessel|1701|December 10, 2291|name|suffix-all-link}} renders as  →  Enterprise-A
  • suffix-full-link
This functions that same as both the previous parameters listed above, but it renders both the vessel name and the vessel's suffix as single link to the article for that specific hull number variant.
Note: this parameter can only be used with name in the parameter1 position.
Example: {{vessel|1701|December 10, 2291|name|suffix-full-link}} renders as  →  Enterprise-A
  • suffix-link
This the same as the previous "suffix" parameters listed above, but it only renders the vessel's suffix as link. The link points to the article for that specific hull number variant.
Note: this parameter can only be used with name in the parameter1 position.
Example: {{vessel|1701|December 10, 2291|name|suffix-link}} renders as  →  Enterprise-A

See also[edit source]

Support templates