Template:Cite book/doc: Difference between revisions

From All Skies Encyclopaedia
imported>Gadget850
ce hatnote
imported>Gadget850
update doc; navboxes
Line 8: Line 8:


Copy a blank version to use. Remember to use the "|" (pipe) character between each parameter. Please delete any unused parameters to avoid clutter in the edit window.
Copy a blank version to use. Remember to use the "|" (pipe) character between each parameter. Please delete any unused parameters to avoid clutter in the edit window.
No templates or magic words are necessary when using an [[International Standard Book Number|ISBN]], [[Online Computer Library Center|OCLC]] number, or [[Digital object identifier|DOI]] as an identifier. Instead of using the <code>id</code> parameter in these instances, simply use the appropriate parameter. For instance, type <code>isbn=</code> followed by the number instead of <code>id=ISBN</code>. Templates are available for other identification number types to be used in the ID parameter ({{tl|ISSN}}, {{tl|LCCN}}, {{tl|LCC}}, etc.) if these are not available. See also the complete [[#Description of parameters|description of parameters]].


{| class="wikitable"
{| class="wikitable"
Line 232: Line 230:


‡ If {{para|chapterurl}} is provided then {{para|chapter}} cannot have wikilinks.
‡ If {{para|chapterurl}} is provided then {{para|chapter}} cannot have wikilinks.
==Fields==
===Wikilinks===
Except where specifically prohibited in the parameter descriptions below, most parameters can be wikilinked (e.g. <code>title = <nowiki>[[book article|book title]]</nowiki></code>), but should generally only be linked to an existing Wikipedia article. Wikilinked parameters must escape the characters <code><nowiki><>[]{}</nowiki></code> rather than including them directly.
===Description of parameters===
====Syntax (for the technical-minded)====
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)
====Description====
* '''last''': Surname of author. Do not wikilink (use ''authorlink'' instead).
** '''first''': Given or first name(s) of author, including title(s) (e.g. ''Firstname Middlename'' or ''Firstname M.'' or ''Dr. Firstname M., Snr.''). Do not wikilink (use ''authorlink'' instead).
*** The 'last' and 'first' parameters are not ideally suited to authors whose surname is usually written first (e.g. as in Chinese). Use the same format as the source uses to handle these cases.
** {{AuthorMask doc}} See [[#Examples|Examples]] for typical usage.
** '''authorlink''': Title of Wikipedia article about author (not the author's personal website). Article should already exist. Must not be wikilinked itself. Do not use this on its own, but along with ''author'' or ''first'' and ''last''.
** '''coauthors''': Full name of additional author or authors, separated by ", " (e.g. ''Joe Bloggs, John F. Kennedy, H. R. Dent'').
*** Whether the surname of the co-authors goes first or last is dependent on the citation style (see the [[#Citation styles|citation style]] section below) preferred.
* OR: '''author''': Full name of author, preferably surname first. (deprecated) Do not wikilink (use ''authorlink'' instead).
* OR: for multiple authors, use the parameters '''first1''', '''last1''', ..., '''first''n'', last''n''''' to 'correctly' record all the information about the book (the first nine authors are printed, then ''et al.'' is appended if even more authors were specified). Do not wikilink as there are corresponding '''authorlink1''', ..., '''authorlink9''' parameters as well. This usage is preferred to the use of '''coauthors'''.
* '''editor''': Name of editor/editors. Do not Wikilink any values in the editor parameter but use ''editor-link'' instead. The template automatically adds "ed." after the editor's name unless the ''chapter'' parameter is used in which case the template adds "in" before the editor's name which appears after the chapter and before the title. This implies that the author is responsible only for part of the book (including the cited chapter) and the editor responsible for the whole book. If, however, the author(s) and editor(s) are responsible for the whole book, then the ''editor'' parameter or its alternates described below should not be used if the ''chapter'' parameter is being used. Instead, the editor(s) should be included in an ''author'' parameter with possibly "(ed.)" after the surname(s). Alternatively, the ''editor'' parameter may be used if the chapter detail is included in the ''title'' parameter instead of using the ''chapter'' parameter.
* OR: alternatively '''editor-first''' and '''editor-last''' can be used in the same way as ''first'' and ''last''.
* OR: for multiple editors up to four in number, use the parameters '''editor1-first''', '''editor1-last''', ..., '''editor''n''-first, editor''n''-last''' to 'correctly' record all the information about the book in the same way as ''first''n and ''last''n.
** '''editor-link''' or '''editor1-link'''... '''editor''n''-link''' is used in the same way as ''authorlink'' or ''authorlink''n.
* '''others''': To record other contributors to the work, such as "Illustrated by Smith" or "Trans. Smith".
* '''title''': Title of book. This is the only required parameter. Can be wikilinked but only to an existing Wikipedia article. Do not use italics.
** '''trans_title''': If the book cited is in a foreign language, an English translation of the title can be given here. The template will display this in square brackets after the ''title'' parameter and it will point to the ''url'' link, if used. Use of ''language'' parameter is recommended if this parameter is used.
{{csdoc|url}}
* '''type''': An optional parameter which can be used to provide additional information about a publication type. The content appears in parentheses following the title. If the publication is a thesis or dissertation, the type might be specified as <code>type=PhD thesis</code>, If the publication is an audiobook on compact disk, the type might be specified as <code>type=CD</code>.
* '''edition''': When the book has more than one edition. ''E.g.:'' "2nd", "Revised" etc. Note that the template automatically displays " ed." after this parameter, so <code>edition=2nd</code> produces "2nd ed.".
* '''series''': When the book is part of a series of publications. Depending on citation style, this might look something like {{para|series|"Animal Welfare" series No. 2}} or {{para|series|No 2 "Animal Welfare" ser.}} or {{para|series|Animal Welfare 2}}. If in doubt, prefer the "{{para|series|"Animal Welfare" series No. 2}}" style, for clarity.
* '''volume''': For one book published in several volumes. This template displays the text in this parameter in bold type after the ''title'' and ''series'' parameters. An alternative is to include the volume information in the ''title'' parameter after the main title (see example below). (NB: There is a separate {{tl|Cite encyclopedia}} template.)
* '''issue''': When the book is one of a series that is published periodically.
* '''date''': Full date of publication edition being referenced, in the same format as other dates in citations in the same article. Must not be wikilinked. Do not use for years without specifying the month: use {{para|year}} instead.<!-- because using |date= for a year alone causes Harvard linking to fail in 60% of cases&nbsp;— not sure how to describe this in non-technical terms -->
* OR: '''year''': Year of publication edition being referenced.
** '''month''': Name of the month of publication. If you also have the day, use ''date'' instead. Must not be wikilinked.
** '''origyear''': Original publication year, for display alongside the date or year. For clarity, please supply specifics, for instance <code>origyear=First published 1859</code> or <code>origyear=Composed 1904</code>. This parameter only displays if there is a value for ''year'' or ''date''.
* '''publisher''': Publisher should not include corporate designation such as "Ltd" or "Inc".
** '''location''': Geographical place of publication.
* '''language''': The language the book is written in, if it is not English. The template automatically puts parentheses around the text and adds "in" before the language name.
* '''isbn''': [[International Standard Book Number]] such as ''1-111-22222-9''. Note that {{para|isbn}}, like all parameter names, must be in lowercase. The parameter must not be wikilinked as the template automatically creates a link. The template is insensitive to formatting so an ISBN number without dashes ("-") may be used (e.g. {{para|isbn|1111222229}}), though ISBNs with correctly formatted dashes are preferred (see [[Wikipedia:ISBN]] and [[ISBN#Overview|ISBN]]). Please use the 13-digit ISBN where possible; this can normally be found beneath the barcode as a number beginning 978 or 979. For books with the older SBN system (9 digits), use this parameter but prefix the number with a zero; thus ''SBN 902888-45-5'' should be entered as {{para|isbn|0-902888-45-5}}. More information about this feature and its advantages is available at [[Wikipedia:ISBN]].
* '''oclc''': [[Online Computer Library Center]] ID number, such as ''3185581''. The parameter must not be wikilinked as the template automatically creates a link.
* '''doi''': A [[digital object identifier]] such as ''<nowiki>10.1016/j.coi.2004.08.001</nowiki>''. The parameter must not be wikilinked as the template automatically creates a link.
** '''doi_brokendate''': The date that a digital object identifier link was found to be broken.
* '''bibcode''': A nineteen character [[Bibcode]] identifier. The parameter must not be wikilinked as the template automatically creates a link.
* Several other parameters are available for catalogue or other identifying numbers; these include {{para|arxiv}}, {{para|asin}}, {{para|issn}} ([[International Standard Serial Number]]), {{para|jfm}}, {{para|jstor}}, {{para|lccn}}, {{para|mr}}, {{para|ol}} ([[Open Library]]), {{para|osti}}, {{para|pmc}}, {{para|pmid}}, {{para|rfc}}, {{para|ssrn}} and {{para|zbl}}.
* '''id''': A [[unique identifier]], used if none of the above are applicable. In this case, you need to specify the kind of identifier you are using, preferably with a template like {{tl|ASIN}} or {{tl|ISSN}}. (Use one of the more specialized parameters if possible; they are linked automatically. In other words, do not use {{para|id|ISBN 1-111-22222-9}} anymore; use {{para|isbn|1-111-22222-9}}. If the book has a SBN but not an ISBN, see {{para|isbn}}.)
* '''pages''' or '''page''': These parameters are for listing the pages relevant to the citation, ''not'' the total number of pages in the book. "<code>|pages= 5–7</code>" produces "pp. 5–7", while "<code>|page= 5</code>" produces "p. 5". The "pp." notation indicating multiple pages, and "p." notation indicating a single page, ''are placed automatically'' when you choose between the plural (''pages'') or singular (''page'') form of the parameter. Page ranges should be separated by an unspaced [[en dash]] (–).
** '''nopp''': using "page" or "pages", automatically places the p. or pp. notations. If this is inappropriate—for instance, if <code>page=Front cover</code>, placing any value after <code>nopp</code> (e.g. <code>nopp=y</code> will hide the p. or pp. notation.
* '''at''': Position within the resource when {{para|page}}/{{para|pages}} is inappropriate, e.g. {{para|at|para. 14}} (when citing a source without page numbers) or {{para|at|no. 456}} (something in a numbered list). This parameter is ignored if {{para|page}}/{{para|pages}} is specified.
** Using e.g. {{para|at|para. 14}} produces similar results to {{para|page|para. 14}}{{para|nopp|y}} or {{para|pages|para. 14}}{{para|nopp|y}}
* '''chapter''' (= '''contribution'''): The chapter of the book, written in full. Punctuation (other than quotation marks, which are supplied around the chapter title automatically by the template) should be included in the value passed to the parameter, e.g. {{para|chapter|Chapter 12: Meet Dick and Jane.}} produces "Chapter 12: Meet Dick and Jane." ahead of ''title''.
** '''trans_chapter''': Acts in the same way as ''trans_title''. The parameter will be displayed in square brackets within the quotation marks which embrace the ''chapter'' parameter. Use of ''language'' parameter is recommended if this parameter is used.
** '''chapterurl''' (='''contribution-url'''): URL of an individual chapter of online book. Should be at the same site as ''url'', if any. If ''chapterurl'' is used, ''url'' should only be used if the beginning of the work and the cited chapter are on separate webpages at the site.
* '''quote''': Relevant quote from the book. Should not be excessive in length: More than a few sentences is rarely needed, and if needed then the Wikipedia article's prose should probably more adequately address the topic and/or quote the material directly, e.g. with {{tlx|quote}}. The template will automatically provide quotation marks, but not a terminal period/full stop (or diaeresis as appropriate), nor initial capitalization, both of which should be added manually. Example: <blockquote>{{para|quote|[I]t was not only competition, but the introduction of new techniques that drew spectators to the events...}}</blockquote>
* '''ref''': ID for anchor. By default, no anchor is generated. The ordinary nonempty value {{para|ref|<var>ID</var>}} generates an anchor with the given <code><var>ID</var></code>; such a linkable reference can be made the target of [[Wikipedia:Citing sources/Further considerations#Wikilinks to full references|wikilinks to full references]], especially useful in short citations like [[Wikipedia:Citing sources#Shortened footnotes|shortened notes]] and [[Wikipedia:Parenthetical referencing|parenthetical referencing]]. The special value {{para|ref|harv}} generates an anchor suitable for the {{tl|harv}} template; see ''[[Template:Citation/doc#Anchors for Harvard referencing templates|anchors for Harvard referencing templates]]''. See "Wikilinks to full references" in [[#Examples|Examples]] below for using the ''ref'' parameter in citation templates in conjunction with short <nowiki><ref>...</ref></nowiki> citations.
* '''laysummary''': Link to a non-technical summary (or review) of the book
** '''laydate''': Date of summary.
* '''separator''': The separator to use in lists of authors, editors, ''etc.''. Defaults to ".", but "," may be useful also. If the parameter is present, but blank, ''no separator will be used''.
* '''author-separator''': Parameter allowing punctuation style to be altered.
* '''author-name-separator''': Parameter allowing punctuation style to be altered.
* '''display-authors''': By default, the number of authors displayed is limited to 8; if 9 are provided, the ninth is displayed as "''et al.''". This parameter allows display of fewer authors before the "''et al.''" (e.g., {{para|display-authors|2}}); alternatively, the "''et al.''" may be suppressed by the use of {{para|display-authors|9}}.
* '''postscript''': The closing punctuation for the citation. If specified, over-rides the default behaviour of terminating the citation with a full stop. If the parameter is present, but blank, ''no terminating punctuation will be used''. This may be useful when generating an output consistent with other templates. It is preferred to manually adding ending punctuation, as the punctuation occurs within the &lt;cite&gt; tag, so will appear before any icons added by browser plugins. Ignored if {{para|quote}} is specified.
* '''lastauthoramp''': The separator to use between the last two names in lists of authors. Defaults to "", but "&amp;" may be useful as well.


==Examples==
==Examples==
Line 428: Line 359:
Attention must be paid: not all other citation templates support this. In such cases, the service can be achieved also by enclosing the concerned bibliographical item inside <code><nowiki><span id=...>...</span></nowiki></code> tags: also this way, it can feature as a target of [[Wikipedia:Citing sources/Further considerations#Wikilinks to full references|Wikilinks to full references]]. The <code>id</code> attribute of the tag must be set to the same name what we would give to the (lacking) <code>ref</code> parameter of the citation template.
Attention must be paid: not all other citation templates support this. In such cases, the service can be achieved also by enclosing the concerned bibliographical item inside <code><nowiki><span id=...>...</span></nowiki></code> tags: also this way, it can feature as a target of [[Wikipedia:Citing sources/Further considerations#Wikilinks to full references|Wikilinks to full references]]. The <code>id</code> attribute of the tag must be set to the same name what we would give to the (lacking) <code>ref</code> parameter of the citation template.


==Testing==
==Parameters==
See [[Template:cite book/regression tests]].
===Syntax===
{{csdoc|syntax}}
 
{{csdoc|coins}}


==Notes==
{{csdoc|sep_period}}
'''1. Extra full-stop'''<br>
:Note the extra full-stop when the last author ends with an initial, and there is no date:
:*{{cite book | last = Invisible | first = M. | title = Mysterious book }}
:We do not know of a practical solution to this—unless there is a way to test the characters of a parameter?


'''2. Deprecated parameters'''<br>
===Description===
:Following from [[Template talk:Cite web/Archive 5#accessmonthday SNAFU ...|this]] January 2009 discussion, and numerous others on that page, the parameters {{para|accessyear}}, {{para|accessmonthday}} and {{para|accessdaymonth}} were found to be more trouble than they're worth. They were created in the days of date autoformatting to force a display in ymd or dmy format; now this is deprecated in favour of setting {{para|dateformat}} in the template and passing the whole date in together as {{para|accessdate}}. See [[Wikipedia:Bots/Requests for approval/MelonBot 12|Requests for approval/MelonBot 12]] for more information.
{{csdoc|author}}
:As of February 2011, if any of {{para|access-date}}, {{para|accessday}}, {{para|accessdaymonth}}, {{para|accessmonth}}, {{para|accessmonthday}}, {{para|accessyear}}, {{para|dateformat}}, or {{para|day}} is used, then the page is listed in [[:Category:Pages containing cite templates with deprecated parameters]] and subject to correction by [[User:MelonBot]].
{{csdoc|editor}}
{{csdoc|others}}
{{csdoc|title_quotes}}
{{csdoc|type}}
{{csdoc|edition}}
{{csdoc|series}}
{{csdoc|volume}}
{{csdoc|issue}}
{{csdoc|date}}
{{csdoc|publisher}}
{{csdoc|language}}
{{csdoc|id1}}
{{csdoc|id2}}
{{csdoc|pages}}
{{csdoc|chapter}}
{{csdoc|url}}
{{csdoc|quote}}
{{csdoc|ref}}
{{csdoc|lay}}
{{csdoc|display}}


==Citation styles==
==Testing==
Established citation styles for coauthors:
See [[Template:cite book/regression tests]].
* [http://www.cws.illinois.edu/workshop/writers/citation/mla/index.html MLA style]: Last, First and First Last. "If there are more than three authors, you may list only the first author followed by the phrase ''et al''."
* [http://www.cws.illinois.edu/workshop/writers/citation/apa/index.html APA style]: Last, F. & Last, F.
* [http://www.liunet.edu/cwis/cwp/library/workshop/citchi.htm Chicago Manual of Style]{{dl|date=October 2011}}: Last, First, and First Last.
* [http://www.liunet.edu/cwis/cwp/library/workshop/cittur.htm Turabian]{{dl|date=October 2011}}: same as Chicago Reference List, above.
* [http://www.library.uq.edu.au/training/citation/harvard.html Harvard]{{dl|date=December 2009}}: Last, F., Last, F. & Last, F.


==COinS==
{{Citation Style 1}}
{{Wikipedia referencing}}
{{UF-COinS}}
{{UF-COinS}}
==Tools==
See [[Wikipedia:Citing sources#Programming tools]] for a list of tools which can help create a reference in the "cite book" format.
==See also==
* {{tl|Citation}}
* {{tl|Cite journal}}
* {{tl|Cite web}}
* [[:Category:Citation templates]]
* [[User:Citation bot|Citation bot]]
* [[Wikipedia:Citing sources|Citing sources]]: Style guide
* [[Wikipedia:Citing sources/example style|Citing sources/example style]]
* [[Wikipedia:Citation templates|Citation templates]]: Related templates
* [[WP:DOI|Digital Object Identifier]]
* [[Template:rp]], an alternative to the {{para|page}}, {{para|pages}} and {{para|at}} parameters for referencing specific pages or sections, especially when the same source is used more than once in an article
* [[Wikipedia:WikiProject Wikicite|WikiProject Wikicite]]
* [[Zotero]]
<includeonly>
<includeonly>
[[Category:Citation templates|{{PAGENAME}}]]
[[Category:Citation templates|{{PAGENAME}}]]

Revision as of 12:09, 16 February 2012

Template:Important

This template is used to cite sources in Wikipedia. It is specifically for books. When citing an article in a compilation or anthology, {{cite journal}} or {{cite encyclopedia}} work better. If the book is being referenced via a web page, then unless it is a page that reproduces the book (or sections of it), {{Cite web}} should be used instead.

Usage

All parameter names must be in lowercase.

Copy a blank version to use. Remember to use the "|" (pipe) character between each parameter. Please delete any unused parameters to avoid clutter in the edit window.

Full version (copy and paste text below and delete parameters you do not need)
{{cite book |last1= |first1= |authorlink1= |last2= |first2= |authorlink2= |coauthors= |editor1-first= |editor1-last= |editor1-link= |others= |title= |trans_title= |url= |archiveurl= |archivedate= |format= |accessdate= |type= |edition= |series= |volume= |date= |year= |month= |origyear= |publisher= |location= |language= |isbn= |oclc= |doi= |id= |page= |pages= |at= |trans_chapter= |chapter= |chapterurl= |quote= |ref= |bibcode= |laysummary= |laydate= |separator= |postscript= |lastauthoramp=}}
Most commonly used parameters (use this and you will not have to delete as much)
{{cite book |title= |last= |first= |authorlink= |coauthors= |year= |publisher= |location= |isbn= |page= |pages= |url= |accessdate=}}
Example 1
{{cite book |last= Cordell |first= Bruce R. |coauthors= Jeff Grubb, David Yu |title= [[Manual of the Planes]] |publisher= [[Wizards of the Coast]] |year= 2001 |month= September |isbn= 0-7869-1850-8}}

Lua error: bad argument #1 to "get" (not a valid title).

Example 2
{{cite book
 | last = Mumford
 | first = David
 | authorlink = David Mumford
 | title = The Red Book of Varieties and Schemes
 | publisher = [[Springer-Verlag]]
 | series = Lecture Notes in Mathematics 1358
 | year = 1999
 | doi = 10.1007/b62130
 | isbn = 3-540-63293-X
}}

Lua error: bad argument #1 to "get" (not a valid title).

Vertical list Prerequisites * Brief instructions
{{cite book
| last          = 
| first         = 
| authormask    = 
| authorlink    = 
| coauthors     = 
| firstn        = 
| lastn         = 
| authorn-link  = 
| editor        = 
| editorn-last  = 
| editorn-first = 
| editor-link   = 
| editorn-link  = 
| others        = 
| title         = 
| trans_title   = 
| url           = 
| archiveurl    = 
| archivedate   = 
| format        = 
| accessdate    = 
| type          = 
| edition       = 
| series        = 
| volume        = 
| date          = 
| origyear      = 
| year          = 
| month         = 
| publisher     = 
| location      = 
| language      = 
| isbn          = 
| oclc          = 
| lccn          = 
| doi           = 
| bibcode       = 
| id            = 
| page          = 
| pages         = 
| nopp          = 
| at            = 
| chapter       = 
| trans_chapter = 
| chapterurl    = 
| quote         = 
| ref           = 
| laysummary    = 
| laydate       = 
| separator     = 
| postscript    = 
| lastauthoramp = 
}}


last

last
last
lastn

lastn



editor or editor-last
editorn-last





archiveurl
url
url





year or date

year

publisher









page or pages



chapter



laysummary


coauthors or >1 lastn


(no wikilink)
(no wikilink)


alternative to first2, last2 ... first9, last9
(no wikilink). n = 1 through 9
(no wikilink). n = 1 through 9
n = 1 through 9

n = 1 through 4
n = 1 through 4

n = 1 through 4



insert URL of online version of the book or an extract, if available








†preferred (no wikilink)

alternative to date




always include ISBN if one has been assigned







hides automatic 'p' or 'pp'.
alternative to page/pages when those are used with nopp
‡(no wikilink). Synonymous with "contribution".










† This is the preferred parameter with its alternates listed below.

‡ If |chapterurl= is provided then |chapter= cannot have wikilinks.

Examples

Just a title
* {{cite book | title=Mysterious book }}
  • Lua error: bad argument #1 to "get" (not a valid title).
Year and title
* {{cite book | title=Mysterious book | year=1901 }}
  • Lua error: bad argument #1 to "get" (not a valid title).
Basic usage
* {{cite book | first=Joe | last=Bloggs | authorlink=Joe Bloggs | year=1974 | title=Book of Bloggs }}
  • Lua error: bad argument #1 to "get" (not a valid title).
Basic usage with url
* {{cite book | last=Bloggs | first=Joe | authorlink=Joe Bloggs | year=1974 | title=Book of Bloggs | edition=1st | url=http://en.wikipedia.org/ | accessdate=2006-02-17 }}
  • Lua error: bad argument #1 to "get" (not a valid title).
Citing a chapter in a book with different authors for different chapters and an editor
* {{cite book |last=Bloggs | first=Fred |editor-first=John| editor-last=Doe |title=Big Compilation Book With Many Chapters and distinct chapter authors |publisher=Book Publishers |date=2001-01-01 |pages=100–110 |chapter=Chapter 2: The History Of The Bloggs Family |isbn=1234567890}}
  • Lua error: bad argument #1 to "get" (not a valid title).
Citing a chapter in a book with two joint authors and an editor
* {{cite book |last1=Bloggs | first1=Joe| last2=Egg| first2=Fred| first3=John (ed.)| last3=Doe |title=Big Book With Many Chapters and two co-authors |publisher=Book Publishers |date=2001-01-01 ||origyear=1st. Pub. 1986|pages=100–110 |chapter=Chapter 6: Getting There| chapterurl=http://en.wikipedia.org/ |isbn=1234567890| lastauthoramp=y}}
  • Lua error: bad argument #1 to "get" (not a valid title).
Three authors, title with a piped wikilink, edition
* {{cite book | last1=Bloggs | first1=Joe | authorlink=Joe Bloggs | first2=John | last2=Smith | first3=Jim | last3=Smythe | title=[[A Thousand Acres|1000 Acres]] | edition=2nd }}
  • Lua error: bad argument #1 to "get" (not a valid title).
Complex usage showing effect of using volume parameter and lastauthoramp parameter
Without volume and lastauthoramp parameters:
*{{cite book|first1=Major-General I.S.O.| last1=Playfair| authorlink1=Ian Stanley Ord Playfair| first2=Commander G.M.S| last2=Stitt| first3=Brigadier C.J.C.| last3=Molony| first4=Air Vice-Marshal S.E.| last4=Toomer| editor-first=J.R.M| editor-last=Butler| series=History of the Second World War, United Kingdom Military Series| title=Mediterranean and Middle East. Volume I: The Early Successes Against Italy (to May 1941)| publisher=Naval & Military Press |location=Uckfield, UK|year=2007| origyear=1st. pub. [[HMSO]]:1954| isbn=1-845740-65-3}}
  • Lua error: bad argument #1 to "get" (not a valid title).
With volume and last authoramp parameters:
*{{cite book|first1=Major-General I.S.O.| last1=Playfair| authorlink1=Ian Stanley Ord Playfair| first2=Commander G.M.S| last2=Stitt| first3=Brigadier C.J.C.| last3=Molony| first4=Air Vice-Marshall S.E.| last4=Toomer| editor-first=J.R.M| editor-last=Butler| series=History of the Second World War, United Kingdom Military Series| title=Mediterranean and Middle East|volume=Volume I: The Early Successes Against Italy (to May 1941)| publisher=Naval & Military Press |location=Uckfield, UK|year=2007| origyear=1st. pub. [[HMSO]]:1954| isbn=1-845740-65-3|lastauthoramp=y}}
  • Lua error: bad argument #1 to "get" (not a valid title).
Date without day, wikilinked title and publisher, id, pages, location
* {{cite book | last=Cordell | first=Bruce R. | coauthors=Jeff Grubb, David Noonan | year=2001 | month=September | title=[[Manual of the Planes]] | publisher=[[Wizards of the Coast]] | location=Timbuktu | isbn=0-7869-1850-8 | pages= 134–137 }}
  • Lua error: bad argument #1 to "get" (not a valid title).
Other language
* {{cite book | last=Bloggs | first=Jean | year=1974 | title=Livre de Bloggs | edition=1st | language=French| trans_title=Book of Bloggs| url=http://en.wikipedia.org/ | accessdate=2006-02-17 }}
  • Lua error: bad argument #1 to "get" (not a valid title).
Using authormask parameter
{{cite book|first1=Major-General I.S.O.| last1=Playfair| authorlink1=Ian Stanley Ord Playfair| last2=Stitt| first2=Commander G.M.S| last3=Molony| first3=Brigadier C.J.C.| last4=Toomer| first4=Air Vice-Marshall S.E.|editor-last=Butler| editor-first=J.R.M| editor-link=James Ramsay Montagu Butler | series=History of the Second World War, United Kingdom Military Series| title=Mediterranean and Middle East Volume I: The Early Successes Against Italy (to May 1941)| publisher=Naval & Military Press |location=Uckfield, UK|year=2004| origyear=1st. pub. [[HMSO]]:1954| isbn=1-845740-65-3| lastauthoramp=y}}
{{cite book|first1=Major-General I.S.O.| last1=Playfair| authorlink1=Ian Stanley Ord Playfair| last2=Flynn| first2=Captain F.C. (R.N.)| last3=Molony| first3=Brigadier C.J.C.| last4=Toomer| first4=Air Vice-Marshall S.E.|editor-last=Butler| editor-first=J.R.M| editor-link=James Ramsay Montagu Butler |series=History of the Second World War, United Kingdom Military Series| title=The Mediterranean and Middle East, Volume II: The Germans come to the help of their Ally (1941)| publisher=Naval & Military Press |location=Uckfield, UK |year=2004| origyear=1st. pub. [[HMSO]]:1956| isbn=1-845740-66-1| lastauthoramp=y| authormask=2}}
{{cite book|first1=Major-General I.S.O.| last1=Playfair| authorlink1=Ian Stanley Ord Playfair| last2=Flynn| first2=Captain F.C. (R.N.)| last3=Molony| first3=Brigadier C.J.C.| last4=Gleave| first4=Group Captain T.P.|editor-last=Butler| editor-first=Sir James| editor-link=James Ramsay Montagu Butler |series=History of the Second World War, United Kingdom Military Series| title=The Mediterranean and Middle East, Volume III: British Fortunes reach their Lowest Ebb (September 1941 to September 1942)| publisher=Naval & Military Press |location=Uckfield, UK |year=2004| origyear=1st. pub. [[HMSO]]:1960| isbn=1-845740-67-X| lastauthoramp=y| authormask=2}}
Lua error: bad argument #1 to "get" (not a valid title).
Lua error: bad argument #1 to "get" (not a valid title).
Lua error: bad argument #1 to "get" (not a valid title).
Using a DOI
*{{cite book |last=Mumford |first=David |authorlink=David Mumford |year=1999 |title=The Red Book of Varieties and Schemes: Includes the Michigan Lectures (1974) on Curves and Their Jacobians |edition=2nd |publisher=[[Springer-Verlag]] |doi=10.1007/b62130 |isbn=354063293X }}
  • Lua error: bad argument #1 to "get" (not a valid title).
Wikilinks to full references
As mentioned, the bibliographical data of the cited source can be “tagged” by an identifier: this enables the system to “find” the target of the wikilinks. This “tagging” with an identifier can be done by enclosing between <cite id=...>...</cite> tags, but this tool can be superfluous if the bibliographical data are provided with a citation template: the ref parameter of the chosen citation template must be set to the same name.

Wikilink example edit:

Shamans may fulfill multiple functions, including healing, curing infertile women, and securing the success of hunts.<ref>[[#Mer85|Merkur 1985]]: 4</ref>

== Notes ==

{{reflist|2}}

== References ==

* {{cite book |last=Merkur |first=Daniel |year=1985 |title=Becoming Half Hidden: Shamanism and Initiation among the Inuit |publisher=Almqvist & Wiksell |location=Stockholm |isbn=91-22-00752-0 |ref=Mer85}}

Example rendered result:

Shamans may fulfill multiple functions, including healing, curing infertile women, and securing the success of hunts.[1]

Notes

References

  • Lua error: bad argument #1 to "get" (not a valid title).

Attention must be paid: not all other citation templates support this. In such cases, the service can be achieved also by enclosing the concerned bibliographical item inside <span id=...>...</span> tags: also this way, it can feature as a target of Wikilinks to full references. The id attribute of the tag must be set to the same name what we would give to the (lacking) ref parameter of the citation template.

Parameters

Syntax

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. See Wikipedia:COinS. 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 included raw in the metadata. Also, HTML entities, for example &nbsp;, &ndash;, or &#160;, should not be used in parameters that contribute to the metadata.

COinS metadata is created for these parameters

Note: This table of metadata is displayed in the documentation of all Citation Style 1 templates. Not all of these parameters are supported by every CS1 template. Some of these parameters are mutually exclusive, some are aliases of another parameter, and some require other parameters to be present. A full list of this template's supported parameters, their aliases, and their dependencies is shown in the Usage section near the top of this documentation page.

  • |periodical=, |journal=, |newspaper=, |magazine=, |work=, |website=, |encyclopedia=, |encyclopaedia=, |dictionary=
  • |chapter=, |script-chapter=, |contribution=, |script-contribution=, |entry=, |script-entry=, |article=, |script-article=, |section=, |script-section=
  • |title=, |script-title=, |book-title=
  • |publication-place=, |place=, |location=
  • |date=, |year=, |publication-date=
  • |series=, |version=
  • |volume=, |issue=, |number=
  • |page=, |pages=, |at=, |quote-page=, |quote-pages=
  • |edition=
  • |publisher=, |institution=
  • |url=, |chapter-url=, |contribution-url=, |section-url=
  • |author-last=, |author-last#=, |author#-last=, |author-surname=, |author-surname#=, |author#-surname=, |last=, |last#=, |surname=, |surname#=, |author=, |author#=, |subject=, |subject#=, |host=, |host#=
  • |author-first=, |author-first#=, |author#-first=, |author-given=, |author-given#=, |author#-given=, |first=, |first#=, |given=, |given#=
  • |degree=
  • |arxiv=, |bibcode=, |biorxiv=, |citeseerx=, |doi=, |eissn=, |eprint=, |hdl=, |isbn=, |issn=, |jfm=, |jstor=, |lccn=, |message-id=, |mr=, |oclc=, |osti=, |pmc=, |pmid=, |rfc=, |ssrn=, |s2cid=, |zbl=

By default, sets of fields are terminated with a period (.).

Description

  • last: Surname of a single author. Do not wikilink—use author-link instead. For corporate authors or authors for whom only one name is listed by the source, use last or one of its aliases (e.g. |author=Bono). Aliases: surname, author, last1, surname1, author1.
    • author: this parameter is used to hold the name of an organizational author (e.g. a committee) or the complete name (first and last) of a single person; for the latter, prefer the use of |first= and |last=. This parameter should never hold the names of more than one author. Supports accept-this-as-written markup. Do not use italics in this field, as doing so produces corrupt metadata.
    • first: Given or first names of author; for example: Firstname Middlename or Firstname M. or Firstname M. Sr. Do not wikilink—use author-link instead. Aliases: given, first1, given1. Requires last; first name will not display if last is empty. Use generational and regnal suffixes only in accordance with MOS:JRSR and use honorifics (including Dr., Sir, and similar) only in accordance with MOS:HON.
    • 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, but not the other way around). 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, author1-link, authorlink.
    • OR: for multiple authors, use author-link1 through author-linkn. Aliases: author1-link through authorn-link.
    • name-list-style: accepts a limited list of keywords as value; when set to amp, ampersand, or &, inserts an ampersand between the last two names in a name list; when set to and, inserts the conjunction 'and' between the last two names of a name list; when set to vancdisplays name lists in Vancouver style when the lists use the last/first forms of name parameters.
  • vauthors: comma-separated list of author names in Vancouver style; enclose corporate or institutional author names in doubled parentheses. End with etal if appropriate:
    |vauthors=Smythe JB, ((Megabux Corp.)), etal
    • author-link and author-mask may be used for the individual names in |vauthors= as described above
  • authors: deprecated Free-form list of author names; use of this parameter is discouraged because it does not contribute to a citation's metadata; not an alias of last.
  • translator-last: Surname of translator. Do not wikilink—use translator-link instead. Aliases: translator-surname, translator1, translator1-last, translator-last1. Supports accept-this-as-written markup.
    • translator-first: Given or first names of translator. Do not wikilink—use translator-link instead. Aliases: translator-given, 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, but not the other way around). 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.
  • collaboration: Name of a group of authors or collaborators; requires author, last, or vauthors listing one or more primary authors; follows author name-list; appends "et al." to author name-list.
  • 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, editor1-last, editor-surname, editor-surname1, editor1-surname, editor, editor1.
    • editor: This parameter is used to hold the complete name of a single editor (first and last), or the name of an editorial committee. This parameter should never hold the names of more than one editor. Supports accept-this-as-written markup.
    • 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, editor1-first, editor-given, editor-given1, editor1-given.
    • OR: for multiple editors, use editor-last1, editor-first1 through editor-lastn, editor-firstn (Aliases: editorn-last, editor-surnamen or editorn-surname; editorn-first, editor-givenn or editorn-given; 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-style: accepts a limited list of keywords as value; when set to amp, ampersand, or &, inserts an ampersand between the last two names in a name list; when set to and, inserts the conjunction 'and' between the last two names of a name list; when set to vancdisplays name lists in Vancouver style when the lists use the last/first forms of name parameters.
  • veditors: comma separated list of editor names in Vancouver style; enclose corporate or institutional names in doubled parentheses. End with etal if appropriate:
    |veditors=Smythe JB, ((Megabux Corp.)), etal
    • editor-linkn and editor-maskn may be used for the individual names in |veditors=, as described above
  • Display:
    Use display-editors to control the length of the displayed editor name list and to specify when "et al." is included.
    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."

Lua error: expandTemplate: template "Citation Style documentation/others" does not exist. Lua error: expandTemplate: template "Citation Style documentation/title_quotes" does not exist.

  • type: Provides additional information about the media type of the source. May alternatively be used to identify the type of manuscript linked to in the title, if this is not the final version of a manuscript (e.g. if a preprint of a manuscript is freely available, but the version of record is behind a paywall). Format in sentence case. Displays in parentheses following the title. The reserved keyword none can be used to disable the display of a type. Examples: Thesis, Booklet, Accepted manuscript, CD liner, Press release. Alias: medium.
  • 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; volume numbers should be entered just as a numeral (e.g. 37). Volume values that are wholly digits, wholly uppercase Roman numerals, or fewer than five characters will appear in bold. Any alphanumeric value of five or more characters will not appear in bold. In rare cases, publications carry both an ongoing volume and a year-related value; if so, provide them both, for example |volume=IV / #10.

Lua error: expandTemplate: template "Citation Style documentation/issue" does not exist.

  • date: Date of referenced source. 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] Do not wikilink. Displays after the authors and is enclosed in parentheses. If there is no author, then displays after the website and publisher. For acceptable date formats, see Help:Citation Style 1 § Dates.
Shortened footnotes target full citations using the year specified in this parameter. A lowercase letter may be suffixed to the year to disambiguate {{sfn}} links to multiple works by the same author in the same year,[more] unless the date is formatted as YYYY-MM-DD. In the latter case, year or ref is required to disambiguate the link targets.
For approximate year, precede with "c. ", like this: |date=c. 1900.

For no date, or "undated", use |date=n.d.
The date of a Web page, PDF, etc. with no visible date can sometimes be established by searching the page source or document code for a created or updated date; a comment for editors such as date=2021-12-25<!--date from page source-->|orig-date=Original date 2011-01-01 can be added.
Automatic date formatting: Citation Style 1 and 2 templates, including this template, automatically render dates in all date parameters (such as |date=, |publication-date=, |access-date=, |archive-date=, etc.) except for |orig-date= in the style specified by the article's {{use dmy dates}} or {{use mdy dates}} template. See those templates' documentation for details.
  • year: Year of publication. The more flexible |date= parameter also handles a year by itself. Do not use in combination with the |date= parameter, unless both of the following conditions are met:
    1. Shortened footnotes target multiple citations with same last name and year of publication. (This situation necessitates a CITEREF disambiguator, usually a lowercase letter suffixed to the year.)
    2. The |date= format is YYYY-MM-DD. (This format prevents the addition of a disambiguating letter to the year.)
  • orig-date: Original publication date or year; displays in square brackets after the date (or year). For clarity, please supply specifics. For example: |orig-date=First published 1859 or |orig-date=Composed 1904. As |orig-date= does not support automatic date formatting, use the same date format as defined by |df= (or, if it exists in the article, by |cs1-dates= of a {{use dmy dates}} or {{use mdy dates}} template), or as used in the |date= parameter. Alias: orig-year
  • df: date format; sets rendered dates to the specified format; does not support date ranges or seasonal dates; overrides the automatic date formatting described above. Accepts one value which may be one of these:
    dmy – set publication dates to day month year format; access- and archive-dates are not modified;
    mdy – as above for month day, year format
    ymd – as above for year initial numeric format YYYY-MM-DD
    dmy-all – set publication, access-, and archive-dates to day month year format;
    mdy-all – as above for month day, year format
    ymd-all – as above for year initial numeric format YYYY-MM-DD
  1. Publication dates in references within an article should all have the same format. This may be a different format from that used for archive and access dates. See MOS:DATEUNIFY.
  • publisher: Name of publisher; may be wikilinked[1] if relevant. The publisher is the company, organization or other legal entity that publishes the work being cited. For self-published works (i.e., where the publisher is the same as the author or creator) state |publisher=self-published.[2] Do not use the publisher parameter for the name of a work (e.g. a website, book, encyclopedia, newspaper, magazine, journal, etc.). If the name of the publisher changed over time, use the name as stated in the publication or used at the time of the source's publication. Corporate designations such as "Ltd", "Inc.", or "GmbH" are not usually included. This parameter is most commonly used for books, and rarely for websites or periodicals (although it may be used instead of work in some cases). 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.
  • place: For news stories with a dateline, the location where the story was written. If the name of the location changed over time, use the name as stated in the publication or used at the time of the source's publication. In earlier versions of the template this was the publication place, and for compatibility, will be treated as the publication place if the publication-place parameter is absent; see that parameter for further information. Alias: location
  • publication-place: Geographical place of publication; generally not wikilinked; omit when the name of the work includes the publication place, for example, The Boston Globe, The Times of India. Displays after the title. If the name of the publication place changed over time, use the name as stated in the publication or used at the time of the source's publication. If only one of publication-place, place, or location is defined, it will be treated as the publication place and will show after the title; if publication-place and place or location are defined, then place or location is 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. If date (or year) is also defined and is different, then publication-date displays preceded by "published" and enclosed in parentheses, following publisher. If date (or year) is not defined, publication-date is displayed as date. Use the same format as other dates in the article; do not wikilink.
  • 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 article is attributed to a different publication (e.g. in Yahoo News) but cannot be traced, when the content deliverer (e.g. NewsBank) presents the source in a format different from the original, when the URL provided does not make clear the identity of the deliverer, where no URL or DOI is available (e.g. EBSCOhost), or if the deliverer requests attribution. See the access level parameters to display access restrictions, and the agency parameters if the original source is a news agency or wire service.
  • Lua error: bad argument #1 to "get" (not a valid title).: The language (or a comma-separated list of the languages) in which the source is written, as either the ISO 639 language code (preferred) or the full language name. Examples: |language=ru; |lang=fr, pt-br; |lang=Russian; |language=French, Portuguese. See the list of supported codes and names. Do not use templates or wikilinks. Displays in parentheses with "in" before the language name or names. When the only source language is English, no language is displayed in the citation. The use of languages recognized by the citation module adds the page to the appropriate subcategory of Category:CS1 foreign language sources. Because cs1|2 templates are often copied from en.wiki to other wikis, the use of language codes is preferred so that language names render in the correct language and form, e.g. espagnol at a French-language wiki instead of the English word "Spanish". Aliases: Lua error: bad argument #1 to "get" (not a valid title).
  • id: A unique identifier, used where none of the specialized identifiers are applicable; wikilink or use an external link template as applicable. For example, |id=NCJ 122967 will append "NCJ 122967" at the end of the citation. You can use templates such as |id={{NCJ|122967}} to append NCJ 122967 instead.

Lua error: Internal error: The interpreter has terminated with signal "24". Lua error: Internal error: The interpreter has terminated with signal "24". Lua error: Internal error: The interpreter has terminated with signal "24". Lua error: Internal error: The interpreter has terminated with signal "24". Lua error: Internal error: The interpreter has terminated with signal "24". Lua error: Internal error: The interpreter has terminated with signal "24". Lua error: Internal error: The interpreter has terminated with signal "24". Lua error: Internal error: The interpreter has terminated with signal "24".

Testing

See Template:cite book/regression tests.

Lua error: Internal error: The interpreter has terminated with signal "24". Lua error: Internal error: The interpreter has terminated with signal "24". This template produces COinS metadata; see COinS in Wikipedia for background information.

  1. Compare archived talk page.