قالب:USCGC/doc

Usage

This is a typing short cut for linking to U.S. Coast Guard cutter articles named in the format "USCGC Cutter (WDMG-99)". Since Ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[USCGC Cutter (WDMG-99)|USCGC ''Cutter'' (WDMG-99)]]. This template halves that to {{USCGC|Cutter|WDMG-99}}.

Formal Usage

  • {{USCGC|Ship Name}}
  • {{USCGC|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
{{USCGC|Healy|WAGB-20}} [[USCGC Healy (WAGB-20)|USCGC ''Healy'' (WAGB-20)]] USCGC Healy (WAGB-20)
{{USCGC|Seneca|1908}} [[USCGC Seneca (1908)|USCGC ''Seneca'' (1908)]] USCGC Seneca (1908)
{{USCGC|Matagorda}} [[USCGC Matagorda|USCGC ''Matagorda'']] USCGC Matagorda

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 USCGC, 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 {{USCGC|Healy|WAGB-20}} [[USCGC Healy (WAGB-20)|USCGC ''Healy'' (WAGB-20)]] USCGC Healy (WAGB-20)
1 3rd {{USCGC|Healy|WAGB-20|1}} [[USCGC Healy (WAGB-20)|WAGB-20]] WAGB-20
2 2nd {{USCGC|Healy|WAGB-20|2}} [[USCGC Healy (WAGB-20)|''Healy'']] Healy
3 2nd, 3rd {{USCGC|Healy|WAGB-20|3}} [[USCGC Healy (WAGB-20)|''Healy'' (WAGB-20)]] Healy (WAGB-20)
4 invalid result {{USCGC|Healy|WAGB-20|4}} [[USCGC Healy (WAGB-20)|Invalid Optional Parameter]] Invalid Optional Parameter
5 1st, 3rd {{USCGC|Healy|WAGB-20|5}} [[USCGC Healy (WAGB-20)|USCGC (WAGB-20)]] USCGC (WAGB-20)
6 1st, 2nd {{USCGC|Healy|WAGB-20|6}} [[USCGC Healy (WAGB-20)|USCGC ''Healy'']] USCGC Healy
2nd
(no 3rd) 		{{USCGC| Matagorda|3=2}} Alternate usage: {{USCGC|Matagorda||2}} [[USCGC Matagorda|''Matagorda'']] Matagorda

N.B.: Be careful with the third parameter if not using the second parameter. In the Matagorda 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 {{warship}} to create the same link and text, but saving, coincidentally, 6 characters while editing. 

{{USCGC|Healy|WAGB-20|6}} yields the same results as {{warship|USCGC|Healy|WAGB-20}}

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 USCGC

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


تمّ الاسترجاع من "https://www.marefa.org/w/index.php?title=قالب:USCGC/doc&oldid=1968554"