View source for Template:Small scan link/doc

{{documentation subpage}}
{{template shortcut|ssl}}
{{lua|Module:Small scan link}}
===Usage===

A small link to a scan index of a work. 

This is generally only used when a work is not started or is incomplete. Editors are encouraged to remove this template if the work has been completed.

<pre><nowiki>
{{small scan link|1=Link to Scan Index Page}}
</nowiki></pre>

===Parameters===
This template uses two sets of unnamed parameters:

* {{parameter|1}}, {{parameter|2}}, ...: The links to the index page.  At least one is required. Do not use the Index: prefix for the link.
* {{parameter|name1}}, {{parameter|name2}}, ...: Alternative text for each link. Optional (defaults to "transcription project" for a single link, or sequential volume numbers for multiple volumes).

Example:

{{doc example|content=
<pre><nowiki>
* Life with the Esquimaux. {{small scan link|Life with the Esquimaux - 1864 - Volume 1.djvu}}
</nowiki></pre>

Produces:

* Life with the Esquimaux. {{small scan link|Life with the Esquimaux - 1864 - Volume 1.djvu}}
}}

{{doc example|content=
<pre><nowiki>
* ''Armenia, Travels and Studies'' (1901) {{small scan link|Armenia, Travels and Studies, Vol. 1.djvu|Armenia, Travels and Studies, Vol. 2.djvu}}
</nowiki></pre>

* ''Armenia, Travels and Studies'' (1901) {{small scan link|Armenia, Travels and Studies, Vol. 1.djvu|Armenia, Travels and Studies, Vol. 2.djvu}}
}}

{{doc example|title=With display name|content=
<pre><nowiki>
* ''Armenia, Travels and Studies'' (1901) {{small scan link|Armenia, Travels and Studies, Vol. 2.djvu|name1=Volume 2}}
</nowiki></pre>

* ''Armenia, Travels and Studies'' (1901) {{small scan link|Armenia, Travels and Studies, Vol. 2.djvu|name1=Volume 2}}
}}

== Template Data ==
<templatedata>
{
	"params": {
		"1": {
			"label": "Index page 1",
			"description": "Name of an Index page, without the 'Index:' prefix.",
			"type": "wiki-page-name",
			"required": true
		},
		"2": {
			"inherits": "1",
			"label": "Index page 2",
			"required": false
		},
		"3": {
			"inherits": "1",
			"label": "Index page 3",
			"required": false
		}
	},
	"description": "A small link to a scan index of a work.\n\nThis is generally only used when a work is not started or is incomplete. Editors are encouraged to remove this template if the work has been completed.\n",
	"format": "inline"
}
</templatedata>

===See also===
*{{tl|esl}} for linking to scans on an external website
*{{tl|commons category link}} for linking to a single category of scans at [[w:Wikimedia Commons|Commons]]
*{{tl|commons link}} for linking to scans at [[w:Wikimedia Commons|Commons]]
*{{tl|IAsl}} for linking to scans at [[w:Internet Archive|Internet Archive]]
*{{tl|GBS}} for linking to scans at [[w:Google Books|Google Books]]
*{{tl|HTlink}} for linking to scans at [[w:HathiTrust|HathiTrust]]
*{{tl|NLM link}}
*{{tl|scan}} also for linking to Index with a different purpose

<!-- template categories and interwiki links -->
<includeonly>
[[Category:Internal link templates]]
</includeonly>