Template:ISBN/sandbox

This is the template sandbox page for Template:ISBN (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

This template uses Lua:

The link in this template goes to a redirect page instead of to the article that is the target of the redirect. This redirect link is intentional so that links using the template are distinguishable from links to the article on the Special:WhatLinksHere/ISBN page.

This template is used on 471,000+ pages, or roughly 1% of all pages.
To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

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 |ISBN= in Citation Style 1 and Citation Style 2 templates except that this template can be used to render multiple ISBNs.

Usage

This template accepts these parameters:

|idn= – a ISBN identifier; the |idn= parameter name is not required but is recommended for clarity when the template has multiple ISBNs

|link= – accepts a single value no; for use when the 'ISBN' prefix in the rendering should not be linked

|plainlink= – accepts a single value yes; suppresses the 'ISBN' prefix in the rendering

|leadout= – defines the conjunction between the last two identifiers in the rendered list; defaults to ,

The basic form is:

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

For multiple ISBNs:

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

To unlink the prefix:

{{ISBN|0-7475-3269-9|link=no}} → ISBN 0-7475-3269-9

To suppress the prefix:

{{ISBN|0-7475-3269-9|plainlink=yes}} → 0-7475-3269-9

To use and between the last two identifiers in the rendered list:

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

When this template emits an error message for a valid (working) ISBN, use the accept-as-written markup ((..)) to suppress the error message.

{{ISBN|1-4133-0451-0}} → ISBN 1-4133-0451-0 {{isbn}}: Check isbn value: checksum (help)

{{ISBN|((1-4133-0451-0))}} → ISBN 1-4133-0451-0 {{isbn}}: ignored ISBN errors (link)

Tracking categories

Category:Ignored ISBN errors – maintenance category for {{ISBN}} templates using the accept-as-written markup ((..)) to suppress an error message – shared with {{ISBN}}
Category:Pages with ISBN errors – error category for {{ISBN}} templates that show an error message

Because this template uses the same code as cs1|2 templates, error and maintenance visibility is controlled the same way. See Help:CS1 errors § Controlling error message display.

Template Data

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

TemplateData for ISBN

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

Template parameters[Edit template data]
Parameter		Description	Type	Status
ISBN #1	`1`	first ISBN to put in the list Example 0-674-01181-3	String	required
ISBN #2	`2`	second ISBN to put in the list Example 0-674-04200-3	String	suggested
ISBN #3	`3`	third ISBN to put in the list Example 0-674-01169-3	String	optional
ISBN #4	`4`	fourth ISBN to put in the list Example 0-674-01181-6	String	optional
ISBN #5	`5`	fifth ISBN to put in the list Example 0-674-02181-5	String	optional
6	`6`	no description	Unknown	optional
7	`7`	no description	Unknown	optional
8	`8`	no description	Unknown	optional
9	`9`	no description	Unknown	optional
Suppress link to article?	`link`	If 'no', does not produce a link before the list Example no	String	optional
Suppress link to ISBN?	`plainlink`	If 'yes', does not produce "[[ISBN]]: " before the list Example yes	String	optional
last list joiner text	`leadout`	Text between second-to-last and last book ISBN's Example as well as	String	optional

The above documentation is transcluded from Template:ISBN/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.