Knit.Report.Output

Pandoc Writer Configuration

data PandocWriterConfig

Constructors

PandocWriterConfig

Fields

• templateFP :: Maybe FilePath

  optional path to pandoc template

• templateVars :: TemplateVariables

  variable substitutions for the template

• optionsF :: WriterOptionsF

  change default options

type TemplateVariables = Map String String

type WriterOptionsF = WriterOptions -> WriterOptions

mkPandocWriterConfig :: TemplatePath -> TemplateVariables -> WriterOptionsF -> IO PandocWriterConfig

Make a PandocWriterConfig from a PandocTemplate specification

Pandoc Template Types

data TemplatePath

Type to specify path to template, which may be in a directory installed with knit-haskell.

Constructors

DefaultTemplate

FromIncludedTemplateDir Text

FullySpecifiedTemplatePath Text

data CssPath

Type to specify path to Css, which may be in a directory installed with knit-haskell or not.

Constructors

FromIncludedCssDir Text

FullySpecifiedCssPath Text

addCss :: CssPath -> TemplateVariables -> IO TemplateVariables

Add a CssPath to an existing TemplateVariables which may already have Css paths specified

file writing helpers

writeAllPandocResultsWithInfo :: Text -> Text -> [DocWithInfo PandocInfo Text] -> IO ()

Write each lazy text from a list of DocWithInfo to disk. File names come from the PandocInfo Directory and file extension are function arguments.

writePandocResultWithInfo

Arguments

:: Text

directory

-> Text

extension

-> DocWithInfo PandocInfo Text

-> IO ()

Write the Lazy Text in a DocWithInfo to disk Name comes from the PandocInfo Directory and file extection are arguments to the function Create the parent directory or directories, if necessary.

writeAndMakePathLT :: Text -> Text -> IO ()

Write Lazy Text (Pandoc's Html result) to disk. Create the parent directory or directories, if necessary.

writeAndMakePath :: Text -> (a -> Text) -> a -> IO ()

Write (to disk) something which can be converted to text. Create the parent directory or directories, if necessary.