Namespace: dict

@citation-js/core.plugins.dict

Source:

Members

(protected, static, constant) exports.htmlDict

Object containing HTML strings for building JSON and BibTeX. Made to match citeproc, for compatibility.

Deprecated:
Source:

(protected, static, constant) exports.textDict

Object containing text strings for building JSON and BibTeX. Made to match citeproc, for compatibility.

Deprecated:
Source:

(static, constant) register :module:@citation-js/core.util.Register

Type:
Source:

Methods

(static) add(name, dict)

Add dictionary to register. Can be used by output plugins.

Parameters:
Name Type Description
name module:@citation-js/core.plugins.dict~dictName

dictionary name
dict module:@citation-js/core.plugins.dict~dict

dictionary data
Source:
To Do:
  • docs
Throws:

argument validation error

Type
TypeError

(static) get(name) → {module:@citation-js/core.plugins.dict~dict}

Get dictionary data.

Parameters:
Name Type Description
name module:@citation-js/core.plugins.dict~dictName

output format name
Source:
Returns:

dictionary data

Type
module:@citation-js/core.plugins.dict~dict

(static) has(name) → {Boolean}

Check if dictionary plugin exists.

Parameters:
Name Type Description
name module:@citation-js/core.plugins.dict~dictName

output format name
Source:
Returns:

register has plugin

Type
Boolean

(static) list() → {Array.<String>}

List dictionary plugins.

Source:
Returns:

list of plugins

Type
Array.<String>

(static) remove(name)

Remove dictionary.

Parameters:
Name Type Description
name module:@citation-js/core.plugins.dict~dictName

output format name
Source:

Type Definitions

dict

Type:
Source:

dictEntry

Type:
  • Array.<String>
Source:

dictName

Type:
  • String
Source:

entryName

Type:
  • String
Source: