Copyright	Copyright (C) 2006-2010 John MacFarlane
License	GNU GPL, version 2 or above
Maintainer	John MacFarlane <jgm@berkeley.edu>
Stability	alpha
Portability	portable
Safe Haskell	None
Language	Haskell98

Text.Pandoc.Definition

Description

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

Synopsis

Documentation

data Pandoc Source

Constructors

Pandoc Meta [Block]

newtype Meta Source

Metadata for the document: title, authors, date.

Constructors

Meta
Fields unMeta :: Map String MetaValue

nullMeta :: Meta Source

isNullMeta :: Meta -> Bool Source

lookupMeta :: String -> Meta -> Maybe MetaValue Source

Retrieve the metadata value for a given key.

docTitle :: Meta -> [Inline] Source

Extract document title from metadata; works just like the old docTitle.

docAuthors :: Meta -> [[Inline]] Source

Extract document authors from metadata; works just like the old docAuthors.

docDate :: Meta -> [Inline] Source

Extract date from metadata; works just like the old docDate.

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 (required), relative column widths (0 = default), column headers (each a list of blocks), and rows (each a list of lists of blocks)
Div Attr [Block]	Generic block container with attributes
Null	Nothing

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
Span Attr [Inline]	Generic inline container with attributes

data Alignment Source

Alignment of a table column.

Constructors

AlignLeft
AlignRight
AlignCenter
AlignDefault

type ListAttributes = (Int, ListNumberStyle, ListNumberDelim) Source

List attributes.

data ListNumberStyle Source

Style of list numbers.

Constructors

DefaultStyle
Example
Decimal
LowerRoman
UpperRoman
LowerAlpha
UpperAlpha

data ListNumberDelim Source

Delimiter of list numbers.

Constructors

DefaultDelim
Period
OneParen
TwoParens

newtype Format Source

Formats for raw blocks

Constructors

Format String

Instances

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

Attributes: identifier, classes, key-value pairs

nullAttr :: Attr Source

type TableCell = [Block] Source

Table cells are list of Blocks

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 Citation Source

Constructors

Citation
Fields citationId :: String citationPrefix :: [Inline] citationSuffix :: [Inline] citationMode :: CitationMode citationNoteNum :: Int citationHash :: Int

Eq Pandoc Source
Data Pandoc Source
Ord Pandoc Source
Read Pandoc Source
Show Pandoc Source
Generic Pandoc Source
ToJSON Pandoc Source
FromJSON Pandoc Source
Monoid Pandoc Source
NFData Pandoc Source
HasMeta Pandoc Source
Walkable Inline Pandoc Source
Walkable Block Pandoc Source
Walkable Pandoc Pandoc Source
type Rep Pandoc Source

Eq Meta Source
Data Meta Source
Ord Meta Source
Read Meta Source
Show Meta Source
Generic Meta Source
ToJSON Meta Source
FromJSON Meta Source
Monoid Meta Source
NFData Meta Source
HasMeta Meta Source
Walkable Inline Meta Source
Walkable Block Meta Source
Walkable Meta Meta Source
type Rep Meta Source

MetaMap (Map String MetaValue)
MetaList [MetaValue]
MetaBool Bool
MetaString String
MetaInlines [Inline]
MetaBlocks [Block]

Eq MetaValue Source
Data MetaValue Source
Ord MetaValue Source
Read MetaValue Source
Show MetaValue Source
Generic MetaValue Source
ToJSON MetaValue Source
FromJSON MetaValue Source
NFData MetaValue Source
ToMetaValue MetaValue Source
Walkable Inline MetaValue Source
Walkable Block MetaValue Source
type Rep MetaValue Source

Eq Block Source
Data Block Source
Ord Block Source
Read Block Source
Show Block Source
Generic Block Source
ToJSON Block Source
FromJSON Block Source
NFData Block Source
ToMetaValue Blocks Source
Walkable Inline Block Source
Walkable Block Citation Source
Walkable Block Inline Source
Walkable Block Block Source
Walkable Block MetaValue Source
Walkable Block Meta Source
Walkable Block Pandoc Source
Monoid (Many Block)
type Rep Block Source

Eq Inline Source
Data Inline Source
Ord Inline Source
Read Inline Source
Show Inline Source
IsString Inlines
Generic Inline Source
ToJSON Inline Source
FromJSON Inline Source
Monoid Inlines
NFData Inline Source
ToMetaValue Inlines Source
Walkable Inline Citation Source
Walkable Inline Inline Source
Walkable Inline Block Source
Walkable Inline MetaValue Source
Walkable Inline Meta Source
Walkable Inline Pandoc Source
Walkable Block Inline Source
type Rep Inline Source

Eq Alignment Source
Data Alignment Source
Ord Alignment Source
Read Alignment Source
Show Alignment Source
Generic Alignment Source
ToJSON Alignment Source
FromJSON Alignment Source
NFData Alignment Source
type Rep Alignment Source

Eq ListNumberStyle Source
Data ListNumberStyle Source
Ord ListNumberStyle Source
Read ListNumberStyle Source
Show ListNumberStyle Source
Generic ListNumberStyle Source
ToJSON ListNumberStyle Source
FromJSON ListNumberStyle Source
NFData ListNumberStyle Source
type Rep ListNumberStyle Source

Eq ListNumberDelim Source
Data ListNumberDelim Source
Ord ListNumberDelim Source
Read ListNumberDelim Source
Show ListNumberDelim Source
Generic ListNumberDelim Source
ToJSON ListNumberDelim Source
FromJSON ListNumberDelim Source
NFData ListNumberDelim Source
type Rep ListNumberDelim Source

Eq Format Source
Data Format Source
Ord Format Source
Read Format Source
Show Format Source
IsString Format Source
Generic Format Source
ToJSON Format Source
FromJSON Format Source
NFData Format Source
ToJSONFilter a => ToJSONFilter (Maybe Format -> a) Source
type Rep Format Source

Eq QuoteType Source
Data QuoteType Source
Ord QuoteType Source
Read QuoteType Source
Show QuoteType Source
Generic QuoteType Source
ToJSON QuoteType Source
FromJSON QuoteType Source
NFData QuoteType Source
type Rep QuoteType Source

Eq MathType Source
Data MathType Source
Ord MathType Source
Read MathType Source
Show MathType Source
Generic MathType Source
ToJSON MathType Source
FromJSON MathType Source
NFData MathType Source
type Rep MathType Source

Eq Citation Source
Data Citation Source
Ord Citation Source
Read Citation Source
Show Citation Source
Generic Citation Source
ToJSON Citation Source
FromJSON Citation Source
NFData Citation Source
Walkable Inline Citation Source
Walkable Block Citation Source
type Rep Citation Source

Eq CitationMode Source
Data CitationMode Source
Ord CitationMode Source
Read CitationMode Source
Show CitationMode Source
Generic CitationMode Source
ToJSON CitationMode Source
FromJSON CitationMode Source
NFData CitationMode Source
type Rep CitationMode Source