Hakyll.Web.Pandoc.Biblio

Wraps pandocs bibiliography handling

In order to add a bibliography, you will need a bibliography file (e.g. .bib) and a CSL file (.csl). Both need to be compiled with their respective compilers (biblioCompiler and cslCompiler). Then, you can refer to these files when you use readPandocBiblio. This function also takes the reader options for completeness -- you can use defaultHakyllReaderOptions if you're unsure. If you already read the source into a Pandoc type and need to add processing for the bibliography, you can use processPandocBiblio instead. pandocBiblioCompiler is a convenience wrapper which works like pandocCompiler, but also takes paths to compiled bibliography and csl files; pandocBibliosCompiler is similar but instead takes a glob pattern for bib files.

Documentation

newtype CSL

Constructors

CSL

Fields

• unCSL :: ByteString

Instances

Show CSL

Defined in Hakyll.Web.Pandoc.Biblio

Methods

showsPrec :: Int -> CSL -> ShowS

show :: CSL -> String

showList :: [CSL] -> ShowS

Binary CSL

Defined in Hakyll.Web.Pandoc.Biblio

Methods

put :: CSL -> Put

get :: Get CSL

putList :: [CSL] -> Put

Writable CSL

Defined in Hakyll.Web.Pandoc.Biblio

Methods

write :: FilePath -> Item CSL -> IO ()

cslCompiler :: Compiler (Item CSL)

newtype Biblio

Constructors

Biblio

Fields

• unBiblio :: ByteString

Instances

Show Biblio

Defined in Hakyll.Web.Pandoc.Biblio

Methods

showsPrec :: Int -> Biblio -> ShowS

show :: Biblio -> String

showList :: [Biblio] -> ShowS

Binary Biblio

Defined in Hakyll.Web.Pandoc.Biblio

Methods

put :: Biblio -> Put

get :: Get Biblio

putList :: [Biblio] -> Put

Writable Biblio

Defined in Hakyll.Web.Pandoc.Biblio

Methods

write :: FilePath -> Item Biblio -> IO ()

biblioCompiler :: Compiler (Item Biblio)

readPandocBiblio :: ReaderOptions -> Item CSL -> Item Biblio -> Item String -> Compiler (Item Pandoc)

readPandocBiblios :: ReaderOptions -> Item CSL -> [Item Biblio] -> Item String -> Compiler (Item Pandoc)

processPandocBiblio :: Item CSL -> Item Biblio -> Item Pandoc -> Compiler (Item Pandoc)

Process a bibliography file with the given style.

This function supports pandoc's nocite functionality when there is a nocite metadata field present.

Example

In your main function, first compile the respective files:

main = hakyll $ do
  …
  match "style.csl" $ compile cslCompiler
  match "bib.bib"   $ compile biblioCompiler

Then, create a function like the following:

processBib :: Item Pandoc -> Compiler (Item Pandoc)
processBib pandoc = do
  csl <- load @CSL    "bib/style.csl"
  bib <- load @Biblio "bib/bibliography.bib"
  processPandocBiblio csl bib pandoc

Now, feed this function to your pandoc compiler:

myCompiler :: Compiler (Item String)
myCompiler = pandocItemCompilerWithTransformM myReader myWriter processBib

processPandocBiblios :: Item CSL -> [Item Biblio] -> Item Pandoc -> Compiler (Item Pandoc)

Like processPandocBiblio, which see, but support multiple bibliography files.

pandocBiblioCompiler :: String -> String -> Compiler (Item String)

Compiles a markdown file via Pandoc. Requires the .csl and .bib files to be known to the compiler via match statements.

pandocBibliosCompiler :: String -> String -> Compiler (Item String)

Compiles a markdown file via Pandoc. Requires the .csl and .bib files to be known to the compiler via match statements.