View source for Template:ISBN/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{lua|Module:CS1 identifiers|Module:Citation/CS1/Configuration|Module:Citation/CS1/Identifiers|Module:Citation/CS1/Utilities}}
{{ISBN/doc/identifier link information}}
{{High-risk}}
{{notice
  |image=Stop hand nuvola.svg
  |This template should not be used in citation templates such as [[Help:Citation Style 1|Citation Style 1]] and [[Help:Citation Style 2|Citation Style 2]], because it may cause display errors. For example '''<code><nowiki>| isbn = {{ISBN|123-456-7890-123}}</nowiki></code>''' is incorrect use. Consider using {{tl|Format ISBN}} to help format ISBN identifiers within citation templates.
}}

This template produces a simple, standardized link from a [[International Standard Book Number]] (ISBN).  The ISBN is rendered using much of the same code that renders {{para|ISBN}} in {{cs1}} and {{cs2}} templates except that this template can be used to render multiple ISBNs.

== Usage ==
This template accepts these parameters:
:{{para|id{{var|n}}}} – a ISBN identifier; the {{para|id{{var|n}}}} parameter name is not required but is recommended for clarity when the template has multiple ISBNs
:{{para|link}} – accepts a single value <code>no</code>; for use when the 'ISBN' prefix in the rendering should not be linked
:{{para|plainlink}} – accepts a single value <code>yes</code>; suppresses the 'ISBN' prefix in the rendering
:{{para|leadout}} – defines the conjunction between the last two identifiers in the rendered list; defaults to <code>, </code>
The basic form is:
:<syntaxhighlight lang="wikitext" inline="1">{{ISBN|0-7475-3269-9}}</syntaxhighlight> → {{ISBN|0-7475-3269-9}}
For multiple ISBNs:
:<syntaxhighlight lang="wikitext" inline="1">{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1}}</syntaxhighlight> → {{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1}}
To unlink the prefix:
:<syntaxhighlight lang="wikitext" inline="1">{{ISBN|0-7475-3269-9|link=no}}</syntaxhighlight> → {{ISBN|0-7475-3269-9|link=no}}
To suppress the prefix:
:<syntaxhighlight lang="wikitext" inline="1">{{ISBN|0-7475-3269-9|plainlink=yes}}</syntaxhighlight> → {{ISBN|0-7475-3269-9|plainlink=yes}}
To use <code>and</code> between the last two identifiers in the rendered list:
:<syntaxhighlight lang="wikitext" inline="1">{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1|leadout=and}}</syntaxhighlight> → {{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1|leadout=and}}
When this template emits an error message for a valid (working) ISBN, use the accept-as-written markup <code>((..))</code> to suppress the error message.
:<syntaxhighlight lang="wikitext" inline="1">{{ISBN|1-4133-0451-0}}</syntaxhighlight> → {{ISBN|1-4133-0451-0}}
:<syntaxhighlight lang="wikitext" inline="1">{{ISBN|((1-4133-0451-0))}}</syntaxhighlight> → {{ISBN|((1-4133-0451-0))}}

==Tracking categories==
*{{cl|Ignored ISBN errors}} – {{color|#18911f|maintenance}} category for {{tld|ISBN}} templates using the accept-as-written markup <code>((..))</code> to suppress an error message – shared with {{tlx|ISBN}}
*{{cl|Pages with ISBN errors}} – {{color|#d33|error}} category for {{tld|ISBN}} templates that show an error message

Because this template uses the same code as cs1|2 templates, {{color|#d33|error}} and {{color|#18911f|maintenance}} visibility is controlled the same way.  See {{slink|Help:CS1_errors|Controlling_error_message_display}}.

===See also===
* [[Wikipedia:ISBN]]
* {{mwl|#isbn|}} (not recommended; it has none of the helpful features above)
* {{tl|Format ISBN}}, help to format ISBN values with dashes
* {{tl|SBN}}, similar template for SBNs rather than ISBNs
* {{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|OCLC}}, to link directly to Worldcat; useful for books with no ISBN.
* {{tl|PMID}}
* {{tl|IETF RFC}}
* {{tl|ISMN}}
* {{tl|ISSN}}
* {{tl|Catalog lookup link}}
* {{tl|ISBN missing|date=August 2019}}

==Template Data==
{{TemplateData header}}
<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": {},
		"link": {
			"label": "Suppress link to article?",
			"description": "If 'no', does not produce a link before the list",
			"example": "no",
			"type": "string"
		},
		"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"
		}
	},
	"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>

<includeonly>{{Sandbox other||
[[Category:Catalog lookup templates]]
[[Category:International Standard Book Number templates]]
[[Category:Variadic templates]]

}}</includeonly>