Wikipedia>Jonesey95: Fix Linter errors using AutoEd

2020-06-04T18:04:24Z

Fix Linter errors using AutoEd

New page

{{Documentation subpage}}

== Usage ==
This is a typing short cut for linking to [[US Navy]] ship articles named in the format "USS 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>[[USS Deep Six (AWOL-99)|USS ''Deep Six'' (AWOL-99)]]</nowiki>. This template halves that to <nowiki>{{USS|Deep Six|AWOL-99}}.
</nowiki>

This template does not support <code><nowiki>subst:</nowiki></code> (substitution). Behind the scenes, it invokes {{tl|ship}}.
=== Formal usage ===

* <code><nowiki>{{USS|Ship Name}}</nowiki></code>
* <code><nowiki>{{USS|Ship Name|ID}}</nowiki></code>, where ID can be the [[hull number]], launch year, or [[pennant number]], as specified in the article title.

=== Examples ===
{|class=wikitable width="100%"
|- style="background-color:#FCFCFC" align="left"
! Template usage
! Equivalent wikicode
! Final result
|-
| <code><nowiki>{{USS|Enterprise|CVN-65}}</nowiki></code>
| <code><nowiki>[[USS Enterprise (CVN-65)|USS ''Enterprise'' (CVN-65)]]</nowiki></code>
| {{USS|Enterprise|CVN-65}}
|-
| <code><nowiki>{{USS|Constellation|1797}}</nowiki></code>
| <code><nowiki>[[USS Constellation (1797)|USS ''Constellation'' (1797)]]</nowiki></code>
| {{USS|Constellation|1797}}
|-
| <code><nowiki>{{USS|Constitution}}</nowiki></code>
| <code><nowiki>[[USS Constitution|USS ''Constitution'']]</nowiki></code>
| {{USS|Constitution}}
|}

Last example could be used to link to ship index (disambiguation) page

===Target page===
By default, the wikilink is build like this:
* <code><nowiki>{{PREFIX|ship's name|ID}}</nowiki></code>.
:With <code><nowiki>{{USS|Enterprise|CVN-65}}</nowiki></code>, the ''targetpage'' is
:{{nowrap|1=<code><nowiki>[[USS Enterprise (CVN-65)]]</nowiki></code>}}.
:Elements PREFIX and ID can be omitted (if they are not part of the targetpage title).

===Formatted label===
:Then the template by default adds the formatted ''label'':
:<code><nowiki>[[targetpage|label]]</nowiki></code>. By default:
:<code><nowiki>{{USS|Enterprise|CVN-65}}</nowiki></code>, by default the label is:
:<code><nowiki>[[USS Enterprise (CVN-65)|USS ''Enterprise'' (CVN-65)]]</nowiki></code>, showing as:
:{{USS|Enterprise|CVN-65}}.

The default label can be changed with a simple parameter. The extra ''third position'', unnamed parameter allows setting which changes the elements of the ship's full name. It sets the ''label'' in the link:
For example, in your article, the hull number (disambiguator) may not be needed to show. In that case, add option {{para||2}}, and the result is:
* <code><nowiki>{{USS|Enterprise|CVN-65</nowiki><span style="background:yellow;">|2</span>}}</code> →
:<code><nowiki>[[USS Enterprise (CVN-65)|''Enterprise'']]</nowiki></code> →
:{{USS|Enterprise|CVN-65|2}}

The options are:
{|class=wikitable style="font-size: 90%; text-align: left; width: 100%;"
! Value
! Will show
! Example
! Wikilink {{nobold|1=<nowiki>[[targetpage|label]]</nowiki>}}
! Shows
|-
! style="text-align:left;" | {{nobold|1=(default)}}
| PREFIX ''name'' (ID)
| <nowiki>{{USS|Enterprise|CVN-65}}</nowiki>
| <nowiki>[[USS Enterprise (CVN-65)|USS ''Enterprise'' (CVN-65)]]</nowiki>
| {{USS|Enterprise|CVN-65}}
|-
! style="text-align:left;" | 1
| ''ID''
| <nowiki>{{USS|Enterprise|CVN-65|1}}</nowiki>
| <nowiki>[[USS Enterprise (CVN-65)|''CVN-65'']]</nowiki>
| {{USS|Enterprise|CVN-65|1}}
|-
! style="text-align:left;" | 2
| ''name''
| <nowiki>{{USS|Enterprise|CVN-65|2}}</nowiki>
| <nowiki>[[USS Enterprise (CVN-65)|''Enterprise'']]</nowiki>
| {{USS|Enterprise|CVN-65|2}}
|-
! style="text-align:left;" | 3
| ''name'' (ID)
| <nowiki>{{USS|Enterprise|CVN-65|3}}</nowiki>
| <nowiki>[[USS Enterprise (CVN-65)|''Enterprise'' (CVN-65)]]</nowiki>
| {{USS|Enterprise|CVN-65|3}}
|-
! style="text-align:left;" | 4 {{nobold|1=<small>(dflt)</small>}}
| PREFIX ''name'' (ID)
| <nowiki>{{USS|Enterprise|CVN-65|4}}</nowiki>
| <nowiki>[[USS Enterprise (CVN-65)|USS ''Enterprise'' (CVN-65)]]</nowiki>
| {{USS|Enterprise|CVN-65|4}}
|-
! style="text-align:left;" | 5
| PREFIX ''ID''
| <nowiki>{{USS|Enterprise|CVN-65|5}}</nowiki>
| <nowiki>[[USS Enterprise (CVN-65)|USS ''CVN-65'']]</nowiki>
| {{USS|Enterprise|CVN-65|5}}
|-
! style="text-align:left;" | 6
| PREFIX ''name''
| <nowiki>{{USS|Enterprise|CVN-65|6}}</nowiki>
| <nowiki>[[USS Enterprise (CVN-65)|USS ''Enterprise'']]</nowiki>
| {{USS|Enterprise|CVN-65|6}}
|}
:{{small|1=''Note'': options default (=blank), 2 and 6 are mostly used.}}

===PREFIX not in article name===
It is possible that the prefix is not part of the ''target'' pagename. In that case, extra parameter {{para|up|yes}} ('''u'''nlink '''p'''refix) puts the name outside of the link: [example here]

== TemplateData ==
{{Template:Ship/doc/fixed prefix: TemplateData}}

== See also ==
{{WPSHIPS shortcut templates}}

<includeonly>{{sandbox other||
[[Category:Ship prefix templates|USS]]

}}</includeonly>

Template:USS/doc - Revision history

Wikipedia>Jonesey95: Fix Linter errors using AutoEd