Difference between revisions of "Template:ISBN/doc"

From blackwiki
Jump to navigation Jump to search
(→‎See also: Add explanation of Template:ISBNT)
imported>Pokechu22
(Reverted 1 edit by 105.112.106.173 (talk): Unexplained removal)
 
(30 intermediate revisions by 18 users not shown)
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).
 +
 
<code><nowiki>{{ISBN|0-7475-3269-9}}</nowiki></code>
 
<code><nowiki>{{ISBN|0-7475-3269-9}}</nowiki></code>
  
Line 9: Line 13:
 
{{ISBN|0-7475-3269-9}}
 
{{ISBN|0-7475-3269-9}}
  
The idea is to switch from "[[Help:Magic links|magic link]]" syntax to more explicit syntax.
+
And:
 +
 
 +
<code><nowiki>{{ISBN|978-1-4133-0454-1}}</nowiki></code>
 +
 
 +
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:
 +
 
 +
<code><nowiki>{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1}}</nowiki></code>
 +
 
 +
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 <code>leadout=</code> parameter:
 +
 
 +
<code><nowiki>{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1|leadout=, and}}</nowiki></code>
 +
 
 +
results in:
 +
 
 +
{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1|leadout=, and}}
 +
 
 +
If the leading "ISBN" should not be a link (for example because it is already linked in the article), the link can be suppressed using the <code>link=no</code> parameter:
 +
 
 +
<code><nowiki>{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1|link=no}}</nowiki></code>
 +
 
 +
results in:
 +
 
 +
{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1|link=no}}
 +
 
 +
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|plainlink=yes}}</nowiki></code>
 +
 
 +
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 <code>plainlink</code> and <code>leadout</code> parameter can be used at the same time:
 +
 
 +
<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 ===
 +
 
 +
The template preserves the formatting of the input values, for example:
 +
 
 +
<code><nowiki>{{ISBN|978-1-4133-0454-1|978141330454-1|978 1-41330-454-1}}</nowiki></code>
 +
 
 +
results in:
 +
 
 +
{{ISBN|978-1-4133-0454-1|978141330454-1|978 1-41330-454-1}}
  
 
===Error checking===
 
===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]].
 
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 <code>invalid?=yes</code> (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]].
 +
 +
* <code><nowiki>{{ISBN|1-4133-0451-0}}</nowiki></code> &nbsp; produces {{ISBN|1-4133-0451-0}}
 +
 +
* <code><nowiki>{{ISBN|1-4133-0451-0|invalid1=yes}}</nowiki></code> &nbsp; produces {{ISBN|1-4133-0451-0|invalid1=yes}}
 +
 +
* <code><nowiki>{{ISBN|1-4133-0451-0|invalid1=no}}</nowiki></code> &nbsp; produces {{ISBN|1-4133-0451-0|invalid1=no}}
 +
 +
* <code><nowiki>{{ISBN}}</nowiki></code> &nbsp; produces {{ISBN}}
 +
 +
===Tracking categories===
 +
*{{clc|Pages with ISBN errors}}
 +
*{{clc|Pages with listed invalid ISBNs}}
 +
*{{clc|Pages using ISBN template with unknown parameters}}
  
 
===See also===
 
===See also===
 
* [[Wikipedia:ISBN]]
 
* [[Wikipedia:ISBN]]
 +
* {{tl|SBN}}, similar template for SBNs rather than ISBNs
 
* {{tl|ISBNT}}, to make an ISBN link without a visible prefix
 
* {{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|OCLC}}, to link directly to Worldcat; useful for books with no ISBN.
 
* {{tl|PMID}}
 
* {{tl|PMID}}
 
* {{tl|IETF RFC}}
 
* {{tl|IETF RFC}}
 
* {{tl|ISMN}}
 
* {{tl|ISMN}}
 
* {{tl|ISSN}}
 
* {{tl|ISSN}}
 +
* {{tl|Catalog lookup link}}
 +
* {{tl|ISBN missing|date=August 2019}}
 +
 +
==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": {},
 +
"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"
 +
},
 +
"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>
  
<includeonly>
+
<includeonly>{{Sandbox other||
 
[[Category:Catalog lookup templates]]
 
[[Category:Catalog lookup templates]]
 
[[Category:International Standard Book Number templates]]
 
[[Category:International Standard Book Number templates]]
</includeonly>
+
[[Category:Wikipedia formatting and function templates|{{PAGENAME}}]]
 +
}}</includeonly>

Latest revision as of 06:27, 20 December 2020

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. 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:

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" should not be a link (for example because it is already linked in the article), the link can be suppressed using the link=no parameter:

{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1|link=no}}

results in:

ISBN 978-1-4133-0454-1, 978-1-4133-0454-1, 978-1-4133-0454-1

If 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:

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:

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}}   produces Parameter error in {{ISBN}}: Missing ISBN.

Tracking categories

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

Template parameters

ParameterDescriptionTypeStatus
ISBN #11

first ISBN to put in the list

Example
0-674-01181-3
Stringrequired
ISBN #22

second ISBN to put in the list

Example
0-674-04200-3
Stringsuggested
ISBN #33

third ISBN to put in the list

Example
0-674-01169-3
Stringoptional
ISBN #44

fourth ISBN to put in the list

Example
0-674-01181-6
Stringoptional
ISBN #55

fifth ISBN to put in the list

Example
0-674-02181-5
Stringoptional
66

no description

Unknownoptional
77

no description

Unknownoptional
88

no description

Unknownoptional
99

no description

Unknownoptional
Suppress link to article?link

If 'no', does not produce a link before the list

Example
no
Stringoptional
Suppress link to ISBN?plainlink

If 'yes', does not produce "[[ISBN]]: " before the list

Example
yes
Stringoptional
last list joiner textleadout

Text between second-to-last and last book ISBN's

Example
as well as
Stringoptional
Invalid1invalid1

no description

Unknownoptional
Invalid2invalid2

no description

Unknownoptional
Invalid3invalid3

no description

Unknownoptional
Invalid4invalid4

no description

Unknownoptional
Invalid5invalid5

no description

Unknownoptional
Invalid6invalid6

no description

Unknownoptional
Invalid7invalid7

no description

Unknownoptional
Invalid8invalid8

no description

Unknownoptional
Invalid9invalid9

no description

Unknownoptional