Tissevert/pandoc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions1

Doc fixes in Text.Pandoc.

Browse source
This commit is contained in:
John MacFarlane 2012-01-24 20:49:05 -08:00
parent 0f60e0cf76
commit f7ed8d5ddc
1 changed files with 9 additions and 10 deletions

19
src/Text/Pandoc.hs
View file

@ -215,13 +215,12 @@ jsonFilter :: (Pandoc -> Pandoc) -> String -> String
jsonFilter f = encodeJSON . f . decodeJSON jsonFilter f = encodeJSON . f . decodeJSON
-- | 'toJsonFilter' convert a function into a filter that reads pandoc's json output -- | 'toJsonFilter' convert a function into a filter that reads pandoc's json output
-- from stdin, transforms it, and writes it to stdout. Usage example: -- from stdin, transforms it by walking the AST and applying the specified
-- function, and writes the result as json to stdout. Usage example:
-- --
-- > -- capitalize.hs -- > -- capitalize.hs
-- > -- compile with: -- > -- compile with: ghc --make capitalize
-- > -- ghc --make capitalize -- > -- run with: pandoc -t json | ./capitalize | pandoc -f json
-- > -- run with:
-- > -- pandoc -t json | ./capitalize | pandoc -f json
-- > -- >
-- > import Text.Pandoc -- > import Text.Pandoc
-- > import Data.Char (toUpper) -- > import Data.Char (toUpper)
@ -233,10 +232,11 @@ jsonFilter f = encodeJSON . f . decodeJSON
-- > capitalizeStrings (Str s) = Str $ map toUpper s -- > capitalizeStrings (Str s) = Str $ map toUpper s
-- > capitalizeStrings x = x -- > capitalizeStrings x = x
-- --
-- The function can be any type @(a -> a)@ or @(a -> IO a)@, where @a@ -- The function can be any type @(a -> a)@, @(a -> IO a)@, @(a -> [a])@,
-- is an instance of 'Data'. So, for example, @a@ can be 'Pandoc', -- or @(a -> IO [a])@, where @a@ is an instance of 'Data'.
-- 'Inline', 'Block', ['Inline'], ['Block'], 'Meta', 'ListNumberStyle', -- So, for example, @a@ can be 'Pandoc', 'Inline', 'Block', ['Inline'],
-- 'Alignment', 'ListNumberDelim', 'QuoteType', etc. See 'Text.Pandoc.Definition'. -- ['Block'], 'Meta', 'ListNumberStyle', 'Alignment', 'ListNumberDelim',
-- 'QuoteType', etc. See 'Text.Pandoc.Definition'.
class ToJsonFilter a where class ToJsonFilter a where
toJsonFilter :: a -> IO () toJsonFilter :: a -> IO ()
@ -256,4 +256,3 @@ instance (Data a) => ToJsonFilter (a -> IO [a]) where
toJsonFilter f = getContents toJsonFilter f = getContents
>>= (bottomUpM (fmap concat . mapM f) :: Pandoc -> IO Pandoc) . decodeJSON >>= (bottomUpM (fmap concat . mapM f) :: Pandoc -> IO Pandoc) . decodeJSON
>>= putStr . encodeJSON >>= putStr . encodeJSON