Copyright	(c) Adam Conner-Sax 2019
License	BSD-3-Clause
Maintainer	adam_conner_sax@yahoo.com
Stability	experimental
Safe Haskell	None
Language	Haskell2010

Knit.Effect.Pandoc

Contents

Effects
Requirement Support
Format ADTs
Combinators
Interpreters
Docs effect type-aliases
Docs Effect Interpreters

Description

Polysemy Pandoc effect. This is writer-like, allowing the interspersed addition of various Pandoc-readable formats into one doc and then rendering to many Pandoc-writeable formats. Currently only a subset of formats are supported. Inputs can express requirements, e.g., hvega requires html output because it uses javascript. Those requirements are then checked before output is rendered and an error thrown if the input is not supported.

Synopsis

data ToPandoc m r
data FromPandoc m r
data Requirement
- = VegaSupport
- | LatexSupport
data PandocWithRequirements
data PandocReadFormat a where
- ReadDocX :: PandocReadFormat ByteString
- ReadMarkDown :: PandocReadFormat Text
- ReadCommonMark :: PandocReadFormat Text
- ReadRST :: PandocReadFormat Text
- ReadLaTeX :: PandocReadFormat Text
- ReadHtml :: PandocReadFormat Text
data PandocWriteFormat a where
addFrom :: Member ToPandoc effs => PandocReadFormat a -> ReaderOptions -> a -> Semantic effs ()
require :: Member ToPandoc effs => Requirement -> Semantic effs ()
writeTo :: Member FromPandoc effs => PandocWriteFormat a -> WriterOptions -> Pandoc -> Semantic effs a
toPandoc :: PandocMonad m => PandocReadFormat a -> ReaderOptions -> a -> m Pandoc
fromPandoc :: PandocMonad m => PandocWriteFormat a -> WriterOptions -> PandocWithRequirements -> m a
runPandocWriter :: PandocEffects effs => Semantic (ToPandoc ': effs) () -> Semantic effs PandocWithRequirements
type Pandocs = Docs PandocWithRequirements
data NamedDoc a = NamedDoc {
- ndName :: Text
- ndDoc :: a
}
newPandoc :: (PandocEffects effs, Member Pandocs effs) => Text -> Semantic (ToPandoc ': effs) () -> Semantic effs ()
pandocsToNamed :: PandocEffects effs => PandocWriteFormat a -> WriterOptions -> Semantic (Pandocs ': effs) () -> Semantic effs [NamedDoc a]
fromPandocE :: PandocEffects effs => PandocWriteFormat a -> WriterOptions -> Semantic (ToPandoc ': effs) () -> Semantic effs a

Effects

data ToPandoc m r Source #

Pandoc writer, add any read format to current doc

data FromPandoc m r Source #

Pandoc output effect, take given doc and produce formatted output

Requirement Support

data Requirement Source #

ADT to allow inputs to request support, if necessary or possible, in the output format. E.g., Latex output in Html needs MathJax. But Latex needs to nothing to output in Latex. Vega-lite needs some script headers to output in Html and can't be output in other formats. For now, we support all the things we can in any output format so this just results in a runtime test.

Constructors

VegaSupport	Supported only for Html output.
LatexSupport	Supported in Html output (via MathJax) and Latex output.

Instances

Bounded Requirement Source #
Instance details Defined in Knit.Effect.Pandoc Methods minBound :: Requirement # maxBound :: Requirement #
Enum Requirement Source #
Instance details Defined in Knit.Effect.Pandoc Methods succ :: Requirement -> Requirement # pred :: Requirement -> Requirement # toEnum :: Int -> Requirement # fromEnum :: Requirement -> Int # enumFrom :: Requirement -> [Requirement] # enumFromThen :: Requirement -> Requirement -> [Requirement] # enumFromTo :: Requirement -> Requirement -> [Requirement] # enumFromThenTo :: Requirement -> Requirement -> Requirement -> [Requirement] #
Eq Requirement Source #
Instance details Defined in Knit.Effect.Pandoc Methods (==) :: Requirement -> Requirement -> Bool # (/=) :: Requirement -> Requirement -> Bool #
Ord Requirement Source #
Instance details Defined in Knit.Effect.Pandoc Methods compare :: Requirement -> Requirement -> Ordering # (<) :: Requirement -> Requirement -> Bool # (<=) :: Requirement -> Requirement -> Bool # (>) :: Requirement -> Requirement -> Bool # (>=) :: Requirement -> Requirement -> Bool # max :: Requirement -> Requirement -> Requirement # min :: Requirement -> Requirement -> Requirement #
Show Requirement Source #
Instance details Defined in Knit.Effect.Pandoc Methods showsPrec :: Int -> Requirement -> ShowS # show :: Requirement -> String # showList :: [Requirement] -> ShowS #

data PandocWithRequirements Source #

Instances

Semigroup PandocWithRequirements Source #
Instance details Defined in Knit.Effect.Pandoc Methods (<>) :: PandocWithRequirements -> PandocWithRequirements -> PandocWithRequirements # sconcat :: NonEmpty PandocWithRequirements -> PandocWithRequirements # stimes :: Integral b => b -> PandocWithRequirements -> PandocWithRequirements #
Monoid PandocWithRequirements Source #
Instance details Defined in Knit.Effect.Pandoc Methods mempty :: PandocWithRequirements # mappend :: PandocWithRequirements -> PandocWithRequirements -> PandocWithRequirements # mconcat :: [PandocWithRequirements] -> PandocWithRequirements #

Format ADTs

data PandocReadFormat a where Source #

Supported formats for adding to current Pandoc

Constructors

ReadDocX :: PandocReadFormat ByteString
ReadMarkDown :: PandocReadFormat Text
ReadCommonMark :: PandocReadFormat Text
ReadRST :: PandocReadFormat Text
ReadLaTeX :: PandocReadFormat Text
ReadHtml :: PandocReadFormat Text

Instances

Show (PandocReadFormat a) Source #
Instance details Defined in Knit.Effect.Pandoc Methods showsPrec :: Int -> PandocReadFormat a -> ShowS # show :: PandocReadFormat a -> String # showList :: [PandocReadFormat a] -> ShowS #

data PandocWriteFormat a where Source #

Supported formats for writing current Pandoc

Instances

Show (PandocWriteFormat a) Source #
Instance details Defined in Knit.Effect.Pandoc Methods showsPrec :: Int -> PandocWriteFormat a -> ShowS # show :: PandocWriteFormat a -> String # showList :: [PandocWriteFormat a] -> ShowS #

Combinators

addFrom :: Member ToPandoc effs => PandocReadFormat a -> ReaderOptions -> a -> Semantic effs () Source #

Add a piece of a Pandoc readable type to the current doc

require :: Member ToPandoc effs => Requirement -> Semantic effs () Source #

Add a requirement that the output format must satisfy.

writeTo :: Member FromPandoc effs => PandocWriteFormat a -> WriterOptions -> Pandoc -> Semantic effs a Source #

Write given doc in requested format

toPandoc :: PandocMonad m => PandocReadFormat a -> ReaderOptions -> a -> m Pandoc Source #

Convert a to Pandoc with the given options

fromPandoc :: PandocMonad m => PandocWriteFormat a -> WriterOptions -> PandocWithRequirements -> m a Source #

Convert Pandoc to requested format with the given options. | Throw a PandocError if the output format is unsupported given the inputs.

Interpreters

runPandocWriter :: PandocEffects effs => Semantic (ToPandoc ': effs) () -> Semantic effs PandocWithRequirements Source #

Run ToPandoc by interpreting in Writer and then running that Writer.

Docs effect type-aliases

type Pandocs = Docs PandocWithRequirements Source #

Type-alias for use with the Docs effect.

data NamedDoc a Source #

Data type to hold one named document of type a.

Constructors

NamedDoc
Fields ndName :: Text ndDoc :: a

Instances

Functor NamedDoc Source #
Instance details Defined in Knit.Effect.Docs Methods fmap :: (a -> b) -> NamedDoc a -> NamedDoc b # (<$) :: a -> NamedDoc b -> NamedDoc a #
Foldable NamedDoc Source #
Instance details Defined in Knit.Effect.Docs Methods fold :: Monoid m => NamedDoc m -> m # foldMap :: Monoid m => (a -> m) -> NamedDoc a -> m # foldr :: (a -> b -> b) -> b -> NamedDoc a -> b # foldr' :: (a -> b -> b) -> b -> NamedDoc a -> b # foldl :: (b -> a -> b) -> b -> NamedDoc a -> b # foldl' :: (b -> a -> b) -> b -> NamedDoc a -> b # foldr1 :: (a -> a -> a) -> NamedDoc a -> a # foldl1 :: (a -> a -> a) -> NamedDoc a -> a # toList :: NamedDoc a -> [a] # null :: NamedDoc a -> Bool # length :: NamedDoc a -> Int # elem :: Eq a => a -> NamedDoc a -> Bool # maximum :: Ord a => NamedDoc a -> a # minimum :: Ord a => NamedDoc a -> a # sum :: Num a => NamedDoc a -> a # product :: Num a => NamedDoc a -> a #
Traversable NamedDoc Source #
Instance details Defined in Knit.Effect.Docs Methods traverse :: Applicative f => (a -> f b) -> NamedDoc a -> f (NamedDoc b) # sequenceA :: Applicative f => NamedDoc (f a) -> f (NamedDoc a) # mapM :: Monad m => (a -> m b) -> NamedDoc a -> m (NamedDoc b) # sequence :: Monad m => NamedDoc (m a) -> m (NamedDoc a) #

Docs Effect Interpreters

newPandoc Source #

Arguments

:: (PandocEffects effs, Member Pandocs effs)
=> Text	name of document
-> Semantic (ToPandoc ': effs) ()
-> Semantic effs ()

Add the Pandoc stored in the writer-style ToPandoc effect to the named docs collection with the given name.

pandocsToNamed Source #

Arguments

:: PandocEffects effs
=> PandocWriteFormat a	format for Pandoc output
-> WriterOptions	options for the Pandoc Writer
-> Semantic (Pandocs ': effs) ()	effects stack to be (partially) run to get documents
-> Semantic effs [NamedDoc a]	documents in requested format, within the effects monad

Given a write format and options, convert a list of named Pandocs to a list of named docs in the requested format

fromPandocE Source #

Arguments

:: PandocEffects effs
=> PandocWriteFormat a	format for Pandoc output
-> WriterOptions	options for the Pandoc Writer
-> Semantic (ToPandoc ': effs) ()	effects stack to be (partially) run to get document
-> Semantic effs a	document in requested format, within the effects monad

Given a write format and options, run the writer-style ToPandoc effect and produce a doc of requested type

WriteDocX :: PandocWriteFormat ByteString
WriteMarkDown :: PandocWriteFormat Text
WriteCommonMark :: PandocWriteFormat Text
WriteRST :: PandocWriteFormat Text
WriteLaTeX :: PandocWriteFormat Text
WriteHtml5 :: PandocWriteFormat Html
WriteHtml5String :: PandocWriteFormat Text