@citation-js/core

@citation-js/core

Convert different bibliographic metadata sources.

Install

npm install @citation-js/core

Usage

Getting Started

You can read a guide on how to get started, together with some tutorials and examples, here.

Cite

More info

To use the Cite constructor, require() the module like this:

const {Cite} = require('@citation-js/core')

For example, to get the bibliographical data of the Wikidata item wd:Q21972834, and then format it in HTML, English and APA:

let example = new Cite('Q21972834')

let output = example.format('bibliography', {
  format: 'html',
  template: 'apa',
  lang: 'en-US'
})

console.log(output)

To test this code, go to RunKit.

Async

Use the async API (recommended for Wikidata, URL, and DOI input) like this:

let example = await Cite.async('Q21972834')

let output = example.format('bibliography', {
  format: 'html',
  template: 'apa',
  lang: 'en-US'
})

console.log(output)

Cite.async() also supports options as the second argument, and a callback function as last argument.

Changelog

0.6.0 (2022-05-30)

Bug Fixes

• core: avoid flatMap for Node 10 support (8a65094)

• plugin-bibjson: set correct generic type (ec7de7f)

• plugin-bibtex: consider entries with no type (a55fe60)

• plugin-bibtex: fix biblatex handling of mastersthesis (6196adf)

• plugin-bibtex: fix handling of bookpagination (7f41e30)

• plugin-bibtex: fix typo in crossref code (3c377e4)

• plugin-bibtex: map biblatex eid to number (0eb15af), closes #140

• plugin-bibtex: set default CSL type correctly (94a402e)

• plugin-bibtex: set default CSL type correctly (bcd11b3)

• plugin-bibtex: use CSL 1.0.2 'custom' field (986f80b)

• plugin-ris: fix ISSN regex (76402c1)

• plugin-ris: fix name parsing (4382f31)

• plugin-wikidata: fall back to original-author (1af1249), closes #106

• chore!: drop Node 10, 12 support (37ea76b)

Features

• core: output CSL 1.0.2 by default (5acec19)
• core: remove custom _ fields when cleaning (c974ebc)
• core: update internal format to CSL 1.0.2 (7249425)
• plugin-bibjson: update mapping to CSL 1.0.2 (d04aacf)
• plugin-bibtex: add Semantic Scholar s2id mapping (#159) (f116cde)
• plugin-bibtex: implement crossref properly (f9cdf5b), closes #115
• plugin-bibtex: update mapping to CSL 1.0.2 (6c68aff)
• plugin-csl: adapt to CSL 1.0.2 input (4090164)
• plugin-csl: update styles and locales (1ede64b)
• plugin-ris: update mapping to CSL 1.0.2 (b59bd12)
• plugin-wikidata: import issue/vol/etc. from qualifiers (dc7e270)
• plugin-wikidata: update mapping to CSL 1.0.2 (09f2e2d), closes #142

BREAKING CHANGES

• use Node.js 14 or above
• core: to get CSL 1.0.1 output, use the 'version' option
• plugin-csl: output of updated styles and locales may differ
• core: use the 'custom' object instead of fields starting with an underscore.