HORIZON HASKELLDocslts/ghc-9.10.xc74966e2026-09-27Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · c74966e · 2026-09-27

Moduleciteproc-0.8.1Haskell2010

Citeproc.Types

  • 71 types
  • 1 class
  • 25 values
  • Packageciteproc-0.8.1
  • Exports97
  • LanguageHaskell2010
  • LicenceBSD-2-Clause
  • SourceTypes.hs
datadata CiteprocOptions
#

Options affecting the output in ways that go beyond what can be specified in styles.

Constructors

  • CiteprocOptions
    • linkCitations :: Bool

      Create hyperlinks from citations to bibliography entries

    • linkBibliography :: Bool

      Enables the following options:

      • Automatically linkify any DOI, PMCID, PMID, or URL appearing in a bibliography entry.

      • When a bibliography entry has a DOI, PMCID, PMID, or URL available (in order of priority), but the style does not explicitly render at least one of them, add a hyperlink to the title instead.

      • A bibliography item with a DOI, PMCID, PMID, or URL available (in order of priority) will be wrapped in a hyperlink when the hyperlink has not already been applied to one of its parts (e.g. to the title).

Instances2Eq, Show
classclass (Semigroup a, Monoid a, Show a, Eq a, Ord a) => CiteprocOutput a where
#

CSL styles require certain formatting transformations to be defined. These are defined in the CiteprocOutput class. The library may be used with any structured format that defines these operations. See the Citeproc.CslJson module for an instance that corresponds to the markup allowed in CSL JSON. See the Citeproc.Pandoc module for an instance for Pandoc Inlines.

Methods

Instances2CiteprocOutput
newtypenewtype ItemId
#

The identifier used to identify a work in a bibliographic database.

Constructors

Instances7Eq, Ord, Show, Semigroup, Monoid, FromJSON, …
datadata CitationItem a
#

The part of a citation corresponding to a single work, possibly including a label, locator, prefix and suffix.

Constructors

Instances5Eq, Ord, Show, FromJSON, ToJSON
datadata Citation a
#

A citation (which may include several items, e.g. in (Smith 2000; Jones 2010, p. 30)).

Constructors

Instances5Eq, Ord, Show, FromJSON, ToJSON
datadata NameFormat
#

Constructors

Instances2Eq, Show
datadata Name
#

Constructors

Instances5Eq, Ord, Show, FromJSON, ToJSON
  • Eq NameDefined in citeproc-0.8.1 · Citeproc.Types
  • Ord NameDefined in citeproc-0.8.1 · Citeproc.Types
  • Show NameDefined in citeproc-0.8.1 · Citeproc.Types
  • FromJSON NameDefined in citeproc-0.8.1 · Citeproc.Types
  • ToJSON NameDefined in citeproc-0.8.1 · Citeproc.Types
datadata Formatting
#

Constructors

Instances4Eq, Show, Semigroup, Monoid
datadata StyleOptions
#

Constructors

Instances2Eq, Show
datadata Lang
#

Represents a BCP 47 language tag (https://tools.ietf.org/html/bcp47).

Constructors

Instances6Eq, Ord, Show, IsString, Binary, Lift
  • Eq LangDefined in unicode-collation-0.1.3.6 · Text.Collate.Lang
  • Ord LangDefined in unicode-collation-0.1.3.6 · Text.Collate.Lang
  • Show LangDefined in unicode-collation-0.1.3.6 · Text.Collate.Lang
  • IsString LangDefined in unicode-collation-0.1.3.6 · Text.Collate.Lang
  • Binary LangDefined in unicode-collation-0.1.3.6 · Text.Collate.Lang
  • Lift LangDefined in unicode-collation-0.1.3.6 · Text.Collate.Lang
datadata Locale
#

Defines locale-specific terms, punctuation styles, and date formats.

Constructors

Instances4Eq, Show, Semigroup, Monoid
datadata Reference a
#

Encodes bibliographic data for a single work.

Constructors

Instances8Functor, Foldable, Traversable, Eq, Ord, Show, …
valuemakeReferenceMap :: [Reference a] -> ([Reference a], ReferenceMap a)
#

Returns a pair consisting of the cleaned up list of references and a reference map. If the original reference list contains items with the same id, then the one that occurs last in the list is retained, and the others are omittedfrom the cleaned-up list.

datadata Val a
#

Value associated with a certain variable in a bibliographic entry.

Constructors

Instances7Functor, Foldable, Traversable, Eq, Ord, Show, …
  • Functor ValDefined in citeproc-0.8.1 · Citeproc.Types
  • Foldable ValDefined in citeproc-0.8.1 · Citeproc.Types
  • Traversable ValDefined in citeproc-0.8.1 · Citeproc.Types
  • Eq a => Eq (Val a)Defined in citeproc-0.8.1 · Citeproc.Types
  • Ord a => Ord (Val a)Defined in citeproc-0.8.1 · Citeproc.Types
  • Show a => Show (Val a)Defined in citeproc-0.8.1 · Citeproc.Types
  • ToJSON a => ToJSON (Val a)Defined in citeproc-0.8.1 · Citeproc.Types
newtypenewtype Variable
#
Instances10Eq, Ord, Show, IsString, Semigroup, Monoid, …
newtypenewtype Abbreviations
#

An abbreviations map. These are typically stored in a JSON serialization: for examples of the format, see https://github.com/citation-style-language/abbreviations. Abbreviations are substituted in the output when the variable and its content are matched by something in the abbreviations map.

Instances5Eq, Ord, Show, FromJSON, ToJSON
datadata Result a
#

Result of citation processing.

Constructors

  • Result
    • resultCitations :: [a]

      List of formatted citations corresponding to the citations given to citeproc

    • resultBibliography :: [(Text, a)]

      List of formatted bibliography entries (if the style calls for a bibliography), each a pair consisting of the item identifier and the formatted entry

    • resultWarnings :: [Text]

      Warnings from citation processing

Instances6Functor, Foldable, Traversable, Show, FromJSON, ToJSON