Grlucas: 1 revision imported

2018-11-27T12:49:12Z

1 revision imported

← Older revision		Revision as of 08:49, 27 November 2018
(No difference)

en>Boghog: /* Rationale */ include section on consistency

2018-08-06T08:24:06Z

Rationale: include section on consistency

New page

{{Documentation subpage}}


{{Lua|Module:Citation/CS1|Module:ParseVauthors}}

This template is used to create citations for articles in journals. It is an alternative to {{tl|cite journal}} that instead formats authors according to the [[Vancouver system]]. This author format is documented in:
* {{cite book | author = Patrias K | editor = Wendling P | title = The NLM Style Guide for Authors, Editors, and Publishers [Internet]| chapter = Author for Journal Articles | chapterurl = https://www.ncbi.nlm.nih.gov/books/NBK7282/#A32371 | year = 2011 | origyear = 2007 | publisher = National Library of Medicine (US) | location= Bethesda (MD) | edition = 2<sup>nd</sup> }}
* {{cite web | url = https://www.nlm.nih.gov/bsd/uniform_requirements.html | author = International Committee of Medical Journal Editors (ICMJE) | title = Recommendations for the Conduct, Reporting, Editing and Publication of Scholarly Work in Medical Journals: Sample References | publisher = U.S. National Library of Medicine }}

In all other respects, this template is identical to {{tl|cite journal}}. Both are based on [[Module:Citation/CS1]] and use identical parameters. The only difference is in how the authors are rendered.

== Default parameter settings ==

This template achieves Vancouver author format by changing the default settings for the following parameters to:

<code> | name-list-format = vanc | display-authors = 6 </code>

Note: While the [[National Library of Medicine]] now lists all authors,<ref name="urlPubMed Help - PubMed Help - NCBI Bookshelf">{{cite web | url = https://www.ncbi.nlm.nih.gov/books/NBK3827/#pubmedhelp.NLM_Author_Indexing_ | title = NLM Author Indexing Policy | work = NCBI Bookshelf }}</ref> the original [[ICMJE]] recommendations state "''List the first six authors followed by et al.''"<ref name="url_ICMJE">{{cite web | url = https://www.nlm.nih.gov/bsd/uniform_requirements.html | author = International Committee of Medical Journal Editors (ICMJE) | title = Recommendations for the Conduct, Reporting, Editing and Publication of Scholarly Work in Medical Journals: Sample References | format = | work = | publisher = U.S. National Library of Medicine }}</ref> The default {{para|display-authors|6}} setting follows the ICMJE recommendation.

== Optional vauthors parameter ==

{| class="wikitable floatright" style="text-align: center;"
|-
! colspan="4" | Comparison of alternative author parameters
|-
! Feature !! {{para|lastn}},<br />{{para|firstn}} !! {{para|vauthors}} !! {{para|authors}}
|-
| Clean author metadata || {{ya}} || {{ya}} || {{na}}
|-
| {{para|author-link}} compatible || {{ya}} || {{ya}} || {{na}}
|-
| {{para|display-authors}} compatible || {{ya}} || {{ya}} || {{na}}
|-
| Author format checking || {{na}} || {{ya}} || {{na}}
|-
| Compact || {{na}} || {{ya}} || {{ya}}
|}

This template adds support for an optional {{para|vauthors}} parameter that generates clean author [[metadata]] in the HTML output (see [[Wikipedia:COinS]]) while avoiding the character overhead of explicit firstn, lastn parameters. The {{para|vauthors}} parameter is also fully compatible with {{para|author-link}} and {{para|displayauthors}} parameters.

== Parameter explanations ==

; vauthors: Author list formatted in Vancouver style ([[comma-separated values|comma separated list]]). This concatenated author list is automatically split internally by the template into the individual authors' first and last names that are respectively assigned to sequential {{para|first1}}, {{para|last1}}, {{para|first2}}, {{para|last2}}, ... parameters. This parameter is also checked for formatting errors (should not contain semicolons or periods, neither of which conforms to the Vancouver system). If such an error is detected, a vauthors error message is appended to the rendered citation.

; other parameters: Refer to the [[Template:Cite_journal#Parameters|documentation]] in {{tl|cite journal}}.

== Usage ==

Single vauthors parameter (recommended):
:* <nowiki>{{vcite2 journal | vauthors = Awata T, Yamashita H, Kurihara S, Morita-Ohkubo T, Miyashita Y, Katayama S, Mori K, Yoneya S, Kohda M, Okazaki Y, Maruyama T, Shimada A, Yasuda K, Nishida N, Tokunaga K, Koike A | title = A genome-wide association study for diabetic retinopathy in a Japanese population: potential association with a long intergenic non-coding RNA | journal = PLoS ONE | volume = 9 | issue = 11 | pages = e111715 | year = 2014 | pmid = 25364816 | pmc = 4218806 | doi = 10.1371/journal.pone.0111715 }}</nowiki> →
:* {{vcite2 journal | vauthors = Awata T, Yamashita H, Kurihara S, Morita-Ohkubo T, Miyashita Y, Katayama S, Mori K, Yoneya S, Kohda M, Okazaki Y, Maruyama T, Shimada A, Yasuda K, Nishida N, Tokunaga K, Koike A | title = A genome-wide association study for diabetic retinopathy in a Japanese population: potential association with a long intergenic non-coding RNA | journal = PLoS ONE | volume = 9 | issue = 11 | pages = e111715 | year = 2014 | pmid = 25364816 | pmc = 4218806 | doi = 10.1371/journal.pone.0111715 }}

"author1, author2, ..." parameters:
:* <nowiki>{{vcite2 journal | author1 = Awata T | author2 = Yamashita H | author3 = Kurihara S | author4 = Morita-Ohkubo T | author5 = Miyashita Y | author6 = Katayama S | author7 = Mori K | author8 = Yoneya S | author9 = Kohda M | author10 = Okazaki Y | author11 = Maruyama T | author12 = Shimada A | author13 = Yasuda K | author14 = Nishida N | author15 = Tokunaga K | author16 = Koike A | title = A genome-wide association study for diabetic retinopathy in a Japanese population: potential association with a long intergenic non-coding RNA | journal = PLoS ONE | volume = 9 | issue = 11 | pages = e111715 | year = 2014 | pmid = 25364816 | pmc = 4218806 | doi = 10.1371/journal.pone.0111715 }}</nowiki> →
:* {{vcite2 journal | author1 = Awata T | author2 = Yamashita H | author3 = Kurihara S | author4 = Morita-Ohkubo T | author5 = Miyashita Y | author6 = Katayama S | author7 = Mori K | author8 = Yoneya S | author9 = Kohda M | author10 = Okazaki Y | author11 = Maruyama T | author12 = Shimada A | author13 = Yasuda K | author14 = Nishida N | author15 = Tokunaga K | author16 = Koike A | title = A genome-wide association study for diabetic retinopathy in a Japanese population: potential association with a long intergenic non-coding RNA | journal = PLoS ONE | volume = 9 | issue = 11 | pages = e111715 | year = 2014 | pmid = 25364816 | pmc = 4218806 | doi = 10.1371/journal.pone.0111715 }}

"first1, last1, first2, last2, ..." parameters:
:* <nowiki>{{vcite2 journal | last1 = Awata | first1 = T | last2 = Yamashita | first2 = H | last3 = Kurihara | first3 = S | last4 = Morita-Ohkubo | first4 = T | last5 = Miyashita | first5 = Y | last6 = Katayama | first6 = S | last7 = Mori | first7 = K | last8 = Yoneya | first8 = S | last9 = Kohda | first9 = M | last10 = Okazaki | first10 = Y | last11 = Maruyama | first11 = T | last12 = Shimada | first12 = A | last13 = Yasuda | first13 = K | last14 = Nishida | first14 = N | last15 = Tokunaga | first15 = K | last16 = Koike | first16 = A | title = A genome-wide association study for diabetic retinopathy in a Japanese population: potential association with a long intergenic non-coding RNA | journal = PLoS ONE | volume = 9 | issue = 11 | pages = e111715 | year = 2014 | pmid = 25364816 | pmc = 4218806 | doi = 10.1371/journal.pone.0111715 }}</nowiki> →
:* {{vcite2 journal | last1 = Awata | first1 = T | last2 = Yamashita | first2 = H | last3 = Kurihara | first3 = S | last4 = Morita-Ohkubo | first4 = T | last5 = Miyashita | first5 = Y | last6 = Katayama | first6 = S | last7 = Mori | first7 = K | last8 = Yoneya | first8 = S | last9 = Kohda | first9 = M | last10 = Okazaki | first10 = Y | last11 = Maruyama | first11 = T | last12 = Shimada | first12 = A | last13 = Yasuda | first13 = K | last14 = Nishida | first14 = N | last15 = Tokunaga | first15 = K | last16 = Koike | first16 = A | title = A genome-wide association study for diabetic retinopathy in a Japanese population: potential association with a long intergenic non-coding RNA | journal = PLoS ONE | volume = 9 | issue = 11 | pages = e111715 | year = 2014 | pmid = 25364816 | pmc = 4218806 | doi = 10.1371/journal.pone.0111715 }}

== Rationale ==

The two main advantages of {{para|vauthors}} is efficiency and consistency.

=== Efficiency ===

The [[WP:CITE|purpose of citations]] is to support the corresponding text. If a citation has a large number authors, the use of explicit {{para|first1}}, {{para|last1}}, {{para|first2}}, {{para|last2}}, ... parameters in {{tl|cite journal}} becomes unwieldy and starts to overwhelm the surrounding [[wiki markup|wiki text]]. The author format in the [[Vancouver system]] is both efficient (requires fewer characters) and accurate (it is easy to parse since it is comma delimited). For citations a large number of authors, this template permits a significant reduction in both the length of the displayed citation as well as the size of the imbedded template.

According to [[WP:MEDREF]], medical articles should be relatively dense with inline citations. At the same time, there has been a steady increase in the average number of authors in citations in the biomedical<ref name="urlNumber of Authors per MEDLINE/PubMed Citation">{{cite web | url = https://www.nlm.nih.gov/bsd/authors1.html | title = Number of Authors per MEDLINE/PubMed Citation | publisher =U.S. National Library of Medicine }}</ref> and physical sciences.<ref name="urlMultiauthor Papers: Onward and Upward - ScienceWatch Newsletter">{{cite web | url = http://archive.sciencewatch.com/newsletter/2012/201207/multiauthor_papers/ | title = Multiauthor Papers: Onward and Upward | work = ScienceWatch Newsletter | publisher = Thomson Reuters }}</ref> Citations with "hyperauthorship" (authors in excess of 50) are becoming increasingly common.<ref name="urlMultiauthor Papers: Onward and Upward - ScienceWatch Newsletter"/> Because of the number and size of citations, it becomes increasingly difficult to locate and edit prose within wiki text. The use of a compact author format may be useful in these situations.

Alternatives are to use {{tl|cite pmid}}, {{tl|cite doi}}, etc. templates, but the use of these templates per [[Template_talk:Cite_doi/Archive_1#RfC:_Should_Template:cite_doi_cease_creating_a_separate_subpage_for_each_DOI?|consensus]] has been deprecated. [[WP:LDR|List defined references]] is another alternative, but the disadvantage of this approach is that it separates the text and citation which is used to support the text.

=== Consistency ===

{{para|firstn}} imposes few restrictions on how first names stored and displayed. The first name parameter may or may not include middle names, may be spelled out in full or use initials, and if initials are used may or may not include periods and may or may not contain a space between the first and middle initials. In contrast {{para|vauthors}} imposes strict restrictions on how first names are stored and displayed. The first name can only be one (first name initial) or two (first + middle initial). In short, the use of {{para|vauthors}} insures that author name are consistently formatted throughout an article.

== Tools ==

[https://tools.wmflabs.org/citation-template-filling/cgi-bin/index.cgi Wikipedia template filling]: Converts PubMed ID or PubMed Central ID to a full <nowiki>{{vcite2 journal}}</nowiki> citation.

== See also ==
* [[Wikipedia:Citing sources|Citing sources]]
* {{tl|vcite journal}}, {{tl|vancite journal}}, {{tl|cite journal}} – Cite journal articles.
* {{tl|citation}} – Cite sources in general.

== References ==
{{Reflist}}

{{UF-COinS}}

<includeonly>{{#ifeq:{{SUBPAGENAME}} | sandbox | |

[[Category:Citation Style 1 meta-templates]]
[[Category:Citation Style Vancouver templates]]
}}</includeonly>

Template:Vcite2 journal/doc - Revision history

Grlucas: 1 revision imported

en>Boghog: /* Rationale */ include section on consistency