HaTeX-3.22.3.2: The Haskell LaTeX library.
Safe HaskellSafe-Inferred
LanguageHaskell2010

Text.LaTeX.Packages.BibLaTeX

Description

BibLaTeX is a reference-citation package using .bib files (BibTeX) but no extra style-files.

Synopsis

Documentation

biblatex :: PackageName Source #

BibLaTeX package. Use it to import it like this:

usepackage [] biblatex

addbibresource :: LaTeXC l => FilePath -> l Source #

Use a bibliography file as resource for reference information.

cite :: LaTeXC l => l -> l Source #

Automatic bibliography retrieval

documentWithDOIReferences Source #

Arguments

:: (MonadIO m, LaTeXC (m ()), Semigroup (m ()), r ~ DOIReference) 
=> (r -> m (Maybe T))

Reference-resolver function, for looking up BibTeX entries for a given DOI. If the DOI cannot be looked up (Nothing), we just include a footnote with a synopsis and the DOI in literal form. (Mostly intended to ease offline editing.)

-> ReferenceQueryT r m ()

The document content, possibly containing citations in DOI-only form.

-> m ()

LaTeX rendition. The content will already be wrapped in \begin…end{document} here and an automatically-generated .bib file included, but you still need to usepackage biblatex yourself.

citeDOI Source #

Arguments

:: (Functor m, Monoid (m ()), IsString (m ())) 
=> PlainDOI

The unambiguous document identifier.

-> String

Synopsis of the cited work, in the form "J Doe et al 1950: Investigation of a Foo"; this is strictly speaking optional, the synopsis will not be included in the final document (provided the DOI can be properly resolved).

-> ReferenceQueryT DOIReference m () 

textc :: Functor m => ReferenceQueryT DOIReference m () -> ReferenceQueryT DOIReference m () Source #

Transform a citation into \textcite, i.e. so that it can be used as a noun in a sentence.

textC :: Functor m => ReferenceQueryT DOIReference m () -> ReferenceQueryT DOIReference m () Source #

Transform a citation into \Textcite, i.e. so that it can be used as the first word in a sentence.

data DOIReference Source #

Instances

Instances details
Generic DOIReference Source # 
Instance details

Defined in Text.LaTeX.Packages.BibLaTeX

Associated Types

type Rep DOIReference :: Type -> Type #

Eq DOIReference Source # 
Instance details

Defined in Text.LaTeX.Packages.BibLaTeX

Ord DOIReference Source # 
Instance details

Defined in Text.LaTeX.Packages.BibLaTeX

type Rep DOIReference Source # 
Instance details

Defined in Text.LaTeX.Packages.BibLaTeX

type Rep DOIReference = D1 ('MetaData "DOIReference" "Text.LaTeX.Packages.BibLaTeX" "HaTeX-3.22.3.2-HZvUhlnm8H82ymAYOfPoYP" 'False) (C1 ('MetaCons "DOIReference" 'PrefixI 'True) (S1 ('MetaSel ('Just "_referenceDOI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PlainDOI) :*: S1 ('MetaSel ('Just "_referenceSynopsis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LaTeX)))

data ReferenceQueryT r m a Source #

Instances

Instances details
MonadIO m => MonadIO (ReferenceQueryT r m) Source # 
Instance details

Defined in Text.LaTeX.Packages.BibLaTeX

Methods

liftIO :: IO a -> ReferenceQueryT r m a #

Applicative m => Applicative (ReferenceQueryT r m) Source # 
Instance details

Defined in Text.LaTeX.Packages.BibLaTeX

Methods

pure :: a -> ReferenceQueryT r m a #

(<*>) :: ReferenceQueryT r m (a -> b) -> ReferenceQueryT r m a -> ReferenceQueryT r m b #

liftA2 :: (a -> b -> c) -> ReferenceQueryT r m a -> ReferenceQueryT r m b -> ReferenceQueryT r m c #

(*>) :: ReferenceQueryT r m a -> ReferenceQueryT r m b -> ReferenceQueryT r m b #

(<*) :: ReferenceQueryT r m a -> ReferenceQueryT r m b -> ReferenceQueryT r m a #

Functor m => Functor (ReferenceQueryT r m) Source # 
Instance details

Defined in Text.LaTeX.Packages.BibLaTeX

Methods

fmap :: (a -> b) -> ReferenceQueryT r m a -> ReferenceQueryT r m b #

(<$) :: a -> ReferenceQueryT r m b -> ReferenceQueryT r m a #

Monad m => Monad (ReferenceQueryT r m) Source # 
Instance details

Defined in Text.LaTeX.Packages.BibLaTeX

Methods

(>>=) :: ReferenceQueryT r m a -> (a -> ReferenceQueryT r m b) -> ReferenceQueryT r m b #

(>>) :: ReferenceQueryT r m a -> ReferenceQueryT r m b -> ReferenceQueryT r m b #

return :: a -> ReferenceQueryT r m a #

(Applicative m, LaTeXC (m a), Semigroup (m a), a ~ ()) => LaTeXC (ReferenceQueryT r m a) Source # 
Instance details

Defined in Text.LaTeX.Packages.BibLaTeX

Methods

liftListL :: ([LaTeX] -> LaTeX) -> [ReferenceQueryT r m a] -> ReferenceQueryT r m a Source #

(Functor m, Monoid (m a), IsString (m ()), a ~ ()) => IsString (ReferenceQueryT r m a) Source # 
Instance details

Defined in Text.LaTeX.Packages.BibLaTeX

Methods

fromString :: String -> ReferenceQueryT r m a #

(Applicative m, Semigroup (m a), Monoid (m a), a ~ ()) => Monoid (ReferenceQueryT r m a) Source # 
Instance details

Defined in Text.LaTeX.Packages.BibLaTeX

(Applicative m, Semigroup (m a), a ~ ()) => Semigroup (ReferenceQueryT r m a) Source # 
Instance details

Defined in Text.LaTeX.Packages.BibLaTeX

Methods

(<>) :: ReferenceQueryT r m a -> ReferenceQueryT r m a -> ReferenceQueryT r m a #

sconcat :: NonEmpty (ReferenceQueryT r m a) -> ReferenceQueryT r m a #

stimes :: Integral b => b -> ReferenceQueryT r m a -> ReferenceQueryT r m a #

Generic (ReferenceQueryT r m a) Source # 
Instance details

Defined in Text.LaTeX.Packages.BibLaTeX

Associated Types

type Rep (ReferenceQueryT r m a) :: Type -> Type #

Methods

from :: ReferenceQueryT r m a -> Rep (ReferenceQueryT r m a) x #

to :: Rep (ReferenceQueryT r m a) x -> ReferenceQueryT r m a #

type Rep (ReferenceQueryT r m a) Source # 
Instance details

Defined in Text.LaTeX.Packages.BibLaTeX

type Rep (ReferenceQueryT r m a)

masterBibFile Source #

Arguments

:: MonadIO m 
=> FilePath

A .bib file containing entries for all relevant literature.

-> DOIReference -> m (Maybe T)

Lookup-function, suitable for documentWithDOIReferences.