Difference between revisions of "Template:KRI/doc"
imported>DePiep m (TemplateData: use central template form for all prefix ship templates (via WP:JWB)) |
imported>Jay D. Easy (wtf) |
||
| Line 2: | Line 2: | ||
== Usage == | == Usage == | ||
| − | This is a typing short cut for linking to [[ | + | This is a typing short cut for linking to [[Indonesian 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 <nowiki>[[KRI Nala (363)|KRI ''Nala'' (363)]]</nowiki>. This template halves that to <nowiki>{{KRI|Nala|363}}. |
</nowiki> | </nowiki> | ||
=== Formal usage === | === Formal usage === | ||
| − | |||
* <tt><nowiki>{{KRI|Ship Name}}</nowiki></tt> | * <tt><nowiki>{{KRI|Ship Name}}</nowiki></tt> | ||
* <tt><nowiki>{{KRI|Ship Name|ID}}</nowiki></tt>, where ID can be the [[hull number]], launch year, or [[pennant number]], as specified in the article title. | * <tt><nowiki>{{KRI|Ship Name|ID}}</nowiki></tt>, where ID can be the [[hull number]], launch year, or [[pennant number]], as specified in the article title. | ||
| Line 12: | Line 11: | ||
=== Examples === | === Examples === | ||
{|class=wikitable width="100%" | {|class=wikitable width="100%" | ||
| − | + | |- style="background-color:#FCFCFC" align="left" | |
| − | + | ! Template usage | |
| − | + | ! Equivalent wikicode | |
| − | + | ! Final result | |
| − | + | |- | |
| − | + | | <tt><nowiki>{{KRI|Nala|363}}</nowiki></tt> | |
| − | + | | <tt><nowiki>[[KRI Nala (363)|KRI ''Nala'' (363)]]</nowiki></tt> | |
| − | + | | {{KRI|Nala|363}} | |
| − | + | |} | |
Last example could be used to link to ship index (disambiguation) page | Last example could be used to link to ship index (disambiguation) page | ||
| Line 69: | Line 68: | ||
| {{KRI|Nala|363|5}} | | {{KRI|Nala|363|5}} | ||
|- | |- | ||
| − | ! 6 | + | ! 6 |
| style="text-align:center;" | 1st, 2nd | | style="text-align:center;" | 1st, 2nd | ||
| <tt><nowiki>{{KRI|Nala|363|6}</nowiki>}</tt> | | <tt><nowiki>{{KRI|Nala|363|6}</nowiki>}</tt> | ||
| Line 75: | Line 74: | ||
| {{KRI|Nala|363|6}} | | {{KRI|Nala|363|6}} | ||
|} | |} | ||
| + | |||
''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. | ''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. | ||
Revision as of 19:30, 1 July 2019
| 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 Indonesian 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.
TemplateData
Template:Ship/doc/fixed prefix: TemplateData
See also
Template:WPSHIPS shortcut templates