Text.Pandoc.Writers.Shared

Shared utility functions for pandoc writers.

Documentation

metaToContext :: (Monad m, TemplateTarget a) => WriterOptions -> ([Block] -> m (Doc a)) -> ([Inline] -> m (Doc a)) -> Meta -> m (Context a)

Create template Context 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.

metaToContext' :: (Monad m, TemplateTarget a) => ([Block] -> m (Doc a)) -> ([Inline] -> m (Doc a)) -> Meta -> m (Context a)

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

addVariablesToContext :: TemplateTarget a => WriterOptions -> Context a -> Context a

Add variables to a template Context, using monoidal append. Also add `meta-json`. Note that metadata values are used in template contexts only when like-named variables aren't set.

getField :: FromContext a b => Text -> Context a -> Maybe b

Retrieve a field value from a template context.

setField :: ToContext a b => Text -> b -> Context a -> Context a

Set a field of a template context. 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 :: ToContext a b => Text -> b -> Context a -> Context a

Reset a field of a template context. 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 :: ToContext a b => Text -> b -> Context a -> Context a

Set a field of a template context 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 :: HasChars a => Text -> Attr -> Doc a

isDisplayMath :: Inline -> Bool

fixDisplayMath :: Block -> Block

unsmartify :: WriterOptions -> Text -> Text

gridTable

Arguments

:: (Monad m, HasChars a)

=> WriterOptions

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

-> Bool

headless

-> [Alignment]

-> [Double]

-> [[Block]]

-> [[[Block]]]

-> m (Doc a)

lookupMetaBool :: Text -> Meta -> Bool

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

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

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

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

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

lookupMetaString :: Text -> Meta -> Text

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.

endsWithPlain :: [Block] -> Bool