Template:Colledge: Ships RN

Template documentationview edit history purge

This template uses Lua:

This template uses WP:SSTS; see that page for complete system documentation.

This template generates citations to the various editions and volumes of the book Ships of the Royal Navy by J. J. Colledge and subsequent co-authors.

The key=value parameters such as |author=, |title=, etc., are defined in Module:SST/shards/sets/COLLEDGE_SHIPS_RN.

Editions and volumes

Because this work was published in various formats over several decades—initially as split volumes and later as combined revisions—the routing for this template is driven strictly by the publication year.

To cite a specific volume or revision, use the |year= parameter with the corresponding identifier from the table below:

Revision	Volume	Year	Title
Original	1: Major Ships	`\|year=1969`	Ships of the Royal Navy: An Historical Index
Original	2: Navy-built Trawlers, Drifters, Tugs and Requisitioned Ships	`\|year=1970`	Ships of the Royal Navy: An Historical Index
1st Rev	1: Major Ships	`\|year=1987`	Ships of the Royal Navy: The Complete Record of All Fighting Ships of the Royal Navy
1st Rev	2: Navy-built Trawlers, Drifters, Tugs and Requisitioned Ships	`\|year=1989`	Ships of the Royal Navy: The Complete Record of All Fighting Ships of the Royal Navy
2nd Rev	Major Ships	`\|year=2003`	Ships of the Royal Navy: The Complete Record of All Fighting Ships of the Royal Navy
3rd Rev	Major Ships	`\|year=2006`	Ships of the Royal Navy: The Complete Record of All Fighting Ships of the Royal Navy from the 15th Century to the Present
4th Rev	Combined 1 & 2	`\|year=2010`	Ships of the Royal Navy: The Complete Record of All Fighting Ships of the Royal Navy
5th Rev	Combined 1 & 2	`\|year=2020`	Ships of the Royal Navy: The Complete Record of all Fighting Ships of the Royal Navy from the 15th Century to the Present

Default: |year=2020

Usage

Default (2020 5th Revision)

{{Colledge: Ships RN}}

Colledge, J. J.; et al. (1969–2020). Ships of the Royal Navy: The Complete Record of All Fighting Ships of the Royal Navy.

Specific Year/Volume

{{Colledge: Ships RN |year=1987}}

Colledge, J. J. (1987) [1969]. Ships of the Royal Navy: The Complete Record of All Fighting Ships of the Royal Navy. Vol. 1: Major Ships (1st Rev ed.). Annapolis, Maryland: Naval Institute Press. ISBN 978-0-87021-652-7.

Single Page

{{Colledge: Ships RN |year=2010 |page=42}}

Colledge, J. J.; Warlow, Ben (2010) [1969]. Ships of the Royal Navy: The Complete Record of All Fighting Ships of the Royal Navy (4th Rev ed.). Newbury, Berkshire: Casemate. p. 42. ISBN 978-1-935149-07-1. OCLC 603386630.

Multiple Pages

{{Colledge: Ships RN |year=1969 |pages=42-43, 44-45}}

Colledge, J. J. (1969). Ships of the Royal Navy: An Historical Index. Vol. 1: Major Ships. New York: Augustus M. Kelley. pp. 42-43, 44-45.

Chapter

{{Colledge: Ships RN |year=2003 |chapter=Introduction |chapter-page=12 |page=12}}

Colledge, J. J.; Warlow, Ben (2003) [1969]. "Introduction". Ships of the Royal Navy: The Complete Record of All Fighting Ships of the Royal Navy (2nd Rev ed.). London: Greenhill Books. p. 12. ISBN 978-1-85367-566-9.

Short citations

To create a short inline citation that links to this template, use the specific tag for the year you are citing. Because the authors change across revisions, the required {{sfn}} parameters also change:

Year	Revision / Volume	SFN Tag
1969	Original, Vol 1: Major Ships	`{{sfn\|Colledge\|1969}}`
1970	Original, Vol 2: Navy-built Trawlers, Drifters, Tugs...	`{{sfn\|Colledge\|1970}}`
1987	1st Rev, Vol 1: Major Ships	`{{sfn\|Colledge\|1987}}`
1989	1st Rev, Vol 2: Navy-built Trawlers, Drifters, Tugs...	`{{sfn\|Colledge\|1989}}`
2003	2nd Rev, Major Ships	`{{sfn\|Colledge\|Warlow\|2003}}`
2006	3rd Rev, Major Ships	`{{sfn\|Colledge\|Warlow\|2006}}`
2010	4th Rev, Combined 1 & 2	`{{sfn\|Colledge\|Warlow\|2010}}`
2020	5th Rev, Combined 1 & 2	`{{sfn\|Colledge\|Warlow\|Bush\|2020}}`

Note: This assumes {{Colledge: Ships RN}} exists elsewhere in the article.

Options

Supplement and Override

You have the option to supplement or override parameters.

Supplement: You can add additional parameters supported by standard citation templates (like {{cite book}} or {{cite encyclopedia}}) such as |quote=, |ref=, etc.
Override: You can override parameters already defined by the template (for example, providing a custom |url= if you are citing a specific digital scan not mapped by the system).

Digital availability

Because texts have complex publication histories, digital availability may vary by volume. Some volumes may be physical-only, while others may be hosted digitally (e.g., on the Internet Archive, Google Books, or Wikisource). If a specific volume is hosted digitally, the underlying SST Module will automatically generate the correct links and activate the relevant digital features below.

Volumes and editions

Many historical works span multiple volumes or have been printed in various editions. SSTS templates are built to handle these variations natively. You can pass the |volume= or |edition= parameters exactly as you would in standard wikitext.

Edition:

{{The Ottoman Empire |edition=Second |page=112}}

Volume:

{{The Ottoman Empire |volume=2 |page=112}}

SSTS uses a normalization module that understands that "Second", "2nd", and "2" all mean the same thing, or "Vol. 1", "Volume 1", and "1".

Chapters

To link to a specific chapter, use |chapter= and |chapter-page=.

{{The Cambridge History of Iran |volume=1 |chapter=Introduction |chapter-page=12}}

Page numbers

The system supports page number formatting of various types:

|page=42 - single page
|pages=42-50 - page ranges
|pages=42, 50, 60 - multiple pages
|pages=42-49, 50-59, 60-69 - multiple page range groups

All of these will get automatically linked to the specific page numbers.

Page number options

Leaf numbers

Because the page number printed on the physical page (e.g., Roman numeral "xii") might not match the digital file's "leaf" or "sequence" number (e.g., scan #7), SSTS uses a special display@machine syntax within the |page= or |pages= parameters to bridge this gap.

Left of the @: The page number as it is printed in the physical book. This is what readers will see in the citation text.
Right of the @: The machine code instructing the URL how to find that exact page in the digital archive.

Different digital libraries require slightly different machine codes.

Use the format display@<host code><leaf #>.

Example Internet Archive: xiii@n7 means printed page "xiii" is located at Internet Archive leaf number 7 (e.g. the URL ../page/n7). Thus, |page=xiii@n7
Example Google Books: xiii@gPR13 means printed page "xiii" is located at Google Books leaf number 13 (e.g. the URL ...&pg=PR13).

Host Service	Host Code	Format	Resulting Link	Citation and Destination Printed Page
Internet Archive	n	42	`.../page/42`	42
Internet Archive	n	xii@n7	`.../page/n7`	xii
HathiTrust	s	42	Not Available	Does not support printed-page-number linking
HathiTrust	s	42@s54	`...&seq=54`	42
Project Gutenberg	u	42	`.../pg78102-images.html#page-42`	42
Project Gutenberg	u	42@u42	`.../pg78102-images.html#page-42`	42
Wikisource	w	42	Not Available	Does not support printed-page-number linking
Wikisource	w	42@w54	`[[s:Page:FileName.pdf/54\|42]]`	42
Wikisource	w	42@w"Chapter 1"	`[[s:Page:FileName.pdf/Chapter_1\|42]]`	42
Google Books	g	42	`...&pg=PA42`	42
Google Books	g	42@gPA42	`...&pg=PA42`	42 (PA is "Page Arabic")
Google Books	g	xiii	`...&pg=PR13`	xiii
Google Books	g	xiii@gPR13	`...&pg=PR13`	xiii (PR is "Page Roman")
Google Books	g	cover@gPP1	`...&pg=PP1`	cover (PP is "Page Physical" or unnumbered pages, covers, blank pages etc)
Google Books	g	insert@gPT15	`...&pg=PT15`	insert (PT is "Page Text" unnumbered inserts, photo plates, etc)

Search

Many digital libraries support a "search inside" feature that automatically highlights a specific word or phrase on the page when the reader opens the link. SSTS allows you to trigger this feature directly from the citation by enclosing your search term in square brackets [] within the |page= or |pages= parameter.

This syntax can be used on its own, or appended to the @ linking syntax.

Basic search:
```
{{The Ottoman Empire |page=42 [Suleiman]}}
```
Result: Links to printed page 42 and searches the text for the word "Suleiman", highlighting it on the digital scan.

Combined with leaf linking:
```
{{The Ottoman Empire |page=xii@n7 [Constantinople]}}
```
Result: Displays printed page "xii" in the citation, routes the reader to machine leaf "n7", and searches the page for "Constantinople".

Multiple terms:
```
{{The Ottoman Empire |page=45 [military reform], 57-60 [justinian] }}
```
Result: You can include multiple search terms one for each page grouping separated by a comma.

Please note that this feature relies on the destination host's capabilities. Based on current engine configurations, search-highlighting is supported by:

Internet Archive
HathiTrust
Google Books

Dummy search

A core feature of this module is its handling of the Internet Archive's restricted viewing modes.

If an editor provides a page number, the module automatically appends that number as a "dummy" search string (e.g., ?q=42). This is a necessary architectural workaround: supplying a search string forces the IA viewer to open and highlight specific pages that might be blocked due to restrictions (similar to Google Books snippet view with search strings).

Documentation

The examples in this documentation are based on stock / generic page numbers and search terms; they may not work precisely for this particular book. For more details on the underlying system, see Wikipedia:SSTS.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Colledge: Ships RN in articles based on its TemplateData.

TemplateData for Colledge: Ships RN

Generates citations to the various editions and volumes of Ships of the Royal Navy by J. J. Colledge.

Template parameters[Edit template data]
Parameter		Description	Type	Status
page	`page`	Page number Example 113	String	optional
pages	`pages`	Multiple page numbers Example 42, 56, 301-350	String	optional
chapter-page	`chapter-page`	Page number where the chapter begins (creates chapter URL) Example 12	String	optional
quote	`quote`	Standard CS1 parameter for quote	String	optional
ref	`ref`	Standard CS1 parameter for ref	String	optional
chapter	`chapter`	Standard CS1 parameter for chapter	String	optional
year	`year`	Publication year (Used to route to the correct edition/volume) Example 1987	String	optional
date	`date`	Alias for year	String	optional
author-mask	`author-mask`	Standard CS1 parameter for author-mask	String	optional