citeproc-hs-0.3.2: A Citation Style Language implementation in Haskell Source code Contents Index

Text.CSL.Proc Portability unportable Stability unstable Maintainer Andrea Rossato <andrea.rossato@unitn.it>

Description

This module provides functions for processing the evaluated Output for disambiguation and citation collapsing.

Synopsis

data ProcOpts = ProcOpts { bibOpts :: BibOpts } data BibOpts = Select [(String, String)] [(String, String)] | Include [(String, String)] [(String, String)] | Exclude [(String, String)] [(String, String)] procOpts :: ProcOpts processCitations :: ProcOpts -> Style -> [Reference] -> Citations -> [[FormattedOutput]] processBibliography :: ProcOpts -> Style -> [Reference] -> [[FormattedOutput]] citeproc :: ProcOpts -> Style -> [Reference] -> Citations -> BiblioData procRefs :: Style -> [Reference] -> [Reference] sortItems :: Show a => [(a, [Sorting])] -> [a] procBiblio :: BibOpts -> Style -> [Reference] -> [[Output]] filterRefs :: BibOpts -> [Reference] -> [Reference] procGroup :: Style -> [(Cite, Reference)] -> CitationGroup formatBiblioLayout :: Formatting -> Delimiter -> [Output] -> [Output] formatCitLayout :: Style -> CitationGroup -> [FormattedOutput] addAffixes :: Formatting -> [Output] -> [Output] localModifiers :: Style -> Bool -> Cite -> Output -> Output

Documentation

data ProcOpts Source

Constructors ProcOpts bibOpts :: BibOpts Instances Eq ProcOpts Read ProcOpts Show ProcOpts

data BibOpts Source

Constructors Select [(String, String)] [(String, String)] Include [(String, String)] [(String, String)] Exclude [(String, String)] [(String, String)] Instances Eq BibOpts Read BibOpts Show BibOpts

procOpts :: ProcOpts Source

processCitations :: ProcOpts -> Style -> [Reference] -> Citations -> [[FormattedOutput]] Source

With a Style, a list of References and the list of citation groups (the list of citations with their locator), produce the FormattedOutput for each citation group.

processBibliography :: ProcOpts -> Style -> [Reference] -> [[FormattedOutput]] Source

With a Style and the list of References produce the FormattedOutput for the bibliography.

citeproc :: ProcOpts -> Style -> [Reference] -> Citations -> BiblioData Source

With a Style, a list of References and the list of Citations, produce the FormattedOutput for each citation group and the bibliography.

procRefs :: Style -> [Reference] -> [Reference] Source

Given the CSL Style and the list of References sort the list according to the Style and assign the citation number to each Reference.

sortItems :: Show a => [(a, [Sorting])] -> [a] Source

procBiblio :: BibOpts -> Style -> [Reference] -> [[Output]] Source

With a Style and a sorted list of References produce the evaluated output for the bibliography.

filterRefs :: BibOpts -> [Reference] -> [Reference] Source

procGroup :: Style -> [(Cite, Reference)] -> CitationGroup Source

Given the CSL Style and the list of References coupled with their position, generate a CitationGroup. The citations are sorted according to the Style.

formatBiblioLayout :: Formatting -> Delimiter -> [Output] -> [Output] Source

formatCitLayout :: Style -> CitationGroup -> [FormattedOutput] Source

addAffixes :: Formatting -> [Output] -> [Output] Source

localModifiers :: Style -> Bool -> Cite -> Output -> Output Source

The Bool is True if we are formatting a textual citation (in pandoc terminology).

Produced by Haddock version 2.6.1