pandoc-3.7.0.2: Conversion between markup formats

Copyright | Copyright (C) 2006-2024 John MacFarlane
License | GNU GPL, version 2 or above
Maintainer | John MacFarlane <jgm@berkeley@edu>
Stability | alpha
Portability | portable
Safe Haskell | None
Language | Haskell2010

Text.Pandoc.App

Description

Does a pandoc conversion based on command-line options.

Synopsis

- convertWithOpts :: ScriptingEngine -> Opt -> IO ()
- handleOptInfo :: ScriptingEngine -> OptInfo -> IO ()
- data Opt = Opt {
  - optTabStop :: Int
  - optPreserveTabs :: Bool
  - optStandalone :: Bool
  - optFrom :: Maybe Text
  - optTo :: Maybe Text
  - optTableOfContents :: Bool
  - optListOfFigures :: Bool
  - optListOfTables :: Bool
  - optShiftHeadingLevelBy :: Int
  - optTemplate :: Maybe FilePath
  - optVariables :: Context Text
  - optMetadata :: Meta
  - optMetadataFiles :: [FilePath]
  - optOutputFile :: Maybe FilePath
  - optInputFiles :: Maybe [FilePath]
  - optNumberSections :: Bool
  - optNumberOffset :: [Int]
  - optSectionDivs :: Bool
  - optIncremental :: Bool
  - optSelfContained :: Bool
  - optEmbedResources :: Bool
  - optLinkImages :: Bool
  - optHtmlQTags :: Bool
  - optHighlightStyle :: Maybe Text
  - optSyntaxDefinitions :: [FilePath]
  - optTopLevelDivision :: TopLevelDivision
  - optHTMLMathMethod :: HTMLMathMethod
  - optAbbreviations :: Maybe FilePath
  - optReferenceDoc :: Maybe FilePath
  - optSplitLevel :: Int
  - optChunkTemplate :: Maybe Text
  - optEpubSubdirectory :: String
  - optEpubMetadata :: Maybe FilePath
  - optEpubFonts :: [FilePath]
  - optEpubCoverImage :: Maybe FilePath
  - optEpubTitlePage :: Bool
  - optTOCDepth :: Int
  - optDumpArgs :: Bool
  - optIgnoreArgs :: Bool
  - optVerbosity :: Verbosity
  - optTrace :: Bool
  - optLogFile :: Maybe FilePath
  - optFailIfWarnings :: Bool
  - optReferenceLinks :: Bool
  - optReferenceLocation :: ReferenceLocation
  - optFigureCaptionPosition :: CaptionPosition
  - optTableCaptionPosition :: CaptionPosition
  - optDpi :: Int
  - optWrap :: WrapOption
  - optColumns :: Int
  - optFilters :: [Filter]
  - optEmailObfuscation :: ObfuscationMethod
  - optIdentifierPrefix :: Text
  - optIndentedCodeClasses :: [Text]
  - optDataDir :: Maybe FilePath
  - optCiteMethod :: CiteMethod
  - optListings :: Bool
  - optPdfEngine :: Maybe String
  - optPdfEngineOpts :: [String]
  - optSlideLevel :: Maybe Int
  - optSetextHeaders :: Bool
  - optListTables :: Bool
  - optAscii :: Bool
  - optDefaultImageExtension :: Text
  - optExtractMedia :: Maybe FilePath
  - optTrackChanges :: TrackChanges
  - optFileScope :: Bool
  - optTitlePrefix :: Maybe Text
  - optCss :: [FilePath]
  - optIpynbOutput :: IpynbOutput
  - optIncludeBeforeBody :: [FilePath]
  - optIncludeAfterBody :: [FilePath]
  - optIncludeInHeader :: [FilePath]
  - optResourcePath :: [FilePath]
  - optRequestHeaders :: [(Text, Text)]
  - optNoCheckCertificate :: Bool
  - optEol :: LineEnding
  - optStripComments :: Bool
  - optCSL :: Maybe FilePath
  - optBibliography :: [FilePath]
  - optCitationAbbreviations :: Maybe FilePath
  - optSandbox :: Bool
  }
- data OptInfo
  - = BashCompletion
  - | ListInputFormats
  - | ListOutputFormats
  - | ListExtensions (Maybe Text)
  - | ListHighlightLanguages
  - | ListHighlightStyles
  - | PrintDefaultTemplate (Maybe FilePath) Text
  - | PrintDefaultDataFile (Maybe FilePath) Text
  - | PrintHighlightStyle (Maybe FilePath) Text
  - | VersionInfo
  - | Help
  - | OptError PandocError
- data LineEnding
  - = LF
  - | CRLF
  - | Native
- data IpynbOutput
  - = IpynbOutputAll
  - | IpynbOutputNone
  - | IpynbOutputBest
- data Filter
  - = LuaFilter FilePath
  - | JSONFilter FilePath
- defaultOpts :: Opt
- parseOptions :: [OptDescr (Opt -> ExceptT OptInfo IO Opt)] -> Opt -> IO (Either OptInfo Opt)
- parseOptionsFromArgs :: [OptDescr (Opt -> ExceptT OptInfo IO Opt)] -> Opt -> String -> [String] -> IO (Either OptInfo Opt)
- options :: [OptDescr (Opt -> ExceptT OptInfo IO Opt)]
- applyFilters :: (PandocMonad m, MonadIO m) => ScriptingEngine -> Environment -> [Filter] -> [String] -> Pandoc -> m Pandoc

# Documentation

convertWithOpts :: ScriptingEngine -> Opt -> IO () #

handleOptInfo :: ScriptingEngine -> OptInfo -> IO () #

React to an `OptInfo` by printing the requested information and exiting or (if there was a parsing error) raising an error.

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

- optListOfFigures :: Bool

  Include list of figures

- optListOfTables :: Bool

  Include list of tables

- 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 (deprecated)

- optEmbedResources :: Bool

  Make HTML accessible offline

- optLinkImages :: Bool

  Link ODT images rather than embedding

- 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

- optSplitLevel :: Int

  Header level at which to split documents in epub and chunkedhtml

- optChunkTemplate :: Maybe Text

  Template to use for chunk filenames

- optEpubSubdirectory :: String

  EPUB subdir in OCF container

- optEpubMetadata :: Maybe FilePath

  EPUB metadata

- optEpubFonts :: [FilePath]

  EPUB fonts to embed

- optEpubCoverImage :: Maybe FilePath

  Cover image for epub

- optEpubTitlePage :: Bool

  INclude title page in 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

- optFigureCaptionPosition :: CaptionPosition

  position for figure caption

- optTableCaptionPosition :: CaptionPosition

  position for table caption

- optDpi :: Int

  Dpi

- optWrap :: WrapOption

  Options for wrapping text

- optColumns :: Int

  Line length in characters

- optFilters :: [Filter]

  Filters to apply

- optEmailObfuscation :: ObfuscationMethod
- optIdentifierPrefix :: Text
- 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

- optListTables :: Bool

  Use list tables for RST

- 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

- optCSL :: Maybe FilePath

  CSL stylesheet

- optBibliography :: [FilePath]

  Bibliography files

- optCitationAbbreviations :: Maybe FilePath

  Citation abbreviations

- optSandbox :: Bool

#### Instances

Instances details

FromJSON Opt # |
Instance details Defined in Text.Pandoc.App.Opt Methods parseJSON :: Value -> Parser Opt # parseJSONList :: Value -> Parser [Opt] # omittedField :: Maybe Opt #
ToJSON Opt # |
Instance details Defined in Text.Pandoc.App.Opt Methods toJSON :: Opt -> Value # toEncoding :: Opt -> Encoding # toJSONList :: [Opt] -> Value # toEncodingList :: [Opt] -> Encoding # omitField :: Opt -> Bool #
Generic Opt # |

Instance details

Defined in Text.Pandoc.App.Opt

Associated Types

type Rep Opt |

Instance details

Defined in Text.Pandoc.App.Opt

type Rep Opt = D1 ('MetaData "Opt" "Text.Pandoc.App.Opt" "pandoc-3.7.0.2-LV2qWKW0Q2RElzdkrvf5Ll" '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 "optFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "optTo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "optTableOfContents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "optListOfFigures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "optListOfTables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "optShiftHeadingLevelBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "optTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)))))) :*: (((S1 ('MetaSel ('Just "optVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Context Text)) :*: S1 ('MetaSel ('Just "optMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Meta)) :*: (S1 ('MetaSel ('Just "optMetadataFiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath]) :*: (S1 ('MetaSel ('Just "optOutputFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)) :*: S1 ('MetaSel ('Just "optInputFiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [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 "optEmbedResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "optLinkImages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "optHtmlQTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "optHighlightStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: 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 "optSplitLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))))) :*: (((S1 ('MetaSel ('Just "optChunkTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: 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 "optEpubCoverImage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath))))) :*: ((S1 ('MetaSel ('Just "optEpubTitlePage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (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 "optFigureCaptionPosition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CaptionPosition)))) :*: ((S1 ('MetaSel ('Just "optTableCaptionPosition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CaptionPosition) :*: S1 ('MetaSel ('Just "optDpi") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "optWrap") '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 Text)) :*: (S1 ('MetaSel ('Just "optIndentedCodeClasses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text]) :*: (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 "optPdfEngineOpts") '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 "optListTables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "optAscii") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "optDefaultImageExtension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (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 Text))) :*: (S1 ('MetaSel ('Just "optCss") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath]) :*: (S1 ('MetaSel ('Just "optIpynbOutput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 IpynbOutput) :*: 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 [(Text, Text)]) :*: S1 ('MetaSel ('Just "optNoCheckCertificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))) :*: ((S1 ('MetaSel ('Just "optEol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LineEnding) :*: (S1 ('MetaSel ('Just "optStripComments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "optCSL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)))) :*: (S1 ('MetaSel ('Just "optBibliography") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath]) :*: (S1 ('MetaSel ('Just "optCitationAbbreviations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)) :*: S1 ('MetaSel ('Just "optSandbox") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))))))))

Methods

from :: Opt -> Rep Opt x #

to :: Rep Opt x -> Opt #

Show Opt # |
Instance details Defined in Text.Pandoc.App.Opt Methods showsPrec :: Int -> Opt -> ShowS # show :: Opt -> String # showList :: [Opt] -> ShowS #
FromJSON (Opt -> Opt) # |
Instance details Defined in Text.Pandoc.App.Opt Methods parseJSON :: Value -> Parser (Opt -> Opt) # parseJSONList :: Value -> Parser [Opt -> Opt] # omittedField :: Maybe (Opt -> Opt) #
type Rep Opt # |

Instance details

Defined in Text.Pandoc.App.Opt

type Rep Opt = D1 ('MetaData "Opt" "Text.Pandoc.App.Opt" "pandoc-3.7.0.2-LV2qWKW0Q2RElzdkrvf5Ll" '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 "optFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "optTo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "optTableOfContents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "optListOfFigures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "optListOfTables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "optShiftHeadingLevelBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "optTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)))))) :*: (((S1 ('MetaSel ('Just "optVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Context Text)) :*: S1 ('MetaSel ('Just "optMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Meta)) :*: (S1 ('MetaSel ('Just "optMetadataFiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath]) :*: (S1 ('MetaSel ('Just "optOutputFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)) :*: S1 ('MetaSel ('Just "optInputFiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [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 "optEmbedResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "optLinkImages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "optHtmlQTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "optHighlightStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: 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 "optSplitLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))))) :*: (((S1 ('MetaSel ('Just "optChunkTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: 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 "optEpubCoverImage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath))))) :*: ((S1 ('MetaSel ('Just "optEpubTitlePage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (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 "optFigureCaptionPosition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CaptionPosition)))) :*: ((S1 ('MetaSel ('Just "optTableCaptionPosition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CaptionPosition) :*: S1 ('MetaSel ('Just "optDpi") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "optWrap") '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 Text)) :*: (S1 ('MetaSel ('Just "optIndentedCodeClasses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text]) :*: (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 "optPdfEngineOpts") '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 "optListTables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "optAscii") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "optDefaultImageExtension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (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 Text))) :*: (S1 ('MetaSel ('Just "optCss") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath]) :*: (S1 ('MetaSel ('Just "optIpynbOutput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 IpynbOutput) :*: 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 [(Text, Text)]) :*: S1 ('MetaSel ('Just "optNoCheckCertificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))) :*: ((S1 ('MetaSel ('Just "optEol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LineEnding) :*: (S1 ('MetaSel ('Just "optStripComments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "optCSL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)))) :*: (S1 ('MetaSel ('Just "optBibliography") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath]) :*: (S1 ('MetaSel ('Just "optCitationAbbreviations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)) :*: S1 ('MetaSel ('Just "optSandbox") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))))))))

data OptInfo #

Option parser results requesting informational output.

Constructors

BashCompletion |
ListInputFormats |
ListOutputFormats |
ListExtensions (Maybe Text) |
ListHighlightLanguages |
ListHighlightStyles |
PrintDefaultTemplate (Maybe FilePath) Text |
PrintDefaultDataFile (Maybe FilePath) Text |
PrintHighlightStyle (Maybe FilePath) Text |
VersionInfo |
Help |
OptError PandocError |

#### Instances

Instances details

Generic OptInfo # |

Instance details

Defined in Text.Pandoc.App.Opt

Associated Types

type Rep OptInfo |

Instance details

Defined in Text.Pandoc.App.Opt

type Rep OptInfo = D1 ('MetaData "OptInfo" "Text.Pandoc.App.Opt" "pandoc-3.7.0.2-LV2qWKW0Q2RElzdkrvf5Ll" 'False) (((C1 ('MetaCons "BashCompletion" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ListInputFormats" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ListOutputFormats" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "ListExtensions" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :+: (C1 ('MetaCons "ListHighlightLanguages" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ListHighlightStyles" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "PrintDefaultTemplate" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: (C1 ('MetaCons "PrintDefaultDataFile" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "PrintHighlightStyle" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))) :+: (C1 ('MetaCons "VersionInfo" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Help" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OptError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PandocError))))))

Methods

from :: OptInfo -> Rep OptInfo x #

to :: Rep OptInfo x -> OptInfo #

Show OptInfo # |
Instance details Defined in Text.Pandoc.App.Opt Methods showsPrec :: Int -> OptInfo -> ShowS # show :: OptInfo -> String # showList :: [OptInfo] -> ShowS #
type Rep OptInfo # |

Instance details

Defined in Text.Pandoc.App.Opt

type Rep OptInfo = D1 ('MetaData "OptInfo" "Text.Pandoc.App.Opt" "pandoc-3.7.0.2-LV2qWKW0Q2RElzdkrvf5Ll" 'False) (((C1 ('MetaCons "BashCompletion" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ListInputFormats" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ListOutputFormats" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "ListExtensions" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :+: (C1 ('MetaCons "ListHighlightLanguages" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ListHighlightStyles" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "PrintDefaultTemplate" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: (C1 ('MetaCons "PrintDefaultDataFile" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "PrintHighlightStyle" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))) :+: (C1 ('MetaCons "VersionInfo" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Help" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OptError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PandocError))))))

data LineEnding #

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

Constructors

LF |
CRLF |
Native |

#### Instances

Instances details

FromJSON LineEnding # |
Instance details Defined in Text.Pandoc.App.Opt Methods parseJSON :: Value -> Parser LineEnding # parseJSONList :: Value -> Parser [LineEnding] # omittedField :: Maybe LineEnding #
ToJSON LineEnding # |
Instance details Defined in Text.Pandoc.App.Opt Methods toJSON :: LineEnding -> Value # toEncoding :: LineEnding -> Encoding # toJSONList :: [LineEnding] -> Value # toEncodingList :: [LineEnding] -> Encoding # omitField :: LineEnding -> Bool #
Generic LineEnding # |

Instance details

Defined in Text.Pandoc.App.Opt

Associated Types

type Rep LineEnding |
Instance details Defined in Text.Pandoc.App.Opt type Rep LineEnding = D1 ('MetaData "LineEnding" "Text.Pandoc.App.Opt" "pandoc-3.7.0.2-LV2qWKW0Q2RElzdkrvf5Ll" '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)))

Methods

from :: LineEnding -> Rep LineEnding x #

to :: Rep LineEnding x -> LineEnding #

Show LineEnding # |
Instance details Defined in Text.Pandoc.App.Opt Methods showsPrec :: Int -> LineEnding -> ShowS # show :: LineEnding -> String # showList :: [LineEnding] -> ShowS #
type Rep LineEnding # |
Instance details Defined in Text.Pandoc.App.Opt type Rep LineEnding = D1 ('MetaData "LineEnding" "Text.Pandoc.App.Opt" "pandoc-3.7.0.2-LV2qWKW0Q2RElzdkrvf5Ll" '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 IpynbOutput #

How to handle output blocks in ipynb.

Constructors

IpynbOutputAll |
IpynbOutputNone |
IpynbOutputBest |

#### Instances

Instances details

FromJSON IpynbOutput # |
Instance details Defined in Text.Pandoc.App.Opt Methods parseJSON :: Value -> Parser IpynbOutput # parseJSONList :: Value -> Parser [IpynbOutput] # omittedField :: Maybe IpynbOutput #
ToJSON IpynbOutput # |
Instance details Defined in Text.Pandoc.App.Opt Methods toJSON :: IpynbOutput -> Value # toEncoding :: IpynbOutput -> Encoding # toJSONList :: [IpynbOutput] -> Value # toEncodingList :: [IpynbOutput] -> Encoding # omitField :: IpynbOutput -> Bool #
Generic IpynbOutput # |

Instance details

Defined in Text.Pandoc.App.Opt

Associated Types

type Rep IpynbOutput |
Instance details Defined in Text.Pandoc.App.Opt type Rep IpynbOutput = D1 ('MetaData "IpynbOutput" "Text.Pandoc.App.Opt" "pandoc-3.7.0.2-LV2qWKW0Q2RElzdkrvf5Ll" 'False) (C1 ('MetaCons "IpynbOutputAll" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "IpynbOutputNone" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "IpynbOutputBest" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: IpynbOutput -> Rep IpynbOutput x #

to :: Rep IpynbOutput x -> IpynbOutput #

Show IpynbOutput # |
Instance details Defined in Text.Pandoc.App.Opt Methods showsPrec :: Int -> IpynbOutput -> ShowS # show :: IpynbOutput -> String # showList :: [IpynbOutput] -> ShowS #
type Rep IpynbOutput # |
Instance details Defined in Text.Pandoc.App.Opt type Rep IpynbOutput = D1 ('MetaData "IpynbOutput" "Text.Pandoc.App.Opt" "pandoc-3.7.0.2-LV2qWKW0Q2RElzdkrvf5Ll" 'False) (C1 ('MetaCons "IpynbOutputAll" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "IpynbOutputNone" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "IpynbOutputBest" 'PrefixI 'False) (U1 :: Type -> Type)))

data Filter #

Type of filter and path to filter file.

Constructors

LuaFilter FilePath |
JSONFilter FilePath |

#### Instances

Instances details

FromJSON Filter # |
Instance details Defined in Text.Pandoc.Filter Methods parseJSON :: Value -> Parser Filter # parseJSONList :: Value -> Parser [Filter] # omittedField :: Maybe Filter #
ToJSON Filter # |
Instance details Defined in Text.Pandoc.Filter Methods toJSON :: Filter -> Value # toEncoding :: Filter -> Encoding # toJSONList :: [Filter] -> Value # toEncodingList :: [Filter] -> Encoding # omitField :: Filter -> Bool #
Generic Filter # |

Instance details

Defined in Text.Pandoc.Filter

Associated Types

type Rep Filter |

Instance details

Defined in Text.Pandoc.Filter

type Rep Filter = D1 ('MetaData "Filter" "Text.Pandoc.Filter" "pandoc-3.7.0.2-LV2qWKW0Q2RElzdkrvf5Ll" '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)))

Methods

from :: Filter -> Rep Filter x #

to :: Rep Filter x -> Filter #

Show Filter # |
Instance details Defined in Text.Pandoc.Filter Methods showsPrec :: Int -> Filter -> ShowS # show :: Filter -> String # showList :: [Filter] -> ShowS #
Eq Filter # |
Instance details Defined in Text.Pandoc.Filter Methods (==) :: Filter -> Filter -> Bool # (/=) :: Filter -> Filter -> Bool #
type Rep Filter # |

Instance details

Defined in Text.Pandoc.Filter

type Rep Filter = D1 ('MetaData "Filter" "Text.Pandoc.Filter" "pandoc-3.7.0.2-LV2qWKW0Q2RElzdkrvf5Ll" '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 -> ExceptT OptInfo IO Opt)] -> Opt -> IO (Either OptInfo Opt) #

parseOptionsFromArgs :: [OptDescr (Opt -> ExceptT OptInfo IO Opt)] -> Opt -> String -> [String] -> IO (Either OptInfo Opt) #

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

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

applyFilters :: (PandocMonad m, MonadIO m) => ScriptingEngine -> Environment -> [Filter] -> [String] -> Pandoc -> m Pandoc #

Modify the given document using a filter.