Template:Cite bioRxiv/doc
bioRxiv contains preliminary reports that have not been peer-reviewed and hence should be used with a high degree of caution. Per WP:MEDRS and WP:SCIRS, these reports should not be used to support medical or scientific claims. |
This is a documentation subpage for Template:Cite bioRxiv. It may contain usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
{{Cite arXiv}} | arXiv preprints |
---|---|
{{Cite AV media}} | audio and visual media |
{{Cite AV media notes}} | AV media liner notes |
{{Cite bioRxiv}} | bioRxiv preprints |
{{Cite book}} | books and chapters |
{{Cite CiteSeerX}} | CiteSeerX papers |
{{Cite conference}} | conference papers |
{{cite document}} | short, stand-alone, offline documents |
{{Cite encyclopedia}} | edited collections |
{{Cite episode}} | radio or TV episodes |
{{Cite interview}} | interviews |
{{Cite journal}} | academic journals |
{{Cite magazine}} | magazines, periodicals |
{{Cite mailing list}} | public mailing lists |
{{Cite map}} | maps |
{{Cite medRxiv}} | medRxiv preprints |
{{Cite news}} | news articles |
{{Cite newsgroup}} | online newsgroups |
{{Cite podcast}} | podcasts |
{{Cite press release}} | press releases |
{{Cite report}} | reports |
{{Cite serial}} | audio or video serials |
{{Cite sign}} | signs, plaques |
{{Cite speech}} | speeches |
{{Cite SSRN}} | SSRN papers |
{{Cite tech report}} | technical reports |
{{Cite thesis}} | theses |
{{Cite web}} | web sources not covered by the above |
See also | Specific-source templates Citation Style 1 wrapper templates |
This Citation Style 1 template is used to create citations for preprints at the bioRxiv. It links to the abstract at https://doi.org/'''10.1101/######
, which will usually resolve to https://www.biorxiv.org/content/biorxiv
.
Usage
- Common parameters, horizontal format
{{cite bioRxiv |last1= |first1= |date= |title= |biorxiv=}}
- biorxiv (Mandatory): bioRxiv DOI identifier. That is use
|biorxiv=10.1101/012345
not|doi=10.1101/012345
- title: Title of the cited paper.
The template uses the style of {{cite journal}}. Once a paper is accepted in a peer-reviewed journal, it is recommended to use one of those templates, as the peer-reviewed status of the article is important, while preserving the bioRxiv link in order to guarantee open access to the previous version of the article. To preserve the bioRxiv link, add e.g. |biorxiv=10.1101/012345
to the {{citation}} or {{cite journal}} templates.
Examples
{{cite bioRxiv |last1=Navarrete |first1=I. |last2=Panchi |first2=N. |last3=Kromann |first3=P. |last4=Forbes |first4=G. |last5=Andrade-Piedra |first5=J. |date=15 February 2017 |title=Health quality of seed potato and yield losses in Ecuador |biorxiv=10.1101/108712}}
- Navarrete, I.; Panchi, N.; Kromann, P.; Forbes, G.; Andrade-Piedra, J. (15 February 2017). "Health quality of seed potato and yield losses in Ecuador". bioRxiv 10.1101/108712.
Parameters
Deprecated
{{#lst:Help:CS1 errors|deprecated_params_table}} {{#lst:Help:CS1 errors|deleted_params_table}}
Description
Authors
- 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 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).
|first1=...
|last1=...
|author2=...
.
Aliases: surname1, given1 through surnamen, givenn, or author1 through authorn. For an individual author plus an institutional author, you can use - 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 toand
, inserts the conjunction 'and' between the last two names of a name list; when set tovanc
displays name lists in Vancouver style when the lists use thelast
/first
forms of name parameters.
- 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
- 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
- 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.
- Note: When using shortened footnotes or parenthetical referencing styles with templates, do not use multiple names in one field, or else the anchor will not match the inline link.
Date
- 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.
- 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
orupdated
date; a comment for editors such asdate=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:- 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.) - The
|date=
format is YYYY-MM-DD. (This format prevents the addition of a disambiguating letter to the year.)
- Shortened footnotes target multiple citations with same last name and year of publication. (This situation necessitates a
- 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 formatymd
– as above for year initial numeric format YYYY-MM-DDdmy-all
– set publication, access-, and archive-dates to day month year format;mdy-all
– as above for month day, year formatymd-all
– as above for year initial numeric format YYYY-MM-DD
- ↑ 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.
Title
- title: Title of source. Displays in italics.
- Titles containing certain characters will not display and link correctly unless those characters are encoded.
newline | [ | ] | | |
---|---|---|---|
space | [ | ] | {{!}} (preferred)
|
{{bracket|text}} | | or {{pipe}} – |
- language: 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: español at a French-language wiki instead of the English word "Spanish". Aliases: lang
TemplateData
TemplateData for Cite bioRxiv
<templatedata> { "params": { "biorxiv": { "label": "bioRxiv", "description": "bioRxiv identifier without the \"bioRxiv:\" prefix", "type": "string", "required": true, "example": "108712" }, "title": { "label": "Title", "description": "Title of the paper cited", "type": "string", "suggested": true }, "first": { "aliases": [ "first1", "given", "given1" ], "label": "First name", "description": "First name of first author", "type": "string", "suggested": true }, "last": { "aliases": [ "last1", "surname", "surname1" ], "label": "Last name", "description": "Last name of first author", "type": "string", "suggested": true }, "author": { "aliases": [ "author1" ], "label": "Author", "description": "Complete name of the first author", "type": "string" }, "author-link": { "aliases": [ "author-link1", "author1-link" ], "label": "Author's article", "description": "Title of the Wikipedia article about the first author", "type": "wiki-page-name" }, "first2": { "aliases": [ "given2" ], "label": "Author 2's first name", "description": "First name of second author", "type": "string" }, "last2": { "aliases": [ "surname2" ], "label": "Author 2's last name", "description": "Last name of second author", "type": "string" }, "author2": { "label": "Author 2", "description": "Full name of second author", "type": "string" }, "author-link2": { "aliases": [ "authorlink2", "author2-link", "author2link" ], "label": "Author 2's article", "description": "Title of Wikipedia article about the second author", "type": "wiki-page-name" }, "collaboration": { "label": "collaboration", "description": "Name of a group of authors, in addition to the ones listed in the Author parameters", "type": "string" }, "date": { "label": "Date", "description": "Date of the source being cited. Use n.d. for no date, and c. for inexact dated.", "type": "string" }, "df": { "label": "Date format for publication dates", "description": "Either ymd (Year-Month-Day), dmy (Day-Month-Year), or mdy (Month-Day-Year) add -all at end to also affect access and archive dates", "example": "dmy", "type": "string" }, "trans-title": { "label": "Translated title", "description": "English translation of title", "type": "string" }, "language": { "label": "Language(s)", "description": "Language(s) the source is written in. Separate by commas, and do not include 'and'.", "type": "string" } }, "format": "{{_ |_=_}}", "description": "Formats a citation to a paper with a bioRxiv id", "paramOrder": [ "biorxiv", "author", "first", "last", "first2", "last2", "author2", "author-link", "author-link2", "title", "collaboration", "date", "df", "trans-title", "language" ] } </templatedata>