View source for Template:ISBN/doc

{{Documentation subpage}}
{{Lua|Module:Check isxn}}
{{High-risk|380000+}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

== Usage ==
Use this template to create a link (or list of links) to [[Special:BookSources]] for one or more [[International Standard Book Number]]s with the usual "ISBN" prefix. The template supports 10- and 13-digit ISBNs (with or without hyphens).

<tt><nowiki>{{ISBN|0-7475-3269-9}}</nowiki></tt>

results in:

{{ISBN|0-7475-3269-9}}

And:

<tt><nowiki>{{ISBN|978-1-4133-0454-1}}</nowiki></tt>

results in:

{{ISBN|978-1-4133-0454-1}}

The idea is to switch from "[[Help:Magic links|magic link]]" syntax to more explicit syntax. {{oldid2|772133164|Future of magic links|This March 2017 (English Wikipedia) RfC}} determined the magic link should be replaced by this template.

If more than one ISBN is given, the template will separate them using a comma:

<tt><nowiki>{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1}}</nowiki></tt>

results in:

{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1}}

Alternatively the conjugation between the last two list items can be defined using the <tt>leadout=</tt> parameter:

<tt><nowiki>{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1|leadout=and}}</nowiki></tt>

results in:

{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1|leadout=and}}

It the leading "ISBN" link should not occur (for example in longer lists), it can be suppressed using the <tt>plainlink=yes</tt> parameter:

<tt><nowiki>{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1|plainlink=yes}}</nowiki></tt>

results in:

{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1|plainlink=yes}}

(Alternatively the {{tl|ISBNT}} template can be used.)

The <tt>plainlink</tt> and <tt>leadout</tt> parameter can be used at the same time:

<tt><nowiki>{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1|plainlink=yes|leadout=as well as}}</nowiki></tt>

results in:

{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1|plainlink=yes|leadout=as well as}}

=== Formatting ===

The template preserves the formatting of the input values, for example:

<tt><nowiki>{{ISBN|978-1-4133-0454-1|978141330454-1|978 1-41330-454-1}}</nowiki></tt>

results in:

{{ISBN|978-1-4133-0454-1|978141330454-1|978 1-41330-454-1}}

===Error checking===
This template uses [[Module:Check isxn]] to validate the ISBN. If the ISBN is not valid, this subtemplate will still generate the link, and it will add the article to [[:Category:Pages with ISBN errors]].

Since invalid ISBNs are sometimes used in publications, it is possible to disable the validity check for individual ISBNs given as parameters. In order to do so, add <tt>invalid?=yes</tt> (with ? replaced by the parameter number 1 to 9) to the template. In this case, the article will be added to [[:Category:Pages with listed invalid ISBNs]].

* <tt><nowiki>{{ISBN|1-4133-0451-0}}</nowiki></tt> &nbsp; produces {{ISBN|1-4133-0451-0}}

* <tt><nowiki>{{ISBN|1-4133-0451-0|invalid1=yes}}</nowiki></tt> &nbsp; produces {{ISBN|1-4133-0451-0|invalid1=yes}}

* <tt><nowiki>{{ISBN|1-4133-0451-0|invalid1=no}}</nowiki></tt> &nbsp; produces {{ISBN|1-4133-0451-0|invalid1=no}}

* <tt><nowiki>{{ISBN}}</nowiki></tt> &nbsp; produces {{ISBN}}

===See also===
* [[Wikipedia:ISBN]]
* {{tl|ISBNT}}, to make an ISBN link without a visible prefix
* {{tl|Listed Invalid ISBN}}, to link an ISBN that is invalid but printed in a source publication.
* {{tl|PMID}}
* {{tl|IETF RFC}}
* {{tl|ISMN}}
* {{tl|ISSN}}
* {{tl|Catalog lookup link}}

<includeonly>
[[Category:Catalog lookup templates]]
[[Category:International Standard Book Number templates]]
[[Category:Wikipedia formatting and function templates|{{PAGENAME}}]]
</includeonly>

==Template Data==
<templatedata>
{
	"params": {
		"1": {
			"label": "ISBN #1",
			"description": "first ISBN to put in the list",
			"example": "0-674-01181-3",
			"type": "string",
			"required": true,
			"suggested": true
		},
		"2": {
			"label": "ISBN #2",
			"description": "second ISBN to put in the list",
			"example": "0-674-04200-3",
			"type": "string",
			"suggested": true
		},
		"3": {
			"label": "ISBN #3",
			"description": "third ISBN to put in the list",
			"example": "0-674-01169-3",
			"type": "string"
		},
		"4": {
			"label": "ISBN #4",
			"description": "fourth ISBN to put in the list",
			"example": "0-674-01181-6",
			"type": "string"
		},
		"5": {
			"label": "ISBN #5",
			"description": "fifth ISBN to put in the list",
			"example": "0-674-02181-5",
			"type": "string"
		},
		"6": {},
		"7": {},
		"8": {},
		"9": {},
		"plainlink": {
			"label": "Suppress link to ISBN?",
			"description": "If 'yes', does not produce \"[[ISBN]]: \" before the list",
			"example": "yes",
			"type": "string"
		},
		"leadout": {
			"label": "last list joiner text",
			"description": "Text between second-to-last and last book ISBN's",
			"example": "as well as",
			"type": "string"
		},
		"invalid1": {},
		"invalid2": {},
		"invalid3": {},
		"invalid4": {},
		"invalid5": {},
		"invalid6": {},
		"invalid7": {},
		"invalid8": {},
		"invalid9": {}
	},
	"description": "Use this template to create a link (or list of links) to Special:BookSources for one or more International Standard Book Numbers with the usual \"ISBN\" prefix"
}
</templatedata>