{"route":"/en-US-v0.14.1/reference/model/cite/","title":"Cite","description":"Documentation for the `cite` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"syntax","name":"Syntax","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-key","name":"key","children":[]},{"id":"parameters-supplement","name":"supplement","children":[]},{"id":"parameters-form","name":"form","children":[]},{"id":"parameters-style","name":"style","children":[]}]}],"body":{"kind":"func","content":{"path":[],"name":"cite","title":"Cite","keywords":[],"oneliner":"Cite a work from the bibliography.","element":true,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Cite a work from the bibliography.

\n

Before you starting citing, you need to add a bibliography somewhere in\nyour document.

\n

Example

\n
This was already noted by\npirates long ago. @arrgh\n\nMultiple sources say ...\n@arrgh @netwok.\n\nYou can also call `cite`\nexplicitly. #cite(<arrgh>)\n\n#bibliography("works.bib")\n
\"Preview\"
\n

If your source name contains certain characters such as slashes, which are\nnot recognized by the <> syntax, you can explicitly call label instead.

\n
Computer Modern is an example of a modernist serif typeface.\n#cite(label("DBLP:books/lib/Knuth86a")).\n
\n

Syntax

\n

This function indirectly has dedicated syntax. References can be\nused to cite works from the bibliography. The label then corresponds to the\ncitation key.

"}],"self":false,"params":[{"name":"key","details":[{"kind":"html","content":"

The citation key that identifies the entry in the bibliography that\nshall be cited, as a label.

"},{"kind":"example","content":{"body":"
// All the same\n@netwok \\\n#cite(<netwok>) \\\n#cite(label("netwok"))\n
\"Preview\"
","title":null}}],"types":["label"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"supplement","details":[{"kind":"html","content":"

A supplement for the citation such as page or chapter number.

\n

In reference syntax, the supplement can be added in square brackets:

"},{"kind":"example","content":{"body":"
This has been proven. @distress[p.~7]\n\n#bibliography("works.bib")\n
\"Preview\"
","title":null}}],"types":["none","content"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"form","details":[{"kind":"html","content":"

The kind of citation to produce. Different forms are useful in different\nscenarios: A normal citation is useful as a source at the end of a\nsentence, while a "prose" citation is more suitable for inclusion in the\nflow of text.

\n

If set to none, the cited work is included in the bibliography, but\nnothing will be displayed.

"},{"kind":"example","content":{"body":"
#cite(<netwok>, form: "prose")\nshow the outsized effects of\npirate life on the human psyche.\n
\"Preview\"
","title":null}}],"types":["none","str"],"strings":[{"string":"normal","details":"

Display in the standard way for the active style.

"},{"string":"prose","details":"

Produces a citation that is suitable for inclusion in a sentence.

"},{"string":"full","details":"

Mimics a bibliography entry, with full information about the cited work.

"},{"string":"author","details":"

Shows only the cited work's author(s).

"},{"string":"year","details":"

Shows only the cited work's year.

"}],"default":""normal"","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"style","details":[{"kind":"html","content":"

The citation style.

\n

This can be:

\n"}],"types":["auto","str","bytes"],"strings":[{"string":"alphanumeric","details":"

Alphanumeric

"},{"string":"american-anthropological-association","details":"

American Anthropological Association

"},{"string":"american-chemical-society","details":"

American Chemical Society

"},{"string":"american-geophysical-union","details":"

American Geophysical Union

"},{"string":"american-institute-of-aeronautics-and-astronautics","details":"

American Institute of Aeronautics and Astronautics

"},{"string":"american-institute-of-physics","details":"

American Institute of Physics 4th edition

"},{"string":"american-medical-association","details":"

American Medical Association 11th edition

"},{"string":"american-meteorological-society","details":"

American Meteorological Society

"},{"string":"american-physics-society","details":"

American Physical Society

"},{"string":"american-physiological-society","details":"

American Physiological Society

"},{"string":"american-political-science-association","details":"

American Political Science Association

"},{"string":"american-psychological-association","details":"

American Psychological Association 7th edition

"},{"string":"apa","details":"

A short alias of american-psychological-association

"},{"string":"american-society-for-microbiology","details":"

American Society for Microbiology

"},{"string":"american-society-of-civil-engineers","details":"

American Society of Civil Engineers

"},{"string":"american-society-of-mechanical-engineers","details":"

American Society of Mechanical Engineers

"},{"string":"american-sociological-association","details":"

American Sociological Association 6th/7th edition

"},{"string":"angewandte-chemie","details":"

Angewandte Chemie International Edition

"},{"string":"annual-reviews","details":"

Annual Reviews (sorted by order of appearance)

"},{"string":"annual-reviews-author-date","details":"

Annual Reviews (author-date)

"},{"string":"associacao-brasileira-de-normas-tecnicas","details":"

Associação Brasileira de Normas Técnicas (Português - Brasil)

"},{"string":"association-for-computing-machinery","details":"

Association for Computing Machinery

"},{"string":"biomed-central","details":"

BioMed Central

"},{"string":"bristol-university-press","details":"

Bristol University Press

"},{"string":"british-medical-journal","details":"

BMJ

"},{"string":"bmj","details":"

A short alias of british-medical-journal

"},{"string":"cell","details":"

Cell

"},{"string":"chicago-author-date","details":"

Chicago Manual of Style 18th edition (author-date)

"},{"string":"chicago-notes","details":"

Chicago Manual of Style 18th edition (notes and bibliography)

"},{"string":"chicago-fullnotes","details":"

A short alias of chicago-notes

"},{"string":"chicago-shortened-notes","details":"

Chicago Manual of Style 18th edition (shortened notes and bibliography)

"},{"string":"copernicus","details":"

Copernicus Publications

"},{"string":"council-of-science-editors","details":"

Council of Science Editors, Citation-Sequence (numeric, brackets)

"},{"string":"council-of-science-editors-author-date","details":"

Council of Science Editors, Name-Year 9th edition (author-date)

"},{"string":"current-opinion","details":"

Current Opinion journals

"},{"string":"deutsche-gesellschaft-für-psychologie","details":"

Deutsche Gesellschaft für Psychologie 5. Auflage (Deutsch)

"},{"string":"deutsche-sprache","details":"

Deutsche Sprache (Deutsch)

"},{"string":"elsevier-harvard","details":"

Elsevier - Harvard (with titles)

"},{"string":"elsevier-vancouver","details":"

Elsevier - Vancouver

"},{"string":"elsevier-with-titles","details":"

Elsevier (numeric, with titles)

"},{"string":"frontiers","details":"

Frontiers journals

"},{"string":"future-medicine","details":"

Future Medicine journals

"},{"string":"future-science","details":"

Future Science Group

"},{"string":"gb-7714-2005-numeric","details":"

China National Standard GB/T 7714-2005 (numeric, 中文)

"},{"string":"gb-7714-2015-author-date","details":"

China National Standard GB/T 7714-2015 (author-date, 中文)

"},{"string":"gb-7714-2015-note","details":"

China National Standard GB/T 7714-2015 (note, 中文)

"},{"string":"gb-7714-2015-numeric","details":"

China National Standard GB/T 7714-2015 (numeric, 中文)

"},{"string":"gost-r-705-2008-numeric","details":"

Russian GOST R 7.0.5-2008 (numeric)

"},{"string":"harvard-cite-them-right","details":"

Cite Them Right 12th edition - Harvard

"},{"string":"institute-of-electrical-and-electronics-engineers","details":"

IEEE

"},{"string":"ieee","details":"

A short alias of institute-of-electrical-and-electronics-engineers

"},{"string":"institute-of-physics-numeric","details":"

Institute of Physics (numeric)

"},{"string":"iso-690-author-date","details":"

ISO-690 (author-date, English)

"},{"string":"iso-690-numeric","details":"

ISO-690 (numeric, English)

"},{"string":"karger","details":"

Karger journals

"},{"string":"mary-ann-liebert-vancouver","details":"

Mary Ann Liebert - Vancouver

"},{"string":"modern-humanities-research-association-notes","details":"

Modern Humanities Research Association 4th edition (notes)

"},{"string":"modern-humanities-research-association","details":"

A short alias of modern-humanities-research-association-notes

"},{"string":"modern-language-association","details":"

Modern Language Association 9th edition (in-text citations)

"},{"string":"mla","details":"

A short alias of modern-language-association

"},{"string":"modern-language-association-8","details":"

Modern Language Association 8th edition

"},{"string":"mla-8","details":"

A short alias of modern-language-association-8

"},{"string":"multidisciplinary-digital-publishing-institute","details":"

Multidisciplinary Digital Publishing Institute

"},{"string":"nature","details":"

Nature

"},{"string":"pensoft","details":"

Pensoft Journals

"},{"string":"public-library-of-science","details":"

Public Library of Science

"},{"string":"plos","details":"

A short alias of public-library-of-science

"},{"string":"royal-society-of-chemistry","details":"

Royal Society of Chemistry

"},{"string":"sage-vancouver","details":"

SAGE - Vancouver

"},{"string":"sist02","details":"

SIST02 (日本語)

"},{"string":"spie","details":"

SPIE journals

"},{"string":"springer-basic","details":"

Springer - Basic (numeric, brackets)

"},{"string":"springer-basic-author-date","details":"

Springer - Basic (author-date)

"},{"string":"springer-fachzeitschriften-medizin-psychologie","details":"

Springer - Fachzeitschriften Medizin Psychologie (Deutsch)

"},{"string":"springer-humanities-author-date","details":"

Springer - Humanities (author-date)

"},{"string":"springer-lecture-notes-in-computer-science","details":"

Springer - Lecture Notes in Computer Science

"},{"string":"springer-mathphys","details":"

Springer - MathPhys (numeric, brackets)

"},{"string":"springer-socpsych-author-date","details":"

Springer - SocPsych (author-date)

"},{"string":"springer-vancouver","details":"

Springer - Vancouver (brackets)

"},{"string":"taylor-and-francis-chicago-author-date","details":"

Taylor & Francis Journals Standard Reference Style Guide: Chicago author-date version 2.0

"},{"string":"taylor-and-francis-national-library-of-medicine","details":"

Taylor & Francis - National Library of Medicine

"},{"string":"the-institution-of-engineering-and-technology","details":"

The Institution of Engineering and Technology

"},{"string":"the-lancet","details":"

The Lancet

"},{"string":"thieme","details":"

Thieme-German (Deutsch)

"},{"string":"trends","details":"

Trends journals

"},{"string":"turabian-author-date","details":"

Chicago Manual of Style 17th edition (author-date)

"},{"string":"turabian-fullnote-8","details":"

Chicago Manual of Style 17th edition (notes and bibliography, subsequent author-title)

"},{"string":"vancouver","details":"

Vancouver

"},{"string":"vancouver-superscript","details":"

Vancouver (superscript)

"}],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true}],"returns":["content"],"scope":[]}}}