Safe Haskell	None
Language	Haskell2010

Text.LaTeX.Packages.BibLaTeX

Contents

Automatic bibliography retrieval

Description

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

Synopsis

biblatex :: PackageName
addbibresource :: LaTeXC l => FilePath -> l
cite :: LaTeXC l => l -> l
printbibliography :: LaTeXC l => l
documentWithDOIReferences :: (MonadIO m, LaTeXC (m ()), Semigroup (m ()), r ~ DOIReference) => (r -> m (Maybe T)) -> ReferenceQueryT r m () -> m ()
type PlainDOI = String
citeDOI :: forall (m :: Type -> Type). (Functor m, Monoid (m ()), IsString (m ())) => PlainDOI -> String -> ReferenceQueryT DOIReference m ()
textc :: forall (m :: Type -> Type). Functor m => ReferenceQueryT DOIReference m () -> ReferenceQueryT DOIReference m ()
textC :: forall (m :: Type -> Type). Functor m => ReferenceQueryT DOIReference m () -> ReferenceQueryT DOIReference m ()
data DOIReference
data ReferenceQueryT r (m :: Type -> Type) a
applyDOIReferenceResolves :: (MonadIO m, LaTeXC (m ()), Semigroup (m ()), r ~ DOIReference) => (r -> m (Maybe T)) -> ReferenceQueryT r m () -> m (Map DOIReference T, m ())
masterBibFile :: MonadIO m => FilePath -> DOIReference -> m (Maybe T)

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 #

printbibliography :: LaTeXC 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.

All-inclusive preparation of a document containing DOI references. Uses applyDOIReferenceResolves under the hood.

type PlainDOI = String Source #

citeDOI Source #

Arguments

:: forall (m :: Type -> Type). (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 :: forall (m :: Type -> Type). 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 :: forall (m :: Type -> Type). 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

Instance details

Defined in Text.LaTeX.Packages.BibLaTeX

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

Methods

from :: DOIReference -> Rep DOIReference x #

to :: Rep DOIReference x -> DOIReference #

Show DOIReference Source #

Instance details

Defined in Text.LaTeX.Packages.BibLaTeX

Methods

showsPrec :: Int -> DOIReference -> ShowS #

show :: DOIReference -> String #

showList :: [DOIReference] -> ShowS #

Eq DOIReference Source #

Instance details

Defined in Text.LaTeX.Packages.BibLaTeX

Methods

(==) :: DOIReference -> DOIReference -> Bool #

(/=) :: DOIReference -> DOIReference -> Bool #

Ord DOIReference Source #

Instance details

Defined in Text.LaTeX.Packages.BibLaTeX

Methods

compare :: DOIReference -> DOIReference -> Ordering #

(<) :: DOIReference -> DOIReference -> Bool #

(<=) :: DOIReference -> DOIReference -> Bool #

(>) :: DOIReference -> DOIReference -> Bool #

(>=) :: DOIReference -> DOIReference -> Bool #

max :: DOIReference -> DOIReference -> DOIReference #

min :: DOIReference -> DOIReference -> DOIReference #

type Rep DOIReference Source #

Instance details

Defined in Text.LaTeX.Packages.BibLaTeX

type Rep DOIReference = D1 ('MetaData "DOIReference" "Text.LaTeX.Packages.BibLaTeX" "HaTeX-3.23.0.1-4eJFE33duoG8ZWxrt7ZwAw" '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 :: Type -> Type) 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 #

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

Instance details

Defined in Text.LaTeX.Packages.BibLaTeX

Methods

mempty :: ReferenceQueryT r m a #

mappend :: ReferenceQueryT r m a -> ReferenceQueryT r m a -> ReferenceQueryT r m a #

mconcat :: [ReferenceQueryT r m a] -> ReferenceQueryT r m a #

(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 #

(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 #

Generic (ReferenceQueryT r m a) Source #

Instance details

Defined in Text.LaTeX.Packages.BibLaTeX

Associated Types

type Rep (ReferenceQueryT r m a)
Instance details Defined in Text.LaTeX.Packages.BibLaTeX type Rep (ReferenceQueryT r m a)

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)

applyDOIReferenceResolves Source #

Arguments

:: (MonadIO m, LaTeXC (m ()), Semigroup (m ()), r ~ DOIReference)
=> (r -> m (Maybe T))	Reference-resolver function.
-> ReferenceQueryT r m ()	The document content.
-> m (Map DOIReference T, m ())	All the BibTeX entries found, and a version of the document with all its doi-references changed to point to the identifiers in that file.

More manual version of documentWithDOIReferences, only retrieving suitable BibTeX entries for the DOI-references contained in the document, but not generating any .bib files or wrapping the content in it.

masterBibFile Source #

Arguments

:: MonadIO m
=> FilePath	A `.bib` file containing entries for all relevant literature.
-> DOIReference	Lookup-function, suitable for `documentWithDOIReferences`.
-> m (Maybe T)