Template:Citation/doc: Difference between revisions
imported>DePiep (expand on "nopp=") |
imported>Koavf m (fmt) |
||
Line 9: | Line 9: | ||
All parameter names are [[lowercase]]. |
All parameter names are [[lowercase]]. |
||
== |
==Anchored citations== |
||
This template can generate a citation that can be combined with [[WP:CITESHORT|shortened footnotes]] or [[Wikipedia:Parenthetical referencing|parenthetical referencing]]. It does this by creating an [[HTML element #anchor|HTML anchor]] containing an ID. The special parameter {{para|ref|harv}} generates an ID suitable for [[Harvard referencing]] templates such as {{tl|harv}} as specified in the next section; this is the default for the {{tl|citation}} template. If an empty {{para|ref}} is given, no anchor is generated; this is the default for the Cite templates such as {{tl|cite book}} and {{tl|cite news}}. You can also specify the ID directly, using the {{para|ref|<var>ID</var>}} parameter. For example, suppose an article's ''References'' section contains the markup: |
This template can generate a citation that can be combined with [[WP:CITESHORT|shortened footnotes]] or [[Wikipedia:Parenthetical referencing|parenthetical referencing]]. It does this by creating an [[HTML element #anchor|HTML anchor]] containing an ID. The special parameter {{para|ref|harv}} generates an ID suitable for [[Harvard referencing]] templates such as {{tl|harv}} as specified in the next section; this is the default for the {{tl|citation}} template. If an empty {{para|ref}} is given, no anchor is generated; this is the default for the Cite templates such as {{tl|cite book}} and {{tl|cite news}}. You can also specify the ID directly, using the {{para|ref|<var>ID</var>}} parameter. For example, suppose an article's ''References'' section contains the markup: |
||
Line 17: | Line 17: | ||
Then, the markup "<code><nowiki>([[#CivDis|Freud 1930]])</nowiki></code>" generates a parenthetical reference "([[#CivDis|Freud 1930]])" containing a wikilink to the citation (try clicking on the wikilink). |
Then, the markup "<code><nowiki>([[#CivDis|Freud 1930]])</nowiki></code>" generates a parenthetical reference "([[#CivDis|Freud 1930]])" containing a wikilink to the citation (try clicking on the wikilink). |
||
=== |
===Anchors for Harvard referencing templates=== |
||
IDs compatible with Harvard referencing templates such as {{tl|harv}} are computed from the last names of the authors and the year of the cited source. For example, the markup "<code><nowiki>{{harv|Wright|Evans|1851|p=ix}}</nowiki></code>" generates the Harvard reference "{{harv|Wright|Evans|1851|p=ix}}", which wikilinks to the citation whose markup and appearance are shown below: |
IDs compatible with Harvard referencing templates such as {{tl|harv}} are computed from the last names of the authors and the year of the cited source. For example, the markup "<code><nowiki>{{harv|Wright|Evans|1851|p=ix}}</nowiki></code>" generates the Harvard reference "{{harv|Wright|Evans|1851|p=ix}}", which wikilinks to the citation whose markup and appearance are shown below: |
||
Line 30: | Line 30: | ||
Similarly, the year is used, as specified by {{para|year}}. If no year is given, this template attempts to derive the year from {{para|date}} (or, if no date is given, from {{para|publication-date}}) by applying the [[m:Help:Extension:ParserFunctions#.23time:|MediaWiki #time function]]. This heuristic works with many common date formats but has known problems, so when in doubt it is safer to use {{para|year}}. |
Similarly, the year is used, as specified by {{para|year}}. If no year is given, this template attempts to derive the year from {{para|date}} (or, if no date is given, from {{para|publication-date}}) by applying the [[m:Help:Extension:ParserFunctions#.23time:|MediaWiki #time function]]. This heuristic works with many common date formats but has known problems, so when in doubt it is safer to use {{para|year}}. |
||
=== |
===IDs must be unique=== |
||
Names, years, and hand-specified IDs must be chosen so that the IDs are unique within a page; otherwise the HTML will not conform to the W3C standards, and any references to the citations will not work reliably. For example, suppose a page contains the following two citations with {{tl|harv}}-compatible IDs: |
Names, years, and hand-specified IDs must be chosen so that the IDs are unique within a page; otherwise the HTML will not conform to the W3C standards, and any references to the citations will not work reliably. For example, suppose a page contains the following two citations with {{tl|harv}}-compatible IDs: |
||
Line 107: | Line 107: | ||
* '''author2-link''', '''author3-link''', '''author4-link''': Title of an existing Wikipedia article about the second, third, and fourth author, if applicable. |
* '''author2-link''', '''author3-link''', '''author4-link''': Title of an existing Wikipedia article about the second, third, and fourth author, if applicable. |
||
* '''author-separator''': override the default semi-colon that separates authors' names. |
* '''author-separator''': override the default semi-colon that separates authors' names. |
||
* '''author-name-separator''': override the default comma that separates authors' names. |
* '''author-name-separator''': override the default comma that separates authors' names. |
||
* '''display-authors''': Truncate the list of authors at an arbitrary point with "''et al''". Still include the first 9 authors to allow metadata to be generated. |
* '''display-authors''': Truncate the list of authors at an arbitrary point with "''et al''". Still include the first 9 authors to allow metadata to be generated. |
||
* '''publication-date''' (or '''date'''): Date<ref group="n" name="dates" /> of publication. |
* '''publication-date''' (or '''date'''): Date<ref group="n" name="dates" /> of publication. |
||
Line 113: | Line 113: | ||
* '''year''': Year of authorship or publication. (Mandatory for use with links from [[:Template:Harvard citation]]. In some situations, the template may be able to derive a year from the full ''date''.) |
* '''year''': Year of authorship or publication. (Mandatory for use with links from [[:Template:Harvard citation]]. In some situations, the template may be able to derive a year from the full ''date''.) |
||
* '''origyear''': Year of first publication, if different. |
* '''origyear''': Year of first publication, if different. |
||
* '''title''': Title of the book. If the title includes [square brackets], these must be encoded |
* '''title''': Title of the book. If the title includes [square brackets], these must be encoded as "<code>&#91;</code>" for "[" and "<code>&#93;</code>" for "]" |
||
* '''edition''': Number or name of the edition, if not the first; for example: ''edition''=2nd. |
* '''edition''': Number or name of the edition, if not the first; for example: ''edition''=2nd. |
||
* '''volume''': The volume number of a multi-volume book. |
* '''volume''': The volume number of a multi-volume book. |
||
Line 257: | Line 257: | ||
| issue=2 |
| issue=2 |
||
| year=1976 |
| year=1976 |
||
| pages= |
| pages=1–8 |
||
| url=https://byustudies.byu.edu/ |
| url=https://byustudies.byu.edu/ |
||
shop/PDFSRC/12.2Hill.pdf |
shop/PDFSRC/12.2Hill.pdf |
||
Line 270: | Line 270: | ||
| issue=2 |
| issue=2 |
||
| year=1976 |
| year=1976 |
||
| pages= |
| pages=1–8 |
||
| url=https://byustudies.byu.edu/shop/PDFSRC/12.2Hill.pdf |
| url=https://byustudies.byu.edu/shop/PDFSRC/12.2Hill.pdf |
||
}} |
}} |
||
Line 369: | Line 369: | ||
* '''editor2-first''', '''editor3-first''', '''editor4-first''': The second, third, and fourth editors' first or given name(s), if applicable. |
* '''editor2-first''', '''editor3-first''', '''editor4-first''': The second, third, and fourth editors' first or given name(s), if applicable. |
||
* '''editor2-link''', '''editor3-link''', '''editor4-link''': Title of an existing Wikipedia article about the second, third, and fourth editor, if applicable. |
* '''editor2-link''', '''editor3-link''', '''editor4-link''': Title of an existing Wikipedia article about the second, third, and fourth editor, if applicable. |
||
* '''title''': Title of the book or compilation. If the title includes [square brackets], these must be encoded |
* '''title''': Title of the book or compilation. If the title includes [square brackets], these must be encoded as "<code>&#91;</code>" for "[" and "<code>&#93;</code>" for "]" |
||
* '''edition''': Number or name of the edition, if not the first; for example: ''edition''=2nd. |
* '''edition''': Number or name of the edition, if not the first; for example: ''edition''=2nd. |
||
* '''series''': Series of which this periodical is a part. |
* '''series''': Series of which this periodical is a part. |
||
Line 456: | Line 456: | ||
and Historical Writing |
and Historical Writing |
||
| volume = 1 |
| volume = 1 |
||
| pages = |
| pages = 719–720 |
||
| publisher = Fitzroy Dearborn |
| publisher = Fitzroy Dearborn |
||
| place = London |
| place = London |
||
Line 474: | Line 474: | ||
| title = Encyclopedia of Historians and Historical Writing |
| title = Encyclopedia of Historians and Historical Writing |
||
| volume = 1 |
| volume = 1 |
||
| pages = |
| pages = 719–720 |
||
| publisher = Fitzroy Dearborn |
| publisher = Fitzroy Dearborn |
||
| place = London |
| place = London |
||
Line 490: | Line 490: | ||
and Historical Writing |
and Historical Writing |
||
| volume = 1 |
| volume = 1 |
||
| pages = |
| pages = 719–720 |
||
| publisher = Fitzroy Dearborn |
| publisher = Fitzroy Dearborn |
||
| place = London |
| place = London |
||
Line 505: | Line 505: | ||
| title = Encyclopedia of Historians and Historical Writing |
| title = Encyclopedia of Historians and Historical Writing |
||
| volume = 1 |
| volume = 1 |
||
| pages = |
| pages = 719–720 |
||
| publisher = Fitzroy Dearborn |
| publisher = Fitzroy Dearborn |
||
| place = London |
| place = London |
||
Line 574: | Line 574: | ||
* '''editor2-first''', '''editor3-first''', '''editor4-first''': The second, third, and fourth editors' first or given name(s), if applicable. |
* '''editor2-first''', '''editor3-first''', '''editor4-first''': The second, third, and fourth editors' first or given name(s), if applicable. |
||
* '''editor2-link''', '''editor3-link''', '''editor4-link''': Title of an existing Wikipedia article about the second, third, and fourth editor, if applicable. |
* '''editor2-link''', '''editor3-link''', '''editor4-link''': Title of an existing Wikipedia article about the second, third, and fourth editor, if applicable. |
||
* '''title''': Title of the book or compilation. If the title includes [square brackets], these must be encoded |
* '''title''': Title of the book or compilation. If the title includes [square brackets], these must be encoded as "<code>&#91;</code>" for "[" and "<code>&#93;</code>" for "]" |
||
* '''periodical''' (or '''journal''', '''newspaper''', '''magazine'''): Name of the periodical. |
* '''periodical''' (or '''journal''', '''newspaper''', '''magazine'''): Name of the periodical. |
||
* '''series''': Series of which this periodical is a part. |
* '''series''': Series of which this periodical is a part. |
||
Line 695: | Line 695: | ||
* '''publication-date''': Date of publication or filing. |
* '''publication-date''': Date of publication or filing. |
||
* '''issue-date''' (or '''date'''): Date patent was issued by patent agency. |
* '''issue-date''' (or '''date'''): Date patent was issued by patent agency. |
||
* '''title''': Title of the patent. If the title includes [square brackets], these must be encoded |
* '''title''': Title of the patent. If the title includes [square brackets], these must be encoded as "<code>&#91;</code>" for "[" and "<code>&#93;</code>" for "]" |
||
* '''country-code''': [[ISO 3166-1 alpha-2|Two-letter abbreviation]] of the country issuing the patent. |
* '''country-code''': [[ISO 3166-1 alpha-2|Two-letter abbreviation]] of the country issuing the patent. |
||
* '''description''': Type of patent; shown between country code and number. |
* '''description''': Type of patent; shown between country code and number. |
||
Line 755: | Line 755: | ||
{{UF-COinS}} |
{{UF-COinS}} |
||
== |
==Additional parameters== |
||
{{AuthorMask doc}} |
{{AuthorMask doc}} |
||
<includeonly> |
<includeonly> |
||
[[Category:Citation templates| |
[[Category:Citation templates| ]] |
||
[[da:Skabelon:Citation]] |
[[da:Skabelon:Citation]] |
Revision as of 21:06, 23 April 2010
![]() | This is a documentation subpage for Template:Citation It may contain usage information, categories and other content that is not part of the original template page. |
Template:For2 The Citation template generates a citation for a book, periodical, contribution in a collective work, patent, or a web page. It determines the citation type by examining which parameters are used.
If invoked with the right parameters, this template produces output identical to that of the Cite templates, such as {{cite book}} and {{cite web}}. The default behavior sometimes differs from that of the Cite templates; for example, this template by default generates anchors for Harvard references whereas the Cite templates do not, and this template by default uses commas to separate some fields that the Cite templates separate with periods.
All parameter names are lowercase.
Anchored citations
This template can generate a citation that can be combined with shortened footnotes or parenthetical referencing. It does this by creating an HTML anchor containing an ID. The special parameter |ref=harv
generates an ID suitable for Harvard referencing templates such as {{harv}} as specified in the next section; this is the default for the {{citation}} template. If an empty |ref=
is given, no anchor is generated; this is the default for the Cite templates such as {{cite book}} and {{cite news}}. You can also specify the ID directly, using the |ref=ID
parameter. For example, suppose an article's References section contains the markup:
{{Citation |author=Sigmund Freud |title=Civilization and Its Discontents |year=1930 |ref=CivDis}}
which generates the citation:
- Lua error: bad argument #1 to "get" (not a valid title).
Then, the markup "([[#CivDis|Freud 1930]])
" generates a parenthetical reference "(Freud 1930)" containing a wikilink to the citation (try clicking on the wikilink).
Anchors for Harvard referencing templates
IDs compatible with Harvard referencing templates such as {{harv}} are computed from the last names of the authors and the year of the cited source. For example, the markup "{{harv|Wright|Evans|1851|p=ix}}
" generates the Harvard reference "(Wright & Evans 1851, p. ix)", which wikilinks to the citation whose markup and appearance are shown below:
{{Citation |last1=Wright |first1=Thomas |last2=Evans |first2=R.H. |title=Historical and Descriptive Account of the Caricatures of James Gillray |location=London |publisher=Henry G. Bohn |year=1851 |oclc=59510372 }}
- Lua error: bad argument #1 to "get" (not a valid title).
In this example the {{citation}} template defines, and the {{harv}} template uses, the HTML ID "CITEREFWrightEvans1851
", composed by concatenating the string "CITEREF
" with the last names of the authors and the year. The {{harvid}} template can be used to generate such IDs, for example, {{harvid|Wright|Evans|1851}}
generates "CITEREFWrightEvans1851
".
The names of only the first four authors are used; other author names are not concatenated to the ID. If no author names are given, editor names are used instead. For patents, inventor names are used instead of authors or editors. If these names are not given, this template does not generate an anchor.
Last names are used, as specified by the parameters |last1=
(or |last=
), |last2=
, |last3=
, and |last4=
, and similarly for |editor1-last=
etc. and for |inventor1-last=
etc. If a full name is given but no last name is specified, this template falls back on the full name, but this usage is not recommended. For example, in "{{Citation |author=Sigmund Freud |title=The Ego and the Id |year=1923}}
" no last name is given, so this citation cannot be combined with the Harvard reference "{{harv|Freud|1923}}
". To make these {{citation}} and {{harv}} invocations compatible, either replace "|author=Sigmund Freud
" with "|first=Sigmund
|last=Freud
", or add "|ref={{harvid|Freud|1923}}
" to the {{citation}} invocation, or add the same ref parameter (say, "|ref=EgoId
") to both the {{citation}} and the {{harv}} invocations.
Similarly, the year is used, as specified by |year=
. If no year is given, this template attempts to derive the year from |date=
(or, if no date is given, from |publication-date=
) by applying the MediaWiki #time function. This heuristic works with many common date formats but has known problems, so when in doubt it is safer to use |year=
.
IDs must be unique
Names, years, and hand-specified IDs must be chosen so that the IDs are unique within a page; otherwise the HTML will not conform to the W3C standards, and any references to the citations will not work reliably. For example, suppose a page contains the following two citations with {{harv}}-compatible IDs:
- Lua error: bad argument #1 to "get" (not a valid title).
- Lua error: bad argument #1 to "get" (not a valid title).
If these citations were altered to say "2008" rather than "2008a" and "2008b", the resulting page would not work, because the two different citations would both attempt to use the ID "CITEREFMontesHalterman2008
". To avoid this problem, distinguish the citations by appending suffixes to the years, e.g., "|year=2008a
" and "|year=2008b
", as was done above. Any Harvard references to these citations should use years with the same suffixes.
It is good practice to verify that a page does not contain duplicate IDs by using the W3C Markup Validation Service; see External links.
Citing books
Parameters (all are optional)
{{Citation |last= |first= |author= |authorlink= |coauthors= |firstn=,lastn=,authorn= |author-separator= |editor= |editorn= |editorn-last= |editorn-first= |editor-link= |editorn-link= |others= |title= |url= |archiveurl= |archivedate= |format= |accessdate= |edition= |series= |volume= |date= |origyear= |year= |month= |publisher= |location= |language= |isbn= |oclc= |doi= |doi_brokendate= |bibcode= |id= |page= |pages= |nopp= |at= |chapter= |chapterurl= |quote= |laysummary= |laydate= |separator= |postscript= |lastauthoramp= |ref= }} |
|
Examples
One author | {{ Citation | last=Turner | first=O. | title=History of the Pioneer Settlement of Phelps and Gorham's Purchase, and Morris' Reserve | publisher=William Alling | place=Rochester, New York | year=1851 | url = http://olivercowdery.com/texts/1851Trn1.htm#turn1851 }} |
Lua error: bad argument #1 to "get" (not a valid title). |
Three authors, a volume, and an edition. Ampersand (&) forced before final author's name. | {{ Citation | last1=Lincoln | first1=A. | last2=Washington | first2=G. | last3=Adams | first3=J. | lastauthoramp=yes | title=All the Presidents' Names | publisher=The Pentagon | place=Home Base, New York | volume=XII | edition=2nd | year=2007 }} |
Lua error: bad argument #1 to "get" (not a valid title). |
Citing journals, newspapers, magazines, or other periodicals
Parameters
{{Citation | last = | first = | author-link = | publication-date = | date = | year = | title = | periodical = | series = | publication-place = | place = | publisher = | volume = | issue = | pages = | page = | at = | url = | archiveurl = | archivedate = | issn = | pmid = | pmc = | doi = | oclc = | accessdate = | ref = }} |
Template:Citation parameter legend |
Examples
Journal article | {{Citation | last=Hill | first=Marvin S. | title=Joseph Smith and the 1826 Trial: New Evidence and New Difficulties | journal=BYU Studies | volume=12 | issue=2 | year=1976 | pages=1–8 | url=https://byustudies.byu.edu/ shop/PDFSRC/12.2Hill.pdf }} |
Lua error: bad argument #1 to "get" (not a valid title). |
Newspaper article | {{Citation | last=Smith | first=Joseph III | author-link=Joseph Smith III | title=Last Testimony of Sister Emma | newspaper=The Saints' Herald | publication-place=Plano, IL | volume=26 | issue=19 | date=October 1, 1879 | year=1879 | month=October | page=289 | url=http://www.sidneyrigdon.com/ dbroadhu/IL/sain1872.htm#100179 }} |
Lua error: bad argument #1 to "get" (not a valid title). |
Citing edited books, or parts of edited books, including encyclopedias and encyclopedia articles
Parameters
{{Citation | last = | first = | author-link = | last2 = | first2 = | author2-link = | year = | date = | publication-date = | contribution = | contribution-url = | editor-last = | editor-first = | editor-link = | editor2-last = | editor2-first = | editor2-link = | title = | edition = | series = | place = | publication-place = | publisher = | volume = | pages = | id = | isbn = | doi = | oclc = | url = | ref = }} |
|
Examples
Manuscript published in an edited compilation | {{Citation | last=Bidamon | first=Emma Smith | author-link=Emma Hale Smith | chapter=Letter to Emma S. Pilgrim | date=March 27, 1876 | year=1876 | editor-last=Vogel | editor-first=Dan | title=Early Mormon Documents | volume=1 | publisher=Signature Books | publication-date=1996 | isbn=1–56085–072–8 }} |
Lua error: bad argument #1 to "get" (not a valid title). |
Work with an editor but no author | {{Citation | editor-last=Vogel | editor-first=Dan | title=Early Mormon Documents | volume=1 | publisher=Signature Books | publication-date=1996 | isbn=1–56085–072–8 }} |
Lua error: bad argument #1 to "get" (not a valid title). |
Encyclopedia article by a named author | {{Citation | last = Kramer | first = Martin | author-link = Martin Kramer | contribution = Bernard Lewis | editor-last = Boyd | editor-first = Kelley | title = Encyclopedia of Historians and Historical Writing | volume = 1 | pages = 719–720 | publisher = Fitzroy Dearborn | place = London | publication-date = 1999 | contribution-url = http:// www.geocities.com/martinkramerorg/ BernardLewis.htm }} |
Lua error: bad argument #1 to "get" (not a valid title). |
Encyclopedia article with no named author | {{Citation | contribution = Bernard Lewis | editor-last = Boyd | editor-first = Kelley | title = Encyclopedia of Historians and Historical Writing | volume = 1 | pages = 719–720 | publisher = Fitzroy Dearborn | place = London | year = 1999 | contribution-url = http:// www.geocities.com/martinkramerorg/ BernardLewis.htm }} |
Lua error: bad argument #1 to "get" (not a valid title). |
Citing contributions, republications, or edited quotations in a periodical article
Parameters
{{Citation | last = | first = | author-link = | last2 = | first2 = | author2-link = | year = | date = | publication-date = | contribution = | contribution-url = | editor-last = | editor-first = | editor-link = | editor2-last = | editor2-first = | editor2-link = | title = | periodical = | series = | volume = | issue = | pages = | place = | publication-place = | publisher = | id = | issn = | doi = | oclc = | url = | accessdate = | ref = }} |
|
Examples
Manuscript edited and published in a journal | {{Citation | last=Knight | first=Joseph, Sr. | year=1833 | editor-last=Jessee | editor-first=Dean | title=Joseph Knight's Recollection of Early Mormon History | journal=BYU Studies | volume=17 | issue=1 | publication-date=1976 | pages=35 | url=https://byustudies.byu.edu/ shop/PDFSRC/17.1Jessee.pdf }} |
Lua error: bad argument #1 to "get" (not a valid title). |
Manuscript written at one date and place, then published in a periodical at a different date and place with commentary by the editor. | {{Citation | last=Klingensmith | first=Philip | contribution=Affidavit | year=1872 | date=September 5, 1872 | place=Lincoln County, Nevada | title=Mountain Meadows Massacre | editor-last=Toohy | editor-first=Dennis J. | journal=Corinne Daily Reporter | publication-date=September 24, 1872 | publication-place=Corinne, Utah | volume=5 | issue=252 | pages=1 | contribution-url=http:// udn.lib.utah.edu/u?/corinne,5359 }} |
Lua error: bad argument #1 to "get" (not a valid title). |
Citing patents
Parameters (all are optional)
{{Citation | inventor-last = | inventor-first = | inventorlink = | inventor2-last = | inventor2-first = | inventorlink2 = | publication-date = | issue-date = | title = | country-code = | description = | patent-number = }} |
|
Examples
United States patent with multiple inventors | {{Citation | inventor1-last = Degermark | inventor1-first = Mikael | inventor2-last = Brodnik | inventor2-first = Andrej | inventor3-last = Carlsson | inventor3-first = Svante | inventor4-last = Pink | inventor4-first = Stephen | title = Fast routing lookup system using complete prefix tree, bit vector, and pointers in a routing table for determining where to route IP datagrams | issue-date = 2001 | patent-number = 6266706 | country-code = US}} |
Lua error: bad argument #1 to "get" (not a valid title). |
Dates
- ↑ 1.0 1.1 1.2 1.3 1.4 1.5 1.6 1.7 1.8
- The format of dates in the references of an article should use a consistent and unambiguous style. Example formats used in Wikipedia citations include:
- 2009
- 2009-09-14
- 14 September 2009
- September 14, 2009 (with comma)
- 2009 Sep 14
- September 2009
- Sept./Oct. 2009
- As indicated above, month names are sometimes abbreviated (e.g., September to "Sept" or "Sept." or "Sep" or "Sep.")
- Dates should not be linked in references.
- Please see Wikipedia:Manual of Style (dates and numbers) for more guidance about formatting dates.
Tools
See Wikipedia:Citing sources for a list of tools which can help create a reference in the 'citation' format.
COinS
This template produces COinS metadata; see COinS in Wikipedia for background information.
Additional parameters