Difference between revisions of "Template:KRI/doc"
imported>DePiep m (set categorisation to sandbox/other (via WP:JWB)) |
imported>Swpb m (→See also: clean up using AWB) |
||
| Line 129: | Line 129: | ||
<includeonly>{{sandbox other|| | <includeonly>{{sandbox other|| | ||
| − | [[Category:Ship templates|KRI]] | + | [[Category:Ship prefix templates|KRI]] |
}}</includeonly> | }}</includeonly> | ||
Revision as of 20:54, 8 March 2018
| This is a documentation subpage for Template:KRI. It contains usage information, categories and other content that is not part of the original template page. |
Contents
Usage
This is a typing short cut for linking to US Navy ship articles named in the format "KRI 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 [[KRI Nala (363)|KRI ''Nala'' (363)]]. This template halves that to {{KRI|Nala|363}}.
Formal usage
- {{KRI|Ship Name}}
- {{KRI|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 |
|---|---|---|
| {{KRI|Nala|363}} | [[KRI Nala (363)|KRI ''Nala'' (363)]] | KRI Nala (363) |
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 KRI, 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 | {{KRI|Nala|363}} | [[KRI Nala (363) |KRI ''Nala'' (363)]] | KRI Nala (363) |
| 1 | 3rd | {{KRI|Nala|363|1}} | [[KRI Nala (363) |363]] | 363 |
| 2 | 2nd | {{KRI|Nala|363|2}} | [[KRI Nala (363) |''Nala'']] | Nala |
| 3 | 2nd, 3rd | {{KRI|Nala|363|3}} | [[KRI Nala (363) |''Nala'' (363)]] | Nala (363) |
| 4 | invalid result | {{KRI|Nala|363|4}} | [[KRI Nala (363) |Invalid Optional Parameter]] | KRI Nala (363) |
| 5 | 1st, 3rd | {{KRI|Nala|363|5}} | [[KRI Nala (363) |KRI (363)]] | KRI 363 |
| 6 | 1st, 2nd | {{KRI|Nala|363|6}} | [[KRI Nala (363) |KRI ''Nala'']] | KRI Nala |
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.
Template data
TemplateData for KRI
This template provides a wikilink to a ship's page, with label options
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Prefix | 1 | Fleet identifier
| String | optional |
| Name | 2 | Ship's name
| String | optional |
| ID | 3 | Hull number, launch year, or pennanr number
| String | optional |
| Format | 4 | Formats label (parts showing)
| Number | optional |
| unlink prefix | up | yes=puts Fleet ID outside of Wikilink
| Boolean | optional |
See also
Template:WPSHIPS shortcut templates