Template:Cite arXiv/doc

Not to be confused with Template:Cite archive.

__EXPECTED_UNCONNECTED_PAGE__

Citation Style 1 templates
Some attributes
First	Unknown
Second	Unknown
Third	Unknown
Other attributes

This Citation Style 1 template is used to create citations for preprints at arXiv. It links to the abstract at https://www.arxiv.org/abs/eprint.

Usage

To use the template, you need only specify the arxiv or eprint parameter. Once you save the page, Citation bot will detect the citation and complete it automatically.

Copy a blank version to use. Almost all parameter names are supported only in lower case (some initialisms, such as |isbn= have upper-case aliases like |ISBN=, which are acceptable for use). Use the "|" (pipe) character between each parameter. Unused parameters may be deleted to avoid clutter in the edit window. Some samples on this documentation page may include the current date. If the date is not current, then the page.

Most-commonly-used parameters in horizontal format

{{cite arXiv |last= |first= |date= |title= |arxiv= |class=}}

Full parameter set in horizontal format

{{cite arXiv |last1= |first1= |author-link1= |last2= |first2= |author-link2= |display-authors= |author-mask1= |author-mask2= |collaboration= |name-list-style= |df= |date= |year= |title= |trans-title= |language= |page= |pages= |at= |no-pp= |arxiv= |class= |quote= |mode= |ref= |postscript=}}

Most-commonly-used parameters in vertical format

{{cite arXiv |last = |first = |date = |title = |arxiv = |class = }}

Full parameter set in vertical format

Vertical list	Prerequisites	Brief instructions / notes
{{cite arXiv |last1 = |first1 = |author-link1 = |last2 = |first2 = |author-link2 = |display-authors = |author-mask1 = |author-mask2 = |collaboration = |name-list-style = |df = |date = |year = |title = |trans-title = |language = |page = |pages = |at = |no-pp = |arxiv = |class = |quote = |mode = |ref = |postscript = }}	last1 (or an alias) last1 (or an alias) last1 (or an alias) last2 (or an alias) last2 (or an alias) last1 (or an alias) last1 (or an alias) last2 (or an alias) last1 (or an alias) last2 (or an alias)         title         page, pages, p or pp	Don't link. Aliases include 'last'; 'surname1'; 'surname'; 'author1'; and 'author' Don't link. Aliases include 'first'; 'given1'; and 'given' Don't link. Aliases include 'author1-link'; 'author-link'; 'authorlink1'; 'author1link'; and 'authorlink' Don't link. Similar: 'last3', etc. Aliases include 'surname2'; and 'author2' Don't link. Similar: 'first3', etc. Aliases include 'given2' Don't link. Similar: 'author-link3', etc. Aliases include 'author2-link'; 'authorlink2'; and 'author2link' Number (number of authors displayed) or 'etal' (more authors) Not for lists of cited works. Aliases include 'author1-mask'; and 'author-mask' Aliases include 'author2-mask' Set to 'amp' or 'ampersand' to separate the last author with ' & '; set to 'and' to separate with ' and '         Required   Aliases include 'lang' Aliases include 'p' Aliases include 'pp'   set to "yes" to suppress the "p." or "pp." before page numbers Required. Aliases include 'eprint'   Aliases include 'quotation' 'cs1' or 'cs2'

• If a field name is listed in the Prerequisites column, it is a prerequisite for the field to the left.
• Note that quotation marks aren't part of the parameter names or their aliases and are there to make identifying them easier for readers.

• title: Title of the cited paper.
• arxiv or eprint (mandatory): arXiv/Eprint identifier, without any "arXiv:" prefix. Prior to April 2007, the identifiers included a classification, an optional two-letter subdivision, and a 7-digit YYMMNNN year, month, and sequence number of submission in that category. E.g. gr-qc/0610068 or math.GT/0309136. After April 2007, the format was changed to a simple YYMM.NNNN. Starting in January 2015, the identifier was changed to be 5 digits: YYMM.NNNNN.
• class: arXiv classification, e.g. hep-th. Optional. To be used only with new-style (2007 and later) eprint identifiers that do not include the classification.

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 arXiv link in order to guarantee open access to the previous version of the article. To preserve the arXiv link, add e.g. |arxiv=gr-qc/0610068 or |arxiv=math.GT/0309136 or |arxiv=YYMM.NNNN (following the above examples) to the {{citation}} or {{cite journal}} templates.

Examples

• {{cite arXiv |last=Sparling |first=George A. J. |date=2006 |title=Spacetime is spinorial; new dimensions are timelike |eprint=gr-qc/0610068}}

  Sparling, George A. J. (2006). "Spacetime is spinorial; new dimensions are timelike". arXiv:gr-qc/0610068.

• {{cite arXiv |last=Leinster |first=Tom |date=2007 |title=The Euler characteristic of a category as the sum of a divergent series |eprint=0707.0835 |class=math.CT}}

  Leinster, Tom (2007). "The Euler characteristic of a category as the sum of a divergent series". arXiv:0707.0835 [math.CT].

Parameters

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 (including Dr., Sir, and similar) 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). See the display parameters to change how many authors are displayed. 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, 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 to and, inserts the conjunction 'and' between the last two names of a name list. When set to vanc, displays name lists in Vancouver style when the lists use the last/first forms of name parameters. (Alternatively, {{CS1 config|name-list-style=vanc}} at the top of the page can do the same to every citation on the pages.)
• vauthors: comma-separated list of author names formatted as in the Vancouver system. 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

"Wikipedia:Undated" redirects here. For undated signatures, see Template:Undated.

• 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. Do not wikilink. Displays after the authors and is enclosed in parentheses. If there is no author, then displays after the website and publisher. For acceptable date formats, see Help:Citation Style 1 § Dates.

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 or updated date; a comment for editors such as |date=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:
  1. 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.)
  2. The |date= format is YYYY-MM-DD. (This format prevents the addition of a disambiguating letter to the year.)
• 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 format

  ymd – as above for year initial numeric format YYYY-MM-DD

  dmy-all – set publication, access-, and archive-dates to day month year format;

  mdy-all – as above for month day, year format

  ymd-all – as above for year initial numeric format YYYY-MM-DD

Title

(See also Help:Citation Style 1 § Titles and chapters.)

• title: Title of source. Displays in quotation marks. For titles containing quotation marks, convert regular quotation marks (") to single quotation marks ('). See MOS:QINQ for guidance in more complex situations.

Titles containing certain characters will not display and link correctly unless those characters are encoded.

newline	[	]	|
space	[	]	{{!}} (preferred)
	{{bracket|text}}		| or {{pipe}} – see also Help:Table § Rendering the 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, e.g. espagnol at a French-language wiki instead of the English word "Spanish". Aliases: lang

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Cite arXiv in articles based on its TemplateData.

TemplateData for Cite arXiv

Formats a citation to a paper with an arXiv id

Template parameters

This template has custom formatting.

Parameter		Description	Type	Status
arXiv	arxiv eprint	arXiv identifier without the "arXiv:" prefix; can include version number Example 1612.00008v1	String	required
arXiv class	class	arXiv classification, for post-2007 ids	String	optional
Author	author author1	Complete name of the first author	String	optional
First name	first first1 given given1	First name of first author	String	suggested
Last name	last last1 surname surname1	Last name of first author	String	suggested
Author 2's first name	first2 given2	First name of second author	String	optional
Author 2's last name	last2 surname2	Last name of second author	String	optional
Author 2	author2	Full name of second author	String	optional
Author's article	author-link author-link1 author1-link	Title of the Wikipedia article about the first author	Page name	optional
Author 2's article	author-link2 author2-link	Title of Wikipedia article about the second author	Page name	optional
Title	title	Title of the paper cited	String	suggested
collaboration	collaboration	Name of a group of authors, in addition to the ones listed in the Author parameters	String	optional
Date	date	Date of the source being cited. Use n.d. for no date, and c. for inexact dated.	String	optional
Date format for publication dates	df	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	String	optional
Translated title	trans-title	English translation of title	String	optional
Language(s)	language	Language(s) the source is written in. Separate by commas, and do not include 'and'.	String	optional

External links

• Official website
• Understanding the arXiv identifier

Template:Cite arXiv invokes Module:Navbox using Lua.

Usage

This template can be used to make a standard navigation box. It is intended for use within another template that standardises the title and contents of the box (see Template:ShipNavbox). This template SHOULD NOT be used directly within articles, as it creates a maintenance burden to do so whenever the contents of the box have to be updated.

The purpose of this template is to standardise the attributes of all navigation boxes, for example, their colours and other CSS attributes. The template is fairly simple, and could be extended to add other features in the future. Using this template allows changes to be implemented much quicker and easier than editing each template separately.

Syntax

{{navbox
|state      = uncollapsed, collapsed, plain, autocollapse (default)
|name       = mandatory - name of the template
|style      = optional - style for the whole table
|title      = mandatory - navbox header
|gtitleN    = optional - title of N-th group of items
|styleN     = optional - style for groupN; i.e. text-align
|groupN     = mandatory - list of groups of items
|fstyle     = optional - style for footer ; i.e. text-align
|footer     = optional - navbox footer
}}

• Groups: Currently there is no technical limit to the maximum number of groups.
  • Groups of items can be added as parameters: group1, group2, group3, ... up to groupN.
• Group title: Each group has its own title parameter: gtitle1, gtitle2, gtitle3, ... up to gtitleN. Note that the default width for the first column is 15%.
• Group style: Style may also be customised to each group in: style1, style2, style3, ... up to styleN.
  • Note that neither the title nor the items have any wiki-links built into the template. As a result, users of the template are free to use wiki-links as they wish.
• Line breaks: Line-breaks (<br />) are unnecessary, as text wrapping is done automatically by the template. This also includes links and text in gtitleN and groupN.
• Bullets: Create unordered lists with lines beginning with *.
• Pipe links: Because of the nature of template syntax, it may be necessary to use Template:! ({{!}}).

States

• Autocollapse: By default, the state of a navbox is "autocollapsed". This means that if the number of navboxes in a page exceeds the maximum allocation of the collapsible navboxes, then the remaining navboxes are collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
  • Currently, the autocollapse allocation is 2 (see MediaWiki:Common.js). This means that if there are 3 navboxes in a page, the third and subsequent navboxes will be collapsed automatically.
• Uncollapsed: Forces the navbox to be displayed.
  • All of the navboxes in this documentation are in the uncollapsed state.
• Collapsed: The reverse of uncollapsed. Forces the navbox to be hidden instead.
  • Navboxes with a height of more than 300 pixels will also be collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
• Plain: Removes the "show/hide" link.

Sub-groups

• For larger navboxes, it may be necessary to include sub-groups within a particular group of items. It is also possible to collapsible navboxes within the parent navbox, see Collapsible sub-groups.
• To create sub-groups within {{navbox}}, certain parameters are to be included:
  • The parent navbox group (i.e. group2 in the example below) requires the type parameter (gtype2 = Subgroup).
  • The nested navbox (sub-group) requires the inclusion of the sub-group parameter (subgroup = yes). This enables the template to differentiate between the sub-group and the parent navbox.

{{navbox
|name    =
|title   =
|gtitle1 =
|group1  =
|gtitle2 =  
|gtype2  = Subgroup (mandatory)
|group2  = 
  {{navbox
  |subgroup = yes (mandatory)
  |gtitle1  = 
  |group1   =
  |gtitle2  = 
  |group2   = 
  }}
}}

Collapsible sub-groups

• For extremely long navboxes, it is recommended to use collapsible navboxes within the parent navbox. Further sub-groups can then be added to these collapsible navboxes.
• To create collapsible sub-groups within {{navbox}}, these parameters need to be included:
  • The parent navbox is almost always uncollapsed (state=uncollapsed).
  • The parent navbox group (i.e. group1 in the example below) requires the type parameter (gtype1 = Subgroup).
  • The nested collapsible navbox requires the inclusion of the collapsible parameter (collapsible = yes). This enables the template to differentiate between the collapsible navbox and the parent navbox.
  • The nested collapsible navbox is forcefully collapsed (state=collapsed).

{{navbox
|state  = uncollapsed
|name   = 
|gtype1 = Subgroup
|group1 = 
  {{navbox
  |collapsible = yes
  |state   = collapsed
  |title   = 
  |gtitle1 = 
  |group1  = 
  |gtitle2 = 
  |group2  = 
  }}
}}

Use of images

• The use of images in navboxes is permitted, but please resize the images to keep them small. Inventory-sized images (25-30 pixels) are recommended.
• Please use {{t|plink}} to create links with images. Use {{t|plink}} for any case where text is not desired after the link. It functions the same as {{t|plink}}, but it does not produce a wikilink in text. Use {{t|chatl}} to link chatheads. These templates create links for both the image and text (except for {{t|plink}}) using far less wikicode than the standard syntax.

Link and file share the same name

{{plink|Item}}

File name differs from the link

{{plink|Item|File}}

Link and file share the same name, but different text is desired to display

{{plink|Item|alt=Text}}

File name differs from the link and different text is desired to display

{{plink|Item|File|alt=Text}}

Categorising

Navboxes are very useful for transcluding categories onto a large number of pages that share both a trait and the navigation box. For example: Template:ShipNavbox transcludes Category:Ships onto every page that uses it.

There are 2 methods of categorising pages with navboxes:

The first way is with {{t|Ctg}}. This is the preferred method, and can be used in most cases. The rules and operations for the Category handler template are very simple; however, they are enough to produce the desired results on most pages.

Categorisation should only be used on a template for large-scale addition. It is unhelpful, for example, to use a rule that only applies to 1 page.

Examples

To see the following navboxes in action, see Template:Navbox.

Single line navbox with centered list

{{navbox
|name    = 
|title   = 
|style1  = text-align:center
|group1  =
}}

Navbox with standard footer

{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|footer  = Centered footer
}}

Navbox with styled footer

{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|fstyle  = text-align:right
|footer  = Right-aligned footer
}}

Multiple line navbox

{{navbox
|name    = 
|title   = 
|gtitle1 = Group title 1
|group1  = 
|gtitle2 = Group title 2
|group2  = 
|gtitle3 = Group title 3
|group3  = 
}}

Collapsed navbox

{{navbox
|state   = collapsed
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox with Tnavbar

{{navbox
|state   = plain
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox without Tnavbar

{{navbox
|state   = plain
|title   = 
|style1  = text-align:center
|group1  = 
}}

Complicated navbox

{{navbox
|state   = uncollapsed
|name    = 
|title   = 
|gtitle1 = Level 1 Title 1
|group1  = 
|gtitle2 = Level 1 Title 2
|group2  = 
|gtitle3 = Level 1 Title 3
|group3  = 
|gtitle4 = Level 1 Title 4
|group4  = 
|gtitle5 = Level 1 Title 5
|gtype5  = Subgroup
|group5  = 
  {{navbox
  |subgroup = Yes
  |gtitle1  = Level 2 Title 1
  |group1   =
  |gtitle2  = Level 2 Title 2
  |group2   =
  |gtitle3  = Level 2 Title 3
  |gtype3   = Subgroup
  |group3   = 
    {{navbox
    |subgroup = Yes
    |gtitle1  = Level 3 Title 1
    |group1   =
    |gtitle2  = Level 3 Title 2
    |group2   =
    }}
  |gtitle4  = Level 2 Title 4
  |group4   = 
  }}
|gtitle6 = Level 1 Title 6
|group6  = 
|gtitle7 = Level 1 Title 7
|group7  = 
|fstyle  = 
|footer  = 
}}

Preventing unwanted documentation

The Navbox template's documentation is automatically transcluded under the navbox on any Template namespace page. It is not transcluded when used as a sub-group or collapsible sub-group template (subgroup= yes or collapsible=yes).

Should the documentation appear when it is unwanted, it can be hidden by setting the doc parameter doc=no on the template. In most cases, the doc parameter is NOT used and the parameter is removed completely.