Copyright	(c) Andrea Rossato
License	BSD-style (see LICENSE)
Maintainer	Andrea Rossato <andrea.rossato@unitn.it>
Stability	unstable
Portability	unportable
Safe Haskell	None
Language	Haskell2010

Text.CSL.Proc

Description

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

Synopsis

data ProcOpts = ProcOpts {
- bibOpts :: BibOpts
- linkCitations :: Bool
}
data BibOpts
- = Select [(Text, Text)] [(Text, Text)]
- | Include [(Text, Text)] [(Text, Text)]
- | Exclude [(Text, Text)] [(Text, Text)]
newtype FieldVal = FieldVal {
- unFieldVal :: (Text, Text)
}
procOpts :: ProcOpts
processCitations :: ProcOpts -> Style -> [Reference] -> Citations -> [Formatted]
processBibliography :: ProcOpts -> Style -> [Reference] -> [Formatted]
citeproc :: ProcOpts -> Style -> [Reference] -> Citations -> BiblioData
procRefs :: Style -> [Reference] -> [Reference]
sortItems :: Show a => [(a, [Sorting])] -> [a]
procBiblio :: BibOpts -> Style -> [Reference] -> [[Output]]
subsequentAuthorSubstitute :: Bibliography -> [[Output]] -> [[Output]]
filterRefs :: BibOpts -> [Reference] -> [Reference]
procGroup :: Style -> [(Cite, Maybe Reference)] -> CitationGroup
formatBiblioLayout :: Formatting -> Delimiter -> [Output] -> [Output]
formatCitLayout :: Style -> CitationGroup -> Formatted
addAffixes :: Formatting -> [Output] -> [Output]
localModifiers :: Style -> Bool -> Cite -> Output -> Output
contribOnly :: Style -> Output -> Output

Documentation

data ProcOpts Source #

Constructors

ProcOpts
Fields bibOpts :: BibOpts linkCitations :: Bool

Instances

Eq ProcOpts Source #
Instance details Defined in Text.CSL.Proc Methods (==) :: ProcOpts -> ProcOpts -> Bool # (/=) :: ProcOpts -> ProcOpts -> Bool #
Read ProcOpts Source #
Instance details Defined in Text.CSL.Proc Methods readsPrec :: Int -> ReadS ProcOpts # readList :: ReadS [ProcOpts] # readPrec :: ReadPrec ProcOpts # readListPrec :: ReadPrec [ProcOpts] #
Show ProcOpts Source #
Instance details Defined in Text.CSL.Proc Methods showsPrec :: Int -> ProcOpts -> ShowS # show :: ProcOpts -> String # showList :: [ProcOpts] -> ShowS #

data BibOpts Source #

Constructors

Select [(Text, Text)] [(Text, Text)]
Include [(Text, Text)] [(Text, Text)]
Exclude [(Text, Text)] [(Text, Text)]

Instances

Eq BibOpts Source #
Instance details Defined in Text.CSL.Proc Methods (==) :: BibOpts -> BibOpts -> Bool # (/=) :: BibOpts -> BibOpts -> Bool #
Read BibOpts Source #
Instance details Defined in Text.CSL.Proc Methods readsPrec :: Int -> ReadS BibOpts # readList :: ReadS [BibOpts] # readPrec :: ReadPrec BibOpts # readListPrec :: ReadPrec [BibOpts] #
Show BibOpts Source #
Instance details Defined in Text.CSL.Proc Methods showsPrec :: Int -> BibOpts -> ShowS # show :: BibOpts -> String # showList :: [BibOpts] -> ShowS #
FromJSON BibOpts Source #
Instance details Defined in Text.CSL.Proc Methods parseJSON :: Value -> Parser BibOpts # parseJSONList :: Value -> Parser [BibOpts] #

newtype FieldVal Source #

Constructors

FieldVal
Fields unFieldVal :: (Text, Text)

Instances

Show FieldVal Source #
Instance details Defined in Text.CSL.Proc Methods showsPrec :: Int -> FieldVal -> ShowS # show :: FieldVal -> String # showList :: [FieldVal] -> ShowS #
FromJSON FieldVal Source #
Instance details Defined in Text.CSL.Proc Methods parseJSON :: Value -> Parser FieldVal # parseJSONList :: Value -> Parser [FieldVal] #

procOpts :: ProcOpts Source #

processCitations :: ProcOpts -> Style -> [Reference] -> Citations -> [Formatted] Source #

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

processBibliography :: ProcOpts -> Style -> [Reference] -> [Formatted] Source #

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

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

With a Style, a list of References and the list of Citations, produce the Formatted 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.

subsequentAuthorSubstitute :: Bibliography -> [[Output]] -> [[Output]] Source #

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

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

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

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

formatCitLayout :: Style -> CitationGroup -> Formatted Source #

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

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

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

contribOnly :: Style -> Output -> Output Source #