Template:Cite bioRxiv/doc
 | This is a documentation subpage for Template:Cite bioRxiv. It contains 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 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 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 techreport}} | technical reports |
| {{Cite thesis}} | theses |
| {{Cite web}} | web sources not covered by the above |
| See also | Specific-source templates 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.
UsageEdit
- Common parameters, horizontal format
{{cite bioRxiv |last1= |first1= |date= |title= |biorxiv=}}
- biorxiv (Mandatory): bioRxiv DOI identifier. That is use
|biorxiv=10.1101/012345not|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.
ExamplesEdit
{{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.
ParametersEdit
DeprecatedEdit
{{#lst:Help:CS1 errors|deprecated_params_table}}
In addition to the above list(s) of deprecated and removed parameters, all non-hyphenated aliases of parameters with hyphens are discouraged to be used in citation templates and are kept only for legacy support. They are subject to becoming deprecated and unsupported in the future as well. To streamline the appearance and improve consistency across the project, these variants should no longer be used when adding parameters to citation templates. Instead, select the hyphenated parameter variants and also consider switching other non-hyphenated parameters, which may be present in a citation already, to their hyphenated equivalents at the same time.
DescriptionEdit
AuthorsEdit
- 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 complete name of a single author (first and last) or to hold the name of a corporate author. This parameter should never hold the names of more than one author. Do not wikilink—use author-link instead.
- 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.
- 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). Aliases: surname1, given1 through surnamen, givenn, or author1 through authorn. For an individual author plus an institutional author, you can use
|first1=...|last1=...|author2=.... - author-link: Title of existing Wikipedia article about the author—not the author's website; do not wikilink. Aliases: author-link1, authorlink, authorlink1, author1-link, author1link.
- OR: for multiple authors, use author-link1 through author-linkn. Aliases: authorlink1 through authorlinkn, or author1-link through authorn-link, or author1link through authornlink.
- 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 tovancdisplays name lists in Vancouver style when the lists use thelast/firstforms of name parameters. Alias: name-list-format (deprecated)
- 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
- authors: Free-form list of author names; use of this parameter is discouraged because it does not contribute to a citation's metadata; not an alias of last.
- translator-last: Surname of translator. Do not wikilink—use translator-link instead. Aliases: translator-surname, translator1, translator1-last, translator-last1.
- translator-first: Given or first names of translator. Do not wikilink—use translator-link instead. Aliases: translator-given, translator1-first, translator-first1.
- OR: for multiple translators, use translator-last1, translator-first1 through translator-lastn, translator-firstn, where n is any consecutive number for an unlimited number of translators (each translator-firstn requires a corresponding translator-lastn, but not the other way around). Aliases: translator1-last, translator1-first through translatorn-last, translatorn-first, or translator1 through translatorn.
- translator-link: Title of existing Wikipedia article about the translator—not the translator's website; do not wikilink. Aliases: translator-link1, translator1-link.
- OR: for multiple translators, use translator-link1 through translator-linkn. Aliases: translator1-link through translatorn-link.
- 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.
DateEdit
- 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] Required when year is used to disambiguate
{{sfn}}links to multiple-work citations by the same author in the same year.[more] Do not wikilink. Displays after the authors and is enclosed in parentheses. If there is no author, then displays after publisher..
- For approximate year, precede with "
c.", like this:|date=c. 1900.
- For no date, or "undated", use
|date=n.d.
- 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 source being referenced. The usage of this parameter is discouraged; use the more flexible
|date=parameter instead unless both of the following conditions are met:- The
|date=format is YYYY-MM-DD. - The citation requires a
CITEREFdisambiguator.
- The
- orig-date: Original publication date or year; displays in square brackets after the date (or year). For clarity, please supply specifics. For example:
|orig-date=First published 1859or|orig-date=Composed 1904. As|orig-date=does not support automatic date formatting, use the same date format as defined by|df=(or, if it exists in the article, by|cs1-dates=of a{{use dmy dates}}or{{use mdy dates}}template), or as used in the|date=parameter. Alias: orig-year, origyear - 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.
TitleEdit
- title: Title of source. Displays in italics. If script-title is defined, use title to hold a Romanization (if available) of the title in script-title.
- script-title: Original title for languages that do not use a Latin-based script (Arabic, Chinese, Cyrillic, Greek, Hebrew, Japanese, Korean, etc.); not italicized, follows italicized Romanization defined in title (if present). Must be prefixed with one of the supported language codes to help browsers properly display the script:
... |title=Tōkyō tawā |script-title=ja:東京タワー |trans-title=Tokyo Tower ...
- trans-title: English translation of the title if the source cited is in a foreign language. Displays in square brackets after title; if url is defined, then trans-title is included in the link. Use of the language parameter is recommended.
- script-title: Original title for languages that do not use a Latin-based script (Arabic, Chinese, Cyrillic, Greek, Hebrew, Japanese, Korean, etc.); not italicized, follows italicized Romanization defined in title (if present). Must be prefixed with one of the supported language codes to help browsers properly display the script:
- Titles containing certain characters will not display and link correctly unless those characters are encoded.
| newline | [ | ] | | |
|---|---|---|---|
| space | [ | ] | {{!}} (preferred)
|
| {{bracket|text}} | | or {{pipe}} – | ||
- title-link: Title of existing Wikipedia article about the source named in title – do not use a web address; do not wikilink. Alias: titlelink.
- 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, use of language codes is preferred so that language names render in the correct language and form: espagnol at a French-language wiki instead of the English word "Spanish". Aliases: lang
TemplateDataEdit
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", "authorlink", "authorlink1", "author1-link", "author1link." ], "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" }, "coauthors": { "label": "Co-authors", "description": "Names of co-authors", "type": "string", "deprecated": "Use author, author2, etc." }, "authors": { "label": "Authors", "description": "Full list of all authors", "type": "string" }, "collaboration": { "label": "collaboration", "description": "Name of a group of authors, in addition to the ones listed in the Author parameters", "type": "string" }, "translator-last": { "aliases": [ "translator1-last", "translator-last1" ], "label": "Translator's last name", "description": "Translator's last name", "type": "string" }, "translator-first": { "aliases": [ "translator1-first", "translator-first1" ], "label": "Translator's first name", "description": "Translator's first name", "type": "string" }, "translator": { "aliases": [ "translator1" ], "label": "Translator", "description": "Full name of first translator", "type": "string" }, "translator-link": { "aliases": [ "translator-link1", "translator1-link" ], "label": "Translator's article", "description": "Title of Wikipedia article of the (first) translator", "type": "wiki-page-name" }, "translator-first2": { "aliases": [ "translator2-first" ], "label": "Translator 2's First name", "description": "Translator 2's First name", "type": "string" }, "translator-last2": { "aliases": [ "translator2-last" ], "label": "Translator 2's last name", "description": "Translator 2's last name", "type": "string" }, "translator2": { "label": "Translator 2", "description": "Full name of second translator", "type": "string" }, "translator-link2": { "aliases": [ "translator2-link" ], "label": "Translator 2's article", "description": "Title of WIkipedia article about second translator", "type": "wiki-page-name" }, "date": { "label": "Date", "description": "Date of the source being cited. Use n.d. for no date, and c. for inexact dated", "type": "string" }, "orig-year": { "aliases": [ "origyear" ], "label": "Original publication year", "description": "Original publication year, which displays after the main date. Be specific", "example": "First published 1859", "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" }, "script-title": { "label": "Foreign-script title", "description": "Title of work in original non-latin script. May be prefixed with language code and a colon", "example": "ja:東京タワー", "type": "string" }, "trans-title": { "label": "Translated title", "description": "English translation of title", "type": "string" }, "title-link": { "label": "Article about title", "description": "Wikipedia article that the title is linked to", "type": "wiki-page-name" }, "language": { "label": "Language(s)", "description": "Language(s) the source is written in. Separate by commas, and do not include 'and'", "type": "string" } }, "format": "inline", "description": "Formats a citation to a paper with an bioRxiv id", "paramOrder": [ "biorxiv", "author", "first", "last", "first2", "last2", "author2", "author-link", "author-link2", "authors", "coauthors", "title", "translator", "translator-last", "translator-first", "translator-link", "translator-first2", "translator-last2", "translator2", "translator-link2", "collaboration", "date", "orig-year", "df", "script-title", "trans-title", "title-link", "language" ] } </templatedata>