pandoc-2.7.2: Conversion between markup formats

CopyrightCopyright (C) 2006-2019 John MacFarlane
LicenseGNU GPL, version 2 or above
MaintainerJohn MacFarlane <jgm@berkeley@edu>
Stabilityalpha
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Text.Pandoc.App

Description

Does a pandoc conversion based on command-line options.

Synopsis

Documentation

data Opt Source #

Data structure for command line options.

Constructors

Opt 

Fields

Instances
Show Opt Source # 
Instance details

Defined in Text.Pandoc.App.Opt

Methods

showsPrec :: Int -> Opt -> ShowS #

show :: Opt -> String #

showList :: [Opt] -> ShowS #

Generic Opt Source # 
Instance details

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

Defined in Text.Pandoc.App.Opt

FromJSON Opt Source # 
Instance details

Defined in Text.Pandoc.App.Opt

type Rep Opt Source # 
Instance details

Defined in Text.Pandoc.App.Opt

type Rep Opt = D1 (MetaData "Opt" "Text.Pandoc.App.Opt" "pandoc-2.7.2-8czHjtbLo1Z5l8FdrvwrCd" False) (C1 (MetaCons "Opt" PrefixI True) ((((((S1 (MetaSel (Just "optTabStop") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :*: S1 (MetaSel (Just "optPreserveTabs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :*: (S1 (MetaSel (Just "optStandalone") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "optReader") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)))) :*: ((S1 (MetaSel (Just "optWriter") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)) :*: S1 (MetaSel (Just "optTableOfContents") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :*: (S1 (MetaSel (Just "optBaseHeaderLevel") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :*: S1 (MetaSel (Just "optTemplate") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath))))) :*: (((S1 (MetaSel (Just "optVariables") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(String, String)]) :*: S1 (MetaSel (Just "optMetadata") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(String, String)])) :*: (S1 (MetaSel (Just "optMetadataFile") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath)) :*: S1 (MetaSel (Just "optOutputFile") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath)))) :*: ((S1 (MetaSel (Just "optInputFiles") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "optNumberSections") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :*: (S1 (MetaSel (Just "optNumberOffset") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Int]) :*: (S1 (MetaSel (Just "optSectionDivs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "optIncremental") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))))) :*: ((((S1 (MetaSel (Just "optSelfContained") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "optHtmlQTags") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :*: (S1 (MetaSel (Just "optHighlightStyle") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Style)) :*: S1 (MetaSel (Just "optSyntaxDefinitions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]))) :*: ((S1 (MetaSel (Just "optTopLevelDivision") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TopLevelDivision) :*: S1 (MetaSel (Just "optHTMLMathMethod") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 HTMLMathMethod)) :*: (S1 (MetaSel (Just "optAbbreviations") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath)) :*: S1 (MetaSel (Just "optReferenceDoc") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath))))) :*: (((S1 (MetaSel (Just "optEpubSubdirectory") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "optEpubMetadata") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath))) :*: (S1 (MetaSel (Just "optEpubFonts") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "optEpubChapterLevel") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int))) :*: ((S1 (MetaSel (Just "optEpubCoverImage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath)) :*: S1 (MetaSel (Just "optTOCDepth") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)) :*: (S1 (MetaSel (Just "optDumpArgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: (S1 (MetaSel (Just "optIgnoreArgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "optVerbosity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Verbosity))))))) :*: (((((S1 (MetaSel (Just "optTrace") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "optLogFile") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath))) :*: (S1 (MetaSel (Just "optFailIfWarnings") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "optReferenceLinks") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))) :*: ((S1 (MetaSel (Just "optReferenceLocation") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ReferenceLocation) :*: S1 (MetaSel (Just "optDpi") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)) :*: (S1 (MetaSel (Just "optWrapText") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 WrapOption) :*: S1 (MetaSel (Just "optColumns") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))) :*: (((S1 (MetaSel (Just "optFilters") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Filter]) :*: S1 (MetaSel (Just "optEmailObfuscation") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ObfuscationMethod)) :*: (S1 (MetaSel (Just "optIdentifierPrefix") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "optStripEmptyParagraphs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))) :*: ((S1 (MetaSel (Just "optIndentedCodeClasses") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "optDataDir") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath))) :*: (S1 (MetaSel (Just "optCiteMethod") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CiteMethod) :*: (S1 (MetaSel (Just "optListings") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "optPdfEngine") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String))))))) :*: ((((S1 (MetaSel (Just "optPdfEngineArgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :*: S1 (MetaSel (Just "optSlideLevel") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))) :*: (S1 (MetaSel (Just "optSetextHeaders") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "optAscii") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))) :*: ((S1 (MetaSel (Just "optDefaultImageExtension") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "optExtractMedia") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe FilePath))) :*: (S1 (MetaSel (Just "optTrackChanges") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TrackChanges) :*: (S1 (MetaSel (Just "optFileScope") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "optTitlePrefix") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)))))) :*: (((S1 (MetaSel (Just "optCss") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "optIpynbOutput") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :*: (S1 (MetaSel (Just "optIncludeBeforeBody") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "optIncludeAfterBody") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]))) :*: ((S1 (MetaSel (Just "optIncludeInHeader") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :*: S1 (MetaSel (Just "optResourcePath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath])) :*: (S1 (MetaSel (Just "optRequestHeaders") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(String, String)]) :*: (S1 (MetaSel (Just "optEol") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 LineEnding) :*: S1 (MetaSel (Just "optStripComments") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))))))))

data LineEnding Source #

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

Constructors

LF 
CRLF 
Native 
Instances
Show LineEnding Source # 
Instance details

Defined in Text.Pandoc.App.Opt

Generic LineEnding Source # 
Instance details

Defined in Text.Pandoc.App.Opt

Associated Types

type Rep LineEnding :: Type -> Type #

ToJSON LineEnding Source # 
Instance details

Defined in Text.Pandoc.App.Opt

FromJSON LineEnding Source # 
Instance details

Defined in Text.Pandoc.App.Opt

type Rep LineEnding Source # 
Instance details

Defined in Text.Pandoc.App.Opt

type Rep LineEnding = D1 (MetaData "LineEnding" "Text.Pandoc.App.Opt" "pandoc-2.7.2-8czHjtbLo1Z5l8FdrvwrCd" 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 Source #

Type of filter and path to filter file.

Instances
Show Filter Source # 
Instance details

Defined in Text.Pandoc.Filter

Generic Filter Source # 
Instance details

Defined in Text.Pandoc.Filter

Associated Types

type Rep Filter :: Type -> Type #

Methods

from :: Filter -> Rep Filter x #

to :: Rep Filter x -> Filter #

ToJSON Filter Source # 
Instance details

Defined in Text.Pandoc.Filter

FromJSON Filter Source # 
Instance details

Defined in Text.Pandoc.Filter

type Rep Filter Source # 
Instance details

Defined in Text.Pandoc.Filter

defaultOpts :: Opt Source #

Defaults for command-line options.

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

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

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

Modify the given document using a filter.