User:J Clear/NSS/doc

From Wikipedia, the free encyclopedia


Contents

[edit] Usage

This is a typing short cut for linking to US Navy ship articles named in the format "User:J Clear/NSS Deep Six (AWOL-99)". Since Ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[User:J Clear/NSS Deep Six (AWOL-99)|User:J Clear/NSS ''Deep Six'' (AWOL-99)]]. This template halves that to {{User:J Clear/NSS|Deep Six|AWOL-99}}.

[edit] Formal Usage

  • {{User:J Clear/NSS|Ship Name}}
  • {{User:J Clear/NSS|Ship Name|ID}}, where ID can be the hull number, launch year, or pennant number, as specified in the article title.

[edit] Examples

Template usage Equivalent wikicode Final result
{{User:J Clear/NSS|None Such|INF-1}} [[User:J Clear/NSS {{{lng_ex1_name}}} (INF-1)|User:J Clear/NSS ''None Such'' (INF-1)]] NSS None Such (INF-1)
{{User:J Clear/NSS|No Such|2010}}</nowiki> [[User:J Clear/NSS No Such (2010)|User:J Clear/NSS ''No Such'' (2010)]] NSS No Such (2010)
{{User:J Clear/NSS|Constitution}} [[User:J Clear/NSS Constitution|User:J Clear/NSS ''Constitution'']] NSS Constitution

Last example could be used to link to ship index (disambiguation) page, such as User:J Clear/NSS Nonexistant

[edit] Optional display control parameter

There is an optional third parameter that controls which pieces of text are displayed in the article. It's value is treated as a binary number and will display the corresponding "bits". So setting the 4's bit will display User:J Clear/NSS, 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 {{User:J Clear/NSS|None Such|INF-1}} [[User:J Clear/NSS None Such (INF-1) |User:J Clear/NSS ''None Such'' (INF-1)]] NSS None Such (INF-1)
1 3rd {{User:J Clear/NSS|None Such|INF-1|1}} [[User:J Clear/NSS None Such (INF-1) |INF-1]] INF-1
2 2nd {{User:J Clear/NSS|None Such|INF-1|2}} [[User:J Clear/NSS None Such (INF-1) |''None Such'']] None Such
3 2nd, 3rd {{User:J Clear/NSS|None Such|INF-1|3}} [[User:J Clear/NSS None Such (INF-1) |''None Such'' (INF-1)]] None Such (INF-1)
4 invalid result {{User:J Clear/NSS|None Such|INF-1|4}} [[User:J Clear/NSS None Such (INF-1) |Invalid Optional Parameter]] Invalid Optional Parameter
5 1st, 3rd {{User:J Clear/NSS|None Such|INF-1|5}} [[User:J Clear/NSS None Such (INF-1) |User:J Clear/NSS (INF-1)]] NSS (INF-1)
6 1st, 2nd {{User:J Clear/NSS|None Such|INF-1|6}} [[User:J Clear/NSS None Such (INF-1) |User:J Clear/NSS ''None Such'']] NSS None Such
2nd
(no 3rd)
{{User:J Clear/NSS|Constitution|3=2}}
Alternate usage: {{User:J Clear/NSS|Constitution||2}}
[[User:J Clear/NSS Constitution |''Constitution'']] Constitution

N.B.: Be careful with the third parameter if not using the second parameter. In the Constitution 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.

 {{User:J Clear/NSS|None Such|INF-1|6}} yields the same results as {{warship|User:J Clear/NSS|None Such|INF-1}}== 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