Template:Vcite2 journal/doc

From PhysicsWiki
< Template:Vcite2 journal
Jump to: navigation, search

This template is used to create citations for articles in journals. It is an alternative to {{cite journal}} that instead formats authors according to the Vancouver system. This author format is documented in:

  • Lua error in Module:Citation/CS1 at line 746: Argument map not defined for this variable.
  • Lua error in Module:Citation/CS1 at line 746: Argument map not defined for this variable.

In all other respects, this template is identical to {{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:

| name-list-format = vanc | display-authors = 6

Note: While the National Library of Medicine now lists all authors, the original ICMJE recommendations state "List the first six authors followed by et al." The default |display-authors=6 setting follows the ICMJE recommendation.

Optional vauthors parameter

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

Parameter explanations

vauthors
Author list formatted in Vancouver style (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 |first1=, |last1=, |first2=, |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 documentation in {{cite journal}}.

Usage

Single vauthors parameter (recommended):

  • {{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 }} →
  • Lua error in Module:Citation/CS1 at line 746: Argument map not defined for this variable.

Single author parameter:

  • {{vcite2 journal | author = 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 }} →
  • Lua error in Module:Citation/CS1 at line 746: Argument map not defined for this variable.

"author1, author2, ..." parameters:

  • {{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 }} →
  • Lua error in Module:Citation/CS1 at line 746: Argument map not defined for this variable.

"first1, last1, first2, last2, ..." parameters:

  • {{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 }} →
  • Lua error in Module:Citation/CS1 at line 746: Argument map not defined for this variable.

Rationale

The purpose of citations is to support the corresponding text. If a citation has a large number authors, the use of explicit |first1=, |last1=, |first2=, |last2=, ... parameters in {{cite journal}} becomes unwieldy and starts to overwhelm the surrounding 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 PW: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[1] and physical sciences.[2] Citations with "hyperauthorship" (authors in excess of 50) are becoming increasingly common.[2] 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 {{cite pmid}}, {{cite doi}}, etc. templates, but the use of these templates per consensus has been deprecated. 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.

Tools

PhysicsWiki template filling: Converts PubMed ID or PubMed Central ID to a full {{vcite2 journal}} citation.

See also

References

  1. Lua error in Module:Citation/CS1 at line 746: Argument map not defined for this variable.
  2. 2.0 2.1 Lua error in Module:Citation/CS1 at line 746: Argument map not defined for this variable.

This template produces COinS metadata; see COinS in PhysicsWiki for background information.