Copyright | Copyright (C) 2006-2016 John MacFarlane |
---|---|
License | BSD3 |
Maintainer | John MacFarlane <jgm@berkeley.edu> |
Stability | alpha |
Portability | portable |
Safe Haskell | None |
Language | Haskell98 |
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]
- | LineBlock [[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
- | SoftBreak
- | LineBreak
- | Math MathType String
- | RawInline Format String
- | Link Attr [Inline] Target
- | Image Attr [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
- pandocTypesVersion :: Version
Documentation
Eq Pandoc Source # | |
Data Pandoc Source # | |
Ord Pandoc Source # | |
Read Pandoc Source # | |
Show Pandoc Source # | |
Generic Pandoc Source # | |
Monoid Pandoc Source # | |
NFData Pandoc Source # | |
ToJSON Pandoc Source # | |
FromJSON Pandoc Source # | |
HasMeta Pandoc Source # | |
Walkable Inline Pandoc Source # | |
Walkable Block Pandoc Source # | |
Walkable Pandoc Pandoc Source # | |
type Rep Pandoc Source # | |
Metadata for the document: title, authors, date.
Eq Meta Source # | |
Data Meta Source # | |
Ord Meta Source # | |
Read Meta Source # | |
Show Meta Source # | |
Generic Meta Source # | |
Monoid Meta Source # | |
NFData Meta Source # | |
ToJSON Meta Source # | |
FromJSON 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 # | |
NFData MetaValue Source # | |
ToJSON MetaValue Source # | |
FromJSON MetaValue Source # | |
ToMetaValue MetaValue Source # | |
Walkable Inline MetaValue Source # | |
Walkable Block MetaValue Source # | |
type Rep MetaValue 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
.
Block element.
Plain [Inline] | Plain text, not a paragraph |
Para [Inline] | Paragraph |
LineBlock [[Inline]] | Multiple non-breaking lines |
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 |
Eq Block Source # | |
Data Block Source # | |
Ord Block Source # | |
Read Block Source # | |
Show Block Source # | |
Generic Block Source # | |
NFData Block Source # | |
ToJSON Block Source # | |
FromJSON 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 # | |
Inline elements.
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 |
SoftBreak | Soft line break |
LineBreak | Hard line break |
Math MathType String | TeX math (literal) |
RawInline Format String | Raw inline |
Link Attr [Inline] Target | Hyperlink: alt text (list of inlines), target |
Image Attr [Inline] Target | Image: alt text (list of inlines), target |
Note [Block] | Footnote or endnote |
Span Attr [Inline] | Generic inline container with attributes |
Eq Inline Source # | |
Data Inline Source # | |
Ord Inline Source # | |
Read Inline Source # | |
Show Inline Source # | |
IsString Inlines # | |
Generic Inline Source # | |
Monoid Inlines # | |
NFData Inline Source # | |
ToJSON Inline Source # | |
FromJSON 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 # | |
Alignment of a table column.
type ListAttributes = (Int, ListNumberStyle, ListNumberDelim) Source #
List attributes.
data ListNumberStyle Source #
Style of list numbers.
data ListNumberDelim Source #
Delimiter of list numbers.
Formats for raw blocks
Eq Format Source # | |
Data Format Source # | |
Ord Format Source # | |
Read Format Source # | |
Show Format Source # | |
IsString Format Source # | |
Generic Format Source # | |
NFData Format Source # | |
ToJSON Format Source # | |
FromJSON Format Source # | |
ToJSONFilter a => ToJSONFilter (Maybe Format -> a) Source # | |
type Rep Format Source # | |
type Attr = (String, [String], [(String, String)]) Source #
Attributes: identifier, classes, key-value pairs
Type of quotation marks to use in Quoted inline.
Type of math element (display or inline).
Citation | |
|
Eq Citation Source # | |
Data Citation Source # | |
Ord Citation Source # | |
Read Citation Source # | |
Show Citation Source # | |
Generic Citation Source # | |
NFData Citation Source # | |
ToJSON Citation Source # | |
FromJSON Citation Source # | |
Walkable Inline Citation Source # | |
Walkable Block Citation Source # | |
type Rep Citation Source # | |
data CitationMode Source #
Eq CitationMode Source # | |
Data CitationMode Source # | |
Ord CitationMode Source # | |
Read CitationMode Source # | |
Show CitationMode Source # | |
Generic CitationMode Source # | |
NFData CitationMode Source # | |
ToJSON CitationMode Source # | |
FromJSON CitationMode Source # | |
type Rep CitationMode Source # | |