pandoc-0.42: Conversion between markup formats Contents Index

Text.Pandoc.Definition Portability portable Stability alpha Maintainer John MacFarlane <jgm@berkeley.edu>

Description

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

Synopsis

data Pandoc = Pandoc Meta [Block] data Meta = Meta [Inline] [String] String data Alignment = AlignLeft | AlignRight | AlignCenter | AlignDefault type ListAttributes = (Int, ListNumberStyle, ListNumberDelim) data ListNumberStyle = DefaultStyle | Decimal | LowerRoman | UpperRoman | LowerAlpha | UpperAlpha data ListNumberDelim = DefaultDelim | Period | OneParen | TwoParens data Block = Plain [Inline] | Para [Inline] | CodeBlock String | RawHtml String | BlockQuote [Block] | OrderedList ListAttributes [[Block]] | BulletList [[Block]] | DefinitionList [([Inline], [Block])] | Header Int [Inline] | HorizontalRule | Table [Inline] [Alignment] [Float] [[Block]] [[[Block]]] | Null data QuoteType = SingleQuote | DoubleQuote type Target = (String, String) data Inline = Str String | Emph [Inline] | Strong [Inline] | Strikeout [Inline] | Superscript [Inline] | Subscript [Inline] | Quoted QuoteType [Inline] | Code String | Space | EmDash | EnDash | Apostrophe | Ellipses | LineBreak | TeX String | HtmlInline String | Link [Inline] Target | Image [Inline] Target | Note [Block]

Documentation

data Pandoc

Constructors Pandoc Meta [Block] Instances Eq Pandoc Read Pandoc Show Pandoc

data Meta

Bibliographic information for the document: title (list of Inline), authors (list of strings), date (string). Constructors Meta [Inline] [String] String Instances Eq Meta Read Meta Show Meta

data Alignment

Alignment of a table column. Constructors AlignLeft AlignRight AlignCenter AlignDefault Instances Eq Alignment Read Alignment Show Alignment

type ListAttributes = (Int, ListNumberStyle, ListNumberDelim)

List attributes.

data ListNumberStyle

Style of list numbers. Constructors DefaultStyle Decimal LowerRoman UpperRoman LowerAlpha UpperAlpha Instances Eq ListNumberStyle Read ListNumberStyle Show ListNumberStyle

data ListNumberDelim

Delimiter of list numbers. Constructors DefaultDelim Period OneParen TwoParens Instances Eq ListNumberDelim Read ListNumberDelim Show ListNumberDelim

data Block

Block element. Constructors Plain [Inline] Plain text, not a paragraph Para [Inline] Paragraph CodeBlock String Code block (literal) 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 (list of items, each a pair of an inline list, the term, and a block list) Header Int [Inline] Header - level (integer) and text (inlines) HorizontalRule Horizontal rule Table [Inline] [Alignment] [Float] [[Block]] [[[Block]]] Table, with caption, column alignments, relative column widths, column headers (each a list of blocks), and rows (each a list of lists of blocks) Null Nothing Instances Eq Block Read Block Show Block

data QuoteType

Type of quotation marks to use in Quoted inline. Constructors SingleQuote DoubleQuote Instances Eq QuoteType Read QuoteType Show QuoteType

type Target

= (String, String) Link target (URL, title)

data Inline

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) Quoted QuoteType [Inline] Quoted text (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 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 Instances Eq Inline Read Inline Show Inline

Produced by Haddock version 0.8