pandoc-crossref-0.3.4.0: Pandoc filter for cross-references

CopyrightCopyright (C) 2015 Nikolay Yakimov
LicenseGNU GPL, version 2 or above
MaintainerNikolay Yakimov <root@livid.pp.ru>
Stabilityalpha
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Text.Pandoc.CrossRef

Description

Public interface to pandoc-crossref library

Example of use:

import Text.Pandoc
import Text.Pandoc.JSON

import Text.Pandoc.CrossRef

main :: IO ()
main = toJSONFilter go
  where
    go fmt p@(Pandoc meta _) = runCrossRefIO meta fmt action p
      where
        action (Pandoc _ bs) = do
          meta' <- crossRefMeta
          bs' <- crossRefBlocks bs
          return $ Pandoc meta' bs'

This module also exports utility functions for setting up meta-settings for pandoc-crossref. Refer to documentation for a complete list of metadata field names. All functions accept a single argument of type, returned by Text.Pandoc.Builder functions, and return Meta.

Example:

runCrossRefIO meta fmt crossRefBlocks blocks
  where
    meta =
         figureTitle (str "Figura")
      <> tableTitle (str "Tabla")
      <> figPrefix (str "fig.")
      <> eqnPrefix (str "ec.")
      <> tblPrefix (str "tbl.")
      <> loftitle (header 1 $ text "Lista de figuras")
      <> lotTitle (header 1 $ text "Lista de tablas")
      <> chaptersDepth (MetaString "2")
Synopsis

Documentation

crossRefBlocks :: [Block] -> CrossRefM [Block] #

Walk over blocks, while inserting cross-references, list-of, etc.

Works in CrossRefM monad.

crossRefMeta :: CrossRefM Meta #

Modifies metadata for LaTeX output, adding header-includes instructions to setup custom and builtin environments.

Note, that if output format is not "latex", this function does nothing.

Works in CrossRefM monad.

defaultCrossRefAction :: Pandoc -> CrossRefM Pandoc #

Combines crossRefMeta and crossRefBlocks

Works in CrossRefM monad.

runCrossRef :: forall a b. Meta -> Maybe Format -> (a -> CrossRefM b) -> a -> b #

Run an action in CrossRefM monad with argument, and return pure result.

This is primary function to work with CrossRefM

runCrossRefIO :: forall a b. Meta -> Maybe Format -> (a -> CrossRefM b) -> a -> IO b #

Run an action in CrossRefM monad with argument, and return IO result.

This function will attempt to read pandoc-crossref settings from settings file specified by crossrefYaml metadata field.

nameInLink :: forall a. ToMetaValue a => a -> Meta #

linkReferences :: forall a. ToMetaValue a => a -> Meta #

subfigGrid :: forall a. ToMetaValue a => a -> Meta #

autoEqnLabels :: forall a. ToMetaValue a => a -> Meta #

tableEqns :: forall a. ToMetaValue a => a -> Meta #

ccsLabelSep :: forall a. ToMetaValue a => a -> Meta #

ccsDelim :: forall a. ToMetaValue a => a -> Meta #

customLabel :: forall a. ToMetaValue a => a -> Meta #

listingTemplate :: forall a. ToMetaValue a => a -> Meta #

tableTemplate :: forall a. ToMetaValue a => a -> Meta #

ccsTemplate :: forall a. ToMetaValue a => a -> Meta #

subfigureChildTemplate :: forall a. ToMetaValue a => a -> Meta #

subfigureTemplate :: forall a. ToMetaValue a => a -> Meta #

figureTemplate :: forall a. ToMetaValue a => a -> Meta #

outFormat :: forall a. ToMetaValue a => a -> Meta #

lolTitle :: forall a. ToMetaValue a => a -> Meta #

lotTitle :: forall a. ToMetaValue a => a -> Meta #

lofTitle :: forall a. ToMetaValue a => a -> Meta #

refDelim :: forall a. ToMetaValue a => a -> Meta #

lastDelim :: forall a. ToMetaValue a => a -> Meta #

pairDelim :: forall a. ToMetaValue a => a -> Meta #

rangeDelim :: forall a. ToMetaValue a => a -> Meta #

chapDelim :: forall a. ToMetaValue a => a -> Meta #

secHeaderTemplate :: forall a. ToMetaValue a => a -> Meta #

subfigureRefIndexTemplate :: forall a. ToMetaValue a => a -> Meta #

refIndexTemplate :: forall a. ToMetaValue a => a -> Meta #

secPrefixTemplate :: forall a. ToMetaValue a => a -> Meta #

lstPrefixTemplate :: forall a. ToMetaValue a => a -> Meta #

tblPrefixTemplate :: forall a. ToMetaValue a => a -> Meta #

eqnPrefixTemplate :: forall a. ToMetaValue a => a -> Meta #

figPrefixTemplate :: forall a. ToMetaValue a => a -> Meta #

secPrefix :: forall a. ToMetaValue a => a -> Meta #

lstPrefix :: forall a. ToMetaValue a => a -> Meta #

tblPrefix :: forall a. ToMetaValue a => a -> Meta #

eqnPrefix :: forall a. ToMetaValue a => a -> Meta #

figPrefix :: forall a. ToMetaValue a => a -> Meta #

sectionsDepth :: forall a. ToMetaValue a => a -> Meta #

numberSections :: forall a. ToMetaValue a => a -> Meta #

autoSectionLabels :: forall a. ToMetaValue a => a -> Meta #

codeBlockCaptions :: forall a. ToMetaValue a => a -> Meta #

listings :: forall a. ToMetaValue a => a -> Meta #

chaptersDepth :: forall a. ToMetaValue a => a -> Meta #

cref :: forall a. ToMetaValue a => a -> Meta #

secHeaderDelim :: forall a. ToMetaValue a => a -> Meta #

secLabels :: forall a. ToMetaValue a => a -> Meta #

lstLabels :: forall a. ToMetaValue a => a -> Meta #

tblLabels :: forall a. ToMetaValue a => a -> Meta #

eqnLabels :: forall a. ToMetaValue a => a -> Meta #

figLabels :: forall a. ToMetaValue a => a -> Meta #

chapters :: forall a. ToMetaValue a => a -> Meta #

subfigLabels :: forall a. ToMetaValue a => a -> Meta #

crossrefYaml :: forall a. ToMetaValue a => a -> Meta #

titleDelim :: forall a. ToMetaValue a => a -> Meta #

listingTitle :: forall a. ToMetaValue a => a -> Meta #

tableTitle :: forall a. ToMetaValue a => a -> Meta #

figureTitle :: forall a. ToMetaValue a => a -> Meta #

getOptions :: Meta -> Maybe Format -> Options #

defaultMeta :: Meta #

type CrossRefM a = Reader CrossRefEnv a #

Essentially a reader monad for basic pandoc-crossref environment

data CrossRefEnv #

Enviromnent for CrossRefM

Constructors

CrossRefEnv 

Fields