citeproc-0.8.1: Generates citations and bibliography from CSL styles.
Safe HaskellSafe-Inferred
LanguageHaskell2010

Citeproc.Types

Synopsis

Documentation

data CiteprocOptions #

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

Constructors

CiteprocOptions 

Fields

  • 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).

Instances

Instances details
Show CiteprocOptions # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> CiteprocOptions -> ShowS

show :: CiteprocOptions -> String

showList :: [CiteprocOptions] -> ShowS

Eq CiteprocOptions # 
Instance details

Defined in Citeproc.Types

class (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 CslJson module for an instance that corresponds to the markup allowed in CSL JSON. See the Pandoc module for an instance for Pandoc Inlines.

Methods

toText :: a -> Text #

fromText :: Text -> a #

dropTextWhile :: (Char -> Bool) -> a -> a #

dropTextWhileEnd :: (Char -> Bool) -> a -> a #

addFontVariant :: FontVariant -> a -> a #

addFontStyle :: FontStyle -> a -> a #

addFontWeight :: FontWeight -> a -> a #

addTextDecoration :: TextDecoration -> a -> a #

addVerticalAlign :: VerticalAlign -> a -> a #

addTextCase :: Maybe Lang -> TextCase -> a -> a #

addDisplay :: DisplayStyle -> a -> a #

addQuotes :: a -> a #

movePunctuationInsideQuotes :: a -> a #

inNote :: a -> a #

mapText :: (Text -> Text) -> a -> a #

addHyperlink :: Text -> a -> a #

localizeQuotes :: Locale -> a -> a #

Instances

Instances details
CiteprocOutput Inlines # 
Instance details

Defined in Citeproc.Pandoc

CiteprocOutput (CslJson Text) # 
Instance details

Defined in Citeproc.CslJson

Methods

toText :: CslJson Text -> Text #

fromText :: Text -> CslJson Text #

dropTextWhile :: (Char -> Bool) -> CslJson Text -> CslJson Text #

dropTextWhileEnd :: (Char -> Bool) -> CslJson Text -> CslJson Text #

addFontVariant :: FontVariant -> CslJson Text -> CslJson Text #

addFontStyle :: FontStyle -> CslJson Text -> CslJson Text #

addFontWeight :: FontWeight -> CslJson Text -> CslJson Text #

addTextDecoration :: TextDecoration -> CslJson Text -> CslJson Text #

addVerticalAlign :: VerticalAlign -> CslJson Text -> CslJson Text #

addTextCase :: Maybe Lang -> TextCase -> CslJson Text -> CslJson Text #

addDisplay :: DisplayStyle -> CslJson Text -> CslJson Text #

addQuotes :: CslJson Text -> CslJson Text #

movePunctuationInsideQuotes :: CslJson Text -> CslJson Text #

inNote :: CslJson Text -> CslJson Text #

mapText :: (Text -> Text) -> CslJson Text -> CslJson Text #

addHyperlink :: Text -> CslJson Text -> CslJson Text #

localizeQuotes :: Locale -> CslJson Text -> CslJson Text #

data CiteprocError #

Instances

Instances details
Show CiteprocError # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> CiteprocError -> ShowS

show :: CiteprocError -> String

showList :: [CiteprocError] -> ShowS

Eq CiteprocError # 
Instance details

Defined in Citeproc.Types

newtype ItemId #

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

Constructors

ItemId 

Fields

Instances

Instances details
FromJSON ItemId # 
Instance details

Defined in Citeproc.Types

ToJSON ItemId # 
Instance details

Defined in Citeproc.Types

Monoid ItemId # 
Instance details

Defined in Citeproc.Types

Semigroup ItemId # 
Instance details

Defined in Citeproc.Types

Methods

(<>) :: ItemId -> ItemId -> ItemId #

sconcat :: NonEmpty ItemId -> ItemId

stimes :: Integral b => b -> ItemId -> ItemId

Show ItemId # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> ItemId -> ShowS

show :: ItemId -> String

showList :: [ItemId] -> ShowS

Eq ItemId # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: ItemId -> ItemId -> Bool

(/=) :: ItemId -> ItemId -> Bool

Ord ItemId # 
Instance details

Defined in Citeproc.Types

Methods

compare :: ItemId -> ItemId -> Ordering

(<) :: ItemId -> ItemId -> Bool

(<=) :: ItemId -> ItemId -> Bool

(>) :: ItemId -> ItemId -> Bool

(>=) :: ItemId -> ItemId -> Bool

max :: ItemId -> ItemId -> ItemId

min :: ItemId -> ItemId -> ItemId

data CitationItem a #

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

Instances

Instances details
(FromJSON a, Eq a) => FromJSON (CitationItem a) # 
Instance details

Defined in Citeproc.Types

ToJSON a => ToJSON (CitationItem a) # 
Instance details

Defined in Citeproc.Types

Show a => Show (CitationItem a) # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> CitationItem a -> ShowS

show :: CitationItem a -> String

showList :: [CitationItem a] -> ShowS

Eq a => Eq (CitationItem a) # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: CitationItem a -> CitationItem a -> Bool

(/=) :: CitationItem a -> CitationItem a -> Bool

Ord a => Ord (CitationItem a) # 
Instance details

Defined in Citeproc.Types

Methods

compare :: CitationItem a -> CitationItem a -> Ordering

(<) :: CitationItem a -> CitationItem a -> Bool

(<=) :: CitationItem a -> CitationItem a -> Bool

(>) :: CitationItem a -> CitationItem a -> Bool

(>=) :: CitationItem a -> CitationItem a -> Bool

max :: CitationItem a -> CitationItem a -> CitationItem a

min :: CitationItem a -> CitationItem a -> CitationItem a

data Citation a #

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

Constructors

Citation 

Fields

Instances

Instances details
(FromJSON a, Eq a) => FromJSON (Citation a) # 
Instance details

Defined in Citeproc.Types

ToJSON a => ToJSON (Citation a) # 
Instance details

Defined in Citeproc.Types

Show a => Show (Citation a) # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> Citation a -> ShowS

show :: Citation a -> String

showList :: [Citation a] -> ShowS

Eq a => Eq (Citation a) # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: Citation a -> Citation a -> Bool

(/=) :: Citation a -> Citation a -> Bool

Ord a => Ord (Citation a) # 
Instance details

Defined in Citeproc.Types

Methods

compare :: Citation a -> Citation a -> Ordering

(<) :: Citation a -> Citation a -> Bool

(<=) :: Citation a -> Citation a -> Bool

(>) :: Citation a -> Citation a -> Bool

(>=) :: Citation a -> Citation a -> Bool

max :: Citation a -> Citation a -> Citation a

min :: Citation a -> Citation a -> Citation a

data ElementType a #

Instances

Instances details
Show (ElementType a) # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> ElementType a -> ShowS

show :: ElementType a -> String

showList :: [ElementType a] -> ShowS

Eq (ElementType a) # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: ElementType a -> ElementType a -> Bool

(/=) :: ElementType a -> ElementType a -> Bool

data Element a #

Constructors

Element (ElementType a) Formatting 

Instances

Instances details
Show (Element a) # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> Element a -> ShowS

show :: Element a -> String

showList :: [Element a] -> ShowS

Eq (Element a) # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: Element a -> Element a -> Bool

(/=) :: Element a -> Element a -> Bool

data NumberForm #

Instances

Instances details
Show NumberForm # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> NumberForm -> ShowS

show :: NumberForm -> String

showList :: [NumberForm] -> ShowS

Eq NumberForm # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: NumberForm -> NumberForm -> Bool

(/=) :: NumberForm -> NumberForm -> Bool

data Pluralize #

Instances

Instances details
Show Pluralize # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> Pluralize -> ShowS

show :: Pluralize -> String

showList :: [Pluralize] -> ShowS

Eq Pluralize # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: Pluralize -> Pluralize -> Bool

(/=) :: Pluralize -> Pluralize -> Bool

data DateType #

Instances

Instances details
Show DateType # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> DateType -> ShowS

show :: DateType -> String

showList :: [DateType] -> ShowS

Eq DateType # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: DateType -> DateType -> Bool

(/=) :: DateType -> DateType -> Bool

Ord DateType # 
Instance details

Defined in Citeproc.Types

Methods

compare :: DateType -> DateType -> Ordering

(<) :: DateType -> DateType -> Bool

(<=) :: DateType -> DateType -> Bool

(>) :: DateType -> DateType -> Bool

(>=) :: DateType -> DateType -> Bool

max :: DateType -> DateType -> DateType

min :: DateType -> DateType -> DateType

data Date #

Constructors

Date 

Fields

Instances

Instances details
FromJSON Date # 
Instance details

Defined in Citeproc.Types

ToJSON Date # 
Instance details

Defined in Citeproc.Types

Show Date # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> Date -> ShowS

show :: Date -> String

showList :: [Date] -> ShowS

Eq Date # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: Date -> Date -> Bool

(/=) :: Date -> Date -> Bool

Ord Date # 
Instance details

Defined in Citeproc.Types

Methods

compare :: Date -> Date -> Ordering

(<) :: Date -> Date -> Bool

(<=) :: Date -> Date -> Bool

(>) :: Date -> Date -> Bool

(>=) :: Date -> Date -> Bool

max :: Date -> Date -> Date

min :: Date -> Date -> Date

rawDateEDTF :: Text -> Maybe Date #

newtype DateParts #

Constructors

DateParts [Int] 

Instances

Instances details
FromJSON DateParts # 
Instance details

Defined in Citeproc.Types

ToJSON DateParts # 
Instance details

Defined in Citeproc.Types

Show DateParts # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> DateParts -> ShowS

show :: DateParts -> String

showList :: [DateParts] -> ShowS

Eq DateParts # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: DateParts -> DateParts -> Bool

(/=) :: DateParts -> DateParts -> Bool

Ord DateParts # 
Instance details

Defined in Citeproc.Types

Methods

compare :: DateParts -> DateParts -> Ordering

(<) :: DateParts -> DateParts -> Bool

(<=) :: DateParts -> DateParts -> Bool

(>) :: DateParts -> DateParts -> Bool

(>=) :: DateParts -> DateParts -> Bool

max :: DateParts -> DateParts -> DateParts

min :: DateParts -> DateParts -> DateParts

data ShowDateParts #

Constructors

YearMonthDay 
YearMonth 
Year 

Instances

Instances details
Show ShowDateParts # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> ShowDateParts -> ShowS

show :: ShowDateParts -> String

showList :: [ShowDateParts] -> ShowS

Eq ShowDateParts # 
Instance details

Defined in Citeproc.Types

data DPName #

Constructors

DPYear 
DPMonth 
DPDay 

Instances

Instances details
Show DPName # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> DPName -> ShowS

show :: DPName -> String

showList :: [DPName] -> ShowS

Eq DPName # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: DPName -> DPName -> Bool

(/=) :: DPName -> DPName -> Bool

Ord DPName # 
Instance details

Defined in Citeproc.Types

Methods

compare :: DPName -> DPName -> Ordering

(<) :: DPName -> DPName -> Bool

(<=) :: DPName -> DPName -> Bool

(>) :: DPName -> DPName -> Bool

(>=) :: DPName -> DPName -> Bool

max :: DPName -> DPName -> DPName

min :: DPName -> DPName -> DPName

data DPForm #

Instances

Instances details
Show DPForm # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> DPForm -> ShowS

show :: DPForm -> String

showList :: [DPForm] -> ShowS

Eq DPForm # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: DPForm -> DPForm -> Bool

(/=) :: DPForm -> DPForm -> Bool

data DP #

Constructors

DP 

Instances

Instances details
Show DP # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> DP -> ShowS

show :: DP -> String

showList :: [DP] -> ShowS

Eq DP # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: DP -> DP -> Bool

(/=) :: DP -> DP -> Bool

data VariableForm #

Constructors

ShortForm 
LongForm 

Instances

Instances details
Show VariableForm # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> VariableForm -> ShowS

show :: VariableForm -> String

showList :: [VariableForm] -> ShowS

Eq VariableForm # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: VariableForm -> VariableForm -> Bool

(/=) :: VariableForm -> VariableForm -> Bool

data TextType #

Instances

Instances details
Show TextType # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> TextType -> ShowS

show :: TextType -> String

showList :: [TextType] -> ShowS

Eq TextType # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: TextType -> TextType -> Bool

(/=) :: TextType -> TextType -> Bool

data NameFormat #

Instances

Instances details
Show NameFormat # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> NameFormat -> ShowS

show :: NameFormat -> String

showList :: [NameFormat] -> ShowS

Eq NameFormat # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: NameFormat -> NameFormat -> Bool

(/=) :: NameFormat -> NameFormat -> Bool

data NameAsSortOrder #

Instances

Instances details
Show NameAsSortOrder # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> NameAsSortOrder -> ShowS

show :: NameAsSortOrder -> String

showList :: [NameAsSortOrder] -> ShowS

Eq NameAsSortOrder # 
Instance details

Defined in Citeproc.Types

data NamesFormat #

Constructors

NamesFormat 

Fields

Instances

Instances details
Show NamesFormat # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> NamesFormat -> ShowS

show :: NamesFormat -> String

showList :: [NamesFormat] -> ShowS

Eq NamesFormat # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: NamesFormat -> NamesFormat -> Bool

(/=) :: NamesFormat -> NamesFormat -> Bool

data NameForm #

Constructors

LongName 
ShortName 
CountName 

Instances

Instances details
Show NameForm # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> NameForm -> ShowS

show :: NameForm -> String

showList :: [NameForm] -> ShowS

Eq NameForm # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: NameForm -> NameForm -> Bool

(/=) :: NameForm -> NameForm -> Bool

data Name #

Constructors

Name 

Fields

Instances

Instances details
FromJSON Name # 
Instance details

Defined in Citeproc.Types

ToJSON Name # 
Instance details

Defined in Citeproc.Types

Show Name # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> Name -> ShowS

show :: Name -> String

showList :: [Name] -> ShowS

Eq Name # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: Name -> Name -> Bool

(/=) :: Name -> Name -> Bool

Ord Name # 
Instance details

Defined in Citeproc.Types

Methods

compare :: Name -> Name -> Ordering

(<) :: Name -> Name -> Bool

(<=) :: Name -> Name -> Bool

(>) :: Name -> Name -> Bool

(>=) :: Name -> Name -> Bool

max :: Name -> Name -> Name

min :: Name -> Name -> Name

data DelimiterPrecedes #

Instances

Instances details
Show DelimiterPrecedes # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> DelimiterPrecedes -> ShowS

show :: DelimiterPrecedes -> String

showList :: [DelimiterPrecedes] -> ShowS

Eq DelimiterPrecedes # 
Instance details

Defined in Citeproc.Types

data Condition #

Instances

Instances details
Show Condition # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> Condition -> ShowS

show :: Condition -> String

showList :: [Condition] -> ShowS

Eq Condition # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: Condition -> Condition -> Bool

(/=) :: Condition -> Condition -> Bool

data Position #

Instances

Instances details
Show Position # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> Position -> ShowS

show :: Position -> String

showList :: [Position] -> ShowS

Eq Position # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: Position -> Position -> Bool

(/=) :: Position -> Position -> Bool

Ord Position # 
Instance details

Defined in Citeproc.Types

Methods

compare :: Position -> Position -> Ordering

(<) :: Position -> Position -> Bool

(<=) :: Position -> Position -> Bool

(>) :: Position -> Position -> Bool

(>=) :: Position -> Position -> Bool

max :: Position -> Position -> Position

min :: Position -> Position -> Position

data Match #

Constructors

MatchAll 
MatchAny 
MatchNone 

Instances

Instances details
Show Match # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> Match -> ShowS

show :: Match -> String

showList :: [Match] -> ShowS

Eq Match # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: Match -> Match -> Bool

(/=) :: Match -> Match -> Bool

data Formatting #

Instances

Instances details
Monoid Formatting # 
Instance details

Defined in Citeproc.Types

Semigroup Formatting # 
Instance details

Defined in Citeproc.Types

Methods

(<>) :: Formatting -> Formatting -> Formatting #

sconcat :: NonEmpty Formatting -> Formatting

stimes :: Integral b => b -> Formatting -> Formatting

Show Formatting # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> Formatting -> ShowS

show :: Formatting -> String

showList :: [Formatting] -> ShowS

Eq Formatting # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: Formatting -> Formatting -> Bool

(/=) :: Formatting -> Formatting -> Bool

data FontStyle #

Instances

Instances details
Show FontStyle # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> FontStyle -> ShowS

show :: FontStyle -> String

showList :: [FontStyle] -> ShowS

Eq FontStyle # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: FontStyle -> FontStyle -> Bool

(/=) :: FontStyle -> FontStyle -> Bool

data FontVariant #

Instances

Instances details
Show FontVariant # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> FontVariant -> ShowS

show :: FontVariant -> String

showList :: [FontVariant] -> ShowS

Eq FontVariant # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: FontVariant -> FontVariant -> Bool

(/=) :: FontVariant -> FontVariant -> Bool

data FontWeight #

Instances

Instances details
Show FontWeight # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> FontWeight -> ShowS

show :: FontWeight -> String

showList :: [FontWeight] -> ShowS

Eq FontWeight # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: FontWeight -> FontWeight -> Bool

(/=) :: FontWeight -> FontWeight -> Bool

data TextDecoration #

Instances

Instances details
Show TextDecoration # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> TextDecoration -> ShowS

show :: TextDecoration -> String

showList :: [TextDecoration] -> ShowS

Eq TextDecoration # 
Instance details

Defined in Citeproc.Types

data VerticalAlign #

Instances

Instances details
Show VerticalAlign # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> VerticalAlign -> ShowS

show :: VerticalAlign -> String

showList :: [VerticalAlign] -> ShowS

Eq VerticalAlign # 
Instance details

Defined in Citeproc.Types

data DisplayStyle #

Instances

Instances details
Show DisplayStyle # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> DisplayStyle -> ShowS

show :: DisplayStyle -> String

showList :: [DisplayStyle] -> ShowS

Eq DisplayStyle # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: DisplayStyle -> DisplayStyle -> Bool

(/=) :: DisplayStyle -> DisplayStyle -> Bool

data TextCase #

Instances

Instances details
Show TextCase # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> TextCase -> ShowS

show :: TextCase -> String

showList :: [TextCase] -> ShowS

Eq TextCase # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: TextCase -> TextCase -> Bool

(/=) :: TextCase -> TextCase -> Bool

data SecondFieldAlign #

Instances

Instances details
Show SecondFieldAlign # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> SecondFieldAlign -> ShowS

show :: SecondFieldAlign -> String

showList :: [SecondFieldAlign] -> ShowS

Eq SecondFieldAlign # 
Instance details

Defined in Citeproc.Types

data Style a #

Constructors

Style 

Instances

Instances details
Show (Style a) # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> Style a -> ShowS

show :: Style a -> String

showList :: [Style a] -> ShowS

Eq (Style a) # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: Style a -> Style a -> Bool

(/=) :: Style a -> Style a -> Bool

data TermMatch #

Instances

Instances details
Show TermMatch # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> TermMatch -> ShowS

show :: TermMatch -> String

showList :: [TermMatch] -> ShowS

Eq TermMatch # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: TermMatch -> TermMatch -> Bool

(/=) :: TermMatch -> TermMatch -> Bool

Ord TermMatch # 
Instance details

Defined in Citeproc.Types

Methods

compare :: TermMatch -> TermMatch -> Ordering

(<) :: TermMatch -> TermMatch -> Bool

(<=) :: TermMatch -> TermMatch -> Bool

(>) :: TermMatch -> TermMatch -> Bool

(>=) :: TermMatch -> TermMatch -> Bool

max :: TermMatch -> TermMatch -> TermMatch

min :: TermMatch -> TermMatch -> TermMatch

data TermGender #

Constructors

Masculine 
Feminine 

Instances

Instances details
Show TermGender # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> TermGender -> ShowS

show :: TermGender -> String

showList :: [TermGender] -> ShowS

Eq TermGender # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: TermGender -> TermGender -> Bool

(/=) :: TermGender -> TermGender -> Bool

Ord TermGender # 
Instance details

Defined in Citeproc.Types

data TermNumber #

Constructors

Singular 
Plural 

Instances

Instances details
Show TermNumber # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> TermNumber -> ShowS

show :: TermNumber -> String

showList :: [TermNumber] -> ShowS

Eq TermNumber # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: TermNumber -> TermNumber -> Bool

(/=) :: TermNumber -> TermNumber -> Bool

Ord TermNumber # 
Instance details

Defined in Citeproc.Types

data TermForm #

Constructors

Long 
Short 
Verb 
VerbShort 
Symbol 

Instances

Instances details
Show TermForm # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> TermForm -> ShowS

show :: TermForm -> String

showList :: [TermForm] -> ShowS

Eq TermForm # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: TermForm -> TermForm -> Bool

(/=) :: TermForm -> TermForm -> Bool

Ord TermForm # 
Instance details

Defined in Citeproc.Types

Methods

compare :: TermForm -> TermForm -> Ordering

(<) :: TermForm -> TermForm -> Bool

(<=) :: TermForm -> TermForm -> Bool

(>) :: TermForm -> TermForm -> Bool

(>=) :: TermForm -> TermForm -> Bool

max :: TermForm -> TermForm -> TermForm

min :: TermForm -> TermForm -> TermForm

data Term #

Constructors

Term 

Instances

Instances details
Show Term # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> Term -> ShowS

show :: Term -> String

showList :: [Term] -> ShowS

Eq Term # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: Term -> Term -> Bool

(/=) :: Term -> Term -> Bool

Ord Term # 
Instance details

Defined in Citeproc.Types

Methods

compare :: Term -> Term -> Ordering

(<) :: Term -> Term -> Bool

(<=) :: Term -> Term -> Bool

(>) :: Term -> Term -> Bool

(>=) :: Term -> Term -> Bool

max :: Term -> Term -> Term

min :: Term -> Term -> Term

data SortDirection #

Constructors

Ascending 
Descending 

Instances

Instances details
Show SortDirection # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> SortDirection -> ShowS

show :: SortDirection -> String

showList :: [SortDirection] -> ShowS

Eq SortDirection # 
Instance details

Defined in Citeproc.Types

data SortKey a #

Instances

Instances details
Show (SortKey a) # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> SortKey a -> ShowS

show :: SortKey a -> String

showList :: [SortKey a] -> ShowS

Eq (SortKey a) # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: SortKey a -> SortKey a -> Bool

(/=) :: SortKey a -> SortKey a -> Bool

data SortKeyValue #

Constructors

SortKeyValue SortDirection (Maybe [Text]) 

Instances

Instances details
Show SortKeyValue # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> SortKeyValue -> ShowS

show :: SortKeyValue -> String

showList :: [SortKeyValue] -> ShowS

Eq SortKeyValue # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: SortKeyValue -> SortKeyValue -> Bool

(/=) :: SortKeyValue -> SortKeyValue -> Bool

data LayoutOptions #

Constructors

LayoutOptions 

Instances

Instances details
Show LayoutOptions # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> LayoutOptions -> ShowS

show :: LayoutOptions -> String

showList :: [LayoutOptions] -> ShowS

Eq LayoutOptions # 
Instance details

Defined in Citeproc.Types

data Collapsing #

Instances

Instances details
Show Collapsing # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> Collapsing -> ShowS

show :: Collapsing -> String

showList :: [Collapsing] -> ShowS

Eq Collapsing # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: Collapsing -> Collapsing -> Bool

(/=) :: Collapsing -> Collapsing -> Bool

data Layout a #

Instances

Instances details
Show (Layout a) # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> Layout a -> ShowS

show :: Layout a -> String

showList :: [Layout a] -> ShowS

Eq (Layout a) # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: Layout a -> Layout a -> Bool

(/=) :: Layout a -> Layout a -> Bool

data Lang #

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

Constructors

Lang 

Fields

Instances

Instances details
IsString Lang 
Instance details

Defined in Text.Collate.Lang

Methods

fromString :: String -> Lang

Show Lang 
Instance details

Defined in Text.Collate.Lang

Methods

showsPrec :: Int -> Lang -> ShowS

show :: Lang -> String

showList :: [Lang] -> ShowS

Binary Lang 
Instance details

Defined in Text.Collate.Lang

Methods

put :: Lang -> Put

get :: Get Lang

putList :: [Lang] -> Put

Eq Lang 
Instance details

Defined in Text.Collate.Lang

Methods

(==) :: Lang -> Lang -> Bool

(/=) :: Lang -> Lang -> Bool

Ord Lang 
Instance details

Defined in Text.Collate.Lang

Methods

compare :: Lang -> Lang -> Ordering

(<) :: Lang -> Lang -> Bool

(<=) :: Lang -> Lang -> Bool

(>) :: Lang -> Lang -> Bool

(>=) :: Lang -> Lang -> Bool

max :: Lang -> Lang -> Lang

min :: Lang -> Lang -> Lang

Lift Lang 
Instance details

Defined in Text.Collate.Lang

Methods

lift :: Quote m => Lang -> m Exp #

liftTyped :: forall (m :: Type -> Type). Quote m => Lang -> Code m Lang #

parseLang :: Text -> Either String Lang #

Parse a BCP 47 language tag as a Lang.

renderLang :: Lang -> Text #

Render a Lang in BCP 47 form.

data Locale #

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

Constructors

Locale 

Fields

Instances

Instances details
Monoid Locale # 
Instance details

Defined in Citeproc.Types

Semigroup Locale # 
Instance details

Defined in Citeproc.Types

Methods

(<>) :: Locale -> Locale -> Locale #

sconcat :: NonEmpty Locale -> Locale

stimes :: Integral b => b -> Locale -> Locale

Show Locale # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> Locale -> ShowS

show :: Locale -> String

showList :: [Locale] -> ShowS

Eq Locale # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: Locale -> Locale -> Bool

(/=) :: Locale -> Locale -> Bool

data NameHints #

Instances

Instances details
Show NameHints # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> NameHints -> ShowS

show :: NameHints -> String

showList :: [NameHints] -> ShowS

Eq NameHints # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: NameHints -> NameHints -> Bool

(/=) :: NameHints -> NameHints -> Bool

Ord NameHints # 
Instance details

Defined in Citeproc.Types

Methods

compare :: NameHints -> NameHints -> Ordering

(<) :: NameHints -> NameHints -> Bool

(<=) :: NameHints -> NameHints -> Bool

(>) :: NameHints -> NameHints -> Bool

(>=) :: NameHints -> NameHints -> Bool

max :: NameHints -> NameHints -> NameHints

min :: NameHints -> NameHints -> NameHints

data Reference a #

Encodes bibliographic data for a single work.

Constructors

Reference 

Fields

Instances

Instances details
Foldable Reference # 
Instance details

Defined in Citeproc.Types

Methods

fold :: Monoid m => Reference m -> m

foldMap :: Monoid m => (a -> m) -> Reference a -> m

foldMap' :: Monoid m => (a -> m) -> Reference a -> m

foldr :: (a -> b -> b) -> b -> Reference a -> b

foldr' :: (a -> b -> b) -> b -> Reference a -> b

foldl :: (b -> a -> b) -> b -> Reference a -> b

foldl' :: (b -> a -> b) -> b -> Reference a -> b

foldr1 :: (a -> a -> a) -> Reference a -> a

foldl1 :: (a -> a -> a) -> Reference a -> a

toList :: Reference a -> [a]

null :: Reference a -> Bool

length :: Reference a -> Int

elem :: Eq a => a -> Reference a -> Bool

maximum :: Ord a => Reference a -> a

minimum :: Ord a => Reference a -> a

sum :: Num a => Reference a -> a

product :: Num a => Reference a -> a

Traversable Reference # 
Instance details

Defined in Citeproc.Types

Methods

traverse :: Applicative f => (a -> f b) -> Reference a -> f (Reference b)

sequenceA :: Applicative f => Reference (f a) -> f (Reference a)

mapM :: Monad m => (a -> m b) -> Reference a -> m (Reference b)

sequence :: Monad m => Reference (m a) -> m (Reference a)

Functor Reference # 
Instance details

Defined in Citeproc.Types

Methods

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

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

(Eq a, FromJSON a) => FromJSON (Reference a) # 
Instance details

Defined in Citeproc.Types

ToJSON a => ToJSON (Reference a) # 
Instance details

Defined in Citeproc.Types

Show a => Show (Reference a) # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> Reference a -> ShowS

show :: Reference a -> String

showList :: [Reference a] -> ShowS

Eq a => Eq (Reference a) # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: Reference a -> Reference a -> Bool

(/=) :: Reference a -> Reference a -> Bool

Ord a => Ord (Reference a) # 
Instance details

Defined in Citeproc.Types

Methods

compare :: Reference a -> Reference a -> Ordering

(<) :: Reference a -> Reference a -> Bool

(<=) :: Reference a -> Reference a -> Bool

(>) :: Reference a -> Reference a -> Bool

(>=) :: Reference a -> Reference a -> Bool

max :: Reference a -> Reference a -> Reference a

min :: Reference a -> Reference a -> Reference a

newtype ReferenceMap a #

Constructors

ReferenceMap 

Fields

Instances

Instances details
Show a => Show (ReferenceMap a) # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> ReferenceMap a -> ShowS

show :: ReferenceMap a -> String

showList :: [ReferenceMap a] -> ShowS

makeReferenceMap :: [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.

data Val a #

Value associated with a certain variable in a bibliographic entry.

Constructors

TextVal Text

Plain text value

FancyVal a

Formatted value with parameterized type

NumVal Int

Numerical value

NamesVal [Name]

Structured names

DateVal Date

Structured date

SubstitutedVal

Value suppressed through substitution

Instances

Instances details
Foldable Val # 
Instance details

Defined in Citeproc.Types

Methods

fold :: Monoid m => Val m -> m

foldMap :: Monoid m => (a -> m) -> Val a -> m

foldMap' :: Monoid m => (a -> m) -> Val a -> m

foldr :: (a -> b -> b) -> b -> Val a -> b

foldr' :: (a -> b -> b) -> b -> Val a -> b

foldl :: (b -> a -> b) -> b -> Val a -> b

foldl' :: (b -> a -> b) -> b -> Val a -> b

foldr1 :: (a -> a -> a) -> Val a -> a

foldl1 :: (a -> a -> a) -> Val a -> a

toList :: Val a -> [a]

null :: Val a -> Bool

length :: Val a -> Int

elem :: Eq a => a -> Val a -> Bool

maximum :: Ord a => Val a -> a

minimum :: Ord a => Val a -> a

sum :: Num a => Val a -> a

product :: Num a => Val a -> a

Traversable Val # 
Instance details

Defined in Citeproc.Types

Methods

traverse :: Applicative f => (a -> f b) -> Val a -> f (Val b)

sequenceA :: Applicative f => Val (f a) -> f (Val a)

mapM :: Monad m => (a -> m b) -> Val a -> m (Val b)

sequence :: Monad m => Val (m a) -> m (Val a)

Functor Val # 
Instance details

Defined in Citeproc.Types

Methods

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

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

ToJSON a => ToJSON (Val a) # 
Instance details

Defined in Citeproc.Types

Methods

toJSON :: Val a -> Value #

toEncoding :: Val a -> Encoding #

toJSONList :: [Val a] -> Value #

toEncodingList :: [Val a] -> Encoding #

omitField :: Val a -> Bool #

Show a => Show (Val a) # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> Val a -> ShowS

show :: Val a -> String

showList :: [Val a] -> ShowS

Eq a => Eq (Val a) # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: Val a -> Val a -> Bool

(/=) :: Val a -> Val a -> Bool

Ord a => Ord (Val a) # 
Instance details

Defined in Citeproc.Types

Methods

compare :: Val a -> Val a -> Ordering

(<) :: Val a -> Val a -> Bool

(<=) :: Val a -> Val a -> Bool

(>) :: Val a -> Val a -> Bool

(>=) :: Val a -> Val a -> Bool

max :: Val a -> Val a -> Val a

min :: Val a -> Val a -> Val a

valToText :: CiteprocOutput a => Val a -> Maybe Text #

data Variable #

Instances

Instances details
FromJSON Variable # 
Instance details

Defined in Citeproc.Types

FromJSONKey Variable # 
Instance details

Defined in Citeproc.Types

ToJSON Variable # 
Instance details

Defined in Citeproc.Types

ToJSONKey Variable # 
Instance details

Defined in Citeproc.Types

IsString Variable # 
Instance details

Defined in Citeproc.Types

Methods

fromString :: String -> Variable

Monoid Variable # 
Instance details

Defined in Citeproc.Types

Semigroup Variable # 
Instance details

Defined in Citeproc.Types

Methods

(<>) :: Variable -> Variable -> Variable #

sconcat :: NonEmpty Variable -> Variable

stimes :: Integral b => b -> Variable -> Variable

Show Variable # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> Variable -> ShowS

show :: Variable -> String

showList :: [Variable] -> ShowS

Eq Variable # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: Variable -> Variable -> Bool

(/=) :: Variable -> Variable -> Bool

Ord Variable # 
Instance details

Defined in Citeproc.Types

Methods

compare :: Variable -> Variable -> Ordering

(<) :: Variable -> Variable -> Bool

(<=) :: Variable -> Variable -> Bool

(>) :: Variable -> Variable -> Bool

(>=) :: Variable -> Variable -> Bool

max :: Variable -> Variable -> Variable

min :: Variable -> Variable -> Variable

toVariable :: Text -> Variable #

data Output a #

Instances

Instances details
Show a => Show (Output a) # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> Output a -> ShowS

show :: Output a -> String

showList :: [Output a] -> ShowS

Eq a => Eq (Output a) # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: Output a -> Output a -> Bool

(/=) :: Output a -> Output a -> Bool

Uniplate (Output a) # 
Instance details

Defined in Citeproc.Types

Methods

uniplate :: Output a -> (Str (Output a), Str (Output a) -> Output a) #

descend :: (Output a -> Output a) -> Output a -> Output a #

descendM :: Applicative m => (Output a -> m (Output a)) -> Output a -> m (Output a) #

Biplate (Output a) (Output a) # 
Instance details

Defined in Citeproc.Types

Methods

biplate :: Output a -> (Str (Output a), Str (Output a) -> Output a) #

descendBi :: (Output a -> Output a) -> Output a -> Output a #

descendBiM :: Applicative m => (Output a -> m (Output a)) -> Output a -> m (Output a) #

data Identifier #

Constructors

IdentDOI Text 
IdentPMCID Text 
IdentPMID Text 
IdentURL Text 

Instances

Instances details
Show Identifier # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> Identifier -> ShowS

show :: Identifier -> String

showList :: [Identifier] -> ShowS

Eq Identifier # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: Identifier -> Identifier -> Bool

(/=) :: Identifier -> Identifier -> Bool

fixShortDOI :: Text -> Text #

data Tag #

Instances

Instances details
Show Tag # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> Tag -> ShowS

show :: Tag -> String

showList :: [Tag] -> ShowS

Eq Tag # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: Tag -> Tag -> Bool

(/=) :: Tag -> Tag -> Bool

grouped :: [Output a] -> Output a #

readAsInt :: Text -> Maybe Int #

data VariableType #

Instances

Instances details
Show VariableType # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> VariableType -> ShowS

show :: VariableType -> String

showList :: [VariableType] -> ShowS

Eq VariableType # 
Instance details

Defined in Citeproc.Types

Methods

(==) :: VariableType -> VariableType -> Bool

(/=) :: VariableType -> VariableType -> Bool

data 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.

Instances

Instances details
FromJSON Abbreviations # 
Instance details

Defined in Citeproc.Types

ToJSON Abbreviations # 
Instance details

Defined in Citeproc.Types

Show Abbreviations # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> Abbreviations -> ShowS

show :: Abbreviations -> String

showList :: [Abbreviations] -> ShowS

Eq Abbreviations # 
Instance details

Defined in Citeproc.Types

Ord Abbreviations # 
Instance details

Defined in Citeproc.Types

lookupAbbreviation :: CiteprocOutput a => Variable -> Val a -> Abbreviations -> Maybe (Val a) #

Returns an abbreviation if the variable and its value match something in the abbreviations map.

data Result a #

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
Foldable Result # 
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 # 
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)

Functor Result # 
Instance details

Defined in Citeproc.Types

Methods

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

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

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

Defined in Citeproc.Types

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

Defined in Citeproc.Types

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

Defined in Citeproc.Types

Methods

showsPrec :: Int -> Result a -> ShowS

show :: Result a -> String

showList :: [Result a] -> ShowS

data Inputs a #

Inputs for citation processing.

Constructors

Inputs 

Fields

Instances

Instances details
(FromJSON a, Eq a) => FromJSON (Inputs a) # 
Instance details

Defined in Citeproc.Types

ToJSON a => ToJSON (Inputs a) # 
Instance details

Defined in Citeproc.Types

Show a => Show (Inputs a) # 
Instance details

Defined in Citeproc.Types

Methods

showsPrec :: Int -> Inputs a -> ShowS

show :: Inputs a -> String

showList :: [Inputs a] -> ShowS