quarkdown-stdlib/com.quarkdown.stdlib.module.Bibliography/bibliography

bibliography

.bibliography path:{String}
             style:{String = DEFAULT_CSL_STYLE}
             title:{InlineMarkdownContent? = null}
         breakpage:{Boolean = true}
      headingdepth:{Int = 1}
     numberheading:{Boolean = false}
      indexheading:{Boolean = false}
-> Node
Content copied to clipboard

Generates a bibliography from a bibliography file.

Supported formats include BibTeX (.bib), CSL JSON, YAML, EndNote, and RIS.

The bibliography is formatted using a CSL style definition, powered by citeproc-java. This enables support for a curated selection of citation styles from the CSL Style Repository.

Example:

.bibliography {bibliography.bib} style:{apa}
Content copied to clipboard

Return

an AstRoot containing an optional heading and a BibliographyView

Parameters

path

path to the bibliography file, with extension

style

CSL style identifier (e.g. apa, ieee, chicago-author-date) from Quarkdown's selection. See the wiki page for a list of supported styles.

title

title of the bibliography. If unset, the default localized title is used

breakpage

whether the heading preceding the bibliography triggers an automatic page break. Enabled by default.

headingdepth

depth of the heading preceding the bibliography

numberheading

whether the heading preceding the bibliography should be numbered and have its position tracked in the document hierarchy. Implicitly enabled when indexheading is enabled.

indexheading

whether the heading preceding the bibliography should itself be indexed in the document's table of contents.

See also

to cite bibliography entries

Throws

if the bibliography file cannot be read or parsed

if the specified style does not exist or is invalid

Wiki page

Bibliography