output/csl

Members

(inner, constant) locales :Cite.util.Register

Source:
Type:

(inner, constant) templates :Cite.util.Register

Source:
Type:

Methods

(protected, inner) bibliography(data, optionsopt) → {String}

Source:
Parameters:
Name Type Attributes Default Description
data Array.<CSL>
options Object <optional>
{}
Name Type Attributes Default Description
template String <optional>
'apa'
lang String <optional>
'en-US'
format String <optional>
'text'
nosort Booolean <optional>
false
prepend Cite~wrapper <optional>
append Cite~wrapper <optional>
Returns:
Type:
String

output

(protected, inner) citation(data, optionsopt) → {String}

Source:
Parameters:
Name Type Attributes Default Description
data Array.<CSL>
options Object <optional>
{}
Name Type Attributes Default Description
template String <optional>
'apa'
lang String <optional>
'en-US'
format String <optional>
'text'
entry String | Array.<String> <optional>

list of ids of entries to include in the citation. defaults to all entries

Returns:
Type:
String

output

(protected, inner) fetchEngine(style, lang, template, retrieveItem, retrieveLocale) → {Object}

Retrieve CSL parsing engine

Source:
Parameters:
Name Type Description
style String

CSL style id

lang String

Language code

template String

CSL XML template

retrieveItem module:output/csl~retrieveItem

Code to retreive item

retrieveLocale module:output/csl~retrieveLocale

Code to retreive locale

Returns:
Type:
Object

CSL Engine

(protected, inner) fetchLocale(langopt) → {String}

Retrieve CSL locale

Deprecated:
  • Yes
Source:
Parameters:
Name Type Attributes Default Description
lang String <optional>
"en-US"

lang code

Returns:
Type:
String

CSL locale

(protected, inner) fetchStyle(styleopt) → {String}

Retrieve CSL style

Deprecated:
  • Yes
Source:
Parameters:
Name Type Attributes Default Description
style String <optional>
"apa"

style name

Returns:
Type:
String

CSL style

(protected, inner) getAttributedEntry(string, name, value) → {String}

Add data-* attribute to a HTML string

Source:
Parameters:
Name Type Description
string String

HTML string

name String

attribute name

value String

attribute value

Returns:
Type:
String

HTML string with attribute

(protected, inner) getPrefixedEntry(value, id) → {String}

Add CSL identifiers to entry

Source:
Parameters:
Name Type Description
value String

HTML string

id String | Number

ID

Returns:
Type:
String

HTML string with CSL ID

(protected, inner) getWrappedEntry(value, source, wrapping) → {String}

Pre/append things to entry

Source:
Parameters:
Name Type Description
value String

HTML string

source CSL

source element

wrapping Object

append / prepend configuration

Name Type Attributes Description
prepend String | Cite~wrapper <optional>
append String | Cite~wrapper <optional>
Returns:
Type:
String

Wrapped HTML string

(protected, inner) prepareEngine(data, templateName, language, format) → {Object}

Prepare CSL parsing engine

Source:
Parameters:
Name Type Description
data Array.<CSL>
templateName String
language String
format String
Returns:
Type:
Object

CSL Engine

Type Definitions

retrieveItem(id) → {CSL}

Source:
Parameters:
Name Type Description
id String

Citation id

Returns:
Type:
CSL

CSL Citation object

retrieveLocale(lang) → {String}

Source:
Parameters:
Name Type Description
lang String

Language code

Returns:
Type:
String

CSL Locale

Members

(inner, constant) locales :Cite.util.Register

Source:
Type:

(inner, constant) templates :Cite.util.Register

Source:
Type:

Methods

(protected, inner) bibliography(data, optionsopt) → {String}

Source:
Parameters:
Name Type Attributes Default Description
data Array.<CSL>
options Object <optional>
{}
Name Type Attributes Default Description
template String <optional>
'apa'
lang String <optional>
'en-US'
format String <optional>
'text'
nosort Booolean <optional>
false
prepend Cite~wrapper <optional>
append Cite~wrapper <optional>
Returns:
Type:
String

output

(protected, inner) citation(data, optionsopt) → {String}

Source:
Parameters:
Name Type Attributes Default Description
data Array.<CSL>
options Object <optional>
{}
Name Type Attributes Default Description
template String <optional>
'apa'
lang String <optional>
'en-US'
format String <optional>
'text'
entry String | Array.<String> <optional>

list of ids of entries to include in the citation. defaults to all entries

Returns:
Type:
String

output

(protected, inner) fetchEngine(style, lang, template, retrieveItem, retrieveLocale) → {Object}

Retrieve CSL parsing engine

Source:
Parameters:
Name Type Description
style String

CSL style id

lang String

Language code

template String

CSL XML template

retrieveItem module:output/csl~retrieveItem

Code to retreive item

retrieveLocale module:output/csl~retrieveLocale

Code to retreive locale

Returns:
Type:
Object

CSL Engine

(protected, inner) fetchLocale(langopt) → {String}

Retrieve CSL locale

Deprecated:
  • Yes
Source:
Parameters:
Name Type Attributes Default Description
lang String <optional>
"en-US"

lang code

Returns:
Type:
String

CSL locale

(protected, inner) fetchStyle(styleopt) → {String}

Retrieve CSL style

Deprecated:
  • Yes
Source:
Parameters:
Name Type Attributes Default Description
style String <optional>
"apa"

style name

Returns:
Type:
String

CSL style

(protected, inner) getAttributedEntry(string, name, value) → {String}

Add data-* attribute to a HTML string

Source:
Parameters:
Name Type Description
string String

HTML string

name String

attribute name

value String

attribute value

Returns:
Type:
String

HTML string with attribute

(protected, inner) getPrefixedEntry(value, id) → {String}

Add CSL identifiers to entry

Source:
Parameters:
Name Type Description
value String

HTML string

id String | Number

ID

Returns:
Type:
String

HTML string with CSL ID

(protected, inner) getWrappedEntry(value, source, wrapping) → {String}

Pre/append things to entry

Source:
Parameters:
Name Type Description
value String

HTML string

source CSL

source element

wrapping Object

append / prepend configuration

Name Type Attributes Description
prepend String | Cite~wrapper <optional>
append String | Cite~wrapper <optional>
Returns:
Type:
String

Wrapped HTML string

(protected, inner) prepareEngine(data, templateName, language, format) → {Object}

Prepare CSL parsing engine

Source:
Parameters:
Name Type Description
data Array.<CSL>
templateName String
language String
format String
Returns:
Type:
Object

CSL Engine

Type Definitions

retrieveItem(id) → {CSL}

Source:
Parameters:
Name Type Description
id String

Citation id

Returns:
Type:
CSL

CSL Citation object

retrieveLocale(lang) → {String}

Source:
Parameters:
Name Type Description
lang String

Language code

Returns:
Type:
String

CSL Locale

Members

(inner, constant) locales :Cite.util.Register

Source:
Type:

(inner, constant) templates :Cite.util.Register

Source:
Type:

Methods

(protected, inner) bibliography(data, optionsopt) → {String}

Source:
Parameters:
Name Type Attributes Default Description
data Array.<CSL>
options Object <optional>
{}
Name Type Attributes Default Description
template String <optional>
'apa'
lang String <optional>
'en-US'
format String <optional>
'text'
nosort Booolean <optional>
false
prepend Cite~wrapper <optional>
append Cite~wrapper <optional>
Returns:
Type:
String

output

(protected, inner) citation(data, optionsopt) → {String}

Source:
Parameters:
Name Type Attributes Default Description
data Array.<CSL>
options Object <optional>
{}
Name Type Attributes Default Description
template String <optional>
'apa'
lang String <optional>
'en-US'
format String <optional>
'text'
entry String | Array.<String> <optional>

list of ids of entries to include in the citation. defaults to all entries

Returns:
Type:
String

output

(protected, inner) fetchEngine(style, lang, template, retrieveItem, retrieveLocale) → {Object}

Retrieve CSL parsing engine

Source:
Parameters:
Name Type Description
style String

CSL style id

lang String

Language code

template String

CSL XML template

retrieveItem module:output/csl~retrieveItem

Code to retreive item

retrieveLocale module:output/csl~retrieveLocale

Code to retreive locale

Returns:
Type:
Object

CSL Engine

(protected, inner) fetchLocale(langopt) → {String}

Retrieve CSL locale

Deprecated:
  • Yes
Source:
Parameters:
Name Type Attributes Default Description
lang String <optional>
"en-US"

lang code

Returns:
Type:
String

CSL locale

(protected, inner) fetchStyle(styleopt) → {String}

Retrieve CSL style

Deprecated:
  • Yes
Source:
Parameters:
Name Type Attributes Default Description
style String <optional>
"apa"

style name

Returns:
Type:
String

CSL style

(protected, inner) getAttributedEntry(string, name, value) → {String}

Add data-* attribute to a HTML string

Source:
Parameters:
Name Type Description
string String

HTML string

name String

attribute name

value String

attribute value

Returns:
Type:
String

HTML string with attribute

(protected, inner) getPrefixedEntry(value, id) → {String}

Add CSL identifiers to entry

Source:
Parameters:
Name Type Description
value String

HTML string

id String | Number

ID

Returns:
Type:
String

HTML string with CSL ID

(protected, inner) getWrappedEntry(value, source, wrapping) → {String}

Pre/append things to entry

Source:
Parameters:
Name Type Description
value String

HTML string

source CSL

source element

wrapping Object

append / prepend configuration

Name Type Attributes Description
prepend String | Cite~wrapper <optional>
append String | Cite~wrapper <optional>
Returns:
Type:
String

Wrapped HTML string

(protected, inner) prepareEngine(data, templateName, language, format) → {Object}

Prepare CSL parsing engine

Source:
Parameters:
Name Type Description
data Array.<CSL>
templateName String
language String
format String
Returns:
Type:
Object

CSL Engine

Type Definitions

retrieveItem(id) → {CSL}

Source:
Parameters:
Name Type Description
id String

Citation id

Returns:
Type:
CSL

CSL Citation object

retrieveLocale(lang) → {String}

Source:
Parameters:
Name Type Description
lang String

Language code

Returns:
Type:
String

CSL Locale

Members

(inner, constant) locales :Cite.util.Register

Source:
Type:

(inner, constant) templates :Cite.util.Register

Source:
Type:

Methods

(protected, inner) bibliography(data, optionsopt) → {String}

Source:
Parameters:
Name Type Attributes Default Description
data Array.<CSL>
options Object <optional>
{}
Name Type Attributes Default Description
template String <optional>
'apa'
lang String <optional>
'en-US'
format String <optional>
'text'
nosort Booolean <optional>
false
prepend Cite~wrapper <optional>
append Cite~wrapper <optional>
Returns:
Type:
String

output

(protected, inner) citation(data, optionsopt) → {String}

Source:
Parameters:
Name Type Attributes Default Description
data Array.<CSL>
options Object <optional>
{}
Name Type Attributes Default Description
template String <optional>
'apa'
lang String <optional>
'en-US'
format String <optional>
'text'
entry String | Array.<String> <optional>

list of ids of entries to include in the citation. defaults to all entries

Returns:
Type:
String

output

(protected, inner) fetchEngine(style, lang, template, retrieveItem, retrieveLocale) → {Object}

Retrieve CSL parsing engine

Source:
Parameters:
Name Type Description
style String

CSL style id

lang String

Language code

template String

CSL XML template

retrieveItem module:output/csl~retrieveItem

Code to retreive item

retrieveLocale module:output/csl~retrieveLocale

Code to retreive locale

Returns:
Type:
Object

CSL Engine

(protected, inner) fetchLocale(langopt) → {String}

Retrieve CSL locale

Deprecated:
  • Yes
Source:
Parameters:
Name Type Attributes Default Description
lang String <optional>
"en-US"

lang code

Returns:
Type:
String

CSL locale

(protected, inner) fetchStyle(styleopt) → {String}

Retrieve CSL style

Deprecated:
  • Yes
Source:
Parameters:
Name Type Attributes Default Description
style String <optional>
"apa"

style name

Returns:
Type:
String

CSL style

(protected, inner) getAttributedEntry(string, name, value) → {String}

Add data-* attribute to a HTML string

Source:
Parameters:
Name Type Description
string String

HTML string

name String

attribute name

value String

attribute value

Returns:
Type:
String

HTML string with attribute

(protected, inner) getPrefixedEntry(value, id) → {String}

Add CSL identifiers to entry

Source:
Parameters:
Name Type Description
value String

HTML string

id String | Number

ID

Returns:
Type:
String

HTML string with CSL ID

(protected, inner) getWrappedEntry(value, source, wrapping) → {String}

Pre/append things to entry

Source:
Parameters:
Name Type Description
value String

HTML string

source CSL

source element

wrapping Object

append / prepend configuration

Name Type Attributes Description
prepend String | Cite~wrapper <optional>
append String | Cite~wrapper <optional>
Returns:
Type:
String

Wrapped HTML string

(protected, inner) prepareEngine(data, templateName, language, format) → {Object}

Prepare CSL parsing engine

Source:
Parameters:
Name Type Description
data Array.<CSL>
templateName String
language String
format String
Returns:
Type:
Object

CSL Engine

Type Definitions

retrieveItem(id) → {CSL}

Source:
Parameters:
Name Type Description
id String

Citation id

Returns:
Type:
CSL

CSL Citation object

retrieveLocale(lang) → {String}

Source:
Parameters:
Name Type Description
lang String

Language code

Returns:
Type:
String

CSL Locale

Members

(inner, constant) locales :Cite.util.Register

Source:
Type:

(inner, constant) templates :Cite.util.Register

Source:
Type:

Methods

(protected, inner) bibliography(data, optionsopt) → {String}

Source:
Parameters:
Name Type Attributes Default Description
data Array.<CSL>
options Object <optional>
{}
Name Type Attributes Default Description
template String <optional>
'apa'
lang String <optional>
'en-US'
format String <optional>
'text'
nosort Booolean <optional>
false
prepend Cite~wrapper <optional>
append Cite~wrapper <optional>
Returns:
Type:
String

output

(protected, inner) citation(data, optionsopt) → {String}

Source:
Parameters:
Name Type Attributes Default Description
data Array.<CSL>
options Object <optional>
{}
Name Type Attributes Default Description
template String <optional>
'apa'
lang String <optional>
'en-US'
format String <optional>
'text'
entry String | Array.<String> <optional>

list of ids of entries to include in the citation. defaults to all entries

Returns:
Type:
String

output

(protected, inner) fetchEngine(style, lang, template, retrieveItem, retrieveLocale) → {Object}

Retrieve CSL parsing engine

Source:
Parameters:
Name Type Description
style String

CSL style id

lang String

Language code

template String

CSL XML template

retrieveItem module:output/csl~retrieveItem

Code to retreive item

retrieveLocale module:output/csl~retrieveLocale

Code to retreive locale

Returns:
Type:
Object

CSL Engine

(protected, inner) fetchLocale(langopt) → {String}

Retrieve CSL locale

Deprecated:
  • Yes
Source:
Parameters:
Name Type Attributes Default Description
lang String <optional>
"en-US"

lang code

Returns:
Type:
String

CSL locale

(protected, inner) fetchStyle(styleopt) → {String}

Retrieve CSL style

Deprecated:
  • Yes
Source:
Parameters:
Name Type Attributes Default Description
style String <optional>
"apa"

style name

Returns:
Type:
String

CSL style

(protected, inner) getAttributedEntry(string, name, value) → {String}

Add data-* attribute to a HTML string

Source:
Parameters:
Name Type Description
string String

HTML string

name String

attribute name

value String

attribute value

Returns:
Type:
String

HTML string with attribute

(protected, inner) getPrefixedEntry(value, id) → {String}

Add CSL identifiers to entry

Source:
Parameters:
Name Type Description
value String

HTML string

id String | Number

ID

Returns:
Type:
String

HTML string with CSL ID

(protected, inner) getWrappedEntry(value, source, wrapping) → {String}

Pre/append things to entry

Source:
Parameters:
Name Type Description
value String

HTML string

source CSL

source element

wrapping Object

append / prepend configuration

Name Type Attributes Description
prepend String | Cite~wrapper <optional>
append String | Cite~wrapper <optional>
Returns:
Type:
String

Wrapped HTML string

(protected, inner) prepareEngine(data, templateName, language, format) → {Object}

Prepare CSL parsing engine

Source:
Parameters:
Name Type Description
data Array.<CSL>
templateName String
language String
format String
Returns:
Type:
Object

CSL Engine

Type Definitions

retrieveItem(id) → {CSL}

Source:
Parameters:
Name Type Description
id String

Citation id

Returns:
Type:
CSL

CSL Citation object

retrieveLocale(lang) → {String}

Source:
Parameters:
Name Type Description
lang String

Language code

Returns:
Type:
String

CSL Locale

Members

(inner, constant) locales :Cite.util.Register

Source:
Type:

(inner, constant) templates :Cite.util.Register

Source:
Type:

Methods

(protected, inner) bibliography(data, optionsopt) → {String}

Source:
Parameters:
Name Type Attributes Default Description
data Array.<CSL>
options Object <optional>
{}
Name Type Attributes Default Description
template String <optional>
'apa'
lang String <optional>
'en-US'
format String <optional>
'text'
nosort Booolean <optional>
false
prepend Cite~wrapper <optional>
append Cite~wrapper <optional>
Returns:
Type:
String

output

(protected, inner) citation(data, optionsopt) → {String}

Source:
Parameters:
Name Type Attributes Default Description
data Array.<CSL>
options Object <optional>
{}
Name Type Attributes Default Description
template String <optional>
'apa'
lang String <optional>
'en-US'
format String <optional>
'text'
entry String | Array.<String> <optional>

list of ids of entries to include in the citation. defaults to all entries

Returns:
Type:
String

output

(protected, inner) fetchEngine(style, lang, template, retrieveItem, retrieveLocale) → {Object}

Retrieve CSL parsing engine

Source:
Parameters:
Name Type Description
style String

CSL style id

lang String

Language code

template String

CSL XML template

retrieveItem module:output/csl~retrieveItem

Code to retreive item

retrieveLocale module:output/csl~retrieveLocale

Code to retreive locale

Returns:
Type:
Object

CSL Engine

(protected, inner) fetchLocale(langopt) → {String}

Retrieve CSL locale

Deprecated:
  • Yes
Source:
Parameters:
Name Type Attributes Default Description
lang String <optional>
"en-US"

lang code

Returns:
Type:
String

CSL locale

(protected, inner) fetchStyle(styleopt) → {String}

Retrieve CSL style

Deprecated:
  • Yes
Source:
Parameters:
Name Type Attributes Default Description
style String <optional>
"apa"

style name

Returns:
Type:
String

CSL style

(protected, inner) getAttributedEntry(string, name, value) → {String}

Add data-* attribute to a HTML string

Source:
Parameters:
Name Type Description
string String

HTML string

name String

attribute name

value String

attribute value

Returns:
Type:
String

HTML string with attribute

(protected, inner) getPrefixedEntry(value, id) → {String}

Add CSL identifiers to entry

Source:
Parameters:
Name Type Description
value String

HTML string

id String | Number

ID

Returns:
Type:
String

HTML string with CSL ID

(protected, inner) getWrappedEntry(value, source, wrapping) → {String}

Pre/append things to entry

Source:
Parameters:
Name Type Description
value String

HTML string

source CSL

source element

wrapping Object

append / prepend configuration

Name Type Attributes Description
prepend String | Cite~wrapper <optional>
append String | Cite~wrapper <optional>
Returns:
Type:
String

Wrapped HTML string

(protected, inner) prepareEngine(data, templateName, language, format) → {Object}

Prepare CSL parsing engine

Source:
Parameters:
Name Type Description
data Array.<CSL>
templateName String
language String
format String
Returns:
Type:
Object

CSL Engine

Type Definitions

retrieveItem(id) → {CSL}

Source:
Parameters:
Name Type Description
id String

Citation id

Returns:
Type:
CSL

CSL Citation object

retrieveLocale(lang) → {String}

Source:
Parameters:
Name Type Description
lang String

Language code

Returns:
Type:
String

CSL Locale

Members

(inner, constant) locales :Cite.util.Register

Source:
Type:

(inner, constant) templates :Cite.util.Register

Source:
Type:

Methods

(protected, inner) bibliography(data, optionsopt) → {String}

Source:
Parameters:
Name Type Attributes Default Description
data Array.<CSL>
options Object <optional>
{}
Name Type Attributes Default Description
template String <optional>
'apa'
lang String <optional>
'en-US'
format String <optional>
'text'
nosort Booolean <optional>
false
prepend Cite~wrapper <optional>
append Cite~wrapper <optional>
Returns:
Type:
String

output

(protected, inner) citation(data, optionsopt) → {String}

Source:
Parameters:
Name Type Attributes Default Description
data Array.<CSL>
options Object <optional>
{}
Name Type Attributes Default Description
template String <optional>
'apa'
lang String <optional>
'en-US'
format String <optional>
'text'
entry String | Array.<String> <optional>

list of ids of entries to include in the citation. defaults to all entries

Returns:
Type:
String

output

(protected, inner) fetchEngine(style, lang, template, retrieveItem, retrieveLocale) → {Object}

Retrieve CSL parsing engine

Source:
Parameters:
Name Type Description
style String

CSL style id

lang String

Language code

template String

CSL XML template

retrieveItem module:output/csl~retrieveItem

Code to retreive item

retrieveLocale module:output/csl~retrieveLocale

Code to retreive locale

Returns:
Type:
Object

CSL Engine

(protected, inner) fetchLocale(langopt) → {String}

Retrieve CSL locale

Deprecated:
  • Yes
Source:
Parameters:
Name Type Attributes Default Description
lang String <optional>
"en-US"

lang code

Returns:
Type:
String

CSL locale

(protected, inner) fetchStyle(styleopt) → {String}

Retrieve CSL style

Deprecated:
  • Yes
Source:
Parameters:
Name Type Attributes Default Description
style String <optional>
"apa"

style name

Returns:
Type:
String

CSL style

(protected, inner) getAttributedEntry(string, name, value) → {String}

Add data-* attribute to a HTML string

Source:
Parameters:
Name Type Description
string String

HTML string

name String

attribute name

value String

attribute value

Returns:
Type:
String

HTML string with attribute

(protected, inner) getPrefixedEntry(value, id) → {String}

Add CSL identifiers to entry

Source:
Parameters:
Name Type Description
value String

HTML string

id String | Number

ID

Returns:
Type:
String

HTML string with CSL ID

(protected, inner) getWrappedEntry(value, source, wrapping) → {String}

Pre/append things to entry

Source:
Parameters:
Name Type Description
value String

HTML string

source CSL

source element

wrapping Object

append / prepend configuration

Name Type Attributes Description
prepend String | Cite~wrapper <optional>
append String | Cite~wrapper <optional>
Returns:
Type:
String

Wrapped HTML string

(protected, inner) prepareEngine(data, templateName, language, format) → {Object}

Prepare CSL parsing engine

Source:
Parameters:
Name Type Description
data Array.<CSL>
templateName String
language String
format String
Returns:
Type:
Object

CSL Engine

Type Definitions

retrieveItem(id) → {CSL}

Source:
Parameters:
Name Type Description
id String

Citation id

Returns:
Type:
CSL

CSL Citation object

retrieveLocale(lang) → {String}

Source:
Parameters:
Name Type Description
lang String

Language code

Returns:
Type:
String

CSL Locale

Members

(inner, constant) locales :Cite.util.Register

Source:
Type:

(inner, constant) templates :Cite.util.Register

Source:
Type:

Methods

(protected, inner) bibliography(data, optionsopt) → {String}

Source:
Parameters:
Name Type Attributes Default Description
data Array.<CSL>
options Object <optional>
{}
Name Type Attributes Default Description
template String <optional>
'apa'
lang String <optional>
'en-US'
format String <optional>
'text'
nosort Booolean <optional>
false
prepend Cite~wrapper <optional>
append Cite~wrapper <optional>
Returns:
Type:
String

output

(protected, inner) citation(data, optionsopt) → {String}

Source:
Parameters:
Name Type Attributes Default Description
data Array.<CSL>
options Object <optional>
{}
Name Type Attributes Default Description
template String <optional>
'apa'
lang String <optional>
'en-US'
format String <optional>
'text'
entry String | Array.<String> <optional>

list of ids of entries to include in the citation. defaults to all entries

Returns:
Type:
String

output

(protected, inner) fetchEngine(style, lang, template, retrieveItem, retrieveLocale) → {Object}

Retrieve CSL parsing engine

Source:
Parameters:
Name Type Description
style String

CSL style id

lang String

Language code

template String

CSL XML template

retrieveItem module:output/csl~retrieveItem

Code to retreive item

retrieveLocale module:output/csl~retrieveLocale

Code to retreive locale

Returns:
Type:
Object

CSL Engine

(protected, inner) fetchLocale(langopt) → {String}

Retrieve CSL locale

Deprecated:
  • Yes
Source:
Parameters:
Name Type Attributes Default Description
lang String <optional>
"en-US"

lang code

Returns:
Type:
String

CSL locale

(protected, inner) fetchStyle(styleopt) → {String}

Retrieve CSL style

Deprecated:
  • Yes
Source:
Parameters:
Name Type Attributes Default Description
style String <optional>
"apa"

style name

Returns:
Type:
String

CSL style

(protected, inner) getAttributedEntry(string, name, value) → {String}

Add data-* attribute to a HTML string

Source:
Parameters:
Name Type Description
string String

HTML string

name String

attribute name

value String

attribute value

Returns:
Type:
String

HTML string with attribute

(protected, inner) getPrefixedEntry(value, id) → {String}

Add CSL identifiers to entry

Source:
Parameters:
Name Type Description
value String

HTML string

id String | Number

ID

Returns:
Type:
String

HTML string with CSL ID

(protected, inner) getWrappedEntry(value, source, wrapping) → {String}

Pre/append things to entry

Source:
Parameters:
Name Type Description
value String

HTML string

source CSL

source element

wrapping Object

append / prepend configuration

Name Type Attributes Description
prepend String | Cite~wrapper <optional>
append String | Cite~wrapper <optional>
Returns:
Type:
String

Wrapped HTML string

(protected, inner) prepareEngine(data, templateName, language, format) → {Object}

Prepare CSL parsing engine

Source:
Parameters:
Name Type Description
data Array.<CSL>
templateName String
language String
format String
Returns:
Type:
Object

CSL Engine

Type Definitions

retrieveItem(id) → {CSL}

Source:
Parameters:
Name Type Description
id String

Citation id

Returns:
Type:
CSL

CSL Citation object

retrieveLocale(lang) → {String}

Source:
Parameters:
Name Type Description
lang String

Language code

Returns:
Type:
String

CSL Locale