Help:CS1 errors
 |
This page is a how-to guide detailing a practice or process on the English Wikipedia.
|
| {{Citation}} |  |
| {{Cite album-notes}} | |
| {{Cite AV media}} | |
| {{Cite book}} | |
| {{Cite conference}} | |
| {{Cite DVD-notes}} | |
| {{Cite encyclopedia}} | |
| {{Cite episode}} | |
| {{Cite interview}} | |
| {{Cite journal}} | |
| {{Cite mailing list}} | |
| {{Cite map}} | |
| {{Cite music release notes}} | |
| {{Cite news}} | |
| {{Cite newsgroup}} | |
| {{Cite podcast}} | |
| {{Cite press release}} | |
| {{Cite serial}} | |
| {{Cite sign}} | |
| {{cite speech}} | |
| {{cite techreport}} | |
| {{Cite thesis}} | |
| {{Cite web}} | |
This page describes the error messages reported by Citation Style 1 citations, what they mean, and how editors might resolve the errors.
Prior to 2013, the CS1 templates used the meta-template {{Citation/core}}. In 2013, as part of the WP:LUA project, Wikipedia editors upgraded the CS1 series of templates using a single Lua module. Module:Citation/CS1 is the engine that controls how CS1 citations are displayed and how citation data are passed to external referencing tools through COinS metadata. The benefits of the upgrade are enhanced performance, reduced complexity and redundancy, and for the purposes of this page, improved error detection, categorization, and reporting.
[edit] Controlling error message display
During Citation Style 1 development, many of the new error messages are hidden. Hidden messages are exposed as development proceeds. Editors who wish to see all of the CS1 error messages can do so by updating their common or skin CSS stylsheet to include:
.citation-comment {display: inline !important;} /* show all Citation Style 1 error messages */
Editors who do not wish to see any of the CS1 error messages can hide them all by updating their common or skin CSS stylesheet to include:
.citation-comment {display: none;} /* hide all Citation Style 1 error messages */
[edit] |accessdate= requires |url=
|accessdate= requires |url=
The |accessdate= parameter is used to identify the date that the web resource addressed by |url= was accessed. Without |url=, |accessdate= is meaningless. When |url= is omitted or left blank, the |accessdate= value is not displayed.
To resolve this error, provide a value for |url= or remove |accessdate=.
Pages with this error are automatically placed in Category:Pages using citations with accessdate and no URL.[a]
[edit] |archiveurl= requires |archivedate=
|archiveurl= requires |archivedate=
|archivedate= identifies the date that the web resource was archived.
To resolve this error, provide a value for |archivedate=. For web resources archived at archive.org,[1] the archival date can be found in the |archiveurl=; for resources archived at webcitation.org,[2] the cache date is included in the archive header.
Pages with this error are automatically placed in Category:Pages with archiveurl citation errors.[a]
[edit] |archiveurl= requires |url=
|archiveurl= requires |url=
A properly formatted citation that includes |archiveurl= and |archivedate= requires |url=. When the citation includes |deadurl=no, the ordering of elements in the rendered citation is changed to put the original url first.
To resolve this error, provide a value for |url=. For web resources archived at archive.org,[1] the original url can be found in the |archiveurl= value; for resources archived at webcitation.org,[2] the original url is included in the archive header.
Pages with this error are automatically placed in Category:Pages with archiveurl citation errors.[a]
[edit] Check |doi= value
Check |doi= value
When CS1 citations contain |doi=, a test is done to see if the prefix portion of the DOI value contains the proper "10." registry identifier. Further validation of the DOI is not performed.
To resolve this error, ensure that the |doi= value is correct.
Pages with this error are automatically placed in Category:Pages with DOI errors.[a]
[edit] Check |isbn= value
Check |isbn= value
Citation Style 1 templates that contain |isbn= are checked to ensure that the ISBN is the proper length (ten or thirteen digits) and validate the final check digit according to the ISBN specification. Only one ISBN is allowed in this field because the whole |isbn= value is included in the citation's COinS metadata. See also Wikipedia:COinS. More than one ISBN, or characters that are not part of the ISBN, corrupt the COinS metadata and will also corrupt the link to Special:BookSources.
To resolve this error, ensure that the |isbn= value is correct, that only one ISBN is used, and that no other text is included. Use the 13-digit ISBN when it is available.
In very rare cases, publishers have released books with malformed ISBNs. If you are certain that a non-conforming ISBN truly corresponds to the published work, then add |ignore-isbn-error=true to the citation suppress the error message. In many cases books may have been reissued with a corrected ISBN. Use a corrected ISBN when possible.
Pages with this error are automatically placed in Category:Pages with ISBN errors.[a]
[edit] Check |ol= value
Check |ol= value
The |ol= parameter is the Open Library identifier. It is checked to ensure that the last character is either A (authors), M (books), or W (works). Further validation is not performed.
To resolve this error, ensure that the |ol= value is correct.
Pages with this error are automatically placed in Category:Pages with OL errors.[a]
[edit] Check |url= scheme
Check |url= scheme
External links in CS1 citations are made from two parts: the title (|title=, |chapter=, etc) and the URL (|url=, |chapter-url= etc). The |url= portion must begin with a supported URI scheme. The URI schemes http://, https:// and the protocol relative scheme // are most commonly used; irc://, ircs://, ftp://, news:, mailto: and gopher:// are also supported.
The URL field is checked to ensure it includes either a colon (:) or the the double forward slash (//). Further validation is not performed.
To resolve this error, ensure that the |url= value is correct.
Pages with this error are automatically placed in Category:Pages with URL errors.[a]
[edit] |displayauthors= suggested
|displayauthors= suggested
Prior to the introduction of Lua-based citations, the citation formatting templates were designed to support no more than nine authors. If nine (or more) author parameters were specified, then the template would display eight author names followed by "et al." to indicate that the list had been truncated. Some editors relied on this behavior to include the "et al." label. For example:
| {{ cite book | last12=Twelfth | last6=Sixth | last10=Tenth | last3=Third | last2=Second | last11=Eleventh | last7=Seventh | title=Twelve Little Authors | last4=Fourth | last9=Ninth | last8=Eighth | last5=Fifth | last=First }} | |
| Old | First; Second; Third; Fourth; Fifth; Sixth; Seventh; Eighth et al. Twelve Little Authors. |
| Lua | First; Second; Third; Fourth; Fifth; Sixth; Seventh; Eighth; Ninth; Tenth; Eleventh; Twelfth. Twelve Little Authors. |
The Lua-based citation templates can accommodate an arbitrarily large number of authors. As with the old templates, the Lua-based templates can explicitly include an "et al." label with the |display-authors= parameter.
| {{ cite book | last12=Twelfth | last6=Sixth | last10=Tenth | display-authors=3 | last3=Third | last2=Second | last11=Eleventh | last7=Seventh | title=Twelve Little Authors | last4=Fourth | last9=Ninth | last8=Eighth | last5=Fifth | last=First }} | |
| Old | First; Second; Third et al. Twelve Little Authors. |
| Lua | First; Second; Third et al. Twelve Little Authors. |
The old-style templates supported at most nine authors. The new Lua-based templates cannot know if editors created citations with exactly nine authors because there were only nine authors or, because old-style citations were limited to nine authors. This error message is reported by citations with exactly nine authors but without |displayauthors=. To preserve the behavior of old-style citations, Lua-based citations display "et al." in place of the ninth author.
To resolve this error, add the remaining authors to the citation or set |displayauthors= to 8 or some lesser value to truncate the author list. If there are exactly nine authors, then set |displayauthors= to 9 or higher to display all nine authors without "et al."
Pages with this error are automatically placed in Category:Pages using citations with old-style implicit et al.[a]
[edit] |displayeditors= suggested
|displayeditors= suggested
Prior to the introduction of Lua-based citations, the citation formatting templates were designed to support no more than four editors. Specifically, if four (or more) editor parameters were specified, then the template would display three editor names followed by "et al." to indicate that the list had been truncated. Some editors relied on this behavior to include the "et al." label. For example:
| {{ cite book | last=Milquetoast | editor-last=First | first=Caspar | title=If You don't Think it Presumptuous of Me | editor5-last=Fifth | authorlink=Caspar Milquetoast | editor2-last=Second | editor4-last=Fourth | editor3-last=Third }} | |
| Old | Milquetoast, Caspar. First; Second; Third et al. eds. If You don't Think it Presumptuous of Me. |
| Lua | Milquetoast, Caspar. In First; Second; Third; Fourth; Fifth. If You don't Think it Presumptuous of Me. |
The Lua-based citation templates can accommodate an arbitrarily large number of editors. The Lua-based templates can also explicitly include an "et al." label with the new |displayeditors= parameter, a parameter that was not available to the old-style templates.
| {{ cite book | last=Milquetoast | editor-last=First | first=Caspar | displayeditors=2 | title=If You don't Think it Presumptuous of Me | editor5-last=Fifth | authorlink=Caspar Milquetoast | editor2-last=Second | editor4-last=Fourth | editor3-last=Third }} | |
| Old | Milquetoast, Caspar. First; Second; Third et al. eds. If You don't Think it Presumptuous of Me. |
| Lua | Milquetoast, Caspar. In First; Second et al. If You don't Think it Presumptuous of Me. |
The old-style templates supported at most four editors. The new Lua-based templates cannot know if Wikipedia editors created citations with exactly four editors because there were only four editors or, because old-style citations were limited to four editors. This error message is reported by citations with exactly four editors but without |displayeditors=. To preserve the behavior of old-style citations, Lua-based citations display "et al." in place of the fourth editor.
To resolve this error, add the remaining editors to the citation or set |displayeditors= to 3 or some lesser value to truncate the editor list. If there are exactly four editors, then set |displayeditors= to 4 or higher to display all four editors without including "et al."
Pages with this error are automatically placed in Category:Pages using citations with old-style implicit et al.[a]
[edit] Empty citation
Empty citation
"Empty" may mean that the CS1 citation contains no recognizable parameter identifiers. For example this citation isn't "empty" because it contains usable information, but is "empty" because it doesn't contain the necessary parameter identifiers (in this case |url= and |title=) that tell {{cite web}} how to use the information that the citation does contain:
{{cite web | http://www.foobar.com | The Foobar Bar}}
To resolve this error, add appropriate parameter identifiers. Consider the possibility that the editor meant to use another template entirely. Perhaps the editor used {{citation}} when the intent was to use {{citation needed}} or {{quote}}. In these cases replace the CS1 citation with the appropriate template.
Pages with this error are automatically placed in Category:Pages with empty citations.[a]
[edit] Extra |pages or |at
Extra |pages or |at
This error occurs when CS1 citations attempt to simultaneously use more than one of the parameters: |page=, |pages=, or |at=. Each of these parameters is meant to provide a different way of specifying the location of the cited content within a larger work, and only one of these parameters is displayed in any rendered citation. According to their intended purpose, |page= should be used to specify a single page that is relevant to the cited content, |pages= should be used to specify a range or list of pages (e.g. 37–42) that are relevant, and |at= should be used to indicate a location in the larger work that is not a numbered page (e.g. "back cover"). Sometimes, editors misunderstand the meaning of |pages=, and attempt to use it to indicate the total number of pages in the resource.
When |page= is used with either or both of |pages= or |at=, only the |page= value is displayed. Similarly, when |pages= is used with |at=, only the |pages= value is displayed.
To resolve this error, remove the inappropriate parameter.
Pages with this error are automatically placed in Category:Pages with citations using conflicting page specifications.[a]
[edit] |format= requires |url=
|format= requires |url=
This error occurs when CS1 citations use |format= without also providing a url for |url=. The |format= parameter is used to specify the file format of a web resource (e.g. PDF, DOC, XLS, etc.). In some cases an editor may have intended to use |type= to specify a kind of document (e.g. hard cover, paperback, pamphlet, etc.) The |format= value is always displayed.
To resolve this error, remove |format= or define |url= or change |format= to |type=.
Pages with this error are automatically placed in Category:Pages using citations with format and no URL.[a]
[edit] Missing or empty |title=
There are two slightly different error conditions that can arise when CS1 citations lack appropriate titles. In each case, CS1 reports this error message. The necessary resolution may vary depending on the cause of the error. The error message links to the appropriate description below.
[edit] Bare URL without a title
Missing or empty |title=
All Lua-based CS1 citations report this error when one of the URL-containing parameters cannot be paired with an associated title. This error may also occur when |title= cannot be linked with |url= because the citation also contains a conflicting |titlelink= parameter.
| URL parameters | Title parameters |
|---|---|
|chapterurl= |
|chapter=, |contribution=, |entry=, |article= |
|conferenceurl= |
|conference= |
|contributionurl= |
|chapter=, |contribution=, |entry=, |article= |
|transcripturl= |
|transcript= |
Because URLs are ugly and generally uninformative, it is expected that editors should provide a meaningful title for each URL. In most cases this can be accomplished by using the |title= parameter.
To resolve this error, provide an appropriate title for the URL-containing parameter. In the case where |url= and |titlelink= are contending for |title= you must choose which one to keep. Consider moving |url= or |titlelink= to a more suitable parameter.
Pages with this error are automatically placed in Category:Pages with citations having bare URLs.[a]
[edit] Citation without a title of any form
Missing or empty |title=
This error occurs for CS1 citations when all of the associated title parameters are omitted or left blank. Depending on the type of citation ({{cite web}}, {{cite book}}, {{cite journal}}, etc.), the possible title parameters may include |title=, |chapter=, |article=, |journal=, |booktitle=, and so forth. At least one such title parameter must be provided for each citation.
Sometimes this error occurs because an editor has used a CS1 citation as a shortened footnote when {{sfn}} or one of the {{harv}} family of templates would have been more appropriate.
To resolve this error, provide a value for |title= or, when used as a shortened footnote substitute, replace the CS1 citation with an appropriate shortened footnote template.
Pages with this error are automatically placed in Category:Pages with citations lacking titles.[a]
[edit] Missing or empty |url=
Missing or empty |url=
This is error message is reported only by {{cite web}} CS1 citations where |url= is blank or omitted. The |url= parameter is required so that |title= can link to the web resource.
To resolve this error, provide a value for |url= or use a more appropriate CS1 citation.
Pages with this error are automatically placed in Category:Pages using web citations with no URL.[a]
[edit] More than one of |param1=, |param2=, and |param3= specified
More than one of |param1=, |param2=, and |param3= specified
This error occurs when a CS1 citation includes more than one parameter that maps to the same meaning. For example, |author=, |last=, and |last1= are all synonyms of each other, so no more than one of these parameters should ever be used in a single citation.
To resolve this error, remove or modify the redundant parameter(s).
Pages with this error are automatically placed in Category:Pages with citations having redundant parameters.[a]
[edit] Text "????" ignored
Text "????" ignored
Unlike many Wikipedia templates, the CS1 citations do not use unnamed or positional parameters. When a citation contains text between vertical bars and that text does not contain an equal sign (=), CS1 ignores the text and reports the error. This is true even when the text is the name of a valid parameter.
This error can also caused by vertical bars that are part of URLs or titles. When vertical bars occur in URLs, replace each vertical bar with %7c. When vertical bars occur in parameter values that are not URLs, replace each vertical bar with |.
To resolve this error, remove the extraneous text, add '=', add an appropriate parameter name to complete the parameter, or properly encode vertical bars in URLs and titles.
Pages with this error are automatically placed in Category:Pages with citations using unnamed parameters.[a]
[edit] |trans-chapter= requires |chapter=
|trans-chapter= requires |chapter=
This error occurs when a CS1 citation has an English translation of a chapter title in |trans-chapter= but does not have the original-language chapter title in |chapter=.
To resolve this error, provide a value for |chapter=. Consider adding |language= if not already part of the citation.
Pages with this error are automatically placed in Category:Pages with citations using translated terms without the original.[a]
[edit] |trans-title= requires |title=
|trans-title= requires |title=
CS1 citations report this error when the citation has an English translation of the title in |trans-title= but does not have the original-language title in |title=.
To resolve this error, provide the original language title for |title=. Consider adding |language= if not already part of the citation.
Pages with this error are automatically placed in Category:Pages with citations using translated terms without the original.[a]
[edit] Unknown parameter |????= ignored
Unknown parameter ????= ignored
CS1 citations report this error when the name portion of a parameter's |name=value pair is not recognized as a valid name. Typically, this is caused by spelling errors.
With the old-style citation templates, it was possible to include information within the template that was simply ignored as unrecognized parameters. The Lua-based CS1 engine does not ignore unrecognized parameters. The purpose of the citation is to properly identify the source; not as as repository of notes and ancillary information.
To resolve this error, ensure that the parameter's name is correctly spelled and that there are no characters except spaces between the parameter's name and the leading vertical bar (|) or trailing equal sign (=). A list of valid parameters can be found by consulting Help:Citation Style 1 or visiting the description page of the specific template being used, such as {{cite web}}, {{cite book}}, {{cite journal}}, etc. Consider moving information associated with the unknown parameter into an appropriate parameter or to a section of the article's talk page for preservation.
For frequently encountered spelling errors, consider adding the misspelled parameter name to the list of common parameter misspellings.
Pages with this error are automatically placed in Category:Pages with citations using unsupported parameters.[a]
[edit] Unknown parameter |xxxx= ignored (|yyyy= suggested)
Unknown parameter |xxxx= ignored (|yyyy= suggested)
CS1 citations report this error when the name portion of a parameter's |name=value-pair is not recognized as a valid name. With very few exceptions CS1 citation parameters are lower case. CS1 will report this error when the parameter's name contains uppercase letters (Xxxx, xxXx, XXXX) but the parameter's name is defined as lowercase (xxxx). Some parameters, like |isbn= can be either lowercase or uppercase, but not of mixed case (|isbn= or |ISBN= but not |Isbn=). CS1 will also report this error when the parameter's name matches a name in the list of common parameter misspellings (found |acessdate= but expected |accessdate=).
CS1 will offer a suggested parameter name from the list of valid parameters or from the list of common parameter misspellings.
To resolve this error, replace the erroneous parameter name with a correct one, possibly using the suggested name.
Pages with this error are automatically placed in Category:Pages with citations using unsupported parameters.[a]
[edit] Wikilink embedded in URL title
Wikilink embedded in URL title
External links in a rendered citation are a combination of url-holding parameters, |url=, |chapterurl=, etc, with title-holding parameters, |title=, |chapter=, etc. Title-holding parameters may be wikilinked to another Wikipedia article but not when there is a matching url-holding parameter in the citation. When this condition occurs, the wikilink is suppressed, the wiki markup ignored, and the rendered citation links to the external site. This error can also be caused when a title-holding parameter contains certain templates that output wikilinked content, for example, {{lang}} templates output a wikilinked category.
To resolve this error, remove wikilinks and wikilink-producing templates from title-holding parameters that are intended to be externally linked, or, remove the external URL, which will allow the internal wikilinks to work as expected.
Pages with this error are automatically placed in Category:Pages with citations having wikilinks embedded in URL titles.[a]
[edit] Notes
[edit] References
|
||||||||||||||||||||
