Copyright	Copyright (C) 2010-2019 John MacFarlane
License	BSD3
Maintainer	John MacFarlane <jgm@berkeley.edu>
Stability	alpha
Portability	portable
Safe Haskell	None
Language	Haskell98

Text.Pandoc.Builder

Contents

Document builders
Inline list builders
Block list builders

Description

Convenience functions for building pandoc documents programmatically.

Example of use (with OverloadedStrings pragma):

import Text.Pandoc.Builder

myDoc :: Pandoc
myDoc = setTitle "My title" $ doc $
  para "This is the first paragraph" <>
  para ("And " <> emph "another" <> ".") <>
  bulletList [ para "item one" <> para "continuation"
             , plain ("item two and a " <>
                 link "/url" "go to url" "link")
             ]

Isn't that nicer than writing the following?

import Text.Pandoc.Definition
import Data.Map (fromList)

myDoc :: Pandoc
myDoc = Pandoc (Meta {unMeta = fromList [("title",
          MetaInlines [Str "My",Space,Str "title"])]})
        [Para [Str "This",Space,Str "is",Space,Str "the",Space,Str "first",
         Space,Str "paragraph"],Para [Str "And",Space,Emph [Str "another"],
         Str "."]
        ,BulletList [
          [Para [Str "item",Space,Str "one"]
          ,Para [Str "continuation"]]
         ,[Plain [Str "item",Space,Str "two",Space,Str "and",Space,
                  Str "a",Space,Link nullAttr [Str "link"] ("/url","go to url")]]]]

And of course, you can use Haskell to define your own builders:

import Text.Pandoc.Builder
import Text.JSON
import Control.Arrow ((***))
import Data.Monoid (mempty)

-- | Converts a JSON document into 'Blocks'.
json :: String -> Blocks
json x =
  case decode x of
       Ok y    -> jsValueToBlocks y
       Error y -> error y
   where jsValueToBlocks x =
          case x of
           JSNull         -> mempty
           JSBool x       -> plain $ text $ show x
           JSRational _ x -> plain $ text $ show x
           JSString x     -> plain $ text $ fromJSString x
           JSArray xs     -> bulletList $ map jsValueToBlocks xs
           JSObject x     -> definitionList $
                              map (text *** (:[]) . jsValueToBlocks) $
                              fromJSObject x

Synopsis

module Text.Pandoc.Definition
newtype Many a = Many {
- unMany :: Seq a
}
type Inlines = Many Inline
type Blocks = Many Block
(<>) :: Semigroup a => a -> a -> a
singleton :: a -> Many a
toList :: Many a -> [a]
fromList :: [a] -> Many a
isNull :: Many a -> Bool
doc :: Blocks -> Pandoc
class ToMetaValue a where
- toMetaValue :: a -> MetaValue
class HasMeta a where
- setMeta :: ToMetaValue b => Text -> b -> a -> a
- deleteMeta :: Text -> a -> a
setTitle :: Inlines -> Pandoc -> Pandoc
setAuthors :: [Inlines] -> Pandoc -> Pandoc
setDate :: Inlines -> Pandoc -> Pandoc
text :: Text -> Inlines
str :: Text -> Inlines
emph :: Inlines -> Inlines
strong :: Inlines -> Inlines
strikeout :: Inlines -> Inlines
superscript :: Inlines -> Inlines
subscript :: Inlines -> Inlines
smallcaps :: Inlines -> Inlines
singleQuoted :: Inlines -> Inlines
doubleQuoted :: Inlines -> Inlines
cite :: [Citation] -> Inlines -> Inlines
codeWith :: Attr -> Text -> Inlines
code :: Text -> Inlines
space :: Inlines
softbreak :: Inlines
linebreak :: Inlines
math :: Text -> Inlines
displayMath :: Text -> Inlines
rawInline :: Text -> Text -> Inlines
link :: Text -> Text -> Inlines -> Inlines
linkWith :: Attr -> Text -> Text -> Inlines -> Inlines
image :: Text -> Text -> Inlines -> Inlines
imageWith :: Attr -> Text -> Text -> Inlines -> Inlines
note :: Blocks -> Inlines
spanWith :: Attr -> Inlines -> Inlines
trimInlines :: Inlines -> Inlines
para :: Inlines -> Blocks
plain :: Inlines -> Blocks
lineBlock :: [Inlines] -> Blocks
codeBlockWith :: Attr -> Text -> Blocks
codeBlock :: Text -> Blocks
rawBlock :: Text -> Text -> Blocks
blockQuote :: Blocks -> Blocks
bulletList :: [Blocks] -> Blocks
orderedListWith :: ListAttributes -> [Blocks] -> Blocks
orderedList :: [Blocks] -> Blocks
definitionList :: [(Inlines, [Blocks])] -> Blocks
header :: Int -> Inlines -> Blocks
headerWith :: Attr -> Int -> Inlines -> Blocks
horizontalRule :: Blocks
table :: Inlines -> [(Alignment, Double)] -> [Blocks] -> [[Blocks]] -> Blocks
simpleTable :: [Blocks] -> [[Blocks]] -> Blocks
divWith :: Attr -> Blocks -> Blocks

Documentation

module Text.Pandoc.Definition

newtype Many a Source #

Constructors

Many
Fields unMany :: Seq a

Instances

Functor Many Source #
Instance details Defined in Text.Pandoc.Builder Methods fmap :: (a -> b) -> Many a -> Many b # (<$) :: a -> Many b -> Many a #
IsString Inlines Source #
Instance details Defined in Text.Pandoc.Builder Methods fromString :: String -> Inlines #
Foldable Many Source #
Instance details Defined in Text.Pandoc.Builder Methods fold :: Monoid m => Many m -> m # foldMap :: Monoid m => (a -> m) -> Many a -> m # foldr :: (a -> b -> b) -> b -> Many a -> b # foldr' :: (a -> b -> b) -> b -> Many a -> b # foldl :: (b -> a -> b) -> b -> Many a -> b # foldl' :: (b -> a -> b) -> b -> Many a -> b # foldr1 :: (a -> a -> a) -> Many a -> a # foldl1 :: (a -> a -> a) -> Many a -> a # toList :: Many a -> [a] # null :: Many a -> Bool # length :: Many a -> Int # elem :: Eq a => a -> Many a -> Bool # maximum :: Ord a => Many a -> a # minimum :: Ord a => Many a -> a # sum :: Num a => Many a -> a # product :: Num a => Many a -> a #
Traversable Many Source #
Instance details Defined in Text.Pandoc.Builder Methods traverse :: Applicative f => (a -> f b) -> Many a -> f (Many b) # sequenceA :: Applicative f => Many (f a) -> f (Many a) # mapM :: Monad m => (a -> m b) -> Many a -> m (Many b) # sequence :: Monad m => Many (m a) -> m (Many a) #
Semigroup Inlines Source #
Instance details Defined in Text.Pandoc.Builder Methods (<>) :: Inlines -> Inlines -> Inlines # sconcat :: NonEmpty Inlines -> Inlines # stimes :: Integral b => b -> Inlines -> Inlines #
Monoid Inlines Source #
Instance details Defined in Text.Pandoc.Builder Methods mempty :: Inlines # mappend :: Inlines -> Inlines -> Inlines # mconcat :: [Inlines] -> Inlines #
Arbitrary Blocks Source #
Instance details Defined in Text.Pandoc.Arbitrary Methods arbitrary :: Gen Blocks # shrink :: Blocks -> [Blocks] #
Arbitrary Inlines Source #
Instance details Defined in Text.Pandoc.Arbitrary Methods arbitrary :: Gen Inlines # shrink :: Inlines -> [Inlines] #
ToMetaValue Blocks Source #
Instance details Defined in Text.Pandoc.Builder Methods toMetaValue :: Blocks -> MetaValue Source #
ToMetaValue Inlines Source #
Instance details Defined in Text.Pandoc.Builder Methods toMetaValue :: Inlines -> MetaValue Source #
ToMetaValue Blocks Source #
Instance details Defined in Text.Pandoc.Legacy.Builder Methods toMetaValue :: Blocks -> MetaValue Source #
ToMetaValue Inlines Source #
Instance details Defined in Text.Pandoc.Legacy.Builder Methods toMetaValue :: Inlines -> MetaValue Source #
Eq a => Eq (Many a) Source #
Instance details Defined in Text.Pandoc.Builder Methods (==) :: Many a -> Many a -> Bool # (/=) :: Many a -> Many a -> Bool #
Data a => Data (Many a) Source #
Instance details Defined in Text.Pandoc.Builder Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Many a -> c (Many a) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Many a) # toConstr :: Many a -> Constr # dataTypeOf :: Many a -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Many a)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Many a)) # gmapT :: (forall b. Data b => b -> b) -> Many a -> Many a # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Many a -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Many a -> r # gmapQ :: (forall d. Data d => d -> u) -> Many a -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Many a -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Many a -> m (Many a) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Many a -> m (Many a) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Many a -> m (Many a) #
Ord a => Ord (Many a) Source #
Instance details Defined in Text.Pandoc.Builder Methods compare :: Many a -> Many a -> Ordering # (<) :: Many a -> Many a -> Bool # (<=) :: Many a -> Many a -> Bool # (>) :: Many a -> Many a -> Bool # (>=) :: Many a -> Many a -> Bool # max :: Many a -> Many a -> Many a # min :: Many a -> Many a -> Many a #
Read a => Read (Many a) Source #
Instance details Defined in Text.Pandoc.Builder Methods readsPrec :: Int -> ReadS (Many a) # readList :: ReadS [Many a] # readPrec :: ReadPrec (Many a) # readListPrec :: ReadPrec [Many a] #
Show a => Show (Many a) Source #
Instance details Defined in Text.Pandoc.Builder Methods showsPrec :: Int -> Many a -> ShowS # show :: Many a -> String # showList :: [Many a] -> ShowS #
Generic (Many a) Source #
Instance details Defined in Text.Pandoc.Builder Associated Types type Rep (Many a) :: Type -> Type # Methods from :: Many a -> Rep (Many a) x # to :: Rep (Many a) x -> Many a #
Semigroup (Many Block) Source #
Instance details Defined in Text.Pandoc.Builder Methods (<>) :: Many Block -> Many Block -> Many Block # sconcat :: NonEmpty (Many Block) -> Many Block # stimes :: Integral b => b -> Many Block -> Many Block #
Monoid (Many Block) Source #
Instance details Defined in Text.Pandoc.Builder Methods mempty :: Many Block # mappend :: Many Block -> Many Block -> Many Block # mconcat :: [Many Block] -> Many Block #
type Rep (Many a) Source #
Instance details Defined in Text.Pandoc.Builder type Rep (Many a) = D1 (MetaData "Many" "Text.Pandoc.Builder" "pandoc-types-1.20-5nkXw29dlS6KAIqq5ek52Y" True) (C1 (MetaCons "Many" PrefixI True) (S1 (MetaSel (Just "unMany") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Seq a))))

type Inlines = Many Inline Source #

type Blocks = Many Block Source #

(<>) :: Semigroup a => a -> a -> a infixr 6 #

An associative operation.

singleton :: a -> Many a Source #

toList :: Many a -> [a] Source #

fromList :: [a] -> Many a Source #

isNull :: Many a -> Bool Source #

Document builders

doc :: Blocks -> Pandoc Source #

class ToMetaValue a where Source #

Methods

toMetaValue :: a -> MetaValue Source #

Instances

ToMetaValue Bool Source #
Instance details Defined in Text.Pandoc.Builder Methods toMetaValue :: Bool -> MetaValue Source #
ToMetaValue String Source #
Instance details Defined in Text.Pandoc.Builder Methods toMetaValue :: String -> MetaValue Source #
ToMetaValue Text Source #
Instance details Defined in Text.Pandoc.Builder Methods toMetaValue :: Text -> MetaValue Source #
ToMetaValue MetaValue Source #
Instance details Defined in Text.Pandoc.Builder Methods toMetaValue :: MetaValue -> MetaValue Source #
ToMetaValue Blocks Source #
Instance details Defined in Text.Pandoc.Builder Methods toMetaValue :: Blocks -> MetaValue Source #
ToMetaValue Inlines Source #
Instance details Defined in Text.Pandoc.Builder Methods toMetaValue :: Inlines -> MetaValue Source #
ToMetaValue a => ToMetaValue [a] Source #
Instance details Defined in Text.Pandoc.Builder Methods toMetaValue :: [a] -> MetaValue Source #
ToMetaValue a => ToMetaValue (Map String a) Source #
Instance details Defined in Text.Pandoc.Builder Methods toMetaValue :: Map String a -> MetaValue Source #
ToMetaValue a => ToMetaValue (Map Text a) Source #
Instance details Defined in Text.Pandoc.Builder Methods toMetaValue :: Map Text a -> MetaValue Source #

class HasMeta a where Source #

Methods

setMeta :: ToMetaValue b => Text -> b -> a -> a Source #

deleteMeta :: Text -> a -> a Source #

Instances

HasMeta Meta Source #
Instance details Defined in Text.Pandoc.Builder Methods setMeta :: ToMetaValue b => Text -> b -> Meta -> Meta Source # deleteMeta :: Text -> Meta -> Meta Source #
HasMeta Pandoc Source #
Instance details Defined in Text.Pandoc.Builder Methods setMeta :: ToMetaValue b => Text -> b -> Pandoc -> Pandoc Source # deleteMeta :: Text -> Pandoc -> Pandoc Source #