| 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.
- data Pandoc = Pandoc Meta [Block]
- newtype Meta = Meta {}
- data MetaValue
- = MetaMap (Map String MetaValue)
- | MetaList [MetaValue]
- | MetaBool Bool
- | MetaString String
- | MetaInlines [Inline]
- | MetaBlocks [Block]
- nullMeta :: Meta
- isNullMeta :: Meta -> Bool
- lookupMeta :: String -> Meta -> Maybe MetaValue
- docTitle :: Meta -> [Inline]
- docAuthors :: Meta -> [[Inline]]
- docDate :: Meta -> [Inline]
- data Block
- = Plain [Inline]
- | Para [Inline]
- | CodeBlock Attr String
- | RawBlock Format String
- | BlockQuote [Block]
- | OrderedList ListAttributes [[Block]]
- | BulletList [[Block]]
- | DefinitionList [([Inline], [[Block]])]
- | Header Int Attr [Inline]
- | HorizontalRule
- | Table [Inline] [Alignment] [Double] [TableCell] [[TableCell]]
- | Div Attr [Block]
- | Null
- data Inline
- = Str String
- | Emph [Inline]
- | Strong [Inline]
- | Strikeout [Inline]
- | Superscript [Inline]
- | Subscript [Inline]
- | SmallCaps [Inline]
- | Quoted QuoteType [Inline]
- | Cite [Citation] [Inline]
- | Code Attr String
- | Space
- | LineBreak
- | Math MathType String
- | RawInline Format String
- | Link [Inline] Target
- | Image [Inline] Target
- | Note [Block]
- | Span Attr [Inline]
- data Alignment
- type ListAttributes = (Int, ListNumberStyle, ListNumberDelim)
- data ListNumberStyle
- data ListNumberDelim
- newtype Format = Format String
- type Attr = (String, [String], [(String, String)])
- nullAttr :: Attr
- type TableCell = [Block]
- data QuoteType
- type Target = (String, String)
- data MathType
- data Citation = Citation {}
- data CitationMode
Documentation
data Pandoc
newtype Meta
Metadata for the document: title, authors, date.
data MetaValue
Constructors
| MetaMap (Map String MetaValue) | |
| MetaList [MetaValue] | |
| MetaBool Bool | |
| MetaString String | |
| MetaInlines [Inline] | |
| MetaBlocks [Block] |
isNullMeta :: Meta -> Bool
lookupMeta :: String -> Meta -> Maybe MetaValue
Retrieve the metadata value for a given key.
docAuthors :: Meta -> [[Inline]]
Extract document authors from metadata; works just like the old
docAuthors.
data Block
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 |
Instances
| Eq Block | |
| Data Block | |
| Ord Block | |
| Read Block | |
| Show Block | |
| Generic Block | |
| ToJSON Block | |
| FromJSON Block | |
| ToMetaValue Blocks | |
| Typeable * Block | |
| Walkable Inline Block | |
| Walkable Block Citation | |
| Walkable Block Inline | |
| Walkable Block Block | |
| Walkable Block MetaValue | |
| Walkable Block Meta | |
| Walkable Block Pandoc | |
| Monoid (Many Block) | |
| type Rep Block |
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) |
| 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 |
Instances
type ListAttributes = (Int, ListNumberStyle, ListNumberDelim)
List attributes.
data ListNumberStyle
Style of list numbers.
Constructors
| DefaultStyle | |
| Example | |
| Decimal | |
| LowerRoman | |
| UpperRoman | |
| LowerAlpha | |
| UpperAlpha |
Instances
data ListNumberDelim
Delimiter of list numbers.
Constructors
| DefaultDelim | |
| Period | |
| OneParen | |
| TwoParens |
Instances
newtype Format
Formats for raw blocks
data Citation
Constructors
| Citation | |
Fields
| |
data CitationMode
Constructors
| AuthorInText | |
| SuppressAuthor | |
| NormalCitation |
Instances
| Eq CitationMode | |
| Data CitationMode | |
| Ord CitationMode | |
| Read CitationMode | |
| Show CitationMode | |
| Generic CitationMode | |
| ToJSON CitationMode | |
| FromJSON CitationMode | |
| Typeable * CitationMode | |
| type Rep CitationMode |