Text.Pandoc.Lens

This provides a variety of optics for traversing and destructuring Pandoc documents.

Note that both Inline, Block, and MetaValue have Plated instances which are useful for traversing the AST.

Documents

data Pandoc :: *

Instances

Eq Pandoc

Data Pandoc

Ord Pandoc

Read Pandoc

Show Pandoc

Generic Pandoc

ToJSON Pandoc

FromJSON Pandoc

Monoid Pandoc

NFData Pandoc

type Rep Pandoc = D1 D1Pandoc (C1 C1_0Pandoc ((:*:) (S1 NoSelector (Rec0 Meta)) (S1 NoSelector (Rec0 [Block]))))

body :: Lens' Pandoc [Block]

The body of a pandoc document

meta :: String -> Traversal' Pandoc MetaValue

A traversal focusing on a particular metadata value of a document

Blocks

Prisms are provided for the constructors of Block as well as a Plated instance.

data Block :: *

Block element.

Instances

Eq Block

Data Block

Ord Block

Read Block

Show Block

Generic Block

ToJSON Block

FromJSON Block

NFData Block

HasAttr Block

type Rep Block = D1 D1Block ((:+:) ((:+:) ((:+:) (C1 C1_0Block (S1 NoSelector (Rec0 [Inline]))) ((:+:) (C1 C1_1Block (S1 NoSelector (Rec0 [Inline]))) (C1 C1_2Block ((:*:) (S1 NoSelector (Rec0 Attr)) (S1 NoSelector (Rec0 String)))))) ((:+:) (C1 C1_3Block ((:*:) (S1 NoSelector (Rec0 Format)) (S1 NoSelector (Rec0 String)))) ((:+:) (C1 C1_4Block (S1 NoSelector (Rec0 [Block]))) (C1 C1_5Block ((:*:) (S1 NoSelector (Rec0 ListAttributes)) (S1 NoSelector (Rec0 [[Block]]))))))) ((:+:) ((:+:) (C1 C1_6Block (S1 NoSelector (Rec0 [[Block]]))) ((:+:) (C1 C1_7Block (S1 NoSelector (Rec0 [([Inline], [[Block]])]))) (C1 C1_8Block ((:*:) (S1 NoSelector (Rec0 Int)) ((:*:) (S1 NoSelector (Rec0 Attr)) (S1 NoSelector (Rec0 [Inline]))))))) ((:+:) ((:+:) (C1 C1_9Block U1) (C1 C1_10Block ((:*:) ((:*:) (S1 NoSelector (Rec0 [Inline])) (S1 NoSelector (Rec0 [Alignment]))) ((:*:) (S1 NoSelector (Rec0 [Double])) ((:*:) (S1 NoSelector (Rec0 [TableCell])) (S1 NoSelector (Rec0 [[TableCell]]))))))) ((:+:) (C1 C1_11Block ((:*:) (S1 NoSelector (Rec0 Attr)) (S1 NoSelector (Rec0 [Block])))) (C1 C1_12Block U1)))))

blockInlines :: Traversal' Block Inline

Traverse over the Inline children of a Block

_Plain :: Prism' Block [Inline]

A prism on a Plain Block

_Para :: Prism' Block [Inline]

A prism on a paragraph Block

_CodeBlock :: Prism' Block String

A prism on the text of a CodeBlock

_BlockQuote :: Prism' Block [Block]

A prism on a BlockQuote

_OrderedList :: Prism' Block (ListAttributes, [[Block]])

A prism on the items of a bullet list Block

_BulletList :: Prism' Block [[Block]]

A prism on the items of a bullet list Block

_DefinitionList :: Prism' Block [([Inline], [[Block]])]

A prism on the items of a definition list Block

_Header :: Prism' Block (Int, [Inline])

A prism on a Header Block

_HorizontalRule :: Prism' Block ()

A prism on a HorizontalRule Block

_Div :: Prism' Block [Block]

A prism on a Div Block

_Null :: Prism' Block ()

A prism on a Null Block

Inlines

Prisms are provided for the constructors of Inline as well as a Plated instance.

data Inline :: *

Inline elements.

Instances

Eq Inline

Data Inline

Ord Inline

Read Inline

Show Inline

Generic Inline

ToJSON Inline

FromJSON Inline

NFData Inline

HasAttr Inline

type Rep Inline = D1 D1Inline ((:+:) ((:+:) ((:+:) ((:+:) (C1 C1_0Inline (S1 NoSelector (Rec0 String))) (C1 C1_1Inline (S1 NoSelector (Rec0 [Inline])))) ((:+:) (C1 C1_2Inline (S1 NoSelector (Rec0 [Inline]))) (C1 C1_3Inline (S1 NoSelector (Rec0 [Inline]))))) ((:+:) ((:+:) (C1 C1_4Inline (S1 NoSelector (Rec0 [Inline]))) (C1 C1_5Inline (S1 NoSelector (Rec0 [Inline])))) ((:+:) (C1 C1_6Inline (S1 NoSelector (Rec0 [Inline]))) ((:+:) (C1 C1_7Inline ((:*:) (S1 NoSelector (Rec0 QuoteType)) (S1 NoSelector (Rec0 [Inline])))) (C1 C1_8Inline ((:*:) (S1 NoSelector (Rec0 [Citation])) (S1 NoSelector (Rec0 [Inline])))))))) ((:+:) ((:+:) ((:+:) (C1 C1_9Inline ((:*:) (S1 NoSelector (Rec0 Attr)) (S1 NoSelector (Rec0 String)))) (C1 C1_10Inline U1)) ((:+:) (C1 C1_11Inline U1) (C1 C1_12Inline ((:*:) (S1 NoSelector (Rec0 MathType)) (S1 NoSelector (Rec0 String)))))) ((:+:) ((:+:) (C1 C1_13Inline ((:*:) (S1 NoSelector (Rec0 Format)) (S1 NoSelector (Rec0 String)))) (C1 C1_14Inline ((:*:) (S1 NoSelector (Rec0 [Inline])) (S1 NoSelector (Rec0 Target))))) ((:+:) (C1 C1_15Inline ((:*:) (S1 NoSelector (Rec0 [Inline])) (S1 NoSelector (Rec0 Target)))) ((:+:) (C1 C1_16Inline (S1 NoSelector (Rec0 [Block]))) (C1 C1_17Inline ((:*:) (S1 NoSelector (Rec0 Attr)) (S1 NoSelector (Rec0 [Inline])))))))))

_Str :: Prism' Inline String

A prism on a Str Inline

_Emph :: Prism' Inline [Inline]

A prism on an Emph Inline

_Strong :: Prism' Inline [Inline]

A prism on a Strong Inline

_Strikeout :: Prism' Inline [Inline]

A prism on a Strikeout Inline

_Superscript :: Prism' Inline [Inline]

A prism on a Superscript Inline

_Subscript :: Prism' Inline [Inline]

A prism on a Subscript Inline

_SmallCaps :: Prism' Inline [Inline]

A prism on a SmallCaps Inline

_Quoted :: Prism' Inline (QuoteType, [Inline])

A prism on a Quoted Inline

_Cite :: Prism' Inline ([Citation], [Inline])

A prism on a Cite Inline

_Code :: Prism' Inline String

A prism on the body of a Code Inline

_Space :: Prism' Inline ()

A prism on a Space Inline

_LineBreak :: Prism' Inline ()

A prism on a LineBreak Inline

_Math :: Prism' Inline (MathType, String)

A prism on a Math Inline

_RawInline :: Prism' Inline (Format, String)

A prism on a RawInline Inline

_Link :: Prism' Inline ([Inline], Target)

A prism on a Link Inline

_Image :: Prism' Inline ([Inline], Target)

A prism on a Image Inline

_Note :: Prism' Inline [Block]

A prism on a Note Inline

_Span :: Prism' Inline [Inline]

A prism on a Span Inline

Metadata

Prisms are provided for the constructors of MetaValue as well as a Plated instance.

data MetaValue :: *

Instances

Eq MetaValue

Data MetaValue

Ord MetaValue

Read MetaValue

Show MetaValue

Generic MetaValue

ToJSON MetaValue

FromJSON MetaValue

NFData MetaValue

type Rep MetaValue = D1 D1MetaValue ((:+:) ((:+:) (C1 C1_0MetaValue (S1 NoSelector (Rec0 (Map String MetaValue)))) ((:+:) (C1 C1_1MetaValue (S1 NoSelector (Rec0 [MetaValue]))) (C1 C1_2MetaValue (S1 NoSelector (Rec0 Bool))))) ((:+:) (C1 C1_3MetaValue (S1 NoSelector (Rec0 String))) ((:+:) (C1 C1_4MetaValue (S1 NoSelector (Rec0 [Inline]))) (C1 C1_5MetaValue (S1 NoSelector (Rec0 [Block]))))))

_MetaMap :: Prism' MetaValue (Map String MetaValue)

A prism on a piece of MetaMap metadata

_MetaList :: Prism' MetaValue [MetaValue]

A prism on a piece of MetaList metadata

_MetaBool :: Prism' MetaValue Bool

A prism on a piece of MetaBool metadata

_MetaString :: Prism' MetaValue String

A prism on a piece of MetaString metadata

_MetaInlines :: Prism' MetaValue [Inline]

A prism on a piece of MetaInlines metadata

_MetaBlocks :: Prism' MetaValue [Block]

A prism on a piece of MetaBlocks metadata

Attributes

class HasAttr a where

An object that has attributes

Methods

attributes :: Traversal' a Attr

A traversal over the attributes of an object

Instances

HasAttr Block

HasAttr Inline

attrIdentifier :: Lens' Attr String

A lens onto identifier of an Attr

attrClasses :: Lens' Attr [String]

A lens onto classes of an Attr

attrs :: Lens' Attr [(String, String)]

A lens onto the key-value pairs of an Attr