Difference between revisions of "Template:ISBN missing/doc"

From blackwiki
Jump to navigation Jump to search
imported>Knife-in-the-drawer
(Added two templates)
imported>Knife-in-the-drawer
(Previous documentation was very well written. Just tightened it up a little and removed some excess information.)
Line 3: Line 3:
 
{{Nosubst}}<includeonly>{{template shortcut|ISBN?}}</includeonly>
 
{{Nosubst}}<includeonly>{{template shortcut|ISBN?}}</includeonly>
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{selfref|This template is an in-line request '''for the ISBN of a published source'''.}}
+
{{Tl|ISBN missing}} is an inline cleanup template for flagging a reference that is missing the [[International Standard Book Number|International Standard Book Number (ISBN)]] of the source document.
 
 
{{Tl|ISBN missing}} is an inline cleanup template flagging a broken source citation that is missing the ISBN of the cited source.
 
  
 
==Usage==
 
==Usage==
 
{{Tld|ISBN missing|date&#61;{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
 
{{Tld|ISBN missing|date&#61;{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
  
*With references in a {{cs1}} template ({{Tlx|Cite web}}, {{Tlx|Cite book}}, {{Tlx|Citation}}, etc.):
+
*With a reference formatted via a [[Help:Citation Style 1#Templates|Citation Style 1 template]] ({{Tlx|Cite web}}, {{Tlx|Cite book}}, {{Tlx|Citation}}, etc.):
**Place {{Tlx|ISBN missing<!--|{{grey|<nowiki>{{subst:DATE}}</nowiki>}}-->}} outside the citation template
+
:#Place {{Tld|ISBN missing|date&#61;{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} outside the citation template
**{{warnsign|Do not place this template in the {{para|isbn}} parameter of a {{cs1}} citation.  The inclusion of text other than an ISBN in {{para|isbn}} corrupts the citation's [[WP:COinS|COinS]] metadata and the citation's link to [[Special:BookSources]].}}
+
:#{{warnsign|Do not place it in the {{para|isbn}} parameter of a Citation Style 1 template.  The inclusion of text other than the digits of an ISBN in {{para|isbn}} corrupts the citation's [[WP:COinS|COinS]] metadata and the citation's link to [[Special:BookSources]].}}
*With a free-form reference citation, just append {{Tlx|ISBN missing<!--|{{grey|<nowiki>{{subst:DATE}}</nowiki>}}-->}} to the end of the citation.
+
*With a free-form reference, just append {{Tld|ISBN missing|date&#61;{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} to the end of the citation.
<!--
 
If you're really lazy, you can omit the optional date stuff: {{Tlx|ISBN missing}}
 
  
If you're weird, you can do the date manually: {{Tlx|ISBN missing|{{grey|date&#61;{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}}}
+
==How to fix the problem flagged by this template==
-->
 
  
==How to fix the problem flagged by this template==
+
'''<span style="color:red">Do not remove the <nowiki>{{ISBN missing}}</nowiki> template without fixing the problem in one of the following ways:</span>'''
'''Do not remove the template without fixing the problem one of the following ways.'''
 
  
*If you ''know the ISBN'', fill in the needed information, and remove the template.
+
*'''Determine the ISBN, add it to the reference, then remove the <nowiki>{{ISBN missing}}</nowiki> template'''
*;For a template-formatted citation, add the ISBN:
+
:For a reference formatted via a [[Help:Citation Style 1#Templates|Citation Style 1 template]], use its ISBN paramter:
*#{{para|ISBN|<var>X-XXXX-XXXX-X</var>}}
+
::{{para|ISBN|<var>X-XXXX-XXXX-X</var>}}
*;For a free-form citation::
+
:For a free-form reference:
*#Just add the ISBN as appropriate to the format of the citation; or...
+
:#Add the ISBN as appropriate to the citation, or...
*#''Better yet'', convert the entire citation to {{Tl|Cite journal}}, {{Tl|Cite news}} or some other {{Tl|Cite}}-series template, as appropriate for the work in question.
+
:#''Better yet'', convert the citation to a [[Help:Citation Style 1#Templates|Citation Style 1 template]].
  
*If you ''know that no ISBN was specified'' by the original source, as is common with older books, you have the following option.<!--???-->
+
*'''If you are certain that the source document does not have an ISBN, add a {{tl|No ISBN}} template to the reference, then remove the <nowiki>{{ISBN missing}}</nowiki> template'''
*#Explicitly state that the ISBN was unspecified:
+
:For a reference formatted via a [[Help:Citation Style 1#Templates|Citation Style 1 template]]:
*#:{{para|ISBN|<nowiki><!-- ISBN unspecified --></nowiki>}} (''you must use HTML'' <code><nowiki><!--  --></nowiki></code> ''comment tags to hide the message from the citation processing software'')
+
::1. Use its ISBN paramter to state explicitly that the ISBN does not exist:
*:For free-form citations:
+
:::{{para|ISBN|<nowiki><!-- ISBN unspecified --></nowiki>}} (''you must use HTML'' <code><nowiki><!--  --></nowiki></code> ''comment tags to hide the message from the citation processing software'')
*:::<code>No ISBN specified.</code>
+
::2. Place {{Tlx|No ISBN}} outside the citation template
*:Do ''not'' use question marks.
+
:For free-form reference, just add {{Tlx|No ISBN}} to the end of the citation.
*:Do ''not'' leave the information blank and untag it, or someone else will just come along later and flag this with {{Tl|ISBN missing}} again!
 
*:Do ''not'' use {{para|ISBN|none}}, {{para|ISBN|unknown}} or anything else vague; any implication other than that ''the source itself'' did not specify an ISBN is simply a signal to other editors to re-tag it with {{Tl|ISBN missing}}.
 
  
*If you ''don't know'':
+
'''<span style="color:red">If you remove the <nowiki>{{ISBN missing}}</nowiki> template without fixing the problem in one of the above ways, someone else will come along later and flag the reference with <nowiki>{{ISBN missing}}</nowiki> again!</span>'''
*#Check the source, and add the necessary information, as above.
 
*:Do ''not'' use question marks.
 
*:If the source is a dead link, check archive.org for a backup copy (see your {{Tl|Citation}}/{{Tl|Cite}}-type template's documentation for use of {{para|archiveurl}} and {{para|archivedate}} parameters). If no archive copy is available, use {{Tl|Dead link}} after the citation, but leave {{Tl|ISBN missing}} as well.
 
  
 
==See also==
 
==See also==
{{Citation repair}}
+
*{{cl|Citation Style 1 templates}}, includes all Citation Style 1 templates
;Other
+
*[[Wikipedia:ISBN]], describes how to add an ISBN to an article
* {{Tl|List years}}, for missing years in lists
+
*[[Help:Magic links#ISBN]], a very brief description about adding an ISBN to an article
* {{Tl|Please check ISBN}}, for present but invalid ISBN
 
 
 
{{Inline tags}}
 
  
 
<includeonly>
 
<includeonly>

Revision as of 18:00, 28 June 2015

{{ISBN missing}} is an inline cleanup template for flagging a reference that is missing the International Standard Book Number (ISBN) of the source document.

Usage

{{ISBN missing|date=March 2026}}

  1. Place {{ISBN missing|date=March 2026}} outside the citation template
  2. Template:Warnsign
  • With a free-form reference, just append {{ISBN missing|date=March 2026}} to the end of the citation.

How to fix the problem flagged by this template

Do not remove the {{ISBN missing}} template without fixing the problem in one of the following ways:

  • Determine the ISBN, add it to the reference, then remove the {{ISBN missing}} template
For a reference formatted via a Citation Style 1 template, use its ISBN paramter:
|ISBN=X-XXXX-XXXX-X
For a free-form reference:
  1. Add the ISBN as appropriate to the citation, or...
  2. Better yet, convert the citation to a Citation Style 1 template.
  • If you are certain that the source document does not have an ISBN, add a {{No ISBN}} template to the reference, then remove the {{ISBN missing}} template
For a reference formatted via a Citation Style 1 template:
1. Use its ISBN paramter to state explicitly that the ISBN does not exist:
|ISBN=<!-- ISBN unspecified --> (you must use HTML <!-- --> comment tags to hide the message from the citation processing software)
2. Place {{No ISBN}} outside the citation template
For free-form reference, just add {{No ISBN}} to the end of the citation.

If you remove the {{ISBN missing}} template without fixing the problem in one of the above ways, someone else will come along later and flag the reference with {{ISBN missing}} again!

See also