mNo edit summary
|
No edit summary
|
||
(15 intermediate revisions by 10 users not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
{{High-use}} |
|||
{{Lua|Module:WPSHIPS utilities}} |
|||
== Usage == |
== Usage == |
||
Template {{tl|Ship}} creates a wikilink to its article ''and'' formats the visible name correctly. That is, it handles both parts of <code><nowiki>[[targetpage|label]]</nowiki></code>. Now it is up to the editor (you) to get this right: a bluelink to the article, and well-formatted ship's full name. |
Template {{tl|Ship}} creates a wikilink to its article ''and'' formats the visible name correctly. That is, it handles both parts of <code><nowiki>[[targetpage|label]]</nowiki></code>. Now it is up to the editor (you) to get this right: a bluelink to the article, and well-formatted ship's full name. |
||
The ship's '''article''' may be titled: <code><nowiki>[[HMCS Kootenay (H75)]]</nowiki></code> |
The ship's '''article''' may be titled: <code><nowiki>[[HMCS Kootenay (H75)]]</nowiki></code> → [[HMCS Kootenay (H75)]]. The three parts are called: prefix, name, ID (ID is [[WP:DAB|WP:Disambiguation]], or hull number, pennant number, launch year: to identify the ship when multiple ships have the same name). |
||
Apart from the article title, in the visible '''label''' the name could be formatted. Like: <code><nowiki>[[HMCS Kootenay (H75)|HMCS ''Kootenay'']]</nowiki></code> |
Apart from the article title, in the visible '''label''' the name could be formatted. Like: <code><nowiki>[[HMCS Kootenay (H75)|HMCS ''Kootenay'']]</nowiki></code> → [[HMCS Kootenay (H75)|HMCS ''Kootenay'']] (note the ''italics'', and the omission of the hull number – linked to the same article). |
||
=== Basic usage === |
=== Basic usage === |
||
:<nowiki>{{ship|1-prefix|2-name|3-ID}}</nowiki> → <code><nowiki>[[1-prefix 2-name (3-ID)|1-prefix ''2-name'' (3-ID)]]</nowiki></code> → {{ship|1-prefix|2-name|3-ID}} |
:<nowiki>{{ship|1-prefix|2-name|3-ID}}</nowiki> → <code><nowiki>[[1-prefix 2-name (3-ID)|1-prefix ''2-name'' (3-ID)]]</nowiki></code> → {{ship|1-prefix|2-name|3-ID}} |
||
;1 |
;1 prefix |
||
: like HMS, USS. Leave the parameter blank if the ship's title has no prefix. |
|||
: like HMS, USS |
|||
;2 |
;2 name |
||
: ship's name |
: ship's name |
||
;3 |
;3 ID |
||
:Specifier like [[hull number]], [[pennant number]], or launch year. Also serves as the [[WP:DAB|WP:Disambiguation term]] in article titles. |
:Specifier like [[hull number]], [[pennant number]], or launch year. Also serves as the [[WP:DAB|WP:Disambiguation term]] in article titles. |
||
Line 61: | Line 63: | ||
| style="text-align:center;" | ID |
| style="text-align:center;" | ID |
||
| colspan=2 | <nowiki>{{ship|HMCS|Kootenay|H75|1}}</nowiki> |
| colspan=2 | <nowiki>{{ship|HMCS|Kootenay|H75|1}}</nowiki> |
||
| <nowiki>[[HMCS Kootenay (H75)| |
| <nowiki>[[HMCS Kootenay (H75)|H75]]</nowiki> |
||
| {{ship|HMCS|Kootenay|H75|1}} |
| {{ship|HMCS|Kootenay|H75|1}} |
||
|- |
|- |
||
Line 77: | Line 79: | ||
|- |
|- |
||
! 4 |
! 4 |
||
| style="text-align:center;" | |
| style="text-align:center;" | invalid |
||
| colspan=2 | <nowiki>{{ship|HMCS|Kootenay|H75|4}}</nowiki> |
| colspan=2 | <nowiki>{{ship|HMCS|Kootenay|H75|4}}</nowiki> |
||
| — |
|||
| <nowiki>[[HMCS Kootenay (H75)|HMCS ''Kootenay'' (H75)]]</nowiki> |
|||
| {{ship|HMCS|Kootenay|H75|4}} |
| {{ship|HMCS|Kootenay|H75|4|no-tracking=yes}} |
||
|- |
|- |
||
! 5 |
! 5 |
||
Line 94: | Line 96: | ||
| {{ship|HMCS|Kootenay|H75|6}} |
| {{ship|HMCS|Kootenay|H75|6}} |
||
|} |
|} |
||
===Same format, no wikilink=== |
|||
By setting {{para|wl|no}}, the same formatting is made but the ship's name is not linked: |
|||
:{{ship|HMCS|Kootenay|H75}} (regular, <code><nowiki>{{ship|HMCS|Kootenay|H75}}</nowiki></code>) |
|||
:{{ship|HMCS|Kootenay|H75|wl=no}} (no wikilink, setting <code><nowiki>{{ship|HMCS|Kootenay|H75</nowiki><span style="background:yellow">|wl=no</span>}}</code>) |
|||
=== Prefix in/out option === |
=== Prefix in/out option === |
||
Parameter {{para|up|yes}} (for '''u'''nlinked '''p'''refix) can be used to have an ''unlinked prefix'':. When set to "yes", the template will display the prefix before (outside of) the wikilink |
Parameter {{para|up|yes}} (for '''u'''nlinked '''p'''refix) can be used to have an ''unlinked prefix'':. When set to "yes", the template will display the prefix before (outside of) the wikilink. |
||
;Examples: |
;Examples: |
||
<!-- Better examples needed: show the effect of prefix in/out article title. DePiep, 2018-03-10 --> |
<!-- Better examples needed: show the effect of prefix in/out article title. DePiep, 2018-03-10 --> |
||
* <code><nowiki>{{ship|Japanese battleship|Yamato|up=yes}}</nowiki></code> |
* <code><nowiki>{{ship|Japanese battleship|Yamato|up=yes}}</nowiki></code> → {{ship|Japanese battleship|Yamato|up=yes}} |
||
Using a format option: |
Using a format option: |
||
* <code><nowiki>{{ship|Japanese battleship|Yamato||2|up=yes}}</nowiki></code> |
* <code><nowiki>{{ship|Japanese battleship|Yamato||2|up=yes}}</nowiki></code> → {{ship|Japanese battleship|Yamato||2|up=yes}} |
||
==TemplateData== |
|||
⚫ | |||
{{TemplateData header}} |
|||
⚫ | |||
⚫ | |||
==Template data== |
|||
{{TemplateDataHeader}} |
|||
<templatedata> |
<templatedata> |
||
{ |
{ |
||
Line 127: | Line 131: | ||
"3": { |
"3": { |
||
"label": "ID", |
"label": "ID", |
||
"description": "Hull number, launch year, or |
"description": "Hull number, launch year, or pennant number", |
||
"example": "H75, 1975, ", |
"example": "H75, 1975, ", |
||
"type": "string" |
"type": "string" |
||
Line 155: | Line 159: | ||
} |
} |
||
</templatedata> |
</templatedata> |
||
⚫ | |||
⚫ | |||
⚫ | |||
== See also == |
== See also == |
||
Line 163: | Line 171: | ||
[[Category:Ship templates|Ship]] |
[[Category:Ship templates|Ship]] |
||
[[Category:Ship prefix templates| ]] |
[[Category:Ship prefix templates| ]] |
||
[[Category:Templates that add a tracking category]] |
|||
}}</includeonly> |
}}</includeonly> |
![]() | This is a documentation subpage for Template:Ship. It may contain usage information, categories and other content that is not part of the original template page. |
![]() | This template is used on approximately 38,000 pages and changes may be widely noticed. Test changes in the template's /sandboxor/testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
![]() | This template uses Lua:
|
Template {{Ship}} creates a wikilink to its article and formats the visible name correctly. That is, it handles both parts of [[targetpage|label]]
. Now it is up to the editor (you) to get this right: a bluelink to the article, and well-formatted ship's full name.
The ship's article may be titled: [[HMCS Kootenay (H75)]]
→ HMCS Kootenay (H75). The three parts are called: prefix, name, ID (ID is WP:Disambiguation, or hull number, pennant number, launch year: to identify the ship when multiple ships have the same name).
Apart from the article title, in the visible label the name could be formatted. Like: [[HMCS Kootenay (H75)|HMCS ''Kootenay'']]
→ HMCS Kootenay (note the italics, and the omission of the hull number – linked to the same article).
[[1-prefix 2-name (3-ID)|1-prefix ''2-name'' (3-ID)]]
→ 1-prefix 2-name (3-ID)All parameters are optional. You only need to enter the parts that build the article title.
Template usage | Resulting wikicode | Link showing |
---|---|---|
{{ship|ARA|General Belgrano}} | [[ARA General Belgrano|ARA ''General Belgrano'']] | ARA General Belgrano |
{{ship|HMCS|Kootenay|H75}} | [[HMCS Kootenay (H75)|HMCS ''Kootenay'' (H75)]] | HMCS Kootenay (H75) |
A fourth, unnamed parameter |4=
allows setting which pieces of text are displayed in the wikilink. It sets the label in the link: [[targetpage|label]]
For example, the ship's article is entered as {{ship|HMCS|Kootenay|H75}}
, by default showing as HMCS Kootenay (H75).
But in your article, the hull number (disambiguator) may not be needed to show. In that case, add |4=2
, and the result is:
{{ship|HMCS|Kootenay|H75|2}} [[HMCS Kootenay (H75)|''Kootenay'']]
→ KootenayThe options are:
Value | Parameter(s) displayed |
Example | Equivalent wikicode | Final result | |
---|---|---|---|---|---|
None | prefix, name, ID | {{ship|HMCS|Kootenay|H75}} | [[HMCS Kootenay (H75)|HMCS ''Kootenay'' (H75)]] | HMCS Kootenay (H75) | |
1 | ID | {{ship|HMCS|Kootenay|H75|1}} | [[HMCS Kootenay (H75)|H75]] | H75 | |
2 | name | {{ship|HMCS|Kootenay|H75|2}} | [[HMCS Kootenay (H75)|''Kootenay'']] | Kootenay | |
3 | name, ID | {{ship|HMCS|Kootenay|H75|3}} | [[HMCS Kootenay (H75)|''Kootenay'' (H75)]] | Kootenay (H75) | |
4 | invalid | {{ship|HMCS|Kootenay|H75|4}} | — | Error: {{Ship}} invalid control parameter: 4 (help) | |
5 | prefix, ID | {{ship|HMCS|Kootenay|H75|5}} | [[HMCS Kootenay (H75)|HMCS ''H75'']] | HMCS H75 | |
6 | prefix, name | {{ship|HMCS|Kootenay|H75|6}} | [[HMCS Kootenay (H75)|HMCS ''Kootenay'']] | HMCS Kootenay |
By setting |wl=no
, the same formatting is made but the ship's name is not linked:
{{ship|HMCS|Kootenay|H75}}
){{ship|HMCS|Kootenay|H75|wl=no}}
)
Parameter |up=yes
(for unlinked prefix) can be used to have an unlinked prefix:. When set to "yes", the template will display the prefix before (outside of) the wikilink.
{{ship|Japanese battleship|Yamato|up=yes}}
→ Japanese battleship YamatoUsing a format option:
{{ship|Japanese battleship|Yamato||2|up=yes}}
→ YamatoTemplateData for Ship
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 pennant number
| String | optional |
Format | 4 | Formats label (parts showing)
| Number | optional |
unlink prefix | up | yes=puts Fleet ID outside of Wikilink
| Boolean | optional |