Safe Haskell	None
Language	Haskell2010

Knit.Report.Output

Contents

Pandoc Writer Configuration
Pandoc Template Types
file writing helpers

Synopsis

data PandocWriterConfig = PandocWriterConfig {
- templateFP :: Maybe FilePath
- templateVars :: TemplateVariables
- optionsF :: WriterOptionsF
}
type TemplateVariables = Map String String
type WriterOptionsF = WriterOptions -> WriterOptions
mkPandocWriterConfig :: TemplatePath -> TemplateVariables -> WriterOptionsF -> IO PandocWriterConfig
data TemplatePath
data CssPath
- = FromIncludedCssDir Text
- | FullySpecifiedCssPath Text
addCss :: CssPath -> TemplateVariables -> IO TemplateVariables
writeAllPandocResultsWithInfo :: Text -> Text -> [DocWithInfo PandocInfo Text] -> IO ()
writePandocResultWithInfo :: Text -> Text -> DocWithInfo PandocInfo Text -> IO ()
writeAndMakePathLT :: Text -> Text -> IO ()
writeAndMakePath :: Text -> (a -> Text) -> a -> IO ()

Pandoc Writer Configuration

data PandocWriterConfig Source #

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 Source #

type WriterOptionsF = WriterOptions -> WriterOptions Source #

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

Make a PandocWriterConfig from a PandocTemplate specification

Pandoc Template Types

data TemplatePath Source #

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

Constructors

DefaultTemplate
FromIncludedTemplateDir Text
FullySpecifiedTemplatePath Text

data CssPath Source #

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 Source #

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

file writing helpers

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

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 Source #

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 () Source #

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

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

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