Text.Pandoc.Writers.Shared

Shared utility functions for pandoc writers.

Documentation

metaToJSON :: (Functor m, Monad m, ToJSON a) => WriterOptions -> ([Block] -> m a) -> ([Inline] -> m a) -> Meta -> m Value

Create JSON value for template from a Meta and an association list of variables, specified at the command line or in the writer. Variables overwrite metadata fields with the same names. If multiple variables are set with the same name, a list is assigned. Does nothing if writerTemplate is Nothing.

metaToJSON' :: (Functor m, Monad m, ToJSON a) => ([Block] -> m a) -> ([Inline] -> m a) -> Meta -> m Value

Like metaToJSON, but does not include variables and is not sensitive to writerTemplate.

addVariablesToJSON :: WriterOptions -> Value -> Value

Add variables to JSON object, replacing any existing values. Also include meta-json, a field containing a string representation of the original JSON object itself, prior to addition of variables.

getField :: FromJSON a => String -> Value -> Maybe a

Retrieve a field value from a JSON object.

setField :: ToJSON a => String -> a -> Value -> Value

Set a field of a JSON object. If the field already has a value, convert it into a list with the new value appended to the old value(s). This is a utility function to be used in preparing template contexts.

resetField :: ToJSON a => String -> a -> Value -> Value

Reset a field of a JSON object. If the field already has a value, the new value replaces it. This is a utility function to be used in preparing template contexts.

defField :: ToJSON a => String -> a -> Value -> Value

Set a field of a JSON object if it currently has no value. If it has a value, do nothing. This is a utility function to be used in preparing template contexts.

tagWithAttrs :: String -> Attr -> Doc

isDisplayMath :: Inline -> Bool

fixDisplayMath :: Block -> Block

unsmartify :: WriterOptions -> String -> String

gridTable

Arguments

:: Monad m

=> WriterOptions

-> (WriterOptions -> [Block] -> m Doc)

-> Bool

headless

-> [Alignment]

-> [Double]

-> [[Block]]

-> [[[Block]]]

-> m Doc

lookupMetaBool :: String -> Meta -> Bool

Retrieve the metadata value for a given key and convert to Bool.

lookupMetaBlocks :: String -> Meta -> [Block]

Retrieve the metadata value for a given key and extract blocks.

lookupMetaInlines :: String -> Meta -> [Inline]

Retrieve the metadata value for a given key and extract inlines.

lookupMetaString :: String -> Meta -> String

Retrieve the metadata value for a given key and convert to String.

stripLeadingTrailingSpace :: [Inline] -> [Inline]

toSubscript :: Char -> Maybe Char

toSuperscript :: Char -> Maybe Char

toTableOfContents :: WriterOptions -> [Block] -> Block

Construct table of contents (as a bullet list) from document body.