Thisessay is ahow-to guide detailing a practice or process on the English Wikipedia. |
|
| This help page hastestcases demonstrating various uses. |
Citation Style 1 (CS1) is collection of templates that can be modified to create multiple styles. In its native form, it is a well-used method of giving references in Wikipedia articles. It includes a series of templates that in turn use either the meta-template{{Citation/core}} or the newer LuaModule:Citation/CS1.
The use of CS1 or of templates is not compulsory; perWP:CITEVAR:
Wikipedia does not have a singlehouse style. Editors may choose any option they want; one article need not match what is done in other articles or what is done in professional publications or recommended by academicstyle guides. However, citationswithin a given article should follow a consistent style.
CS1 uses elements ofThe Chicago Manual of Style and thePublication Manual of the American Psychological Association, with significant adaptations.
There are a number of templates that use a name starting withcite; many were developed independently of CS1 and are not compliant with the CS1 style. There are also a number of templates that use one of the general use templates as a meta-template to cite a specific source.
To be compliant with CS1, a template must:
The following is a list of templates that implement Citation Style 1 for one or more types of citations but are not restricted to any specific source.
![]() | Indicates that template usesModule:Citation/CS1; others use{{citation/core}} |
| Ҳа | Indicates that the corresponding tool or gadget can generate the template anytime user wishes. However, this does not mean that the tool or gadget fully supports all parameters or provides an interface for them. In fact, none of the mentioned items do so. |
| Sometimes | Indicates that the corresponding tool or gadget may or may not generate the corresponding template. For more information, see associated footnote. |
| Template | Use | Citation expander gadget | RefToolbar 1.0 | RefToolbar 2.0 | ProveIt | SnipManager | Cite4Wiki |
|---|---|---|---|---|---|---|---|
{{Cite AV media}}![]() | audio and visual sources | Ҳа | Ҳа | ||||
{{Cite AV media notes}}![]() | liner notes from albums, DVDs, CDs and similar audio-visual media | ||||||
{{Cite book}}![]() | books | Ҳа | Ҳа | Ҳа | Ҳа | Ҳа | |
{{Cite conference}}![]() | conference papers | Ҳа | |||||
{{Cite DVD notes}}![]() | DVD liner notes | ||||||
{{Cite encyclopedia}}![]() | edited collections | Ҳа | |||||
{{Cite episode}}![]() | television or radio programs and episodes | Ҳа | |||||
{{Cite interview}}![]() | interviews | ||||||
{{Cite journal}}![]() | magazines, journals, academic papers | Ҳа | Ҳа | Ҳа | Ҳа | Ҳа | Sometimes[lower-alpha 1] |
{{Cite mailing list}}![]() | archived public mailing lists | ||||||
{{Cite map}}![]() | maps | ||||||
{{Cite news}}![]() | news articles in print, video, audio or web | Sometimes [further explanation needed] | Ҳа | Ҳа | Ҳа | Ҳа | Sometimes [further explanation needed] |
{{Cite newsgroup}}![]() | online newsgroups | ||||||
{{Cite podcast}}![]() | audio or videopodcast | ||||||
{{Cite press release}}![]() | press releases | Ҳа | |||||
{{Cite report}}![]() | Unpublished reports by government departments, instrumentalities, operated companies, etc. | ||||||
{{Cite serial}}![]() | audio or video serials | ||||||
{{Cite sign}}![]() | signs, plaques and other visual sources | ||||||
{{Cite speech}}![]() | speeches | ||||||
{{Cite techreport}}![]() | technical reports | ||||||
{{Cite thesis}}![]() | theses | ||||||
{{Cite web}}![]() | web sources not characterized by another template | Ҳа | Ҳа | Ҳа | Ҳа | Ҳа | Ҳа |
The following templates use{{cite journal}} as a meta-template. By simply entering an identifier, a bot will build the citation from information retrieved from a database. No bot currently automatically fills in{{Cite hdl}}.
| Template | Identifier |
|---|---|
{{Cite doi}}![]() | Digital object identifier |
{{Cite hdl}}![]() | Handle System |
{{Cite pmid}}![]() | PubMed |
From a technical standpoint, the bot builds a wrapper template for{{cite journal}}. The wrapper contains the citation information retrieved from the specified database. Once constructed, the wrapper function is used transparently.
There are a number of templates that are CS1 compliant but are tied to a specific source; these are listed inCategory:Citation Style 1 specific-source templates.
Of special note in these is:
| Template | Identifier |
|---|---|
{{Cite arXiv}}![]() | arXiv preprints |
CS1 uses a series of templates that provide a consistent output. The main difference is in parameters optimized for the subject. For example,{{cite book}} has fields for title and chapter, whereas{{cite journal}} has fields for journal and title.
This help page uses the names most commonly used across the templates series; see each template's documentation for details.
CS1 templates present a citation generally as:
An author may be cited using separate parameters for the author's surname and given name by using|last= and|first= respectively. If a cited source has multiple authors, subsequent authors can be listed in the citation using|last2= and|first2=,|last3= and|first3=, etc. as shown in the following example:[Note 1]
{{cite book |last=Hawking |first=Stephen |last2=Hawking |first2=Lucy |title=George's Secret Key to the Universe}}If a cited source has a large number of authors, one can limit the number of authors displayed when the citation is published by using the|display-authors= parameter as described in detail in theDisplay options section of this help page.
If a cited author is notable and the author has a Wikipedia article, the author's name can be linked with|author-link=. If a citation includes multiple notable authors, one may use|author-link2=,|author-link3=, etc. This method is used because|last= and|first= do not allow wikilinking. Please note that|author-link= cannot be used to link to an external website; the external link will not render correctly. Below is an example of a wikilinked author credit:
{{cite book |last=Hawking |first=Stephen |author-link=Stephen Hawking |last2=Hawking |first2=Lucy |title=George's Secret Key to the Universe}}When an author is cited, the date of the cited work is displayed after the author's name, as shown in the example below:
{{cite book |last=Hawking |first=Stephen |author-link=Stephen Hawking |last2=Hawking |first2=Lucy |title=George's Secret Key to the Universe |year=2007}}If no author is cited, the date appears after the title, as shown in the example below:
{{cite book |title=George's Secret Key to the Universe |year=2007}}If the cited source does not credit an author, as is common with newswire reports, press releases or company websites use:
|author=<!--Staff writer(s); no by-line.-->This HTML comment alerts both fact-checking and citation-fixing editors and bots that the cited source specifically did not name an author and therefore an author credit wasn't accidentally omitted from the citation. Without this entry editors and bots would waste time researching cited sources in an attempt to improve existing citations only to find that there is no author to credit.
When using|author= avoid citations like{{cite news|work=Weekday Times|author=Weekday Times editors|title=...}}, unless the article is on a field in which the majority of professional journals covering that field use such a citation style.
Editors should use an|author= organizational citation when the cited source, such as a committee report, specifically names an official body or a sub-unit of the publisher as the collective author of the work, e.g.|author=Commission on Headphone Safety or|author=Rules Sub-committee. Do not use|author= to assert what you think was probably the collective author when the source itself does not specifically specify a collective author; doing so isoriginal research and falsification ofsource verifiability andreliability.
An editor may be cited using separate parameters for the editor's last and first name. A single or first editor would use|editor-last= and|editor-first=; subsequent editors would use|editor2-last= and|editor2-first=,|editor3-last= and|editor3-first=, etc.[Note 2]
If an editor is notable and has a Wikipedia article, you may wikilink to that editor's Wikipedia article using|editor-link=. If a cited work has multiple editors, you may use|editor2-link=,|editor3-link=, etc. to wikilink to each editor's Wikipedia article. This method is used because|editor-last= and|editor-first= do not allow wikilinking. Please note that|editor-link= cannot be used to link to an external website; the external link will not render correctly.
If a cited source has a large number of editors, one can limit the number of editors displayed when the citation is published using the|display-editors= parameter as described in detail in theDisplay options section of this help page.
|others=Illustrated by John Smith or|others=Trans. JonesDates are indicated by these parameters:
origyear=First published 1859 ororigyear=Composed 1904. This parameter only displays if there is a value foryear ordate.Acceptable date formats are shown in the "Acceptable date formats" table of the . Further points:
CS1 usesWikipedia:Manual of Style/Dates and numbers § Dates, months and years () as the reference for all date format checking performed byModule:Citation/CS1. For various reasons, CS1 is not fully compliant with MOS:DATEFORMAT. This table indicates CS1 compliance with the listed sections of MOS:DATEFORMAT.
| section | compliant | comment |
|---|---|---|
| yes | Exceptions: linked dates not supported; sortable dates not supported ( {{dts}} etc.);proper name dates not supported; shortened month names longer than three characters or with terminating periods not supported; | |
| yes | ||
| no | article level restrictions are beyond the scope of CS1 | |
| no | ||
| no | ||
| no | dates earlier than 100 not supported; | |
| limited | Julian prior to 1582; Gregorian from 1582; assumes Gregorian in the overlap period of 1582 – c. 1923 | |
| yes | Exceptions: does not support the use of– or does not support dates prior to 100; does not support solidus separator (/) does not support " to " as a date separator does not support YYYY–YY where the two-digit year is less than 13 (change to YYYY–YYYY to eliminate the error message); | |
| yes | Exceptions: does not support{{circa}} or{{floruit}};does not support dates prior to 100; Supports c. only with a single year value (no ranges or day/month combinations). | |
| no | ||
| no | CS1 capitalizes seasons used as dates in citations, in line with external style guides; | |
| no | ||
| no | ||
| no |
If dates are used withthe ref=harv parameter, the year range is 100 to present without era indication (AD, BC, CE, BCE). In the case where the same author has written more than one work in the same year, a lower-case letter may be appended to the year in the date parameter (date = July 4, 1997b – Module:Citation/CS1 supported templates only) or the year parameter (year = 1997b – all CS1 templates).
{{cite news}},{{cite journal}},{{cite web}},{{cite conference}}, and{{cite podcast}}, where the title is shown in quotation marks. Use title case unless the cited source covers a scientific, legal or other technical topic and sentence case is the predominant style in journals on that topic. Use either or sentence case consistently throughout the article. Do not omit a leading "The" from the title. Subtitles are typically separated from titles with ": " though " – " is also used. , Wikipediadoes not attempt to emulate any stylistic flourishes used by the cited source's publisher, such as ALL-CAPS, all-lower-case,Small Caps, etc.; use either standard title case or sentence case consistently. If the cited source is itself notable and has a Wikipedia article, the title can be wikilinked. Wikilinking the title will make it impossible to use the "url" parameter to link to an external copy of the cited source, so only do this when citing works that do not need to be externally linked. A link to the actual source is preferred to a link to a Wikipedia article about the source.|script-title=ar:العربية. Unrecognized codes are ignored and will display in the rendered citation.|url= if used.|at=Featured NewsTitles containing certain characters will both display and link incorrectly unless those characters are replaced or encoded.
| newline | [ | ] | | |
|---|---|---|---|
| space | [ | ] | | |
</ref> that closes the citation.|work=Amazon.com and |publisher=Amazon|newspaper=The New York Times and |publisher=The New York Times Company|newspaper=USA Today and |publisher=Gannett CompanyWhether the publisher needs to be included depends on the type of work.Wikipedia:Citing sources suggest it should be for books, but not necessarily other works. If the work is self-published,this is a very important fact aboutpotential reliability of the source, and needs to be specified; no consensus exists for the exact value of|publisher=, but some printed style guides suggest "author". When an exhaustive attempt to discover the name of the publisher (trywhois for websites) fails, use|publisher=<!--Unspecified by source.--> to explicitly indicate that this was checked, so other editors do not waste time duplicating your fruitless efforts. Do not guess at the publisher when this information isn't clear.
|location= parameter should be omitted when it is implied by the name of the work, e.g.The New York Times. The|location= parameter should be used when the location is part of the common name but not the actual name of a newspaper. For example, the newspaper commonly known as theNew York Daily News is actuallyDaily News (New York) and can be entered with|newspaper=Daily News|location=New York, which yieldsDaily News (New York).|via= permits adding a level of detail of "say where you found it" within the syntax of Citation Style 1, without requiring external templates like{{HighBeam}} or{{subscription required}}.|via= is not intended to replace|publisher=, so citations of books (say, ebooks) published and sold by Google Books wouldn't use it.An editor may use anyone of the following parameters in a given citation to refer to the specific page(s) or place in a cited source that contains the information that supports the article text. If more than one of the following parameters are used in the same citation, the error messageExtra|pages= or|at= (help) will display in the published citation. When more than one of the following parameters is used in error,|page= overrides both|pages= and|at=;|pages= overrides|at=. To resolve the error, remove extra parameters of this type until only one remains in the affected citation.
|page=52 .|pages=236–239 . Separate non-sequential pages with a comma, for example|pages=157,159 . The form|pages=461,466–467 is used when you are citing both non-contiguous and sequential pages.Note: CS1 citations do not record the total number of pages in a cited source; do not use this parameter for that purpose.|at= parameter including, but not limited to, track, hours, minutes and seconds, act, scene, canto, book, part, folio, stanza, back cover, liner notes, indicia, colophon, dust jacket, etc. Examples include|at=Column 2 or|at=Paragraph 5 or|at=Back cover or|at=Act III, Scene 2.|edition=Revised third displays as: Revised third ed. The edition parameter can be omitted if there is no content difference between two editions of the same work; e.g. if a book was identically published in the UK and the US except, for example, ISBN number and cover art, it is not necessary to indicate either "UK" or "US" edition; or if citing minute:seconds of a film available in both a regular edition and a "Special Limited Collector's Edition", if the running time and cut are the same, it is not necessary to cite the particular edition.|subscription= or|registration=, seeRegistration or subscription required. Other notes about reprintings, etc., should be placed after the template, and before</ref>.Links to sources are regarded as conveniences and are not required, except when citing Web-only sources. There are many digital libraries with works that may be used as sources.
Do not link to:
Links should be kept as simple as possible. For example, when performing a search for a Google Book, the link forMonty Python and Philosophy would look like:
But can be trimmed to:
A direct link to a specific page may be used if supported by the host. For example, the link to page 173 ofMonty Python and Philosophy on Google Books:
If the same source is reused with different pages, separate citations must be created. A way around this problem is to use{{rp}} to provide linked page number citations.
http:// andhttps:// will be supported by all browsers; however,ftp://,gopher://,irc://,ircs://,mailto: andnews: will require a plug-in or an external application and should normally be avoided.IPv6 host-names are currently not supported.%20. To encode the URL, replace the following characters with:| sp | " | ' | < | > | [ | ] | { | | | } |
|---|---|---|---|---|---|---|---|---|---|
| %20 | %22 | %27 | %3c | %3e | %5b | %5d | %7b | %7c | %7d |
URLs with certain filename extensions or URI schemes will apply an icon specific to that file type. This is done through MediaWiki CSS, not these templates.
The original link may become unavailable. When an archived version is located, the original URL is retained and|archive-url= is added with a link to an archived copy of a web page, usually from services like WebCite and the Internet Archive.|archive-date= must be added to show the date the page was archived, not the date the link was added. When|archive-url= is used,|url= and|archive-date= are required, else an error will show. When an archived link is used, the citation displays with the title linked to the archive and the original link at the end:
|dead-url=no:Most templates support these identifiers:
Citations of online sources that require registration or a subscription are acceptable in Wikipedia as documented inVerifiability – Access to sources. As a courtesy to readers and other editors, if a cited online source requires registration, add|registration=yes to the citation; if a cited online source requires a subscription, add|subscription=yes to the citation. If both parameters are added to the same citation,|subscription=yes will override|registration=yes and the "registration required" note will not display in the published citation.
|ref=|ref=harv: Creates an anchor of the formatCITEREFauthorslastnameyear suitable for a{{harv}},{{sfn}} etc. Examples:{{cite book |first=Gary L. |last=Hardcastle |title=Monty Python and Philosophy |year=2006 |ref=harv}}CITEREFHardcastle2006 which may be linked from{{harv|Hardcastle|2006|pp=12-34}}.{{cite book |first=Gary L. |last=Hardcastle |first2=George A. |last2=Reisch |title=Monty Python and Philosophy |year=2006 |ref=harv}}CITEREFHardcastleReisch2006 which may be linked from{{harv|Hardcastle|Reisch|2006|pp=12-34}}.|ref=ID: Creates a custom anchor defined byID. This is useful where the author and/or date is unknown. The{{harvid}} template may be used here to create an anchor suitable for a{{harv}},{{sfn}} etc. For example,|ref={{harvid|Monty Python and Philosophy|2006}} creates an anchor which may be linked from{{harv|Monty Python and Philosophy|2006|pp=12-34}}These features are not often used, but can customize the display for use with other styles.
|mode=cs1, element separator is a semicolon (;); terminal punctuation is a period (.); where appropriate, initial letters of certain words are capitalized ('Retrieved...'). For|mode=cs2, element separator is a comma (,); terminal punctuation is omitted; where appropriate, initial letters of certain words are not capitalized ('retrieved...'). To override default terminal punctuation usepostscript.{{reflist}},<references /> or similar as there is no control of the order in which references are displayed.,); if the parameter is present, but blank, separator punctuation is set to the default; a space must be encoded as .;); if the parameter is present, but blank, separator punctuation is set to the default; a space must be encoded as .|display-authors=2 will display only the first two authors in a citation. By default, all authors are displayed.|display-authors=etal displays all authors in the list followed by et al. Aliases:displayauthors.|display-editors=2 will display only the first two editors in a citation. By default, all editors are displayed except when there are four editors, then the editor list in the citation is truncated to three editors, followed by "et al." This exception mimics the older version of the template for compatibility. If a citation contains four editor names and one wishes all four editor names to display, "et al." may be suppressed by setting|display-editors=4.|display-editors=etal displays all editors in the list followed by et al. Aliases:displayeditors. &) when set to any value. Example:|last-author-amp=yes.); for no terminating punctuation, specify|postscript=none – leaving|postscript= empty is the same as omitting it, but is ambiguous. Ignored ifquote is defined..); if the parameter is present, but blank, separator punctuation is set to the default; a space must be encoded as .et al. is the abbreviation of the Latinet alii (and others). It is used to complete a list of authors of a published work, where the complete list is considered overly long. The term is widely used in English, thus it is not italicized per .
When viewing the page, CS1 templates render the URL to the title to create a link; when printing, the URL is printed.External link icons are not printed.
Not all factually accurate pieces of information about a source are used in a Citation Style 1 citation. Examples of information not included:
CS1 templates may be inserted manually or by use of tools:
Error checking:
| Help:CS1PROBS |
|access-date= does not show.|url= is not supplied, then|access-date= does not show; by design.|title= field includes a newline or an invalid character then the link will be malformed; seeWeb links.www.example.org vs.http://www.example.org.{{!}} instead.|author-link= will break the link; this field is for the name of the Wikipedia article about the author, not a website.|last= or|last1= is not defined, then|last2= will not show. By design.|page=,|pages= or|at= do not show.|separator= is present but blank, no separator punctuation will be used.|separator= is set to an asterisk (*), colon (:) or hash (#) they will be interpreted as wikimarkup.