Difference between revisions of "Template:ISBN/doc"

From blackwiki
Jump to navigation Jump to search
test>Matthiaspaul
(Updated documentation)
test>Matthiaspaul
(Removed sandbox)
Line 10: Line 10:
 
results in:
 
results in:
  
{{ISBN/sandbox|0-7475-3269-9}}
+
{{ISBN|0-7475-3269-9}}
  
 
And:
 
And:
Line 18: Line 18:
 
results in:
 
results in:
  
{{ISBN/sandbox|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. {{oldid2|772133164|Future of magic links|This March 2017 (English Wikipedia) RfC}} determined the magic link should be replaced by this template.
 
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.
Line 28: Line 28:
 
results in:
 
results in:
  
{{ISBN/sandbox|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}}
  
 
Alternatively the conjugation between the last two list items can be defined using the <tt>leadout=</tt> parameter:
 
Alternatively the conjugation between the last two list items can be defined using the <tt>leadout=</tt> parameter:
Line 36: Line 36:
 
results in:
 
results in:
  
{{ISBN/sandbox|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}}
  
 
It the leading "ISBN" link should not occur (for example in longer lists), it can be suppressed using the <tt>plainlink=yes</tt> parameter:
 
It the leading "ISBN" link should not occur (for example in longer lists), it can be suppressed using the <tt>plainlink=yes</tt> parameter:
Line 44: Line 44:
 
results in:
 
results in:
  
{{ISBN/sandbox|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1|plainlink=yes}}
+
{{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.)
 
(Alternatively the {{tl|ISBNT}} template can be used.)
Line 54: Line 54:
 
results in:
 
results in:
  
{{ISBN/sandbox|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1|plainlink=yes|leadout=as well as}}
+
{{ISBN|978-1-4133-0454-1|978-1-4133-0454-1|978-1-4133-0454-1|plainlink=yes|leadout=as well as}}
  
 
===Error checking===
 
===Error checking===
Line 61: Line 61:
 
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 <tt>invalid?=yes</tt> (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]].
 
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 <tt>invalid?=yes</tt> (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]].
  
* <tt><nowiki>{{ISBN|1-4133-0451-0}}</nowiki></tt> &nbsp; produces {{ISBN/sandbox|1-4133-0451-0}}
+
* <tt><nowiki>{{ISBN|1-4133-0451-0}}</nowiki></tt> &nbsp; produces {{ISBN|1-4133-0451-0}}
  
* <tt><nowiki>{{ISBN|1-4133-0451-0|invalid1=yes}}</nowiki></tt> &nbsp; produces {{ISBN/sandbox|1-4133-0451-0|invalid1=yes}}
+
* <tt><nowiki>{{ISBN|1-4133-0451-0|invalid1=yes}}</nowiki></tt> &nbsp; produces {{ISBN|1-4133-0451-0|invalid1=yes}}
  
* <tt><nowiki>{{ISBN|1-4133-0451-0|invalid1=no}}</nowiki></tt> &nbsp; produces {{ISBN/sandbox|1-4133-0451-0|invalid1=no}}
+
* <tt><nowiki>{{ISBN|1-4133-0451-0|invalid1=no}}</nowiki></tt> &nbsp; produces {{ISBN|1-4133-0451-0|invalid1=no}}
  
* <tt><nowiki>{{ISBN}}</nowiki></tt> &nbsp; produces {{ISBN/sandbox}}
+
* <tt><nowiki>{{ISBN}}</nowiki></tt> &nbsp; produces {{ISBN}}
  
 
===See also===
 
===See also===

Revision as of 12:11, 4 September 2017

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

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:

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

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.

See also