citeproc-0.3.0.8: Generates citations and bibliography from CSL styles.
Safe HaskellNone
LanguageHaskell2010

Citeproc

Description

Process citations using the formatting instructions encoded in a CSL stylesheet. The library targets version 1.0.1 of the CSL spec: https://docs.citationstyles.org/en/stable/specification.html

Synopsis

Documentation

citeproc Source #

Arguments

:: CiteprocOutput a 
=> CiteprocOptions

Rendering options

-> Style a

Parsed CSL style

-> Maybe Lang

Overrides default locale for style

-> [Reference a]

List of references (bibliographic data)

-> [Citation a]

List of citations to process

-> Result a 

Process a list of Citations, producing formatted citations and a bibliography according to the rules of a CSL Style. If a Lang is specified, override the style's default locale. To obtain a Style from an XML stylesheet, use parseStyle from Citeproc.Style.

data Result a Source #

Result of citation processing.

Constructors

Result 

Fields

  • 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

Instances

Instances details
Functor Result Source # 
Instance details

Defined in Citeproc.Types

Methods

fmap :: (a -> b) -> Result a -> Result b #

(<$) :: a -> Result b -> Result a #

Foldable Result Source # 
Instance details

Defined in Citeproc.Types

Methods

fold :: Monoid m => Result m -> m #

foldMap :: Monoid m => (a -> m) -> Result a -> m #

foldMap' :: Monoid m => (a -> m) -> Result a -> m #

foldr :: (a -> b -> b) -> b -> Result a -> b #

foldr' :: (a -> b -> b) -> b -> Result a -> b #

foldl :: (b -> a -> b) -> b -> Result a -> b #

foldl' :: (b -> a -> b) -> b -> Result a -> b #

foldr1 :: (a -> a -> a) -> Result a -> a #

foldl1 :: (a -> a -> a) -> Result a -> a #

toList :: Result a -> [a] #

null :: Result a -> Bool #

length :: Result a -> Int #

elem :: Eq a => a -> Result a -> Bool #

maximum :: Ord a => Result a -> a #

minimum :: Ord a => Result a -> a #

sum :: Num a => Result a -> a #

product :: Num a => Result a -> a #

Traversable Result Source # 
Instance details

Defined in Citeproc.Types

Methods

traverse :: Applicative f => (a -> f b) -> Result a -> f (Result b) #

sequenceA :: Applicative f => Result (f a) -> f (Result a) #

mapM :: Monad m => (a -> m b) -> Result a -> m (Result b) #

sequence :: Monad m => Result (m a) -> m (Result a) #

Show a => Show (Result a) Source # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> Result a -> ShowS #

show :: Result a -> String #

showList :: [Result a] -> ShowS #

ToJSON a => ToJSON (Result a) Source # 
Instance details

Defined in Citeproc.Types

FromJSON a => FromJSON (Result a) Source # 
Instance details

Defined in Citeproc.Types