Template:ISBN/doc: Difference between revisions
m (1 revision imported) |
No edit summary |
||
Line 1: | Line 1: | ||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
{{Lua|Module:Check isxn}} |
{{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]]) --> |
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> |
||
== Usage == |
== 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). |
Use this template to create a link (or list of links) to [[Special:BookSources]] for one or more [[w:International Standard Book Number|International Standard Book Number]]s with the usual "ISBN" prefix. The template supports 10- and 13-digit ISBNs (with or without hyphens). |
||
<code><nowiki>{{ISBN|0-7475-3269-9}}</nowiki></code> |
<code><nowiki>{{ISBN|0-7475-3269-9}}</nowiki></code> |
||
Line 21: | Line 20: | ||
{{ISBN|978-1-4133-0454-1}} |
{{ISBN|978-1-4133-0454-1}} |
||
The idea is to switch from "[[Help:Magic links|magic link]]" syntax to more explicit syntax |
The idea is to switch from "[[mw:Help:Magic links|magic link]]" syntax to more explicit syntax. |
||
If more than one ISBN is given, the template will separate them using a comma: |
If more than one ISBN is given, the template will separate them using a comma: |
||
Line 39: | Line 38: | ||
{{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|978-1-4133-0454-1|leadout=, and}} |
||
If the leading "ISBN" should not |
If the leading "ISBN" text should not occur (for example in longer lists), it can be suppressed using the <code>noprefix=yes</code> parameter: |
||
<code><nowiki>{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1| |
<code><nowiki>{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1|noprefix=yes}}</nowiki></code> |
||
results in: |
results in: |
||
{{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|noprefix=yes}} |
||
⚫ | |||
If the leading "ISBN" link should not occur (for example in longer lists), it can be suppressed using the <code>plainlink=yes</code> parameter: |
|||
<code><nowiki>{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1| |
<code><nowiki>{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1|noprefix=yes|leadout=as well as}}</nowiki></code> |
||
results in: |
results in: |
||
{{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|noprefix=yes|leadout=as well as}} |
||
(Alternatively the {{tl|ISBNT}} template can be used.) |
|||
⚫ | |||
<code><nowiki>{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1|plainlink=yes|leadout=as well as}}</nowiki></code> |
|||
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 === |
=== Formatting === |
||
Line 94: | Line 83: | ||
===See also=== |
===See also=== |
||
* [[Wikipedia:ISBN]] |
* [[w:Wikipedia:ISBN]] |
||
* {{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|Format ISBN}}, to hyphenate an ISBN according to official rules |
|||
* {{tl|PMID}} |
|||
* {{tl|IETF RFC}} |
|||
* {{tl|ISMN}} |
|||
* {{tl|ISSN}} |
|||
* {{tl|Catalog lookup link}} |
* {{tl|Catalog lookup link}} |
||
* {{tl|ISBN missing|date=August 2019}} |
|||
==Template Data== |
==Template Data== |
||
Line 153: | Line 133: | ||
"type": "string" |
"type": "string" |
||
}, |
}, |
||
" |
"noprefix": { |
||
"label": "Suppress |
"label": "Suppress leading ISBN?", |
||
"description": "If 'yes', does not produce \" |
"description": "If 'yes', does not produce \"ISBN: \" before the list", |
||
"example": "yes", |
"example": "yes", |
||
"type": "string" |
"type": "string" |
Latest revision as of 10:25, 15 July 2020
Template:Strong for Template:Terminate sentence It contains usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
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:
ISBN 0-7475-3269-9
And:
{{ISBN|978-1-4133-0454-1}}
results in:
ISBN 978-1-4133-0454-1
The idea is to switch from "magic link" syntax to more explicit syntax.
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:
ISBN 978-1-4133-0454-1, 978-1-4133-0454-1, 978-1-4133-0454-1
Alternatively the conjunction 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:
ISBN 978-1-4133-0454-1, 978-1-4133-0454-1, and 978-1-4133-0454-1
If the leading "ISBN" text should not occur (for example in longer lists), it can be suppressed using the noprefix=yes
parameter:
{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1|noprefix=yes}}
results in:
978-1-4133-0454-1, 978-1-4133-0454-1, 978-1-4133-0454-1
The noprefix
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|noprefix=yes|leadout=as well as}}
results in:
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:
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 ISBN 1-4133-0451-0 Parameter error in {{ISBN}}: Invalid ISBN.
{{ISBN|1-4133-0451-0|invalid1=yes}}
produces ISBN 1-4133-0451-0
{{ISBN|1-4133-0451-0|invalid1=no}}
produces ISBN 1-4133-0451-0 Parameter error in {{ISBN}}: Invalid ISBN.
Tracking categories
- Category:Pages with ISBN errors (1)
- Category:Pages with listed invalid ISBNs (0)
- Category:Pages using ISBN template with unknown parameters (0)
See also
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 article? | link | If 'no', does not produce a link before the list
| String | optional |
Suppress leading ISBN? | noprefix | 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 |