pandoc-1.5: Conversion between markup formats

Portabilityportable
Stabilityalpha
MaintainerJohn MacFarlane <jgm@berkeley.edu>

Text.Pandoc.Definition

Description

Definition of Pandoc data structure for format-neutral representation of documents.

Synopsis

Documentation

data Meta Source

Bibliographic information for the document: title, authors, date.

Constructors

Meta 

Fields

docTitle :: [Inline]
 
docAuthors :: [[Inline]]
 
docDate :: [Inline]
 

type Attr = (String, [String], [(String, String)])Source

Attributes: identifier, classes, key-value pairs

data Block Source

Block element.

Constructors

Plain [Inline]

Plain text, not a paragraph

Para [Inline]

Paragraph

CodeBlock Attr String

Code block (literal) with attributes

RawHtml String

Raw HTML block (literal)

BlockQuote [Block]

Block quote (list of blocks)

OrderedList ListAttributes [[Block]]

Ordered list (attributes and a list of items, each a list of blocks)

BulletList [[Block]]

Bullet list (list of items, each a list of blocks)

DefinitionList [([Inline], [[Block]])]

Definition list Each list item is a pair consisting of a term (a list of inlines) and one or more definitions (each a list of blocks)

Header Int [Inline]

Header - level (integer) and text (inlines)

HorizontalRule

Horizontal rule

Table [Inline] [Alignment] [Double] [[Block]] [[[Block]]]

Table, with caption, column alignments, relative column widths (0 = default), column headers (each a list of blocks), and rows (each a list of lists of blocks)

Null

Nothing

data QuoteType Source

Type of quotation marks to use in Quoted inline.

Constructors

SingleQuote 
DoubleQuote 

type Target = (String, String)Source

Link target (URL, title).

data MathType Source

Type of math element (display or inline).

Constructors

DisplayMath 
InlineMath 

data Inline Source

Inline elements.

Constructors

Str String

Text (string)

Emph [Inline]

Emphasized text (list of inlines)

Strong [Inline]

Strongly emphasized text (list of inlines)

Strikeout [Inline]

Strikeout text (list of inlines)

Superscript [Inline]

Superscripted text (list of inlines)

Subscript [Inline]

Subscripted text (list of inlines)

SmallCaps [Inline]

Small caps text (list of inlines)

Quoted QuoteType [Inline]

Quoted text (list of inlines)

Cite [Target] [Inline]

Citation (list of inlines)

Code String

Inline code (literal)

Space

Inter-word space

EmDash

Em dash

EnDash

En dash

Apostrophe

Apostrophe

Ellipses

Ellipses

LineBreak

Hard line break

Math MathType String

TeX math (literal)

TeX String

LaTeX code (literal)

HtmlInline String

HTML code (literal)

Link [Inline] Target

Hyperlink: text (list of inlines), target

Image [Inline] Target

Image: alt text (list of inlines), target and target

Note [Block]

Footnote or endnote

processWith :: (Data a, Data b) => (a -> a) -> b -> bSource

Applies a transformation on as to matching elements in a b.

processWithM :: (Monad m, Data a, Data b) => (a -> m a) -> b -> m bSource

Like processWith, but with monadic transformations.

queryWith :: (Data a, Data c) => (a -> [b]) -> c -> [b]Source

Runs a query on matching a elements in a c.

processPandoc :: Data a => (a -> a) -> Pandoc -> PandocSource

queryPandoc :: Data a => (a -> [b]) -> Pandoc -> [b]Source