Output Formats

Here are the output formats supported natively in Citation.js.

Options

For references to dictionaries, see Dictionary Plugins.

BibTeX & Bib.TXT

Bibliography & Citation

Bibliography and citation formatting is done by the citeproc-js engine, currently maintained by Frank Bennett.

_* Add your own with CSL Plugins_ ^ Only for the citation format at the moment § Only for the bibliography format at the moment

entry

Here's an example for entry:

let cite = new Cite([
  {id: 'a', title: 'Item A', issued: {'date-parts': [[2016]]}},
  {id: 'b', title: 'Item B', issued: {'date-parts': [[2017]]}},
  {id: 'c', title: 'Item C', issued: {'date-parts': [[2018]]}}
])

cite.format('citation')
// '(“Item A,” 2016; “Item B,” 2017; “Item C,” 2018)'

cite.format('citation', {entry: ['a', 'b']})
// '(“Item A,” 2016; “Item B,” 2017)'

cite.format('citation', {entry: 'a'})
// '(“Item A,” 2016)'

prepend and append

Here's an example for prepend and append:

let cite = new Cite({id: 'a', title: 'Item A'})

cite.format('bibliography', {append: ' [foobar]'})
// 'Item A. (n.d.). [foobar]\n'

cite.format('bibliography', {prepend (entry) { return `${entry.id}: ` }})
// 'a: Item A. (n.d.).\n'

And here's another example, possibly more realistic:

let cite = new Cite('Q30000000')

let date = (new Date()).toLocaleDateString()

cite.format('bibliography', {
  format: 'html',
  template: 'apa',
  prepend (entry) {
    return `[${entry.id}]: `
  },
  append: ` [Retrieved on ${date}]`
})

// `<div class="csl-bib-body">
//   <div data-csl-entry-id="Q30000000" class="csl-entry">
//     [Q30000000]: Miccadei, S., De Leo, R., Zammarchi, E., Natali, P. G., & Civitareale, D. (2002). The Synergistic Activity of Thyroid Transcription Factor 1 and Pax 8 Relies on the Promoter/Enhancer Interplay. <i>Molecular Endocrinology</i>, <i>16</i>(4), 837–846. https://doi.org/10.1210/MEND.16.4.0808 [Retrieved on 2018-7-10]
//   </div>
// </div>`

This prepends [$ID]: to each entry, where $ID is the ID of that entry, and appends [Retrieved on $DATE], where $DATE is today (constant for all entries).

CSL Templates

Currently, the following CSL Templates are built-in in Citation.js:

• apa (default)
• vancouver
• harvard1

For different templates, see CSL Plugins.

CSL Locales

Currently, the following CSL Locales are built-in in Citation.js:

• en-US (default)
• es-ES
• de-DE
• fr-FR
• nl-NL

For different locales, see CSL Plugins.

RIS

Label

No options.

JSON