23df0ed176
structure. Key and Note blocks have been removed. Link and image URLs
are now stored directly in Link and Image inlines, and note blocks
are stored in Note inlines. This requires changes in both parsers
and writers. Markdown and RST parsers need to extract data from key
and note blocks and insert them into the relevant inline elements.
Other parsers can be simplified, since there is no longer any need to
construct separate key and note blocks. Markdown, RST, and HTML writers
need to construct lists of notes; Markdown and RST writers need to
construct lists of link references (when the --reference-links option
is specified); and the RST writer needs to construct a list of image
substitution references. All writers have been rewritten to use the
State monad when state is required. This rewrite yields a small speed
boost and considerably cleaner code.
* Text/Pandoc/Definition.hs:
+ blocks: removed Key and Note
+ inlines: removed NoteRef, added Note
+ modified Target: there is no longer a 'Ref' target; all targets
are explicit URL, title pairs
* Text/Pandoc/Shared.hs:
+ Added 'Reference', 'isNoteBlock', 'isKeyBlock', 'isLineClump',
used in some of the readers.
+ Removed 'generateReference', 'keyTable', 'replaceReferenceLinks',
'replaceRefLinksBlockList', along with some auxiliary functions
used only by them. These are no longer needed, since
reference links are resolved in the Markdown and RST readers.
+ Moved 'inTags', 'selfClosingTag', 'inTagsSimple', and 'inTagsIndented'
to the Docbook writer, since that is now the only module that uses
them.
+ Changed name of 'escapeSGMLString' to 'escapeStringForXML'
+ Added KeyTable and NoteTable types
+ Removed fields from ParserState; 'stateKeyBlocks', 'stateKeysUsed',
'stateNoteBlocks', 'stateNoteIdentifiers', 'stateInlineLinks'.
Added 'stateKeys' and 'stateNotes'.
+ Added clause for Note to 'prettyBlock'.
+ Added 'writerNotes', 'writerReferenceLinks' fields to WriterOptions.
* Text/Pandoc/Entities.hs: Renamed 'escapeSGMLChar' and
'escapeSGMLString' to 'escapeCharForXML' and 'escapeStringForXML'
* Text/ParserCombinators/Pandoc.hs: Added lineClump parser: parses a raw
line block up to and including following blank lines.
* Main.hs: Replaced --inline-links with --reference-links.
* README:
+ Documented --reference-links and removed description of --inline-links.
+ Added note that footnotes may occur anywhere in the document, but must
be at the outer level, not embedded in block elements.
* man/man1/pandoc.1, man/man1/html2markdown.1: Removed --inline-links
option, added --reference-links option
* Markdown and RST readers:
+ Rewrote to fit new Pandoc definition. Since there are no longer
Note or Key blocks, all note and key blocks are parsed on a first pass
through the document. Once tables of notes and keys have been constructed,
the remaining parts of the document are reassembled and parsed.
+ Refactored link parsers.
* LaTeX and HTML readers: Rewrote to fit new Pandoc definition. Since
there are no longer Note or Key blocks, notes and references can be
parsed in a single pass through the document.
* RST, Markdown, and HTML writers: Rewrote using state monad new Pandoc
and definition. State is used to hold lists of references footnotes to
and be printed at the end of the document.
* RTF and LaTeX writers: Rewrote using new Pandoc definition. (Because
of the different treatment of footnotes, the "notes" parameter is no
longer needed in the block and inline conversion functions.)
* Docbook writer:
+ Moved the functions 'attributeList', 'inTags', 'selfClosingTag',
'inTagsSimple', 'inTagsIndented' from Text/Pandoc/Shared, since
they are now used only by the Docbook writer.
+ Rewrote using new Pandoc definition. (Because of the different
treatment of footnotes, the "notes" parameter is no longer needed
in the block and inline conversion functions.)
* Updated test suite
* Throughout: old haskell98 module names replaced by hierarchical module
names, e.g. List by Data.List.
* debian/control: Include libghc6-xhtml-dev instead of libghc6-html-dev
in "Build-Depends."
* cabalize:
+ Remove haskell98 from BASE_DEPENDS (since now the new hierarchical
module names are being used throughout)
+ Added mtl to BASE_DEPENDS (needed for state monad)
+ Removed html from GHC66_DEPENDS (not needed since xhtml is now used)
git-svn-id: https://pandoc.googlecode.com/svn/trunk@580 788f1e2b-df1e-0410-8736-df70ead52e1b
97 lines
4.1 KiB
Haskell
97 lines
4.1 KiB
Haskell
{-
|
|
Copyright (C) 2006 John MacFarlane <jgm at berkeley dot edu>
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program; if not, write to the Free Software
|
|
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
-}
|
|
|
|
{- |
|
|
Module : Text.Pandoc.Definition
|
|
Copyright : Copyright (C) 2006 John MacFarlane
|
|
License : GNU GPL, version 2 or above
|
|
|
|
Maintainer : John MacFarlane <jgm at berkeley dot edu>
|
|
Stability : alpha
|
|
Portability : portable
|
|
|
|
Definition of 'Pandoc' data structure for format-neutral representation
|
|
of documents.
|
|
-}
|
|
module Text.Pandoc.Definition where
|
|
|
|
data Pandoc = Pandoc Meta [Block] deriving (Eq, Read, Show)
|
|
|
|
-- | Bibliographic information for the document: title (list of 'Inline'),
|
|
-- authors (list of strings), date (string).
|
|
data Meta = Meta [Inline] -- title
|
|
[String] -- authors
|
|
String -- date
|
|
deriving (Eq, Show, Read)
|
|
|
|
-- | Alignment of a table column.
|
|
data Alignment = AlignLeft
|
|
| AlignRight
|
|
| AlignCenter
|
|
| AlignDefault deriving (Eq, Show, Read)
|
|
|
|
-- | Block element.
|
|
data Block
|
|
= Plain [Inline] -- ^ Plain text, not a paragraph
|
|
| Null -- ^ Nothing
|
|
| Para [Inline] -- ^ Paragraph
|
|
| CodeBlock String -- ^ Code block (literal)
|
|
| RawHtml String -- ^ Raw HTML block (literal)
|
|
| BlockQuote [Block] -- ^ Block quote (list of blocks)
|
|
| OrderedList [[Block]] -- ^ Ordered list (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)
|
|
deriving (Eq, Read, Show)
|
|
|
|
-- | Type of quotation marks to use in Quoted inline.
|
|
data QuoteType = SingleQuote | DoubleQuote deriving (Show, Eq, Read)
|
|
|
|
type Target = (String, String) -- ^ Link target (URL, title)
|
|
|
|
-- | Inline elements.
|
|
data Inline
|
|
= Str String -- ^ Text (string)
|
|
| Emph [Inline] -- ^ Emphasized text (list of inlines)
|
|
| Strong [Inline] -- ^ Strongly emphasized 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 - reference (string),
|
|
-- text (list of blocks)
|
|
deriving (Show, Eq, Read)
|