Template:SMS/doc
 | This is a documentation subpage for Template:SMS. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before changing this template. |
Usage change
This is a typing short cut for linking to Imperial German Navy or Austro-Hungarian Navy ship articles named in the format "SMS Germania (1899)". Since Ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[SMS Germania (1899)|SMS ''Germania'' (1899)]]. This template halves that to {{SMS|Germania|1899}}.
Formal Usage change
{{SMS|Ship Name}}{{SMS|Ship Name|ID}}, where ID can be the hull number, launch year, or pennant number, as specified in the article title.
Examples change
| Template usage | Equivalent wikicode | Final result |
|---|---|---|
{{SMS|Novara|1912}}
|
[[SMS Novara (1912)|SMS ''Novara'' (1912)]]
|
SMS Novara (1912) |
{{SMS|Sankt Georg}}
|
[[SMS Sankt Georg|SMS ''Sankt Georg'']]
|
SMS Sankt Georg |
Last example could be used to link to a ship index (disambiguation) page
Optional display control parameter change
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 SMS, 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 | {{SMS|Novara|1912}}
|
[[SMS Novara (1912) |SMS ''Novara'' (1912)]]
|
SMS Novara (1912) |
| 1 | 3rd | {{SMS|Novara|1912|1}}
|
[[SMS Novara (1912) |1912]]
|
1912 |
| 2 | 2nd | {{SMS|Novara|1912|2}}
|
[[SMS Novara (1912) |''Novara'']]
|
Novara |
| 3 | 2nd, 3rd | {{SMS|Novara|1912|3}}
|
[[SMS Novara (1912) |''Novara'' (1912)]]
|
(1912) |
| 4 | invalid result | {{SMS|Novara|1912|4}}
|
[[SMS Novara (1912) |Invalid Optional Parameter]]
|
SMS Novara (1912) |
| 5 | 1st, 3rd | {{SMS|Novara|1912|5}}
|
[[SMS Novara (1912) |SMS (1912)]]
|
SMS 1912 |
| 6 | 1st, 2nd | {{SMS|Novara|1912|6}}
|
[[SMS Novara (1912) |SMS ''Novara'']]
|
SMS Novara |
| 2nd (no 3rd) |
{{SMS|Sankt Georg|3=2}} Alternate usage: {{SMS|Sankt Georg||2}}
|
[[SMS Sankt Georg |''Sankt Georg'']]
|
Sankt Georg |
N.B.: Be careful with the third parameter if not using the second parameter. In the Sankt Georg 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.
{{SMS|Novara|1912|6}}yields the same results as{{warship|SMS|Novara|1912}}
Optional submarine prefix parameter change
Submarines or U-boats in the German Imperial Navy and the Austro-Hungarian Navy were prefixed with SM rather than SMS. Using an optional sub parameter allows the proper link generation for U-boat articles. The sub parameter also works in conjunction with the optional display parameters listed above.
| Template usage | Equivalent wikicode | Final result |
|---|---|---|
{{SMS|U-90|sub=y}}
|
[[SM U-90|SM ''U-90'']]
|
SM U-90 |
{{SMS|U-4|Austria-Hungary|sub=y}}
|
[[SM U-4 (Austria-Hungary)|SM ''U-4'' (Austria-Hungary)]]
|
SM U-4 (Austria-Hungary) |
{{SMS|U-4|Austria-Hungary|6|sub=y}}
|
[[SM U-4 (Austria-Hungary)|SM ''U-4'']]
|
SM U-4 |
TemplataData section change
This is a typing short cut for linking to Imperial German Navy or Austro-Hungarian Navy (SMS) ship articles named in the format 'SMS Germania (1899)' (that is, the initial letters HMS, the ship's name, and its pennant number). Since ship names are italicized in article text and editors often don't want to include the pennant number, linking to them in the usual manner means typing everything twice, such as [[SMS Germania (1899)|SMS ''Germania'']]. This template halves that to {{SMS|Germania|1899|6}}. Note that this template cannot be used for ships which were not part of the SMS.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Ship Name | 1 | This parameter gives the name of this ship.
| String | required |
| ID | 2 | This parameter gives the ship's hull number, pennant number, year of construction, or any other identifying information that will allow the ship to be distinguished from other ships of the same name.
| String | optional |
| 3 | 3 | This is an optional parameter which sets out in bits the way the editor would like to display the name of the ship within an article. If it is set to 1, the ship will be displayed only by its ID number (that is, but the entry given in parameter 2) without the prefix SMS and without the ship's name; if given as 2, it will give just the ship's name, in italics, without the SMS prefix nor the ID number; if given as 3, it will give the ship's name and its ID number, but not the SMS prefix; 4 is not a valid entry; if given as 5, it will give the SMS prefix and the ID number, but will drop the ship's name; if given as 6, it will give the prefix SMS and the ship's name but will drop the ID number. If left blank, the ship will be displayed as SMS plus the ship's name plus its ID number.
| Number | optional |
See also change