Difference between revisions of "Template:Cite doi/doc"

From blackwiki
Jump to navigation Jump to search
imported>Boghog
m (typo)
imported>Glades12
(→‎Overview: Fixed spelling)
 
(51 intermediate revisions by 26 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
{{mbox|image=[[File:Stop hand caution.svg|60px]]|text=Per [[WP:CITEVAR]], only use this template in articles whose references are formatted as described below. Please '''do not use''' the cite doi template in articles whose references are formatted differently.}}
+
{{mbox|image=[[File:Stop hand.svg|60px]]|text=Per [[Template talk:Cite doi/Archive 1#Should the cite doi template call to individual subtemplates for each doi listing?|consensus]], this template should no longer be used. Instead, please use {{tlx|cite journal|doi{{=}}...}} (see [[Template:Cite journal#Usage|documentation]]).  Also, this template is no longer filled by a bot, so humans have to fix it. }}
  
==Usage==
+
==Overview==
 +
{{tl|Cite doi}} was a template that was used for citing a journal article using its [[digital object identifier|DOI]] number. When this was functioning, an editor could use the template with the DOI number, and a [[User:Citation bot|bot]] would then fill out the full reference. However, the bot created a separate template page for each individual citation which were simply calls to {{tl|cite journal}}.  An [[Template talk:Cite doi/Archive 1#RfC: Should Template:cite doi cease creating a separate subpage for each DOI?|RFC at this template's talk page]] concluded with the consensus that this template should no longer be used because of various problems caused by this system.
  
Saves you filling out a citation template every time you want to cite a journal article. If your source article has a [[digital object identifier]] (DOI), just enter <code><nowiki>{{Cite doi|doi of your source}}</nowiki></code>.  There is no need to [[WP:subst|subst]] this template (so long as it matches the format of citations already in the article).
+
Instead use {{tlx|cite journal|doi{{=}}...}}, which allows you to specify the DOI, then run the citation bot on the page. The [[WP:CITOID|Citoid feature]], which is part of [[WP:VISUAL|Visual Editor]], does this too, and as well as other third-party tools.
  
If another Wikipedia article already uses that reference (via the Cite doi template), it will automatically use the existing information to present the full citation details of the reference in the article. If not, a bot will complete it for you if you click the "jump the queue" link (the bot does not currently autofill the template).  
+
==Third-party tools==
 +
When using third-party tools, you are still responsible for your edits. Proofread the content generated by any of these tools.
  
Use like this:
+
* [https://reftag.appspot.com/doiweb.py DOI Wikipedia reference generator]
 
+
* [[User:Citation bot]]
:<code><nowiki><ref name="Example2006">{{Cite doi|10.1146/annurev.earth.33.092203.122621}}</ref></nowiki></code>
 
 
 
To refer to the same reference elsewhere in the same article, use:
 
 
 
:<code><nowiki><ref name="Example2006"/></nowiki></code>
 
 
 
===Quotes===
 
 
 
To include a quote from the reference, just place it inside the '''ref''' tags. To include more than one quote, the '''name''' parameter must be unique for each '''ref''' tag.
 
 
 
:<code><nowiki><ref name="Example2006a">{{Cite doi|10.1146/annurev.earth.33.092203.122621}} "A sample quote"</ref></nowiki></code><ref name=Example2006a>{{Cite doi|10.1146/annurev.earth.33.092203.122621}} "A sample quote"</ref>
 
 
 
:<code><nowiki><ref name="Example2006b">{{Cite doi|10.1146/annurev.earth.33.092203.122621}} "Another sample quote"</ref></nowiki></code><ref name=Example2006b>{{Cite doi|10.1146/annurev.earth.33.092203.122621}} "Another sample quote"</ref>
 
 
 
Second references for each
 
:<code><nowiki><ref name="Example2006a" /><ref name="Example2006b" /></nowiki></code><ref name="Example2006a" /><ref name="Example2006b" />
 
 
 
If the quote should appear every time a reference is used, then add a '''quote''' parameter to the cite doi template.
 
 
 
===Removing the "edit" link===
 
If you want to remove the "edit" link that this template places, add a second parameter with the text "noedit":
 
:<code><nowiki><ref name="Example2006c">{{Cite doi|10.1146/annurev.earth.33.092203.122621|noedit}}</ref></nowiki></code><ref name="Example2006c">{{Cite doi|10.1146/annurev.earth.33.092203.122621|noedit}}</ref>
 
 
 
===Modifying display of authors===
 
The number of authors displayed can be modified by adding a "displayauthors = n" parameter:
 
 
 
* <code><nowiki><ref>{{Cite doi/sandbox|10.1140/epja/i2006-10091-y}}</ref></nowiki></code><ref name = "Nishio_2006a">{{Cite doi/sandbox|10.1140/epja/i2006-10091-y}}</ref>
 
* <code><nowiki><ref>{{Cite doi/sandbox|10.1140/epja/i2006-10091-y|displayauthors=6}}</ref></nowiki></code><ref name = "Nishio_2006b">{{Cite doi/sandbox|10.1140/epja/i2006-10091-y|displayauthors=6}}</ref>
 
 
 
and by adding to the cite doi template:
 
* <code><nowiki>|displayauthors={{{displayauthors|}}}</nowiki></code>
 
 
 
The authors can be displayed in a [[Vancouver system]] format by adding a "van=yes" parameter:
 
* <code><nowiki><ref>{{Cite doi/sandbox|10.1140/epja/i2006-10091-y|displayauthors=6|van=yes}}</ref></nowiki></code><ref name = "Nishio_2006c">{{Cite doi/sandbox|10.1140/epja/i2006-10091-y|displayauthors=6|van=yes}}</ref>
 
 
 
and by adding to the cite doi template:
 
* <code><nowiki>
 
|displayauthors={{{displayauthors|}}}
 
|authorformat={{{authorformat|}}}
 
|author-separator={{{author-separator|}}}
 
|author-name-separator={{{author-name-separator|}}}</nowiki></code>
 
 
 
===Example references===
 
{{reflist}}
 
 
 
===Troubleshooting===
 
DOIs containing certain characters are not displayed and must be substituted in-text after expansion.
 
*< should be replaced with .3C
 
*> should be replaced with .3E
 
 
 
==Formatting==
 
{{Cite doi/doc/format}}
 
 
 
==Technical overview==
 
 
 
The template works by transcluding a template, which is stored as Template:cite doi/anchor_encoded_version_of_DOI.  This subpage is filled out by [[User:Citation bot|a bot]] using the {{tl|cite journal}} syntax.
 
  
 
== See also ==
 
== See also ==
{{cite doi family}}
+
* {{tl|Cite Q}}, a similar method based on Wikidata items instead of DOI-based sub-templates
*{{tl|Cite isbn}}
+
* [[Template:Ref doi]], a historically deprecated method to create references based upon citations created by this template
 +
* [[Template:Cite jstor]], another historically deprecated method based on JSTOR IDs that used this this template
 +
* [[Template:Cite pmid]], another historically deprecated method based on PMID-based sub-templates
 +
* [[Wikipedia:Digital Object Identifier]] and [[Handle System]]
  
 
{{Citation Style 1}}
 
{{Citation Style 1}}
<includeonly>
 
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
[[Category:Citation Style 1 templates]]
 
[[Category:Science citation templates]]
 
[[Category:Cite doi templates| ]]
 
 
</includeonly>
 
  
<includeonly>
+
<includeonly>{{Sandbox other||
[[simple:Template:Cite doi]]
+
<!-- TEMPLATE CATEGORIES, THANKS -->
</includeonly>
+
}}</includeonly>

Latest revision as of 12:38, 29 July 2020

Overview

{{Cite doi}} was a template that was used for citing a journal article using its DOI number. When this was functioning, an editor could use the template with the DOI number, and a bot would then fill out the full reference. However, the bot created a separate template page for each individual citation which were simply calls to {{cite journal}}. An RFC at this template's talk page concluded with the consensus that this template should no longer be used because of various problems caused by this system.

Instead use {{cite journal|doi=...}}, which allows you to specify the DOI, then run the citation bot on the page. The Citoid feature, which is part of Visual Editor, does this too, and as well as other third-party tools.

Third-party tools

When using third-party tools, you are still responsible for your edits. Proofread the content generated by any of these tools.

See also