View source for Template:CCGS/doc

{{Documentation subpage}}

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 <code><nowiki>[[CCGS Sir John Franklin (2017)|CCGS ''Sir John Franklin'' (2017)]]</nowiki></code>. This template halves that to <code><nowiki>{{CCGS|Sir John Franklin|2017}}</nowiki></code>.

== Usage ==

=== Formal usage ===
* <code><nowiki>{{CCGS|Ship Name}}</nowiki></code>
* <code><nowiki>{{CCGS|Ship Name|ID}}</nowiki></code>, where ID can be the [[hull number]], launch year, or [[pennant number]], as specified in the article title.

=== Examples ===
{|class=wikitable width=100%
!Template usage!!Equivalent wikicode!!Final result
|-
|<kbd><nowiki>{{CCGS|Simcoe|1909}}</nowiki></kbd>
|<kbd><nowiki>[[CCGS Simcoe (1909)|CCGS ''Simcoe'' (1909)]]</nowiki></kbd>
|{{CCGS|Simcoe|1909}}
|-
|<kbd><nowiki>{{CCGS|Sir John Franklin|2017}}</nowiki></kbd> 
|<kbd><nowiki>[[CCGS Sir John Franklin (2017)|CCGS ''Sir John Franklin'' (2017)]]</nowiki></kbd> 
|{{CCGS|Sir John Franklin|2017}}
|-
|<kbd><nowiki>{{CCGS|Sir John Franklin}}</nowiki></kbd>
|<kbd><nowiki>[[CCGS Sir John Franklin|CCGS ''Sir John Franklin'']]</nowiki></kbd>
|{{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:

{|class=wikitable width=100%
!Value!!Parameter(s)<br />displayed!!Example!!Equivalent wikicode!!Final result
|-
!None
|style="text-align:center;"|all
|<kbd><nowiki>{{CCGS|Simcoe|1909}}</nowiki></kbd>
|<kbd><nowiki>[[CCGS Simcoe (1909)|CCGS ''Simcoe'' (1909)]]</nowiki></kbd>
|{{CCGS|Simcoe|1909}}
|-
!1
|style="text-align:center;"|3rd
|<kbd><nowiki>{{CCGS|Simcoe|1909|1}}</nowiki></kbd>
|<kbd><nowiki>[[CCGS Simcoe (1909)|1909]]</nowiki></kbd>
|{{CCGS|Simcoe|1909|1}}
|-
!2
|style="text-align:center;"|2nd
|<kbd><nowiki>{{CCGS|Simcoe|1909|2}}</nowiki></kbd>
|<kbd><nowiki>[[CCGS Simcoe (1909)|''Simcoe'']]</nowiki></kbd>
|{{CCGS|Simcoe|1909|2}}
|-
!3
|style="text-align:center;"|2nd, 3rd
|<kbd><nowiki>{{CCGS|Simcoe|1909|3}}</nowiki></kbd>
|<kbd><nowiki>[[CCGS Simcoe (1909)|''Simcoe'' (1909)]]</nowiki></kbd>
|{{CCGS|Simcoe|1909|3}}
|-
!4
|style="text-align:center;"|invalid result
|<kbd><nowiki>{{CCGS|Simcoe|1909|4}}</nowiki></kbd>
|<kbd><nowiki>[[CCGS Simcoe (1909)|Invalid Optional Parameter]]</nowiki></kbd>
|{{CCGS|Simcoe|1909|4}}
|-
!5
|style="text-align:center;"|1st, 3rd
|<kbd><nowiki>{{CCGS|Simcoe|1909|5}}</nowiki></kbd>
|<kbd><nowiki>[[CCGS Simcoe (1909)|CCGS (1909)]]</nowiki></kbd>  
|{{CCGS|Simcoe|1909|5}}
|-
!6
|style="text-align:center;"|1st, 2nd
|<kbd><nowiki>{{CCGS|Simcoe|1909|6}}</nowiki></kbd>
|<kbd><nowiki>[[CCGS Simcoe (1909)|CCGS ''Simcoe'']]</nowiki></kbd>
|{{CCGS|Simcoe|1909|6}}
|-
|
|style="text-align:center;"|2nd<br />{{small|(no 3rd)}}
|<kbd><nowiki>{{CCGS|Simcoe|3=2}}</nowiki></kbd><br />''Alternate usage'':<br /><kbd><nowiki>{{CCGS|Simcoe||2}}</nowiki></kbd>
|<kbd><nowiki>[[CCGS Simcoe|''Simcoe'']]</nowiki></kbd>
|{{CCGS|Simcoe||2}}
|}

''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. 

Using an optional display control parameter value of 6 yields the same results as using {{tl|warship}} to create the same link and text, but saving, coincidentally, 6 characters while editing.

<kbd><nowiki>{{CCGS|Simcoe|1909|6}}</nowiki></kbd> yields the same results as <kbd><nowiki>{{warship|CCGS|Simcoe|1909}}</nowiki></kbd>

== TemplateData ==
{{Template:Ship/doc/fixed prefix: TemplateData}}

== See also ==
{{WPSHIPS shortcut templates}}

<includeonly>{{sandbox other||
[[Category:Ship prefix templates|CCGS]]
}}</includeonly>