View source for Template:RNLB/doc

{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->

== Usage ==
This is a typing short cut for linking to [[Royal National Lifeboat Institution]] lifeboat articles named in the format "RNLB H F Bailey (ON 670)".  Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as <nowiki>[[RNLB H F Bailey (ON 670)|RNLB ''H F Bailey'' (ON 670)]]</nowiki>.  This template halves that to <nowiki>{{RNLB|H F Bailey|ON 670}}.
</nowiki>

=== Formal usage ===

* <code><nowiki>{{RNLB|Ship Name}}</nowiki></code>
* <code><nowiki>{{RNLB|Ship Name|ID}}</nowiki></code>, where ID can be the RNLI Official No, Operational No. or launch year, 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>{{RNLB|Lester|ON 1287}}</nowiki></code>
 | <code><nowiki>[[RNLB Lester (ON 1287)|RNLB ''Lester'' (ON 1287)]]</nowiki></code>
 | {{RNLB|Lester|ON 1287}}
 |-
 | <code><nowiki>{{RNLB|Manchester Unity of Oddfellows|B-702}}</nowiki></code> 
 | <code><nowiki>[[RNLB Manchester Unity of Oddfellows (B-702)|RNLB ''Manchester Unity of Oddfellows'' (B-702)]]</nowiki></code> 
 | {{RNLB|Manchester Unity of Oddfellows|B-702}}
 |-
 | <code><nowiki>{{RNLB|Alfred Corry}}</nowiki></code>
 | <code><nowiki>[[RNLB Alfred Corry|RNLB ''Alfred Corry'']]</nowiki></code>
 | {{RNLB|Alfred Corry}}
 |}

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 USS, 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:
{|class=wikitable width=100%
! Value
! Parameter(s)<br />displayed
! Example
! Equivalent wikicode
! Final result
|-
! None
| style="text-align:center;" | all
| <code><nowiki>{{RNLB|Lester|ON 1287}}</nowiki></code>
| <code><nowiki>[[RNLB Lester (ON 1287) |RNLB ''Lester'' (ON 1287)]]</nowiki></code>
| {{RNLB|Lester|ON 1287|}}
|-
! 1
| style="text-align:center;" | 3rd
| <code><nowiki>{{RNLB|Lester|ON 1287|1}}</nowiki></code>
| <code><nowiki>[[RNLB Lester (ON 1287) |ON 1287]]</nowiki></code>
| {{RNLB|Lester|ON 1287|1}}
|-
! 2
| style="text-align:center;" | 2nd
| <code><nowiki>{{RNLB|Lester|ON 1287|2}</nowiki>}</code>
| <code><nowiki>[[RNLB Lester (ON 1287) |''Lester'']]</nowiki></code>  
| {{RNLB|Lester|ON 1287|2}}
|-
! 3
| style="text-align:center;" | 2nd, 3rd
| <code><nowiki>{{RNLB|Lester|ON 1287|3}</nowiki>}</code>
| <code><nowiki>[[RNLB Lester (ON 1287) |''Lester'' (ON 1287)]]</nowiki></code>
| {{RNLB|Lester|ON 1287|3}}
|-
! 4
| style="text-align:center;" | invalid result
| <code><nowiki>{{RNLB|Lester|ON 1287|4}</nowiki>}</code>
| <code><nowiki>[[RNLB Lester (ON 1287) |Invalid Optional Parameter]]</nowiki></code>  
| {{RNLB|Lester|ON 1287|4}}
|-
! 5
| style="text-align:center;" | 1st, 3rd
| <code><nowiki>{{RNLB|Lester|ON 1287|5}</nowiki>}</code>
| <code><nowiki>[[RNLB Lester (ON 1287) |RNLB (ON 1287)]]</nowiki></code>  
| {{RNLB|Lester|ON 1287|5}}
|-
! 6
| style="text-align:center;" | 1st, 2nd
| <code><nowiki>{{RNLB|Lester|ON 1287|6}</nowiki>}</code>
| <code><nowiki>[[RNLB Lester (ON 1287) |RNLB ''Lester'']]</nowiki></code>  
| {{RNLB|Lester|ON 1287|6}}
|-
|
| style="text-align:center;" | 2nd<br /><small>(no 3rd)</small>
| <code><nowiki>{{RNLB|Alfred Corry|3=2}}</nowiki></code> <br/> ''Alternate usage'': <code><nowiki>{{RNLB|Alfred Corry||2}}</nowiki></code>
| <code><nowiki>[[RNLB Alfred Corry |''Alfred Corry'']]</nowiki></code>
| {{RNLB|Alfred Corry||2}}
|}
''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. 

<includeonly>{{Sandbox other||

<!-- ADD CATEGORIES BELOW THIS LINE -->

[[Category:Ship templates|USS]]

<!-- ADD INTERWIKIS BELOW THIS LINE -->

}}</includeonly>