@citation-js/plugin-csl

!License
!Dependency status
---

Install

npm install @citation-js/plugin-csl

Usage

Register by importing the package:

``js
require('@citation-js/plugin-csl')
// or
import '@citation-js/plugin-csl'
`

Formats

Formats and other features added by this plugin. General output options:

* template: the style template to use. Currently, the following are built-in:
* apa (default)
* vancouver
* harvard1
* lang: the locale to use. Currently, the following are built-in:
* en-US (default)
* es-ES
* de-DE
* fr-FR
* nl-NL
* format: output (markup) format. Note: this doesn't support the output format dictionaries
* entry (String, Array[String]): entry ID or list of entry IDs to identify the items to cite

$3

This plugin adds the output format bibliography, and accepts the following specific options:

* prepend (String, Function): prepend static or dynamic text to each entry
* append (String, Function): append static or dynamic text to each entry
* nosort (Boolean, default: false): do not sort according to the style-defined rules
* asEntryArray (Boolean, default: false): return an array of entries consisting of an id and the output for that individual entry

Here's an example for prepend and append:

`js
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:

`js
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}]
})

//

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).

Here's an example for asEntryArray:

`js
const cite = new Cite([
{ id: 'a', title: 'Item A', issued: { literal: 2021 } },
{ id: 'b', title: 'Item B', issued: { literal: 2021 } }
])

cite.format('bibliography', { asEntryArray: true })
// [
// [
// "a"
// "Item A. (2021).\n"
// ],
// [
// "b"
// "Item B. (2021).\n"
// ]
// ]
`

$3

Here's an example for entry:

`js
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)'
`

$3

It is possible to add different styles and locales.

`js
const { Cite, plugins } = require('@citation-js/core')
// or
import { Cite, plugins } from '@citation-js/core'
`

#### Templates

Different CSL Templates can be registered like this:

`js
let templateName = 'custom'
let template = '' // The actual XML file

let config = plugins.config.get('@csl')
config.templates.add(templateName, template)

let example = new Cite(...)
example.format('bibliography', {
format: 'html',
template: templateName,
lang: 'en-US'
})
`

#### Locales

Different CSL Locales can be registered like this:

`js
let language = 'en-GB'
let locale = '...' // The actual XML file

let config = plugins.config.get('@csl')
config.locales.add(language, locale)

let example = new Cite(...)
example.format('bibliography', {
format: 'html',
template: 'apa',
lang: language
})
`

#### Engine

The configuration object also exposes an internal method to prepare a Citeproc engine with given data and configuration:

`js
let config = plugins.config.get('@csl')

let citeproc = plugins.engine(
/ data: / [{ ... }],
/ template: / 'apa',
/ locale: / 'en-US',
/ format: / 'html'
)

let sortedIds = citeproc.updateItems(/ ids: / [...])
let makeBibliography = citeproc.makeBibliography()
``