قالب:CCGS/doc

This is a typing short cut for linking to Canadian Coast Guard ship articles named in the format "CCGS Sir John Franklin (2017)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[CCGS Sir John Franklin (2017)|CCGS ''Sir John Franklin'' (2017)]]. This template halves that to {{CCGS|Sir John Franklin|2017}}.

Usage

Formal usage

  • {{CCGS|Ship Name}}
  • {{CCGS|Ship Name|ID}}, where ID can be the hull number, launch year, or pennant number, as specified in the article title.

Examples

Template usage Equivalent wikicode Final result
{{CCGS|Simcoe|1909}} [[CCGS Simcoe (1909)|CCGS ''Simcoe'' (1909)]] CCGS Simcoe (1909)
{{CCGS|Sir John Franklin|2017}} [[CCGS Sir John Franklin (2017)|CCGS ''Sir John Franklin'' (2017)]] CCGS Sir John Franklin (2017)
{{CCGS|Sir John Franklin}} [[CCGS Sir John Franklin|CCGS ''Sir John Franklin'']] CCGS Sir John Franklin

Last example could be used to link to ship index (disambiguation) page

Optional display control parameter

There is an optional third parameter that controls which pieces of text are displayed in the article. Its value is treated as a binary number and will display the corresponding "bits". So setting the 4's bit will display CCGS, setting the 2's bit will display the ship name, and setting the 1's bit will display the ID. If binary math isn't your thing, refer to these examples:

Value Parameter(s)
displayed
Example Equivalent wikicode Final result
None all {{CCGS|Simcoe|1909}} [[CCGS Simcoe (1909)|CCGS ''Simcoe'' (1909)]] CCGS Simcoe (1909)
1 3rd {{CCGS|Simcoe|1909|1}} [[CCGS Simcoe (1909)|1909]] 1909
2 2nd {{CCGS|Simcoe|1909|2}} [[CCGS Simcoe (1909)|''Simcoe'']] Simcoe
3 2nd, 3rd {{CCGS|Simcoe|1909|3}} [[CCGS Simcoe (1909)|''Simcoe'' (1909)]] Simcoe (1909)
4 invalid result {{CCGS|Simcoe|1909|4}} Error: {{CCGS}} invalid control parameter: 4 (help)
5 1st, 3rd {{CCGS|Simcoe|1909|5}} [[CCGS Simcoe (1909)|CCGS (1909)]] CCGS 1909
6 1st, 2nd {{CCGS|Simcoe|1909|6}} [[CCGS Simcoe (1909)|CCGS ''Simcoe'']] CCGS Simcoe
2nd
(no 3rd)
{{CCGS|Simcoe|3=2}}
Alternate usage:
{{CCGS|Simcoe||2}}
[[CCGS Simcoe|''Simcoe'']] Simcoe

N.B.: Be careful with the third parameter if not using the second parameter. In the last Simcoe example above, the "|3=2" means set the third parameter to a value of two, while the alternate syntax shows using a pair of pipes, "||2", to position the value two in the third parameter position.

TemplateData

This section:  view • edit 
TemplateData
This is the بيانات القالب documentation for this template used by المحرر المرئي وأدوات أخرى.

See the monthly error report for this template.

TemplateData for CCGS

This template provides a wikilink to a ship's page, with label options

وسائط القالب

وسيطوصفنوعحالة
Name1

Ship's name

مثال
Bismarck, Belgrano
نصاختياري
ID2

Hull number, launch year, or pennant number

مثال
H75, 1975
نصاختياري
Format3

Formats the label (which name parts will show)

غيابي
blank
مثال
1, 2, 3, 5, 6
رقماختياري
unlink prefixup

up=yes puts prefix before (outside of) the wikilink

غيابي
no
مثال
up=yes
بوليانياختياري

See also

WP:SHIPS shortcut templates:

Class shortcuts
  • {{sclass}} – Shortcut for ship classes that are named for the lead ship
  • {{sclass2}} – Shortcut for ship classes that are named for a common theme
Ship prefix shortcuts
Dictionary of American Naval Fighting Ships (DANFS) templates