Text.Pandoc.Format

Handling of format specifiers for input and output.

Documentation

data FlavoredFormat

Format specifier with the format's name and the lists of extensions to be enabled or disabled.

Constructors

FlavoredFormat

Fields

• formatName :: Text
• formatExtsDiff :: ExtensionsDiff

Instances

Show FlavoredFormat

Defined in Text.Pandoc.Format

Methods

showsPrec :: Int -> FlavoredFormat -> ShowS

show :: FlavoredFormat -> String

showList :: [FlavoredFormat] -> ShowS

data ExtensionsConfig

Describes the properties of a format.

Constructors

ExtensionsConfig

Fields

• extsDefault :: Extensions

  Extensions enabled by default

• extsSupported :: Extensions

  Extensions that can be enabled or disabled.

Instances

Monoid ExtensionsConfig

Defined in Text.Pandoc.Format

Methods

mempty :: ExtensionsConfig

mappend :: ExtensionsConfig -> ExtensionsConfig -> ExtensionsConfig

mconcat :: [ExtensionsConfig] -> ExtensionsConfig

Semigroup ExtensionsConfig

Defined in Text.Pandoc.Format

Methods

(<>) :: ExtensionsConfig -> ExtensionsConfig -> ExtensionsConfig

sconcat :: NonEmpty ExtensionsConfig -> ExtensionsConfig

stimes :: Integral b => b -> ExtensionsConfig -> ExtensionsConfig

Show ExtensionsConfig

Defined in Text.Pandoc.Format

Methods

showsPrec :: Int -> ExtensionsConfig -> ShowS

show :: ExtensionsConfig -> String

showList :: [ExtensionsConfig] -> ShowS

data ExtensionsDiff

Changes to a set of extensions, i.e., list of extensions to be enabled or disabled.

Constructors

ExtensionsDiff

Fields

• extsToEnable :: Extensions
• extsToDisable :: Extensions

Instances

Monoid ExtensionsDiff

Defined in Text.Pandoc.Format

Methods

mempty :: ExtensionsDiff

mappend :: ExtensionsDiff -> ExtensionsDiff -> ExtensionsDiff

mconcat :: [ExtensionsDiff] -> ExtensionsDiff

Semigroup ExtensionsDiff

Defined in Text.Pandoc.Format

Methods

(<>) :: ExtensionsDiff -> ExtensionsDiff -> ExtensionsDiff

sconcat :: NonEmpty ExtensionsDiff -> ExtensionsDiff

stimes :: Integral b => b -> ExtensionsDiff -> ExtensionsDiff

Show ExtensionsDiff

Defined in Text.Pandoc.Format

Methods

showsPrec :: Int -> ExtensionsDiff -> ShowS

show :: ExtensionsDiff -> String

showList :: [ExtensionsDiff] -> ShowS

diffExtensions :: Extensions -> Extensions -> ExtensionsDiff

Calculate the change set to get from one set of extensions to another.

parseFlavoredFormat :: PandocMonad m => Text -> m FlavoredFormat

Parse a format-specifying string into a markup format and the change set to the format's extensions. Throws an error if the spec cannot be parsed or contains an unknown extension.

applyExtensionsDiff :: PandocMonad m => ExtensionsConfig -> FlavoredFormat -> m Extensions

Apply the extension changes in the format spec to the extensions given in the format's extensions configuration. Throws an error in case of an unknown or unsupported extension.

getExtensionsConfig :: Text -> ExtensionsConfig

Returns the extensions configuration of a format.

formatFromFilePaths :: [FilePath] -> Maybe FlavoredFormat

Determines default format based on file extensions; uses the format of the first extension that's associated with a format.

Examples:

formatFromFilePaths ["text.unknown", "no-extension"]

Nothing

formatFromFilePaths ["my.md", "other.rst"]

Just "markdown"