Text.Pandoc.App

Does a pandoc conversion based on command-line options.

Documentation

convertWithOpts :: Opt -> IO ()

data Opt

Data structure for command line options.

Constructors

Opt

Fields

• optTabStop :: Int

  Number of spaces per tab

• optPreserveTabs :: Bool

  Preserve tabs instead of converting to spaces

• optStandalone :: Bool

  Include header, footer

• optFrom :: Maybe Text

  Reader format

• optTo :: Maybe Text

  Writer format

• optTableOfContents :: Bool

  Include table of contents

• optShiftHeadingLevelBy :: Int

  Shift heading level by

• optTemplate :: Maybe FilePath

  Custom template

• optVariables :: Context Text

  Template variables to set

• optMetadata :: Meta

  Metadata fields to set

• optMetadataFiles :: [FilePath]

  Name of YAML metadata files

• optOutputFile :: Maybe FilePath

  Name of output file

• optInputFiles :: Maybe [FilePath]

  Names of input files

• optNumberSections :: Bool

  Number sections in LaTeX

• optNumberOffset :: [Int]

  Starting number for sections

• optSectionDivs :: Bool

  Put sections in div tags in HTML

• optIncremental :: Bool

  Use incremental lists in SlidySlideousS5

• optSelfContained :: Bool

  Make HTML accessible offline

• optHtmlQTags :: Bool

  Use q tags in HTML

• optHighlightStyle :: Maybe Text

  Style to use for highlighted code

• optSyntaxDefinitions :: [FilePath]

  xml syntax defs to load

• optTopLevelDivision :: TopLevelDivision

  Type of the top-level divisions

• optHTMLMathMethod :: HTMLMathMethod

  Method to print HTML math

• optAbbreviations :: Maybe FilePath

  Path to abbrevs file

• optReferenceDoc :: Maybe FilePath

  Path of reference doc

• optEpubSubdirectory :: String

  EPUB subdir in OCF container

• optEpubMetadata :: Maybe FilePath

  EPUB metadata

• optEpubFonts :: [FilePath]

  EPUB fonts to embed

• optEpubChapterLevel :: Int

  Header level at which to split chapters

• optEpubCoverImage :: Maybe FilePath

  Cover image for epub

• optTOCDepth :: Int

  Number of levels to include in TOC

• optDumpArgs :: Bool

  Output command-line arguments

• optIgnoreArgs :: Bool

  Ignore command-line arguments

• optVerbosity :: Verbosity

  Verbosity of diagnostic output

• optTrace :: Bool

  Enable tracing

• optLogFile :: Maybe FilePath

  File to write JSON log output

• optFailIfWarnings :: Bool

  Fail on warnings

• optReferenceLinks :: Bool

  Use reference links in writing markdown, rst

• optReferenceLocation :: ReferenceLocation

  location for footnotes and link references in markdown output

• optDpi :: Int

  Dpi

• optWrap :: WrapOption

  Options for wrapping text

• optColumns :: Int

  Line length in characters

• optFilters :: [Filter]

  Filters to apply

• optEmailObfuscation :: ObfuscationMethod
• optIdentifierPrefix :: Text
• optStripEmptyParagraphs :: Bool

  Strip empty paragraphs

• optIndentedCodeClasses :: [Text]

  Default classes for indented code blocks

• optDataDir :: Maybe FilePath
• optCiteMethod :: CiteMethod

  Method to output cites

• optListings :: Bool

  Use listings package for code blocks

• optPdfEngine :: Maybe String

  Program to use for latex/html -> pdf

• optPdfEngineOpts :: [String]

  Flags to pass to the engine

• optSlideLevel :: Maybe Int

  Header level that creates slides

• optSetextHeaders :: Bool

  Use atx headers for markdown level 1-2

• optAscii :: Bool

  Prefer ascii output

• optDefaultImageExtension :: Text

  Default image extension

• optExtractMedia :: Maybe FilePath

  Path to extract embedded media

• optTrackChanges :: TrackChanges

  Accept or reject MS Word track-changes.

• optFileScope :: Bool

  Parse input files before combining

• optTitlePrefix :: Maybe Text

  Prefix for title

• optCss :: [FilePath]

  CSS files to link to

• optIpynbOutput :: IpynbOutput

  How to treat ipynb output blocks

• optIncludeBeforeBody :: [FilePath]

  Files to include before

• optIncludeAfterBody :: [FilePath]

  Files to include after body

• optIncludeInHeader :: [FilePath]

  Files to include in header

• optResourcePath :: [FilePath]

  Path to search for images etc

• optRequestHeaders :: [(Text, Text)]

  Headers for HTTP requests

• optNoCheckCertificate :: Bool

  Disable certificate validation

• optEol :: LineEnding

  Style of line-endings to use

• optStripComments :: Bool

  Skip HTML comments

Instances

Show Opt

Defined in Text.Pandoc.App.Opt

Methods

showsPrec :: Int -> Opt -> ShowS

show :: Opt -> String

showList :: [Opt] -> ShowS

Generic Opt

Defined in Text.Pandoc.App.Opt

Associated Types

type Rep Opt :: Type -> Type

Methods

from :: Opt -> Rep Opt x

to :: Rep Opt x -> Opt

ToJSON Opt

Defined in Text.Pandoc.App.Opt

Methods

toJSON :: Opt -> Value

toEncoding :: Opt -> Encoding

toJSONList :: [Opt] -> Value

toEncodingList :: [Opt] -> Encoding

FromJSON Opt

Defined in Text.Pandoc.App.Opt

Methods

parseJSON :: Value -> Parser Opt

parseJSONList :: Value -> Parser [Opt]

FromYAML (Opt -> Opt)

Defined in Text.Pandoc.App.Opt

Methods

parseYAML :: Node Pos -> Parser (Opt -> Opt)

type Rep Opt

Defined in Text.Pandoc.App.Opt

type Rep Opt

data LineEnding

The type of line-endings to be used when writing plain-text.

Constructors

LF

CRLF

Native

Instances

Show LineEnding

Defined in Text.Pandoc.App.Opt

Methods

showsPrec :: Int -> LineEnding -> ShowS

show :: LineEnding -> String

showList :: [LineEnding] -> ShowS

Generic LineEnding

Defined in Text.Pandoc.App.Opt

Associated Types

type Rep LineEnding :: Type -> Type

Methods

from :: LineEnding -> Rep LineEnding x

to :: Rep LineEnding x -> LineEnding

FromYAML LineEnding

Defined in Text.Pandoc.App.Opt

Methods

parseYAML :: Node Pos -> Parser LineEnding

ToJSON LineEnding

Defined in Text.Pandoc.App.Opt

Methods

toJSON :: LineEnding -> Value

toEncoding :: LineEnding -> Encoding

toJSONList :: [LineEnding] -> Value

toEncodingList :: [LineEnding] -> Encoding

FromJSON LineEnding

Defined in Text.Pandoc.App.Opt

Methods

parseJSON :: Value -> Parser LineEnding

parseJSONList :: Value -> Parser [LineEnding]

type Rep LineEnding

Defined in Text.Pandoc.App.Opt

type Rep LineEnding = D1 ('MetaData "LineEnding" "Text.Pandoc.App.Opt" "pandoc-2.11.3.1-4U6BfNt0VeLJCKGQVIILWv" 'False) (C1 ('MetaCons "LF" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "CRLF" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Native" 'PrefixI 'False) (U1 :: Type -> Type)))

data Filter

Type of filter and path to filter file.

Constructors

LuaFilter FilePath

JSONFilter FilePath

Instances

Show Filter

Defined in Text.Pandoc.Filter

Methods

showsPrec :: Int -> Filter -> ShowS

show :: Filter -> String

showList :: [Filter] -> ShowS

Generic Filter

Defined in Text.Pandoc.Filter

Associated Types

type Rep Filter :: Type -> Type

Methods

from :: Filter -> Rep Filter x

to :: Rep Filter x -> Filter

FromYAML Filter

Defined in Text.Pandoc.Filter

Methods

parseYAML :: Node Pos -> Parser Filter

ToJSON Filter

Defined in Text.Pandoc.Filter

Methods

toJSON :: Filter -> Value

toEncoding :: Filter -> Encoding

toJSONList :: [Filter] -> Value

toEncodingList :: [Filter] -> Encoding

FromJSON Filter

Defined in Text.Pandoc.Filter

Methods

parseJSON :: Value -> Parser Filter

parseJSONList :: Value -> Parser [Filter]

type Rep Filter

Defined in Text.Pandoc.Filter

type Rep Filter = D1 ('MetaData "Filter" "Text.Pandoc.Filter" "pandoc-2.11.3.1-4U6BfNt0VeLJCKGQVIILWv" 'False) (C1 ('MetaCons "LuaFilter" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)) :+: (C1 ('MetaCons "JSONFilter" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)) :+: C1 ('MetaCons "CiteprocFilter" 'PrefixI 'False) (U1 :: Type -> Type)))

defaultOpts :: Opt

Defaults for command-line options.

parseOptions :: [OptDescr (Opt -> IO Opt)] -> Opt -> IO Opt

options :: [OptDescr (Opt -> IO Opt)]

A list of functions, each transforming the options data structure in response to a command-line option.

applyFilters :: ReaderOptions -> [Filter] -> [String] -> Pandoc -> PandocIO Pandoc

Modify the given document using a filter.