pandoc-types-1.10: Types for representing a structured document

Portabilityportable
Stabilityalpha
MaintainerJohn MacFarlane <jgm@berkeley.edu>
Safe HaskellNone

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

type TableCell = [Block]Source

Table cells are list of Blocks

type Format = StringSource

Formats for raw blocks

data Block Source

Block element.

Constructors

Plain [Inline]

Plain text, not a paragraph

Para [Inline]

Paragraph

CodeBlock Attr String

Code block (literal) with attributes

RawBlock Format String

Raw block

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 Attr [Inline]

Header - level (integer) and text (inlines)

HorizontalRule

Horizontal rule

Table [Inline] [Alignment] [Double] [TableCell] [[TableCell]]

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 [Citation] [Inline]

Citation (list of inlines)

Code Attr String

Inline code (literal)

Space

Inter-word space

LineBreak

Hard line break

Math MathType String

TeX math (literal)

RawInline Format String

Raw inline

Link [Inline] Target

Hyperlink: text (list of inlines), target

Image [Inline] Target

Image: alt text (list of inlines), target

Note [Block]

Footnote or endnote