Difference between revisions of "Template:ISBN/doc"
en>Daviddwd |
(No difference)
|
Revision as of 15:51, 25 December 2018
This is a documentation subpage for Template:ISBN. It contains usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
This template is used on 380,000+ pages. To avoid large-scale disruption and unnecessary server load, any changes to it should first be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can then be added to this page in a single edit. Please consider discussing changes on the talk page before implementing them. |
Usage
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. The template supports 10- and 13-digit ISBNs (with or without hyphens).
{{ISBN|0-7475-3269-9}}
results in:
<templatestyles src="Module:Citation/CS1/styles.css" />ISBN 0-7475-3269-9
And:
{{ISBN|978-1-4133-0454-1}}
results in:
<templatestyles src="Module:Citation/CS1/styles.css" />ISBN 978-1-4133-0454-1
The idea is to switch from "magic link" syntax to more explicit syntax. 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:
{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1}}
results in:
<templatestyles src="Module:Citation/CS1/styles.css" />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 leadout= parameter:
{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1|leadout=and}}
results in:
<templatestyles src="Module:Citation/CS1/styles.css" />ISBN 978-1-4133-0454-1, 978-1-4133-0454-1 and 978-1-4133-0454-1
It the leading "ISBN" link should not occur (for example in longer lists), it can be suppressed using the plainlink=yes parameter:
{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1|plainlink=yes}}
results in:
<templatestyles src="Module:Citation/CS1/styles.css" />978-1-4133-0454-1, 978-1-4133-0454-1, 978-1-4133-0454-1
(Alternatively the {{ISBNT}} template can be used.)
The plainlink and leadout parameter can be used at the same time:
{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1|plainlink=yes|leadout=as well as}}
results in:
<templatestyles src="Module:Citation/CS1/styles.css" />978-1-4133-0454-1, 978-1-4133-0454-1 as well as 978-1-4133-0454-1
Formatting
The template preserves the formatting of the input values, for example:
{{ISBN|978-1-4133-0454-1|978141330454-1|978 1-41330-454-1}}
results in:
<templatestyles src="Module:Citation/CS1/styles.css" />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 invalid?=yes (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.
- {{ISBN|1-4133-0451-0}} produces <templatestyles src="Module:Citation/CS1/styles.css" />ISBN 1-4133-0451-0 Parameter error in {{ISBN}}: Invalid Wikipedia:ISBN.
- {{ISBN|1-4133-0451-0|invalid1=yes}} produces <templatestyles src="Module:Citation/CS1/styles.css" />ISBN 1-4133-0451-0
- {{ISBN|1-4133-0451-0|invalid1=no}} produces <templatestyles src="Module:Citation/CS1/styles.css" />ISBN 1-4133-0451-0 Parameter error in {{ISBN}}: Invalid Wikipedia:ISBN.
- {{ISBN}} produces Parameter error in {{ISBN}}: Missing Wikipedia:ISBN.
See also
- Wikipedia:ISBN
- {{ISBNT}}, to make an ISBN link without a visible prefix
- {{Listed Invalid ISBN}}, to link an ISBN that is invalid but printed in a source publication.
- {{PMID}}
- {{IETF RFC}}
- {{ISMN}}
- {{ISSN}}
- {{Catalog lookup link}}
Template Data
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
Parameter | Description | Type | Status | |
---|---|---|---|---|
ISBN #1 | 1 | first ISBN to put in the list
| String | required |
ISBN #2 | 2 | second ISBN to put in the list
| String | suggested |
ISBN #3 | 3 | third ISBN to put in the list
| String | optional |
ISBN #4 | 4 | fourth ISBN to put in the list
| String | optional |
ISBN #5 | 5 | fifth ISBN to put in the list
| 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 ISBN? | plainlink | If 'yes', does not produce "[[ISBN]]: " before the list
| String | optional |
last list joiner text | leadout | Text between second-to-last and last book ISBN's
| String | optional |
Invalid1 | invalid1 | no description | Unknown | optional |
Invalid2 | invalid2 | no description | Unknown | optional |
Invalid3 | invalid3 | no description | Unknown | optional |
Invalid4 | invalid4 | no description | Unknown | optional |
Invalid5 | invalid5 | no description | Unknown | optional |
Invalid6 | invalid6 | no description | Unknown | optional |
Invalid7 | invalid7 | no description | Unknown | optional |
Invalid8 | invalid8 | no description | Unknown | optional |
Invalid9 | invalid9 | no description | Unknown | optional |