Difference between revisions of "Template:JS/doc"

From blackwiki
Jump to navigation Jump to search
imported>The Bushranger
(create template doc)
 
imported>Jonesey95
m (Fix Linter errors using AutoEd)
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
  
 
== Usage ==
 
== Usage ==
Line 8: Line 7:
 
=== Formal usage ===
 
=== Formal usage ===
  
* <tt><nowiki>{{JS|Ship Name}}</nowiki></tt>
+
* <code><nowiki>{{JS|Ship Name}}</nowiki></code>
* <tt><nowiki>{{JS|Ship Name|ID}}</nowiki></tt>, where ID can be the [[hull number]], launch year, or [[pennant number]], as specified in the article title.
+
* <code><nowiki>{{JS|Ship Name|ID}}</nowiki></code>, where ID can be the [[hull number]], launch year, or [[pennant number]], as specified in the article title.
  
 
=== Example ===
 
=== Example ===
Line 18: Line 17:
 
  ! Final result
 
  ! Final result
 
  |-
 
  |-
  | <tt><nowiki>{{JDS|Ashigara|DDG-178}}</nowiki></tt>
+
  | <code><nowiki>{{JDS|Ashigara|DDG-178}}</nowiki></code>
  | <tt><nowiki>[[JDS Ashigara (DDG-178)|JDS ''Ashigara'' (DDG-178)]]</nowiki></tt>
+
  | <code><nowiki>[[JDS Ashigara (DDG-178)|JDS ''Ashigara'' (DDG-178)]]</nowiki></code>
 
  | {{JDS|Wakaba|DE-261}}
 
  | {{JDS|Wakaba|DE-261}}
 
  |}
 
  |}
 
  
 
=== Optional display control parameter ===
 
=== Optional display control parameter ===
Line 28: Line 26:
 
{|class=wikitable width=100%
 
{|class=wikitable width=100%
 
! Value
 
! Value
! Parameter(s)<br>displayed
+
! Parameter(s)<br />displayed
 
! Example
 
! Example
 
! Equivalent wikicode
 
! Equivalent wikicode
Line 34: Line 32:
 
|-
 
|-
 
! None
 
! None
| align=center | all
+
| style="text-align:center;" | all
| <tt><nowiki>{{JS|Ashigara|DDG-178}}</nowiki></tt>
+
| <code><nowiki>{{JS|Ashigara|DDG-178}}</nowiki></code>
| <tt><nowiki>[[JS Ashigara (DDG-178)|JS ''Ashigara'' (DDG-178)]]</nowiki></tt>
+
| <code><nowiki>[[JS Ashigara (DDG-178)|JS ''Ashigara'' (DDG-178)]]</nowiki></code>
 
| {{JS|Ashigara|DDG-178}}
 
| {{JS|Ashigara|DDG-178}}
 
|-
 
|-
 
! 1
 
! 1
| align=center | 3rd
+
| style="text-align:center;" | 3rd
| <tt><nowiki>{{JS|Ashigara|DDG-178|1}}</nowiki></tt>
+
| <code><nowiki>{{JS|Ashigara|DDG-178|1}}</nowiki></code>
| <tt><nowiki>[[JS Ashigara (DDG-178)|DDG-178]]</nowiki></tt>
+
| <code><nowiki>[[JS Ashigara (DDG-178)|DDG-178]]</nowiki></code>
 
| {{JS|Ashigara|DDG-178|1}}
 
| {{JS|Ashigara|DDG-178|1}}
 
|-
 
|-
 
! 2
 
! 2
| align=center | 2nd
+
| style="text-align:center;" | 2nd
| <tt><nowiki>{{JS|Ashigara|DDG-178|2}</nowiki>}</tt>
+
| <code><nowiki>{{JS|Ashigara|DDG-178|2}</nowiki>}</code>
| <tt><nowiki>[[JS Ashigara (DDG-178)|''Ashigara'']]</nowiki></tt>   
+
| <code><nowiki>[[JS Ashigara (DDG-178)|''Ashigara'']]</nowiki></code>   
 
| {{JS|Ashigara|DDG-178|2}}
 
| {{JS|Ashigara|DDG-178|2}}
 
|-
 
|-
 
! 3
 
! 3
| align=center | 2nd, 3rd
+
| style="text-align:center;" | 2nd, 3rd
| <tt><nowiki>{{JS|Ashigara|DDG-178|3}</nowiki>}
+
| <code><nowiki>{{JS|Ashigara|DDG-178|3}</nowiki>}</code>
| <tt><nowiki>[[JS Ashigara (DDG-178)|''Ashigara'' (DDG-178)]]</nowiki>
+
| <code><nowiki>[[JS Ashigara (DDG-178)|''Ashigara'' (DDG-178)]]</nowiki></code>
 
| {{JS|Ashigara|DDG-178|3}}
 
| {{JS|Ashigara|DDG-178|3}}
 
|-
 
|-
 
! 4
 
! 4
| align=center | invalid result
+
| style="text-align:center;" | invalid result
| <tt><nowiki>{{JS|Ashigara|DDG-178|4}</nowiki>}</tt>
+
| <code><nowiki>{{JS|Ashigara|DDG-178|4}</nowiki>}</code>
| <tt><nowiki>[[JS Ashigara (DDG-178)|Invalid Optional Parameter]]</nowiki></tt>   
+
| <code><nowiki>[[JS Ashigara (DDG-178)|Invalid Optional Parameter]]</nowiki></code>   
 
| {{JS|Ashigara|DDG-178|4}}
 
| {{JS|Ashigara|DDG-178|4}}
 
|-
 
|-
 
! 5
 
! 5
| align=center | 1st, 3rd
+
| style="text-align:center;" | 1st, 3rd
| <tt><nowiki>{{JS|Ashigara|DDG-178|5}</nowiki>}</tt>
+
| <code><nowiki>{{JS|Ashigara|DDG-178|5}</nowiki>}</code>
| <tt><nowiki>[[JS Ashigara (DDG-178)|JS (DDG-178)]]</nowiki></tt>   
+
| <code><nowiki>[[JS Ashigara (DDG-178)|JS (DDG-178)]]</nowiki></code>   
 
| {{JS|Ashigara|DDG-178|5}}
 
| {{JS|Ashigara|DDG-178|5}}
 
|-
 
|-
 
! 6
 
! 6
| align=center | 1st, 2nd
+
| style="text-align:center;" | 1st, 2nd
| <tt><nowiki>{{JS|Ashigara|DDG-178|6}</nowiki>}</tt>
+
| <code><nowiki>{{JS|Ashigara|DDG-178|6}</nowiki>}</code>
| <tt><nowiki>[[JS Ashigara (DDG-178)|JS ''Ashigara'']]</nowiki></tt>   
+
| <code><nowiki>[[JS Ashigara (DDG-178)|JS ''Ashigara'']]</nowiki></code>   
 
| {{JS|Ashigara|DDG-178|6}}
 
| {{JS|Ashigara|DDG-178|6}}
 
|}
 
|}
 +
 +
== TemplateData ==
 +
{{Template:Ship/doc/fixed prefix: TemplateData}}
  
 
== See also ==
 
== See also ==
 
{{WPSHIPS shortcut templates}}
 
{{WPSHIPS shortcut templates}}
  
<includeonly>
+
<includeonly>{{sandbox other||
 
+
[[Category:Ship prefix templates|JS]]
<!-- ADD CATEGORIES BELOW THIS LINE -->
+
}}</includeonly>
 
 
[[Category:Ship templates|JS]]
 
 
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
 
 
 
</includeonly>
 

Latest revision as of 02:23, 3 June 2020

Usage

This is a typing short cut for linking to modern Japan Maritime Self-Defense Force ship articles named in the format "JS 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 [[JS Deep Six (AWOL-99)|JS ''Deep Six'' (AWOL-99)]]. This template halves that to {{JDS|Deep Six|AWOL-99}}.

Formal usage

  • {{JS|Ship Name}}
  • {{JS|Ship Name|ID}}, where ID can be the hull number, launch year, or pennant number, as specified in the article title.

Example

Template usage Equivalent wikicode Final result
{{JDS|Ashigara|DDG-178}} [[JDS Ashigara (DDG-178)|JDS ''Ashigara'' (DDG-178)]] JDS Wakaba (DE-261)

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 BRP, 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 {{JS|Ashigara|DDG-178}} [[JS Ashigara (DDG-178)|JS ''Ashigara'' (DDG-178)]] JS Ashigara (DDG-178)
1 3rd {{JS|Ashigara|DDG-178|1}} [[JS Ashigara (DDG-178)|DDG-178]] DDG-178
2 2nd {{JS|Ashigara|DDG-178|2}} [[JS Ashigara (DDG-178)|''Ashigara'']] Ashigara
3 2nd, 3rd {{JS|Ashigara|DDG-178|3}} [[JS Ashigara (DDG-178)|''Ashigara'' (DDG-178)]] Ashigara (DDG-178)
4 invalid result {{JS|Ashigara|DDG-178|4}} [[JS Ashigara (DDG-178)|Invalid Optional Parameter]] JS Ashigara (DDG-178)
5 1st, 3rd {{JS|Ashigara|DDG-178|5}} [[JS Ashigara (DDG-178)|JS (DDG-178)]] JS DDG-178
6 1st, 2nd {{JS|Ashigara|DDG-178|6}} [[JS Ashigara (DDG-178)|JS ''Ashigara'']] JS Ashigara

TemplateData

Template:Ship/doc/fixed prefix: TemplateData

See also

Template:WPSHIPS shortcut templates