Template:Cite book

This template is used on 650,000+ pages, or roughly 5% of all pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

Uses Lua: Module:Citation/CS1

This Citation Style 1 template is used to create citations for books. When citing an article in a periodical, use {{cite journal}}. For edited collections, use {{cite encyclopedia}}.

Copy a blank version to use. All parameter names must be in lowercase. Use the "|" (pipe) character between each parameter. Delete unused parameters to avoid clutter in the edit window. Some samples may include the current date. If the date is not current, then purge the page.

{{cite book
|last1=
|first1=
|author-link1=
|author-mask1=
|last2=
|first2=
|display-authors=
|last-author-amp=
|date=
|year=
|orig-year=
|chapter=
|trans-chapter=
|chapter-url=
|chapter-format=
|editor1-last=
|editor1-first=
|editor1-link=
|editor1-mask=
|display-editors=
|title=
|script-title=
|trans-title=
|url=
|dead-url=
|format=
|type=
|series=
|language=
|volume=
|issue=
|others=
|edition=
|location=
|publisher=
|publication-date=
|page=
|pages=
|at=
|nopp=
|arxiv=
|asin=
|bibcode=
|doi=
|doi-broken-date=
|isbn=
|issn=
|jfm=
|jstor=
|lccn=
|mr=
|oclc=
|ol=
|osti=
|pmc=
|pmid=
|rfc=
|ssrn=
|zbl=
|id=
|archive-url=
|archive-date=
|access-date=
|via=
|registration=
|subscription=
|lay-summary=
|lay-source=
|lay-date=
|quote=
|name-list-format=
|mode=
|postscript=
|ref=
}}

Template:Markup2 Template:Markup2 Template:Markup2 Template:Markup2 Template:Markup2 Template:Markup2 Template:Markup2 Template:Markup2 Template:Markup2 Template:Markup2 Template:Markup2 Template:Markup2 Template:Markup2 Template:Markup2 Template:Markup2

Nested parameters rely on their parent parameters:

• parent
• OR: parent2—may be used instead of parent
  • child—may be used with parent (and is ignored if parent is not used)
  • OR: child2—may be used instead of child (and is ignored if parent2 is not used)

Where aliases are listed, only one of the parameters may be defined; if multiple aliased parameters are defined, then only one will show.

This template embeds COinS metadata in the HTML output, allowing reference management software to retrieve bibliographic metadata. Template:Crossref As a general rule, only one data item per parameter. Do not include explanatory or alternate text:

• Use |date=27 September 2007 not |date=27 September 2007 (print version 25 September)

Use of templates within the citation template, is discouraged because many of these templates will add extraneous HTML or CSS that will be rendered in the metadata. Also, HTML entities, for example  , –, etc, should not be used in parameters that contribute to the metadata. Do not include Wiki markup '' (italic font) or ''' (bold font) because these markup characters will contaminate the metadata.

COinS metadata is created for these parameters

• |periodical=, |journal=, |newspaper=, |magazine=, |work=, |website=, |encyclopedia=, |encyclopaedia=, |dictionary=
• |chapter=, |contribution=, |entry=, |article=, |section=
• |title=
• |publication-place=, |publicationplace=, |place=, |location=
• |date=, |year=, |publication-date=, |publicationdate=
• |series=, |version=
• |volume=
• |issue=, |number=
• |page=, |pages=, |at=
• |edition=
• |publisher=, |distributor=, |institution=
• |url=
• |chapter-url=, |chapterurl=, |contribution-url=, |contributionurl=, |section-url=, |sectionurl=
• |author#=, |author-last#=, |author#-last=, |last#=, |surname#=
• |author-first#=, |author#-first=, |first#=, |given#=
• any of the named identifiers (|isbn=, |issn=, |doi=, |pmc=, etc)

The following parameters are deprecated. Their use will place the page into Category:Pages containing cite templates with deprecated parameters:

• {{xtd|coauthor · coauthors}}: Use {{bxt|last#}} / {{bxt|first#}} or {{bxt|author}} or {{bxt|authors}}
• {{xtd|Ref}}: Use {{bxt|ref}}

• last: Surname of author. Do not wikilink—use author-link instead. For corporate authors, simply use last to include the same format as the source. Aliases: last1, surname, surname1, author, author1.
  • first: Given or first names of author, including title(s); for example: Firstname Middlename or Firstname M. or Dr. Firstname M., Sr. Do not wikilink—use author-link instead. Aliases: first1, given, given1. Requires last; first name will not display if last is empty.
  • OR: for multiple authors, use last1, first1 through lastn, firstn where n is any consecutive number for an unlimited number of authors (each firstn requires a corresponding lastn). {{Crossref|See the display parameters to change how many authors are displayed.}} Aliases: surname1, given1 through surnamen, givenn, or author1 through authorn. For an individual author plus an institutional author, you can use |first1=...|last1=...|author2=....
  • author-link: Title of existing Wikipedia article about the author—not the author's website; do not wikilink. Aliases: author-link1, authorlink, authorlink1, author1-link, author1link.
  • OR: for multiple authors, use author-link1 through author-linkn. Aliases: authorlink1 through authorlinkn, or author1-link through authorn-link, or author1link through authornlink.
  • name-list-format: displays authors and editors in Vancouver style when set to vanc and when the list uses last/first parameters for the name list(s)
• vauthors: comma separated list of author names in Vancouver style; enclose corporate or institutional author names in doubled parentheses:

  |vauthors=Smythe JB, ((Megabux Corporation))

  • author-link and author-mask may be used for the individual names in |vauthors= as described above
• authors: Free-form list of author names; not an alias of last
• Template:Xtd: (deprecated) Names of coauthors. Requires author, authors, or lastn Include coauthors in author or authors or use separate authorn or lastn/firstn to list coauthors.
• translator-last: Surname of translator. Do not wikilink—use translator-link instead. Aliases: translator1, translator1-last, translator-last1.
  • translator-first: Given or first names of translator. Do not wikilink—use translator-link instead. Aliases: translator-first, translator1-first, translator-first1.
  • OR: for multiple translators, use translator-last1, translator-first1 through translator-lastn, translator-firstn where n is any consecutive number for an unlimited number of translators (each translator-firstn requires a corresponding translator-lastn). Aliases: translator1-last, translator1-first through translatorn-last, translatorn-first, or translator1 through translatorn.
  • translator-link: Title of existing Wikipedia article about the translator—not the translator's website; do not wikilink. Aliases: translator-link1, translator1-link.
  • OR: for multiple translators, use translator-link1 through translator-linkn. Aliases: translator1-link through translatorn-link.
• others: To record other contributors to the work, including illustrators. For the parameter value, write Illustrated by John Smith.

When using {{sfnote|lc=y}} or {{paren|lc=y}} styles with templates, do not use multiple names in one field or else the anchor will not match the inline link.

• title: Title of source. Can be wikilinked to an existing Wikipedia article or url may be used to add an external link, but not both. Displays in italics. If script-title is defined, title holds romanized transliteration of title in script-title.
  • script-title: Original title for languages that do not use a Latin-based alphabet (Arabic, Chinese, Hebrew, Japanese, etc); not italicized, follows italicized transliteration defined in title. May be prefixed with an ISO 639-1 two-character code to help browsers properly display the script:

    ... |title=Tōkyō tawā |script-title=ja:東京タワー |trans-title=Tokyo Tower ...

  • trans-title: English translation of the title if the source cited is in a foreign language. Displays in square brackets after title; if url is defined, then trans-title is included in the link. Use of the language parameter is recommended.

Titles containing certain characters will display and link incorrectly unless those characters are encoded.

• title-link: Title of existing Wikipedia article about the source named in title – do not use a web address; do not wikilink. Alias: titlelink.

• type: Provides additional information about the media type of the source; format in sentence case. Displays in parentheses following the title. Examples: Thesis, Booklet, CD liner, Press release. Alias: medium.

• chapter: The chapter heading of the source. May be wikilinked or may use chapter-url, but not both. Displays in quotes.
  • trans-chapter: English translation of the chapter heading, if the source cited is in a foreign language. Displays in square brackets after the chapter field; if chapter-url is defined, then trans-chapter is included in the link. Use of the language parameter is recommended.

• language: The language in which the source is written. Displays in parentheses with "in" before the language name or names. Use the full language name or ISO 639-1 code. When the source uses more than one language, list them individually, separated by commas, e.g. |language=French, German. The use of language names or language codes recognized by Wikimedia adds the page to the appropriate subcategory of CS1 foreign language sources; do not use templates or wikilinks. Note: When the language is "English" (or "en"), no language is displayed in the citation.

• date: Date of source being referenced. Can be full date (day, month, and year) or partial date (month and year, season and year, or year). Use same format as other publication dates in the citations.^{[date 1]} Required when year is used to disambiguate {{sfn}} links to multiple-work citations by the same author in the same year.^[more] Do not wikilink. Displays after the authors and is enclosed in parentheses. If there is no author, then displays after publisher. Template:Crossref

For approximate year, precede with "c. ", like this: |date=c. 1900.

For no date, or "undated", add as |date=n.d.

• year: Year of source being referenced. Use of |date= is recommended unless all of the following conditions are met:

1. The template uses |ref=harv, or the template is {{citation}}, or |mode=cs2
2. The |date= format is YYYY-MM-DD.
3. The citation requires a CITEREF disambiguator.

• orig-year: Original publication year; displays after the date or year. For clarity, please supply specifics. For example: |orig-year=First published 1859 or |orig-year=Composed 1904.

• publisher: Name of publisher; may be wikilinked if relevant. The publisher is the company that publishes the work being cited. Do not use the publisher parameter for the name of a work (e.g. a book, encyclopedia, newspaper, magazine, journal, website). Not normally used for periodicals. Corporate designations such as "Ltd", "Inc" or "GmbH" are not usually included. Omit where the publisher's name is substantially the same as the name of the work (for example, The New York Times Co. publishes The New York Times newspaper, so there is no reason to name the publisher). Displays after title; if work is defined, then publisher is enclosed in parentheses.
• place: Geographical place of publication; generally not wikilinked; omit when the name of the work includes the location; examples: The Boston Globe, The Times of India. Displays after the title; if work is defined, then location is enclosed in parentheses. Alias: location
• publication-place: If any one of publication-place, place or location are defined, then the location shows after the title; if publication-place and place or location are defined, then place or location are shown before the title prefixed with "written at" and publication-place is shown after the title.
• publication-date: Date of publication when different from the date the work was written. Displays only if year or date are defined and only if different, else publication-date is used and displayed as date. Use the same format as other dates in the article; do not wikilink. Follows publisher; if work is not defined, then publication-date is preceded by "published" and enclosed in parenthesis.
• via: Name of the content deliverer (if different from publisher). via is not a replacement for publisher, but provides additional detail. It may be used when the content deliverer presents the source in a format other than the original (e.g. NewsBank), when the URL provided does not make clear the identity of the deliverer, where no URL or DOI is available (EBSCO), if the deliverer requests attribution, or as requested in WP:The Wikipedia Library (e.g. Credo, HighBeam). Template:Crossref

• edition: When the publication has more than one edition; for example: "2nd", "Revised", and so forth. Appends the string " ed." after the field, so |edition=2nd produces "2nd ed." Does not display if a periodical field is defined.

• series or version: When the source is part of a series, such as a book series or a journal where the issue numbering has restarted.

• volume: For one publication published in several volumes. Displays after the title and series fields; volumes of four characters or less display in bold.|Displays after the title and series fields; displays in bold. If bolding is not desired, then include the volume information in the title field.

• page: The number of a single page in the source that supports the content. Use either |page= or |pages=, but not both. Displays preceded by p. unless |nopp=y.
• OR: pages: A range of pages in the source that supports the content. Use either |page= or |pages=, but not both. Separate using an en dash (–); separate non-sequential pages with a comma (,); do not use to indicate the total number of pages in the source. Displays preceded by pp. unless |nopp=y. Hyphens are automatically converted to en dashes; if hyphens are appropriate, for example: pp. 3-1–3-15, use |at=.
  • nopp: Set to y, yes, or true to suppress the p. or pp. notations where this is inappropriate; for example, where |page=Front cover.
• OR: at: For sources where a page number is inappropriate or insufficient. Overridden by |page= or |pages=. Use only one of |page=, |pages=, or |at=.

Examples: page (p.) or pages (pp.); section (sec.), column (col.), paragraph (para.); track; hours, minutes and seconds; act, scene, canto, book, part, folio, stanza, back cover, liner notes, indicia, colophon, dust jacket, verse.

• url: URL of an online location where the text of the publication can be found. Cannot be used if title is wikilinked. If applicable, the link may point to the specific page(s) referenced. Remove spurious tracking parameters from URLs, e.g. #ixzz2rBr3aO94 or ?utm_source=google&utm_medium=...&utm_term=...&utm_campaign=.... Do not link to any commercial booksellers, such as Amazon.com. See w:WP:PAGELINKS.
  • access-date: Full date when the content pointed to by url was last verified to support the text in the article; do not wikilink; requires url; use the same format as other access and archive dates in the citations.^{[date 1]} Not required for linked documents that do not change. For example, access-date is not required for links to copies of published research papers accessed via DOI or a published book, but should be used for links to news articles on commercial websites (these can change from time to time, even if they are also published in a physical medium). Note that access-date is the date that the URL was checked to not just be working, but to support the assertion being cited (which the current version of the page may not do). Can be hidden or styled by registered editors. Alias: accessdate.
  • archive-url: The URL of an archived copy of a web page, if or in case the url becomes unavailable. Typically used to refer to services like WebCite (see w:Wikipedia:Using WebCite) and Internet Archive (see w:Wikipedia:Using the Wayback Machine); requires archive-date and url. Alias: archiveurl.
    • archive-date: Date when the original URL was archived; preceded by default text "archived from the original on". Use the same format as other access and archive dates in the citations. This does not necessarily have to be the same format that was used for citing publication dates.^{[date 1]} Do not wikilink. Alias: archivedate.
    • dead-url: When the URL is still live, but pre-emptively archived, then set |dead-url=no. This changes the display order with the title retaining the original link and the archive linked at the end. When the original url has been usurped for the purposes of spam, advertising, or is otherwise unsuitable, setting |dead-url=unfit or |dead-url=usurped will not link to the original url in the rendered citation; |url= is still required. Other accepted values are y, yes, or true. Alias: deadurl.
  • template-doc-demo: The archive parameters will be error checked to ensure that all the required parameters are included, or else {{citation error}} is invoked. With errors, main, help and template pages are placed into one of the subcategories of Category:Articles with incorrect citation syntax. Set |template-doc-demo=true to disable categorization; mainly used for documentation where the error is demonstrated.
• format: Format of the work referred to by url; for example: PDF, DOC, or XLS; displayed in parentheses after title. HTML is implied and should not be specified. Automatically added when a PDF icon is displayed. Does not change the external link icon. Note: External link icons do not include alt text; thus, they do not add format information for the visually impaired.

URLs must begin with a supported URI scheme. http:// and https:// will be supported by all browsers; however, ftp://, gopher://, irc://, ircs://, mailto: and news: may require a plug-in or an external application and should normally be avoided. IPv6 host-names are currently not supported.

If URLs in citation template parameters contain certain characters, then they will not display and link correctly. Those characters need to be percent-encoded. For example, a space must be replaced by %20. To encode the URL, replace the following characters with:

Single apostrophes do not need to be encoded; however, unencoded multiples will be parsed as italic or bold markup. Single curly closing braces also do not need to be encoded; however, an unencoded pair will be parsed as the double closing braces for the template transclusion.

• chapter-url: URL of an individual chapter of online source. Should be at the same site as url, if any. If chapter-url is used, url should only be used if the beginning of the work and the cited chapter are on separate webpages at the site. chapter may be wikilinked or chapter-url used, but not both. Aliases: chapterurl, contribution-url, section-url.
• chapter-format: Format of the work referred to by chapter-url; for example: PDF, DOC, or XLS; displayed in parentheses after chapter. HTML is implied and should not be specified. Does not change the external link icon. Note: External link icons do not include alt text; thus, they do not add format information for the visually impaired.

Template:Citation Style documentation/ref

• id: A unique identifier, used where none of the specialized identifiers are applicable; wikilink or use a template as applicable.

These identifiers create links and are designed to accept a single value. Using multiple values or other text will break the link and/or invalidate the identifier. In general, the parameters should include only the variable part of the identifier, e.g. rfc=822 or pmc=345678.

• arxiv: w:arXiv identifier; for example: arxiv=hep-th/9205027 (before April 2007) or arxiv=0706.0001 or arxiv=1501.00001 (since April 2007). Do not include extraneous file extensions like ".pdf" or ".html".
• asin: w:Amazon Standard Identification Number; if first character of asin value is a digit, use isbn.
  • asin-tld: ASIN top-level domain for Amazon sites other than the US; valid values: au, br, ca, cn, co.jp, co.uk, de, es, fr, it, mx
• bibcode: w:Bibcode; used by a number of astronomical data systems; for example: 1974AJ.....79..819H
• doi: w:Digital object identifier; for example: 10.1038/news070508-7. It is checked to ensure it begins with (10.).
  • doi-broken-date: Date the DOI was found to be non-working at http://dx.doi.org. Use the same format as other dates in the article. Alias: doi_brokendate, doi-inactive-date
• isbn: w:International Standard Book Number; for example: 978-0-8126-9593-9. Template:Crossref Dashes in the ISBN are optional, but preferred. Use the ISBN actually printed on or in the book. Use the 13-digit ISBN – beginning with 978 or 979 – when it is available. If only a 10-digit ISBN is printed on or in the book, use it. ISBNs can be found on the page with the publisher's information – usually the back of the title page – or beneath the barcode as a number beginning with 978 or 979 (barcodes beginning with any other numbers are not ISBNs). For sources with the older 9-digit SBN system, prefix the number with a zero; thus, SBN 902888-45-5 should be entered as |isbn=0-902888-45-5. Do not convert a 10-digit ISBN to 13-digit by just adding the 978 prefix; the last digit is a calculated check digit and just making changes to the numbers will make the ISBN invalid. This parameter should hold only the ISBN without any additional characters. It is checked for length, invalid characters – anything other than numbers, spaces, and hyphens, with "X" permitted as the last character in a 10-digit ISBN – and the proper check digit. Alias: ISBN
• ismn: w:International Standard Music Number; for example: 979-0-9016791-7-7. w:Hyphens or spaces in the ISMN are optional. Use the ISMN actually printed on or in the work. This parameter should hold only the ISMN without any additional characters. It is checked for length, invalid characters – anything other than numbers, spaces, and hyphens – and the proper check digit. Alias: ISMN
• issn: w:International Standard Serial Number; eight characters may be split into two groups of four using a w:hyphen, but not an en dash or a space.
• jfm: w:Jahrbuch über die Fortschritte der Mathematik
• jstor: w:JSTOR abstract; for example: jstor=3793107 will generate w:JSTOR 3793107.
• lccn: w:Library of Congress Control Number. When present, alphabetic prefix characters are to be lower case.
• mr: w:Mathematical Reviews
• oclc: OCLC; WorldCat's (Online Computer Library Center)
• ol: w:Open Library identifier; do not include "OL" in the value.
• osti: w:Office of Scientific and Technical Information
• pmc: w:PubMed Central; use article number for full-text free repository of a journal article, e.g. pmc=345678. Do not include "PMC" in the value. Template:Crossref
  • embargo: Date that pmc goes live; if this date is in the future, then pmc is not linked until that date.
• pmid: w:PubMed; use unique identifier. Template:Crossref
• rfc: w:Request for Comments
• ssrn: w:Social Science Research Network
• zbl: w:Zentralblatt MATH

• quote: Relevant text quoted from the source. Displays enclosed in quotes. When supplied, the citation terminator (a period by default) is suppressed, so the quote needs to include terminating punctuation.

• editor-last: Surname of editor. Do not wikilink—use editor-link instead. Where the surname is usually written first—as in Chinese—or for corporate authors, simply use editor-last to include the same format as the source. Aliases: editor-last1, editor-surname, editor-surname1, editor1-last, editor, editor1.
  • editor-first: Given or first names of editor, including title(s); example: Firstname Middlename or Firstname M. or Dr. Firstname M., Sr. Do not wikilink—use editor-link instead. Aliases: editor-first1, editor-given, editor-given1, editor1-first.
  • OR: for multiple editors, use editor-last1, editor-first1 through editor-lastn, editor-firstn (Aliases: editor-surnamen or editorn-last; editor-givenn or editorn-first; editorn). For an individual editor plus an institutional editor, you can use |editor-first1=...|editor-last1=...|editor2=....

• editor-link: Title of existing Wikipedia article about the editor—not the editor's website; do not wikilink. Aliases: editor-link1.
• OR: for multiple editors, use editor-link1 through editor-linkn (alias editorn-link).
• name-list-format: displays authors and editors in Vancouver style when set to vanc and when the list uses last/first parameters for the name list(s)

• veditors: comma separated list of editor names in Vancouver style; enclose corporate or institutional names in doubled parentheses:

  |veditors=Smythe JB, ((Megabux Corporation))

• editor-linkn and editor-maskn may be used for the individual names in |veditors=, as described above

• editors: Free-form list of editor names; not an alias of editor-last

Display:

If authors: Authors are first, followed by the included work, then "In" and the editors, then the main work.

If no authors: Editors appear before the included work; a single editor is followed by "ed."; multiple editors are followed by "eds."

Exactly four editors will show three editors followed by "et al." then "(eds.)" or "eds." (depending upon presence of authors). When five or more editors are listed, all of them will be displayed. Use display-editors to control the length of the displayed editor name list and to specify when "et al." is included.

• lay-url: URL link to a non-technical summary or review of the source; the URL title is set to "Lay summary". Aliases: lay-summary, laysummary.
  • lay-source: Name of the source of the laysummary. Displays in italics and preceded by an endash. Alias: laysource.
  • lay-date: Date of the summary. Displays in parentheses. Alias: laydate.

• mode: Sets element separator, default terminal punctuation, and certain capitalization according to the value provided. For |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 use postscript.
• author-mask: Replaces the name of the first author with em dashes or text. Set author-mask to a numeric value n to set the dash n em spaces wide; set author-mask to a text value to display the text without a trailing author separator; for example, "with". You must still include the values for all authors for metadata purposes. Primarily intended for use with bibliographies or bibliography styles where multiple works by a single author are listed sequentially such as Template:Sfnote. Do not use in a list generated by {{reflist}}, <references /> or similar as there is no control of the order in which references are displayed. You can also use editor-mask and translator-mask in the same way.
• display-authors: Controls the number of author names that are displayed when a citation is published. To change the displayed number of authors, set display-authors to the desired number. For example, |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: Controls the number of editor names that are displayed when a citation is published. To change the displayed number of editors, set display-editors to the desired number. For example, |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.
• last-author-amp: Switches the separator between the last two names of the author list to space ampersand space ( & ) when set to y, yes, or true. Example: |last-author-amp=yes
• postscript: Controls the closing punctuation for a citation; defaults to a period (.); for no terminating punctuation, specify |postscript=none – leaving |postscript= empty is the same as omitting it, but is ambiguous. Ignored if quote is defined.

These parameters add a link note to the end of the citation:

• registration: For online sources that require registration, set |registration=yes (or y, or true); superseded by subscription if both are set.
• subscription: For online sources that require a subscription, set |subscription=yes (or y, or true); supersedes registration if both are set.

Template:Citation Style 1 Template:Wikipedia referencing Template:UF-COinS