From fc1c17b174eabf10f11bf45c4762569cce505956 Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Wed, 16 Nov 2011 14:52:10 -0800 Subject: Added an asciidoc writer (partial). Still TODO: - documentation in README - add default.asciidoc to templates/ - lists - tables - proper escaping - footnotes with blank lines - print separately at end? currently they are just ignored. - fix header (date gives weird result on pandoc README) --- pandoc.cabal | 9 +- src/Tests/Old.hs | 2 +- src/Text/Pandoc.hs | 3 + src/Text/Pandoc/Writers/Asciidoc.hs | 333 ++++++++++++++++ src/pandoc.hs | 1 + tests/tables.asciidoc | 1 + tests/writer.asciidoc | 754 ++++++++++++++++++++++++++++++++++++ 7 files changed, 1099 insertions(+), 4 deletions(-) create mode 100644 src/Text/Pandoc/Writers/Asciidoc.hs create mode 100644 tests/tables.asciidoc create mode 100644 tests/writer.asciidoc diff --git a/pandoc.cabal b/pandoc.cabal index 538f26ce2..f4559be3d 100644 --- a/pandoc.cabal +++ b/pandoc.cabal @@ -19,8 +19,8 @@ Description: Pandoc is a Haskell library for converting from one markup reStructuredText, HTML, LaTeX and Textile, and it can write markdown, reStructuredText, HTML, LaTeX, ConTeXt, Docbook, OpenDocument, ODT, RTF, MediaWiki, Textile, groff man pages, - plain text, Emacs Org-Mode, EPUB, and S5 and Slidy HTML - slide shows. + plain text, Emacs Org-Mode, Asciidoc, EPUB, + and S5 and Slidy HTML slide shows. . Pandoc extends standard markdown syntax with footnotes, embedded LaTeX, definition lists, tables, and other @@ -44,7 +44,7 @@ Data-Files: templates/default.rst, templates/default.plain, templates/default.mediawiki, templates/default.rtf, templates/default.s5, templates/default.slidy, - templates/default.dzslides, + templates/default.dzslides, templates/default.asciidoc, templates/default.textile, templates/default.org -- data for ODT writer reference.odt, @@ -122,6 +122,7 @@ Extra-Source-Files: tests/tables.native, tests/tables.opendocument, tests/tables.org, + tests/tables.asciidoc, tests/tables.texinfo, tests/tables.rst, tests/tables.rtf, @@ -141,6 +142,7 @@ Extra-Source-Files: tests/writer.native, tests/writer.opendocument, tests/writer.org, + tests/writer.asciidoc, tests/writer.rst, tests/writer.rtf, tests/writer.texinfo, @@ -253,6 +255,7 @@ Library Text.Pandoc.Writers.Markdown, Text.Pandoc.Writers.RST, Text.Pandoc.Writers.Org, + Text.Pandoc.Writers.Asciidoc, Text.Pandoc.Writers.Textile, Text.Pandoc.Writers.MediaWiki, Text.Pandoc.Writers.RTF, diff --git a/src/Tests/Old.hs b/src/Tests/Old.hs index cb1417ffa..71a198ca1 100644 --- a/src/Tests/Old.hs +++ b/src/Tests/Old.hs @@ -105,7 +105,7 @@ tests = [ testGroup "markdown" ] , testGroup "other writers" $ map (\f -> testGroup f $ writerTests f) [ "docbook", "opendocument" , "context" , "texinfo" - , "man" , "plain" , "mediawiki", "rtf", "org" + , "man" , "plain" , "mediawiki", "rtf", "org", "asciidoc" ] ] diff --git a/src/Text/Pandoc.hs b/src/Text/Pandoc.hs index 4517b0d52..27b263011 100644 --- a/src/Text/Pandoc.hs +++ b/src/Text/Pandoc.hs @@ -96,6 +96,7 @@ module Text.Pandoc , writeODT , writeEPUB , writeOrg + , writeAsciidoc -- * Writer options used in writers , WriterOptions (..) , HTMLSlideVariant (..) @@ -135,6 +136,7 @@ import Text.Pandoc.Writers.RTF import Text.Pandoc.Writers.MediaWiki import Text.Pandoc.Writers.Textile import Text.Pandoc.Writers.Org +import Text.Pandoc.Writers.Asciidoc import Text.Pandoc.Templates import Text.Pandoc.Parsing import Text.Pandoc.Shared @@ -193,6 +195,7 @@ writers = [("native" , writeNative) ,("textile" , writeTextile) ,("rtf" , writeRTF) ,("org" , writeOrg) + ,("asciidoc" , writeAsciidoc) ] -- | Converts a transformation on the Pandoc AST into a function diff --git a/src/Text/Pandoc/Writers/Asciidoc.hs b/src/Text/Pandoc/Writers/Asciidoc.hs new file mode 100644 index 000000000..c8319764a --- /dev/null +++ b/src/Text/Pandoc/Writers/Asciidoc.hs @@ -0,0 +1,333 @@ +{-# LANGUAGE OverloadedStrings #-} +{- +Copyright (C) 2006-2010 John MacFarlane + +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.Writers.Asciidoc + Copyright : Copyright (C) 2006-2010 John MacFarlane + License : GNU GPL, version 2 or above + + Maintainer : John MacFarlane + Stability : alpha + Portability : portable + +Conversion of 'Pandoc' documents to asciidoc. + +Asciidoc: +-} +module Text.Pandoc.Writers.Asciidoc (writeAsciidoc) where +import Text.Pandoc.Definition +import Text.Pandoc.Templates (renderTemplate) +import Text.Pandoc.Shared +import Text.Pandoc.Parsing hiding (blankline) +import Text.ParserCombinators.Parsec ( runParser, GenParser ) +import Data.List ( isPrefixOf, intersperse, intercalate, transpose ) +import Text.Pandoc.Pretty +import Control.Monad.State + +data WriterState = WriterState { } + +-- | Convert Pandoc to Asciidoc. +writeAsciidoc :: WriterOptions -> Pandoc -> String +writeAsciidoc opts document = + evalState (pandocToAsciidoc opts document) WriterState{ } + +-- | Return markdown representation of document. +pandocToAsciidoc :: WriterOptions -> Pandoc -> State WriterState String +pandocToAsciidoc opts (Pandoc (Meta title authors date) blocks) = do + title' <- inlineListToAsciidoc opts title + let title'' = title' $$ text (replicate (offset title') '=') + authors' <- take 1 `fmap` mapM (inlineListToAsciidoc opts) authors + -- asciidoc only allows a singel author + date' <- inlineListToAsciidoc opts date + let titleblock = not $ null title && null authors && null date + body <- blockListToAsciidoc opts blocks + let colwidth = if writerWrapText opts + then Just $ writerColumns opts + else Nothing + let main = render colwidth body + let context = writerVariables opts ++ + [ ("body", main) + , ("title", render colwidth title'') + , ("date", render colwidth date') + ] ++ + [ ("toc", "yes") | writerTableOfContents opts && + writerStandalone opts ] ++ + [ ("titleblock", "yes") | titleblock ] ++ + [ ("author", render colwidth a) | a <- authors' ] + if writerStandalone opts + then return $ renderTemplate context $ writerTemplate opts + else return main + +-- | Escape special characters for Asciidoc. +escapeString :: String -> String +escapeString = escapeStringUsing markdownEscapes + where markdownEscapes = backslashEscapes "\\`*_>#~^{+" + +-- | Ordered list start parser for use in Para below. +olMarker :: GenParser Char ParserState Char +olMarker = do (start, style', delim) <- anyOrderedListMarker + if delim == Period && + (style' == UpperAlpha || (style' == UpperRoman && + start `elem` [1, 5, 10, 50, 100, 500, 1000])) + then spaceChar >> spaceChar + else spaceChar + +-- | True if string begins with an ordered list marker +beginsWithOrderedListMarker :: String -> Bool +beginsWithOrderedListMarker str = + case runParser olMarker defaultParserState "para start" (take 10 str) of + Left _ -> False + Right _ -> True + +-- | Convert Pandoc block element to markdown. +blockToAsciidoc :: WriterOptions -- ^ Options + -> Block -- ^ Block element + -> State WriterState Doc +blockToAsciidoc _ Null = return empty +blockToAsciidoc opts (Plain inlines) = do + contents <- inlineListToAsciidoc opts inlines + return $ contents <> cr +blockToAsciidoc opts (Para inlines) = do + contents <- inlineListToAsciidoc opts inlines + -- escape if para starts with ordered list marker + let esc = if beginsWithOrderedListMarker (render Nothing contents) + then text "\\" + else empty + return $ esc <> contents <> blankline +blockToAsciidoc _ (RawBlock f str) | f == "html" || f == "docbook" = do + return $ "+++" $$ text str $$ "+++" <> blankline +blockToAsciidoc _ (RawBlock _ _) = return empty +blockToAsciidoc _ HorizontalRule = + return $ blankline <> text "'''''" <> blankline +blockToAsciidoc opts (Header level inlines) = do + contents <- inlineListToAsciidoc opts inlines + let len = offset contents + return $ contents <> cr <> + (case level of + 1 -> text $ replicate len '-' + 2 -> text $ replicate len '~' + 3 -> text $ replicate len '^' + 4 -> text $ replicate len '+' + _ -> empty) <> blankline +blockToAsciidoc _ (CodeBlock (_,classes,_) str) = return $ + flush (attrs <> dashes <> space <> attrs <> cr <> text str <> + cr <> dashes) <> blankline + where dashes = text $ replicate (maximum $ map length $ lines str) '-' + attrs = if null classes + then empty + else text $ intercalate "," $ "code" : classes +blockToAsciidoc opts (BlockQuote blocks) = do + contents <- blockListToAsciidoc opts blocks + let cols = offset contents + let bar = text $ replicate cols '_' + return $ bar $$ contents $$ bar <> blankline +blockToAsciidoc opts (Table caption aligns widths headers rows) = do + caption' <- inlineListToAsciidoc opts caption + let caption'' = if null caption + then empty + else blankline <> ": " <> caption' <> blankline + headers' <- mapM (blockListToAsciidoc opts) headers + let alignHeader alignment = case alignment of + AlignLeft -> lblock + AlignCenter -> cblock + AlignRight -> rblock + AlignDefault -> lblock + rawRows <- mapM (mapM (blockListToAsciidoc opts)) rows + let isSimple = all (==0) widths + let numChars = maximum . map offset + let widthsInChars = + if isSimple + then map ((+2) . numChars) $ transpose (headers' : rawRows) + else map (floor . (fromIntegral (writerColumns opts) *)) widths + let makeRow = hcat . intersperse (lblock 1 (text " ")) . + (zipWith3 alignHeader aligns widthsInChars) + let rows' = map makeRow rawRows + let head' = makeRow headers' + let maxRowHeight = maximum $ map height (head':rows') + let underline = cat $ intersperse (text " ") $ + map (\width -> text (replicate width '-')) widthsInChars + let border = if maxRowHeight > 1 + then text (replicate (sum widthsInChars + + length widthsInChars - 1) '-') + else if all null headers + then underline + else empty + let head'' = if all null headers + then empty + else border <> cr <> head' + let body = if maxRowHeight > 1 + then vsep rows' + else vcat rows' + let bottom = if all null headers + then underline + else border + return $ nest 2 $ head'' $$ underline $$ body $$ + bottom $$ blankline $$ caption'' $$ blankline +blockToAsciidoc opts (BulletList items) = do + contents <- mapM (bulletListItemToAsciidoc opts) items + return $ cat contents <> blankline +blockToAsciidoc opts (OrderedList attribs items) = do + let markers = orderedListMarkers attribs + let markers' = map (\m -> if length m < 3 + then m ++ replicate (3 - length m) ' ' + else m) markers + contents <- mapM (\(item, num) -> orderedListItemToAsciidoc opts item num) $ + zip markers' items + return $ cat contents <> blankline +blockToAsciidoc opts (DefinitionList items) = do + contents <- mapM (definitionListItemToAsciidoc opts) items + return $ cat contents <> blankline + +-- | Convert bullet list item (list of blocks) to markdown. +bulletListItemToAsciidoc :: WriterOptions -> [Block] -> State WriterState Doc +bulletListItemToAsciidoc opts items = do + contents <- blockListToAsciidoc opts items + let sps = replicate (writerTabStop opts - 2) ' ' + let start = text ('-' : ' ' : sps) + return $ hang (writerTabStop opts) start $ contents <> cr + +-- | Convert ordered list item (a list of blocks) to markdown. +orderedListItemToAsciidoc :: WriterOptions -- ^ options + -> String -- ^ list item marker + -> [Block] -- ^ list item (list of blocks) + -> State WriterState Doc +orderedListItemToAsciidoc opts marker items = do + contents <- blockListToAsciidoc opts items + let sps = case length marker - writerTabStop opts of + n | n > 0 -> text $ replicate n ' ' + _ -> text " " + let start = text marker <> sps + return $ hang (writerTabStop opts) start $ contents <> cr + +-- | Convert definition list item (label, list of blocks) to markdown. +definitionListItemToAsciidoc :: WriterOptions + -> ([Inline],[[Block]]) + -> State WriterState Doc +definitionListItemToAsciidoc opts (label, defs) = do + labelText <- inlineListToAsciidoc opts label + let tabStop = writerTabStop opts + let leader = " ~" + let sps = case writerTabStop opts - 3 of + n | n > 0 -> text $ replicate n ' ' + _ -> text " " + defs' <- mapM (mapM (blockToAsciidoc opts)) defs + let contents = vcat $ map (\d -> hang tabStop (leader <> sps) $ vcat d <> cr) defs' + return $ labelText <> cr <> contents <> cr + +-- | Convert list of Pandoc block elements to markdown. +blockListToAsciidoc :: WriterOptions -- ^ Options + -> [Block] -- ^ List of block elements + -> State WriterState Doc +blockListToAsciidoc opts blocks = + mapM (blockToAsciidoc opts) (fixBlocks blocks) >>= return . cat + -- insert comment between list and indented code block, or the + -- code block will be treated as a list continuation paragraph + where fixBlocks (b : CodeBlock attr x : rest) + | (attr == nullAttr) && isListBlock b = + b : RawBlock "html" "\n" : CodeBlock attr x : + fixBlocks rest + fixBlocks (x : xs) = x : fixBlocks xs + fixBlocks [] = [] + isListBlock (BulletList _) = True + isListBlock (OrderedList _ _) = True + isListBlock (DefinitionList _) = True + isListBlock _ = False + +-- | Convert list of Pandoc inline elements to markdown. +inlineListToAsciidoc :: WriterOptions -> [Inline] -> State WriterState Doc +inlineListToAsciidoc opts lst = + mapM (inlineToAsciidoc opts) lst >>= return . cat + +-- | Convert Pandoc inline element to markdown. +inlineToAsciidoc :: WriterOptions -> Inline -> State WriterState Doc +inlineToAsciidoc opts (Emph lst) = do + contents <- inlineListToAsciidoc opts lst + return $ "_" <> contents <> "_" +inlineToAsciidoc opts (Strong lst) = do + contents <- inlineListToAsciidoc opts lst + return $ "*" <> contents <> "*" +inlineToAsciidoc opts (Strikeout lst) = do + contents <- inlineListToAsciidoc opts lst + return $ "[line-through]*" <> contents <> "*" +inlineToAsciidoc opts (Superscript lst) = do + contents <- inlineListToAsciidoc opts lst + return $ "^" <> contents <> "^" +inlineToAsciidoc opts (Subscript lst) = do + contents <- inlineListToAsciidoc opts lst + return $ "~" <> contents <> "~" +inlineToAsciidoc opts (SmallCaps lst) = inlineListToAsciidoc opts lst +inlineToAsciidoc opts (Quoted SingleQuote lst) = do + contents <- inlineListToAsciidoc opts lst + return $ "`" <> contents <> "'" +inlineToAsciidoc opts (Quoted DoubleQuote lst) = do + contents <- inlineListToAsciidoc opts lst + return $ "``" <> contents <> "''" +inlineToAsciidoc _ EmDash = return "\8212" +inlineToAsciidoc _ EnDash = return "\8211" +inlineToAsciidoc _ Apostrophe = return "\8217" +inlineToAsciidoc _ Ellipses = return "\8230" +inlineToAsciidoc _ (Code _ str) = return $ + text "`" <> text (escapeStringUsing (backslashEscapes "`") str) <> "`" +inlineToAsciidoc _ (Str str) = return $ text $ escapeString str +inlineToAsciidoc _ (Math InlineMath str) = + return $ "latexmath:[$" <> text str <> "$]" +inlineToAsciidoc _ (Math DisplayMath str) = + return $ "latexmath:[$$" <> text str <> "$$]" +inlineToAsciidoc _ (RawInline _ _) = return empty +inlineToAsciidoc _ (LineBreak) = return $ " +" <> cr +inlineToAsciidoc _ Space = return space +inlineToAsciidoc opts (Cite _ lst) = inlineListToAsciidoc opts lst +inlineToAsciidoc opts (Link txt (src', tit)) = do +-- relative: link:downloads/foo.zip[download foo.zip] +-- abs: http://google.cod[Google] +-- or my@email.com[email john] + linktext <- inlineListToAsciidoc opts txt + let linktitle = if null tit + then empty + else text $ ",title=\"" ++ tit ++ "\"" + let src = unescapeURI src' + let isRelative = ':' `elem` src + let prefix = if isRelative + then text "link:" + else empty + let srcSuffix = if isPrefixOf "mailto:" src then drop 7 src else src + let useAuto = case (tit,txt) of + ("", [Code _ s]) | s == srcSuffix -> True + _ -> False + return $ if useAuto + then text srcSuffix + else prefix <> text src <> "[" <> linktext <> linktitle <> "]" +inlineToAsciidoc opts (Image alternate (src', tit)) = do +-- image:images/logo.png[Company logo, title="blah"] + let txt = if (null alternate) || (alternate == [Str ""]) + then [Str "image"] + else alternate + linktext <- inlineListToAsciidoc opts txt + let linktitle = if null tit + then empty + else text $ ",title=\"" ++ tit ++ "\"" + let src = unescapeURI src' + return $ "image:" <> text src <> "[" <> linktext <> linktitle <> "]" +inlineToAsciidoc opts (Note [Para inlines]) = + inlineToAsciidoc opts (Note [Plain inlines]) +inlineToAsciidoc opts (Note [Plain inlines]) = do + contents <- inlineListToAsciidoc opts inlines + return $ text "footnote:[" <> contents <> "]" +-- asciidoc can't handle blank lines in notes +inlineToAsciidoc _ (Note _) = return empty diff --git a/src/pandoc.hs b/src/pandoc.hs index 387fc8095..1caa6d58a 100644 --- a/src/pandoc.hs +++ b/src/pandoc.hs @@ -647,6 +647,7 @@ defaultWriterName x = ".odt" -> "odt" ".epub" -> "epub" ".org" -> "org" + ".asciidoc" -> "asciidoc" ['.',y] | y `elem` ['1'..'9'] -> "man" _ -> "html" diff --git a/tests/tables.asciidoc b/tests/tables.asciidoc new file mode 100644 index 000000000..48cdce852 --- /dev/null +++ b/tests/tables.asciidoc @@ -0,0 +1 @@ +placeholder diff --git a/tests/writer.asciidoc b/tests/writer.asciidoc new file mode 100644 index 000000000..60a9518a7 --- /dev/null +++ b/tests/writer.asciidoc @@ -0,0 +1,754 @@ +Pandoc Test Suite +================= +John MacFarlane; Anonymous +July 17, 2006 + +This is a set of tests for pandoc. Most of them are adapted from John Gruber's +markdown test suite. + +''''' + +Headers +------- + +Level 2 with an link:/url[embedded link] +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Level 3 with *emphasis* +^^^^^^^^^^^^^^^^^^^^^^^ + +Level 4 ++++++++ + +Level 5 + +Level 1 +------- + +Level 2 with _emphasis_ +~~~~~~~~~~~~~~~~~~~~~~~ + +Level 3 +^^^^^^^ + +with no blank line + +Level 2 +------- + +with no blank line + +''''' + +Paragraphs +---------- + +Here’s a regular paragraph. + +In Markdown 1.0.0 and earlier. Version 8. This line turns into a list item. +Because a hard-wrapped line in the middle of a paragraph looked like a list +item. + +Here’s one with a bullet. \* criminey. + +There should be a hard line break + +here. + +''''' + +Block Quotes +------------ + +E-mail style: + +__________________________________________ +This is a block quote. It is pretty short. +__________________________________________ + +------------------------ +Code in a block quote: + + sub status { + print "working"; + } +------------------------ + +A list: + +. item one +. item two + +Nested block quotes: + +______ +nested +______ +nested +______ +______ + +This should not be a block quote: 2 \> 1. + +And a following paragraph. + +''''' + +Code Blocks +----------- + +Code: + +---- +---- (should be four hyphens) + +sub status { + print "working"; +} + +this code block is indented by one tab +---- + +And: + +---- + this code block is indented by two tabs + +These should not be escaped: \$ \\ \> \[ \{ +---- + +''''' + +Lists +----- + +Unordered +~~~~~~~~~ + +Asterisks tight: + +[options="compact"] +* asterisk 1 +* asterisk 2 +* asterisk 3 + +Asterisks loose: + +* asterisk 1 + +* asterisk 2 + +* asterisk 3 + +Pluses tight: + +[options="compact"] +* Plus 1 +* Plus 2 +* Plus 3 + +Pluses loose: + +* Plus 1 + +* Plus 2 + +* Plus 3 + +Minuses tight: + +[options="compact"] +* Minus 1 +* Minus 2 +* Minus 3 + +Minuses loose: + +* Minus 1 + +* Minus 2 + +* Minus 3 + +Ordered +~~~~~~~ + +Tight: + +[options="compact"] +1. First +2. Second +3. Third + +and: + +[options="compact"] +1. One +2. Two +3. Three + +Loose using tabs: + +1. First + +2. Second + +3. Third + +and using spaces: + +1. One + +2. Two + +3. Three + +Multiple paragraphs: + +1. Item 1, graf one. ++ +Item 1. graf two. The quick brown fox jumped over the lazy dog’s back. + +2. Item 2. + +3. Item 3. + +Nested +~~~~~~ + +* Tab +** Tab +*** Tab + +Here’s another: + +1. First +2. Second: + [options="compact"] + * Fee + * Fie + * Foe + +3. Third + +Same thing but with paragraphs: + +1. First + +2. Second: + + [options="compact"] + * Fee + * Fie + * Foe + +3. Third + +Tabs and spaces +~~~~~~~~~~~~~~~ + +* this is a list item indented with tabs + +* this is a list item indented with spaces + +** this is an example list item indented with tabs + +** this is an example list item indented with spaces + +Fancy list markers +~~~~~~~~~~~~~~~~~~ + +[start=2] +2. begins with 2 +3. and now 3 ++ +with a continuation ++ +[start=4] +4. sublist with roman numerals, starting with 4 +5. more items + A. a subsublist + B. a subsublist + +Nesting: + +A. Upper Alpha + 1. Upper Roman. + + + [start=6] + 6. Decimal start with 6 + + + [start=3] + c. Lower alpha with paren + +Autonumbering: + +1. Autonumber. +2. More. + 1. Nested. + +Should not be a list item: + +M.A. 2007 + +B. Williams + +''''' + +Definition Lists +---------------- + +Tight using spaces: + +apple + ~ red fruit +orange + ~ orange fruit +banana + ~ yellow fruit + +Tight using tabs: + +apple + ~ red fruit +orange + ~ orange fruit +banana + ~ yellow fruit + +Loose: + +apple + ~ red fruit + +orange + ~ orange fruit + +banana + ~ yellow fruit + +Multiple blocks with italics: + +*apple* + ~ red fruit + + contains seeds, crisp, pleasant to taste + +*orange* + ~ orange fruit + + { orange code block } + + > orange block quote + +Multiple definitions, tight: + +apple + ~ red fruit + ~ computer +orange + ~ orange fruit + ~ bank + +Multiple definitions, loose: + +apple + ~ red fruit + + ~ computer + +orange + ~ orange fruit + + ~ bank + +Blank line after term, indented marker, alternate markers: + +apple + ~ red fruit + + ~ computer + +orange + ~ orange fruit + + 1. sublist + 2. sublist + +HTML Blocks +----------- + +Simple block on one line: + +
+foo +
+ +And nested without indentation: + +
+
+
+foo +
+
+
+bar +
+
+ +Interpreted markdown in a table: + + + + + + +
+This is *emphasized* + +And this is **strong** +
+ + + +Here’s a simple block: + +
+ +foo +
+ +This should be a code block, though: + +
+ foo +
+ +As should this: + +
foo
+ +Now, nested: + +
+
+
+ +foo +
+
+
+ +This should just be an HTML comment: + + + +Multiline: + + + + + +Code block: + + + +Just plain comment, with trailing spaces on the line: + + + +Code: + +
+ +Hr’s: + +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +''''' + +Inline Markup +------------- + +This is *emphasized*, and so *is this*. + +This is **strong**, and so **is this**. + +An *[emphasized link](/url)*. + +***This is strong and em.*** + +So is ***this*** word. + +***This is strong and em.*** + +So is ***this*** word. + +This is code: `>`, `$`, `\`, `\$`, ``. + +~~This is *strikeout*.~~ + +Superscripts: a^bc^d a^*hello*^ a^hello there^. + +Subscripts: H~2~O, H~23~O, H~many of them~O. + +These should not be superscripts or subscripts, because of the unescaped +spaces: a\^b c\^d, a\~b c\~d. + +''''' + +Smart quotes, ellipses, dashes +------------------------------ + +“Hello,” said the spider. “‘Shelob’ is my name.” + +‘A’, ‘B’, and ‘C’ are letters. + +‘Oak,’ ‘elm,’ and ‘beech’ are names of trees. So is ‘pine.’ + +‘He said, “I want to go.”’ Were you alive in the 70’s? + +Here is some quoted ‘`code`’ and a “[quoted +link](http://example.com/?foo=1&bar=2)”. + +Some dashes: one—two — three—four — five. + +Dashes between numbers: 5–7, 255–66, 1987–1999. + +Ellipses…and…and…. + +''''' + +LaTeX +----- + +- \cite[22-23]{smith.1899} +- $2+2=4$ +- $x \in y$ +- $\alpha \wedge \omega$ +- $223$ +- $p$-Tree +- Here’s some display math: + $$\frac{d}{dx}f(x)=\lim_{h\to 0}\frac{f(x+h)-f(x)}{h}$$ +- Here’s one that has a line break in it: $\alpha + \omega \times x^2$. + +These shouldn’t be math: + +- To get the famous equation, write `$e = mc^2$`. +- $22,000 is a *lot* of money. So is $34,000. (It worked if “lot” is + emphasized.) +- Shoes ($20) and socks ($5). +- Escaped `$`: $73 *this should be emphasized* 23$. + +Here’s a LaTeX table: + +\begin{tabular}{|l|l|}\hline +Animal & Number \\ \hline +Dog & 2 \\ +Cat & 1 \\ \hline +\end{tabular} + +''''' + +Special Characters +------------------ + +Here is some unicode: + +- I hat: Î +- o umlaut: ö +- section: § +- set membership: ∈ +- copyright: © + +AT&T has an ampersand in their name. + +AT&T is another way to write it. + +This & that. + +4 < 5. + +6 \> 5. + +Backslash: \\ + +Backtick: \` + +Asterisk: \* + +Underscore: \_ + +Left brace: { + +Right brace: } + +Left bracket: [ + +Right bracket: ] + +Left paren: ( + +Right paren: ) + +Greater-than: \> + +Hash: \# + +Period: . + +Bang: ! + +Plus: + + +Minus: - + +''''' + +Links +----- + +Explicit +~~~~~~~~ + +Just a [URL](/url/). + +[URL and title](/url/ "title"). + +[URL and title](/url/ "title preceded by two spaces"). + +[URL and title](/url/ "title preceded by a tab"). + +[URL and title](/url/ "title with "quotes" in it") + +[URL and title](/url/ "title with single quotes") + +[with\_underscore](/url/with_underscore) + +[Email link](mailto:nobody@nowhere.net) + +[Empty](). + +Reference +~~~~~~~~~ + +Foo [bar](/url/). + +Foo [bar](/url/). + +Foo [bar](/url/). + +With [embedded [brackets]](/url/). + +[b](/url/) by itself should be a link. + +Indented [once](/url). + +Indented [twice](/url). + +Indented [thrice](/url). + +This should [not][] be a link. + + [not]: /url + +Foo [bar](/url/ "Title with "quotes" inside"). + +Foo [biz](/url/ "Title with "quote" inside"). + +With ampersands +~~~~~~~~~~~~~~~ + +Here’s a [link with an ampersand in the URL](http://example.com/?foo=1&bar=2). + +Here’s a link with an amersand in the link text: +[AT&T](http://att.com/ "AT&T"). + +Here’s an [inline link](/script?foo=1&bar=2). + +Here’s an [inline link in pointy braces](/script?foo=1&bar=2). + +Autolinks +~~~~~~~~~ + +With an ampersand: + +- In a list? +- +- It should. + +An e-mail address: + +> Blockquoted: + +Auto-links should not occur here: `` + + or here: + +''''' + +Images +------ + +From “Voyage dans la Lune” by Georges Melies (1902): + +![lalune](lalune.jpg "Voyage dans la Lune") + +Here is a movie ![movie](movie.jpg) icon. + +''''' + +Footnotes +--------- + +Here is a footnote reference,[^1] and another.[^2] This should *not* be a +footnote reference, because it contains a space.[\^my note] Here is an inline +note.[^3] + +> Notes can go in quotes.[^4] + +1. And in list items.[^5] + +This paragraph should not be part of the note, as it is not indented. + +[^1]: Here is the footnote. It can go anywhere after the footnote reference. + It need not be placed at the end of the document. + +[^2]: Here’s the long note. This one contains multiple blocks. + + Subsequent blocks are indented to show that they belong to the footnote + (as with list items). + + { } + + If you want, you can indent every line, but you can also be lazy and just + indent the first line of each block. + +[^3]: This is *easier* to type. Inline notes may contain + [links](http://google.com) and `]` verbatim characters, as well as + [bracketed text]. + +[^4]: In quote. + +[^5]: In list. -- cgit v1.2.3 From fed260439e6f8ed57dd3b2a3aedd5b5ccbd968a6 Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Wed, 16 Nov 2011 19:17:18 -0800 Subject: Updated templates. --- templates | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates b/templates index f632b1cdb..8b89d7c97 160000 --- a/templates +++ b/templates @@ -1 +1 @@ -Subproject commit f632b1cdb9cf23e4d5d0d78d9422303c47d1da3a +Subproject commit 8b89d7c975800f70024fd9a4204f615fec789463 -- cgit v1.2.3 From b7cbd42d071a296220b3a08a1b2ea333150ca198 Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Thu, 17 Nov 2011 00:52:45 -0800 Subject: Use attributes for author/date. --- src/Text/Pandoc/Writers/Asciidoc.hs | 2 +- templates | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Text/Pandoc/Writers/Asciidoc.hs b/src/Text/Pandoc/Writers/Asciidoc.hs index c8319764a..53b607cfc 100644 --- a/src/Text/Pandoc/Writers/Asciidoc.hs +++ b/src/Text/Pandoc/Writers/Asciidoc.hs @@ -52,7 +52,7 @@ pandocToAsciidoc :: WriterOptions -> Pandoc -> State WriterState String pandocToAsciidoc opts (Pandoc (Meta title authors date) blocks) = do title' <- inlineListToAsciidoc opts title let title'' = title' $$ text (replicate (offset title') '=') - authors' <- take 1 `fmap` mapM (inlineListToAsciidoc opts) authors + authors' <- mapM (inlineListToAsciidoc opts) authors -- asciidoc only allows a singel author date' <- inlineListToAsciidoc opts date let titleblock = not $ null title && null authors && null date diff --git a/templates b/templates index 8b89d7c97..279110eb7 160000 --- a/templates +++ b/templates @@ -1 +1 @@ -Subproject commit 8b89d7c975800f70024fd9a4204f615fec789463 +Subproject commit 279110eb7cfedd20e626cdeaaf94ccc6fbb1e8ab -- cgit v1.2.3 From fcfbbd2caa96e27e241a441629fcf6003f7a48da Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Thu, 17 Nov 2011 22:35:39 -0800 Subject: Supported definition lists. --- src/Text/Pandoc/Writers/Asciidoc.hs | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/src/Text/Pandoc/Writers/Asciidoc.hs b/src/Text/Pandoc/Writers/Asciidoc.hs index 53b607cfc..ff73ae7e6 100644 --- a/src/Text/Pandoc/Writers/Asciidoc.hs +++ b/src/Text/Pandoc/Writers/Asciidoc.hs @@ -40,12 +40,13 @@ import Data.List ( isPrefixOf, intersperse, intercalate, transpose ) import Text.Pandoc.Pretty import Control.Monad.State -data WriterState = WriterState { } +data WriterState = WriterState { defListMarker :: String } -- | Convert Pandoc to Asciidoc. writeAsciidoc :: WriterOptions -> Pandoc -> String writeAsciidoc opts document = - evalState (pandocToAsciidoc opts document) WriterState{ } + evalState (pandocToAsciidoc opts document) WriterState{ + defListMarker = "::" } -- | Return markdown representation of document. pandocToAsciidoc :: WriterOptions -> Pandoc -> State WriterState String @@ -221,14 +222,16 @@ definitionListItemToAsciidoc :: WriterOptions -> State WriterState Doc definitionListItemToAsciidoc opts (label, defs) = do labelText <- inlineListToAsciidoc opts label - let tabStop = writerTabStop opts - let leader = " ~" - let sps = case writerTabStop opts - 3 of - n | n > 0 -> text $ replicate n ' ' - _ -> text " " - defs' <- mapM (mapM (blockToAsciidoc opts)) defs - let contents = vcat $ map (\d -> hang tabStop (leader <> sps) $ vcat d <> cr) defs' - return $ labelText <> cr <> contents <> cr + marker <- defListMarker `fmap` get + if marker == "::" + then modify (\st -> st{ defListMarker = ";;"}) + else modify (\st -> st{ defListMarker = "::"}) + let defsToAsciidoc :: [Block] -> State WriterState Doc + defsToAsciidoc ds = vcat `fmap` mapM (blockToAsciidoc opts) ds + defs' <- mapM defsToAsciidoc defs + modify (\st -> st{ defListMarker = marker }) + let contents = nest 2 $ vsep defs' + return $ labelText <> text marker <> cr <> contents <> cr -- | Convert list of Pandoc block elements to markdown. blockListToAsciidoc :: WriterOptions -- ^ Options -- cgit v1.2.3 From 823c0bcda90dc060afd7c5026d194ddc9dec9409 Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Thu, 17 Nov 2011 23:13:29 -0800 Subject: Indicate when a multiblock footnote is omitted. --- src/Text/Pandoc/Writers/Asciidoc.hs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Text/Pandoc/Writers/Asciidoc.hs b/src/Text/Pandoc/Writers/Asciidoc.hs index ff73ae7e6..aaa6964f1 100644 --- a/src/Text/Pandoc/Writers/Asciidoc.hs +++ b/src/Text/Pandoc/Writers/Asciidoc.hs @@ -333,4 +333,4 @@ inlineToAsciidoc opts (Note [Plain inlines]) = do contents <- inlineListToAsciidoc opts inlines return $ text "footnote:[" <> contents <> "]" -- asciidoc can't handle blank lines in notes -inlineToAsciidoc _ (Note _) = return empty +inlineToAsciidoc _ (Note _) = return "[multiblock footnote omitted]" -- cgit v1.2.3 From 23c26bbc65dd719aa200897ae71bc7bea6c14aab Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Fri, 18 Nov 2011 13:10:45 -0800 Subject: Pretty: Added chomp combinator. --- src/Text/Pandoc/Pretty.hs | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/src/Text/Pandoc/Pretty.hs b/src/Text/Pandoc/Pretty.hs index 54d65af6f..5c6eee27c 100644 --- a/src/Text/Pandoc/Pretty.hs +++ b/src/Text/Pandoc/Pretty.hs @@ -59,6 +59,7 @@ module Text.Pandoc.Pretty ( , hsep , vcat , vsep + , chomp , inside , braces , brackets @@ -164,6 +165,17 @@ vcat = foldr ($$) empty vsep :: [Doc] -> Doc vsep = foldr ($+$) empty +-- | Chomps trailing blank space off of a 'Doc'. +chomp :: Doc -> Doc +chomp d = Doc (fromList dl') + where dl = toList (unDoc d) + dl' = reverse $ dropWhile removeable $ reverse dl + removeable BreakingSpace = True + removeable CarriageReturn = True + removeable NewLine = True + removeable BlankLine = True + removeable _ = False + outp :: (IsString a, Monoid a) => Int -> String -> DocState a outp off s | off <= 0 = do @@ -427,3 +439,4 @@ quotes = inside (char '\'') (char '\'') -- | Wraps a 'Doc' in double quotes. doubleQuotes :: Doc -> Doc doubleQuotes = inside (char '"') (char '"') + -- cgit v1.2.3 From f6a0e75389d748818e703566b749af293195b4ee Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Fri, 18 Nov 2011 09:50:32 -0800 Subject: Supported tables in asciidoc, added table tests. --- src/Text/Pandoc/Writers/Asciidoc.hs | 92 +++++++++++++++++++++---------------- tests/tables.asciidoc | 72 ++++++++++++++++++++++++++++- 2 files changed, 124 insertions(+), 40 deletions(-) diff --git a/src/Text/Pandoc/Writers/Asciidoc.hs b/src/Text/Pandoc/Writers/Asciidoc.hs index aaa6964f1..28c99b12a 100644 --- a/src/Text/Pandoc/Writers/Asciidoc.hs +++ b/src/Text/Pandoc/Writers/Asciidoc.hs @@ -36,7 +36,7 @@ import Text.Pandoc.Templates (renderTemplate) import Text.Pandoc.Shared import Text.Pandoc.Parsing hiding (blankline) import Text.ParserCombinators.Parsec ( runParser, GenParser ) -import Data.List ( isPrefixOf, intersperse, intercalate, transpose ) +import Data.List ( isPrefixOf, intercalate ) import Text.Pandoc.Pretty import Control.Monad.State @@ -142,44 +142,58 @@ blockToAsciidoc opts (Table caption aligns widths headers rows) = do caption' <- inlineListToAsciidoc opts caption let caption'' = if null caption then empty - else blankline <> ": " <> caption' <> blankline - headers' <- mapM (blockListToAsciidoc opts) headers - let alignHeader alignment = case alignment of - AlignLeft -> lblock - AlignCenter -> cblock - AlignRight -> rblock - AlignDefault -> lblock - rawRows <- mapM (mapM (blockListToAsciidoc opts)) rows - let isSimple = all (==0) widths - let numChars = maximum . map offset - let widthsInChars = - if isSimple - then map ((+2) . numChars) $ transpose (headers' : rawRows) - else map (floor . (fromIntegral (writerColumns opts) *)) widths - let makeRow = hcat . intersperse (lblock 1 (text " ")) . - (zipWith3 alignHeader aligns widthsInChars) - let rows' = map makeRow rawRows - let head' = makeRow headers' - let maxRowHeight = maximum $ map height (head':rows') - let underline = cat $ intersperse (text " ") $ - map (\width -> text (replicate width '-')) widthsInChars - let border = if maxRowHeight > 1 - then text (replicate (sum widthsInChars + - length widthsInChars - 1) '-') - else if all null headers - then underline - else empty - let head'' = if all null headers - then empty - else border <> cr <> head' - let body = if maxRowHeight > 1 - then vsep rows' - else vcat rows' - let bottom = if all null headers - then underline - else border - return $ nest 2 $ head'' $$ underline $$ body $$ - bottom $$ blankline $$ caption'' $$ blankline + else "." <> caption' <> cr + let isSimple = all (== 0) widths + let relativePercentWidths = if isSimple + then widths + else map (/ (sum widths)) widths + let widths'' :: [Integer] + widths'' = map (floor . (* 100)) relativePercentWidths + -- ensure that the widths sum to 100 + let widths' = case widths'' of + _ | isSimple -> widths'' + (w:ws) | sum (w:ws) < 100 + -> (100 - sum ws) : ws + ws -> ws + let totalwidth :: Integer + totalwidth = floor $ sum widths * 100 + let colspec al wi = (case al of + AlignLeft -> "<" + AlignCenter -> "^" + AlignRight -> ">" + AlignDefault -> "") ++ + if wi == 0 then "" else (show wi ++ "%") + let headerspec = if all null headers + then empty + else text "options=\"header\"," + let widthspec = if totalwidth == 0 + then empty + else text "width=" + <> doubleQuotes (text $ show totalwidth ++ "%") + <> text "," + let tablespec = text "[" + <> widthspec + <> text "cols=" + <> doubleQuotes (text $ intercalate "," + $ zipWith colspec aligns widths') + <> text "," + <> headerspec <> text "]" + let makeCell [Plain x] = do d <- blockListToAsciidoc opts [Plain x] + return $ text "|" <> chomp d + makeCell [Para x] = makeCell [Plain x] + makeCell _ = return $ text "|" <> "[multiblock cell omitted]" + let makeRow cells = hsep `fmap` mapM makeCell cells + rows' <- mapM makeRow rows + head' <- makeRow headers + let head'' = if all null headers then empty else head' + let colwidth = if writerWrapText opts + then writerColumns opts + else 100000 + let maxwidth = maximum $ map offset (head':rows') + let body = if maxwidth > colwidth then vsep rows' else vcat rows' + let border = text $ "|" ++ replicate ((min maxwidth colwidth) - 1) '=' + return $ + caption'' $$ tablespec $$ border $$ head'' $$ body $$ border $$ blankline blockToAsciidoc opts (BulletList items) = do contents <- mapM (bulletListItemToAsciidoc opts) items return $ cat contents <> blankline diff --git a/tests/tables.asciidoc b/tests/tables.asciidoc index 48cdce852..842a9b8c4 100644 --- a/tests/tables.asciidoc +++ b/tests/tables.asciidoc @@ -1 +1,71 @@ -placeholder +Simple table with caption: + +.Demonstration of simple table syntax. +[cols=">,<,^,",options="header",] +|============================ +|Right |Left |Center |Default +|12 |12 |12 |12 +|123 |123 |123 |123 +|1 |1 |1 |1 +|============================ + +Simple table without caption: + +[cols=">,<,^,",options="header",] +|============================ +|Right |Left |Center |Default +|12 |12 |12 |12 +|123 |123 |123 |123 +|1 |1 |1 |1 +|============================ + +Simple table indented two spaces: + +.Demonstration of simple table syntax. +[cols=">,<,^,",options="header",] +|============================ +|Right |Left |Center |Default +|12 |12 |12 |12 +|123 |123 |123 |123 +|1 |1 |1 |1 +|============================ + +Multiline table with caption: + +.Here's the caption. It may span multiple lines. +[width="78%",cols="^21%,<17%,>20%,<42%",options="header",] +|======================================================================= +|Centered Header |Left Aligned |Right Aligned |Default aligned +|First |row |12.0 |Example of a row that spans multiple lines. +|Second |row |5.0 |Here's another one. Note the blank line between rows. +|======================================================================= + +Multiline table without caption: + +[width="78%",cols="^21%,<17%,>20%,<42%",options="header",] +|======================================================================= +|Centered Header |Left Aligned |Right Aligned |Default aligned +|First |row |12.0 |Example of a row that spans multiple lines. +|Second |row |5.0 |Here's another one. Note the blank line between rows. +|======================================================================= + +Table without column headers: + +[cols=">,<,^,>",] +|======================================================================= +|12 |12 |12 |12 + +|123 |123 |123 |123 + +|1 |1 |1 |1 +|======================================================================= + +Multiline table without column headers: + +[width="78%",cols="^21%,<17%,>20%,42%",] +|======================================================================= +|First |row |12.0 |Example of a row that spans multiple lines. + +|Second |row |5.0 |Here's another one. Note the blank line between rows. +|======================================================================= + -- cgit v1.2.3 From e8e5ad210fa4bd49775822951e2b3352bec2c7e0 Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Fri, 18 Nov 2011 13:23:09 -0800 Subject: Added comment about limitations of asciidoc conversion. --- src/Text/Pandoc/Writers/Asciidoc.hs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/Text/Pandoc/Writers/Asciidoc.hs b/src/Text/Pandoc/Writers/Asciidoc.hs index 28c99b12a..f51c43362 100644 --- a/src/Text/Pandoc/Writers/Asciidoc.hs +++ b/src/Text/Pandoc/Writers/Asciidoc.hs @@ -28,6 +28,12 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Conversion of 'Pandoc' documents to asciidoc. +Note that some information may be lost in conversion, due to +expressive limitations of asciidoc. Footnotes and table cells with +paragraphs (or other block items) are not possible in asciidoc. +If pandoc encounters one of these, it will insert a message indicating +that it has omitted the construct. + Asciidoc: -} module Text.Pandoc.Writers.Asciidoc (writeAsciidoc) where -- cgit v1.2.3 From a9a4e24d29542c16e0b31388a46e5bd808f35539 Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Fri, 18 Nov 2011 17:01:38 -0800 Subject: Added fields to track list levels. --- src/Text/Pandoc/Writers/Asciidoc.hs | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/Text/Pandoc/Writers/Asciidoc.hs b/src/Text/Pandoc/Writers/Asciidoc.hs index f51c43362..45aa2cbee 100644 --- a/src/Text/Pandoc/Writers/Asciidoc.hs +++ b/src/Text/Pandoc/Writers/Asciidoc.hs @@ -46,13 +46,19 @@ import Data.List ( isPrefixOf, intercalate ) import Text.Pandoc.Pretty import Control.Monad.State -data WriterState = WriterState { defListMarker :: String } +data WriterState = WriterState { defListMarker :: String + , orderedListLevel :: Int + , bulletListLevel :: Int + } -- | Convert Pandoc to Asciidoc. writeAsciidoc :: WriterOptions -> Pandoc -> String writeAsciidoc opts document = evalState (pandocToAsciidoc opts document) WriterState{ - defListMarker = "::" } + defListMarker = "::" + , orderedListLevel = 1 + , bulletListLevel = 1 + } -- | Return markdown representation of document. pandocToAsciidoc :: WriterOptions -> Pandoc -> State WriterState String -- cgit v1.2.3 From 40c7d096ccbc2f4bb0c0b4b79ba332c2542e997a Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Fri, 18 Nov 2011 17:50:41 -0800 Subject: Implemented bullet lists in asciidoc writer. --- src/Text/Pandoc/Writers/Asciidoc.hs | 39 +++++++++++++++++-------------------- 1 file changed, 18 insertions(+), 21 deletions(-) diff --git a/src/Text/Pandoc/Writers/Asciidoc.hs b/src/Text/Pandoc/Writers/Asciidoc.hs index 45aa2cbee..2ef5b45bb 100644 --- a/src/Text/Pandoc/Writers/Asciidoc.hs +++ b/src/Text/Pandoc/Writers/Asciidoc.hs @@ -209,8 +209,8 @@ blockToAsciidoc opts (Table caption aligns widths headers rows) = do blockToAsciidoc opts (BulletList items) = do contents <- mapM (bulletListItemToAsciidoc opts) items return $ cat contents <> blankline -blockToAsciidoc opts (OrderedList attribs items) = do - let markers = orderedListMarkers attribs +blockToAsciidoc opts (OrderedList (start, sty, _delim) items) = do + let markers = orderedListMarkers (start, sty, Period) let markers' = map (\m -> if length m < 3 then m ++ replicate (3 - length m) ' ' else m) markers @@ -223,11 +223,21 @@ blockToAsciidoc opts (DefinitionList items) = do -- | Convert bullet list item (list of blocks) to markdown. bulletListItemToAsciidoc :: WriterOptions -> [Block] -> State WriterState Doc -bulletListItemToAsciidoc opts items = do - contents <- blockListToAsciidoc opts items - let sps = replicate (writerTabStop opts - 2) ' ' - let start = text ('-' : ' ' : sps) - return $ hang (writerTabStop opts) start $ contents <> cr +bulletListItemToAsciidoc opts blocks = do + let addBlock :: Doc -> Block -> State WriterState Doc + addBlock d b | isEmpty d = chomp `fmap` blockToAsciidoc opts b + addBlock d b@(BulletList _) = do x <- blockToAsciidoc opts b + return $ d <> cr <> chomp x + addBlock d b@(OrderedList _ _) = do x <- blockToAsciidoc opts b + return $ d <> cr <> chomp x + addBlock d b = do x <- blockToAsciidoc opts b + return $ d <> cr <> text "+" <> cr <> chomp x + lev <- bulletListLevel `fmap` get + modify $ \s -> s{ bulletListLevel = lev + 1 } + contents <- foldM addBlock empty blocks + modify $ \s -> s{ bulletListLevel = lev } + let marker = text (replicate lev '*') + return $ marker <> space <> contents <> cr -- | Convert ordered list item (a list of blocks) to markdown. orderedListItemToAsciidoc :: WriterOptions -- ^ options @@ -263,20 +273,7 @@ definitionListItemToAsciidoc opts (label, defs) = do blockListToAsciidoc :: WriterOptions -- ^ Options -> [Block] -- ^ List of block elements -> State WriterState Doc -blockListToAsciidoc opts blocks = - mapM (blockToAsciidoc opts) (fixBlocks blocks) >>= return . cat - -- insert comment between list and indented code block, or the - -- code block will be treated as a list continuation paragraph - where fixBlocks (b : CodeBlock attr x : rest) - | (attr == nullAttr) && isListBlock b = - b : RawBlock "html" "\n" : CodeBlock attr x : - fixBlocks rest - fixBlocks (x : xs) = x : fixBlocks xs - fixBlocks [] = [] - isListBlock (BulletList _) = True - isListBlock (OrderedList _ _) = True - isListBlock (DefinitionList _) = True - isListBlock _ = False +blockListToAsciidoc opts blocks = cat `fmap` mapM (blockToAsciidoc opts) blocks -- | Convert list of Pandoc inline elements to markdown. inlineListToAsciidoc :: WriterOptions -> [Inline] -> State WriterState Doc -- cgit v1.2.3 From 11f6177670a7e0b15a42c7576a988c083d9c77e2 Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Fri, 18 Nov 2011 18:19:47 -0800 Subject: Implemented ordered lists in asciidoc. --- src/Text/Pandoc/Writers/Asciidoc.hs | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/src/Text/Pandoc/Writers/Asciidoc.hs b/src/Text/Pandoc/Writers/Asciidoc.hs index 2ef5b45bb..a3df93a3c 100644 --- a/src/Text/Pandoc/Writers/Asciidoc.hs +++ b/src/Text/Pandoc/Writers/Asciidoc.hs @@ -244,13 +244,20 @@ orderedListItemToAsciidoc :: WriterOptions -- ^ options -> String -- ^ list item marker -> [Block] -- ^ list item (list of blocks) -> State WriterState Doc -orderedListItemToAsciidoc opts marker items = do - contents <- blockListToAsciidoc opts items - let sps = case length marker - writerTabStop opts of - n | n > 0 -> text $ replicate n ' ' - _ -> text " " - let start = text marker <> sps - return $ hang (writerTabStop opts) start $ contents <> cr +orderedListItemToAsciidoc opts marker blocks = do + let addBlock :: Doc -> Block -> State WriterState Doc + addBlock d b | isEmpty d = chomp `fmap` blockToAsciidoc opts b + addBlock d b@(BulletList _) = do x <- blockToAsciidoc opts b + return $ d <> cr <> chomp x + addBlock d b@(OrderedList _ _) = do x <- blockToAsciidoc opts b + return $ d <> cr <> chomp x + addBlock d b = do x <- blockToAsciidoc opts b + return $ d <> cr <> text "+" <> cr <> chomp x + lev <- orderedListLevel `fmap` get + modify $ \s -> s{ orderedListLevel = lev + 1 } + contents <- foldM addBlock empty blocks + modify $ \s -> s{ orderedListLevel = lev } + return $ text marker <> space <> contents <> cr -- | Convert definition list item (label, list of blocks) to markdown. definitionListItemToAsciidoc :: WriterOptions -- cgit v1.2.3 From 965c9415b0daed39e5c7d43f413d99b32645cc2f Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Fri, 18 Nov 2011 18:22:09 -0800 Subject: Ensure blank line before html passthrough. --- src/Text/Pandoc/Writers/Asciidoc.hs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Text/Pandoc/Writers/Asciidoc.hs b/src/Text/Pandoc/Writers/Asciidoc.hs index a3df93a3c..d4c9e3c33 100644 --- a/src/Text/Pandoc/Writers/Asciidoc.hs +++ b/src/Text/Pandoc/Writers/Asciidoc.hs @@ -124,7 +124,7 @@ blockToAsciidoc opts (Para inlines) = do else empty return $ esc <> contents <> blankline blockToAsciidoc _ (RawBlock f str) | f == "html" || f == "docbook" = do - return $ "+++" $$ text str $$ "+++" <> blankline + return $ blankline $$ "+++" $$ text str $$ "+++" <> blankline blockToAsciidoc _ (RawBlock _ _) = return empty blockToAsciidoc _ HorizontalRule = return $ blankline <> text "'''''" <> blankline -- cgit v1.2.3 From f5af4903dfdad6b849f708f476832bdb07cca6a7 Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Fri, 18 Nov 2011 18:31:32 -0800 Subject: Removed link title in asciidoc. Apparently it is not supported. --- src/Text/Pandoc/Writers/Asciidoc.hs | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/src/Text/Pandoc/Writers/Asciidoc.hs b/src/Text/Pandoc/Writers/Asciidoc.hs index d4c9e3c33..f88594680 100644 --- a/src/Text/Pandoc/Writers/Asciidoc.hs +++ b/src/Text/Pandoc/Writers/Asciidoc.hs @@ -326,26 +326,23 @@ inlineToAsciidoc _ (RawInline _ _) = return empty inlineToAsciidoc _ (LineBreak) = return $ " +" <> cr inlineToAsciidoc _ Space = return space inlineToAsciidoc opts (Cite _ lst) = inlineListToAsciidoc opts lst -inlineToAsciidoc opts (Link txt (src', tit)) = do +inlineToAsciidoc opts (Link txt (src', _tit)) = do -- relative: link:downloads/foo.zip[download foo.zip] -- abs: http://google.cod[Google] -- or my@email.com[email john] linktext <- inlineListToAsciidoc opts txt - let linktitle = if null tit - then empty - else text $ ",title=\"" ++ tit ++ "\"" let src = unescapeURI src' - let isRelative = ':' `elem` src + let isRelative = ':' `notElem` src let prefix = if isRelative then text "link:" else empty let srcSuffix = if isPrefixOf "mailto:" src then drop 7 src else src - let useAuto = case (tit,txt) of - ("", [Code _ s]) | s == srcSuffix -> True - _ -> False + let useAuto = case txt of + [Code _ s] | s == srcSuffix -> True + _ -> False return $ if useAuto then text srcSuffix - else prefix <> text src <> "[" <> linktext <> linktitle <> "]" + else prefix <> text src <> "[" <> linktext <> "]" inlineToAsciidoc opts (Image alternate (src', tit)) = do -- image:images/logo.png[Company logo, title="blah"] let txt = if (null alternate) || (alternate == [Str ""]) -- cgit v1.2.3 From 457571e0c896d7ffbd7f53c9df4a9067d9ba0f68 Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Fri, 18 Nov 2011 19:38:00 -0800 Subject: Fixed continuations in asciidoc definition lists. --- src/Text/Pandoc/Writers/Asciidoc.hs | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/src/Text/Pandoc/Writers/Asciidoc.hs b/src/Text/Pandoc/Writers/Asciidoc.hs index f88594680..a4ed7f98d 100644 --- a/src/Text/Pandoc/Writers/Asciidoc.hs +++ b/src/Text/Pandoc/Writers/Asciidoc.hs @@ -42,7 +42,7 @@ import Text.Pandoc.Templates (renderTemplate) import Text.Pandoc.Shared import Text.Pandoc.Parsing hiding (blankline) import Text.ParserCombinators.Parsec ( runParser, GenParser ) -import Data.List ( isPrefixOf, intercalate ) +import Data.List ( isPrefixOf, intersperse, intercalate ) import Text.Pandoc.Pretty import Control.Monad.State @@ -147,9 +147,15 @@ blockToAsciidoc _ (CodeBlock (_,classes,_) str) = return $ else text $ intercalate "," $ "code" : classes blockToAsciidoc opts (BlockQuote blocks) = do contents <- blockListToAsciidoc opts blocks - let cols = offset contents + let isBlock (BlockQuote _) = True + isBlock _ = False + -- if there are nested block quotes, put in an open block + let contents' = if any isBlock blocks + then "--" $$ contents $$ "--" + else contents + let cols = offset contents' let bar = text $ replicate cols '_' - return $ bar $$ contents $$ bar <> blankline + return $ bar $$ chomp contents' $$ bar <> blankline blockToAsciidoc opts (Table caption aligns widths headers rows) = do caption' <- inlineListToAsciidoc opts caption let caption'' = if null caption @@ -269,11 +275,13 @@ definitionListItemToAsciidoc opts (label, defs) = do if marker == "::" then modify (\st -> st{ defListMarker = ";;"}) else modify (\st -> st{ defListMarker = "::"}) + let divider = cr <> text "+" <> cr let defsToAsciidoc :: [Block] -> State WriterState Doc - defsToAsciidoc ds = vcat `fmap` mapM (blockToAsciidoc opts) ds + defsToAsciidoc ds = (vcat . intersperse divider . map chomp) + `fmap` mapM (blockToAsciidoc opts) ds defs' <- mapM defsToAsciidoc defs modify (\st -> st{ defListMarker = marker }) - let contents = nest 2 $ vsep defs' + let contents = nest 2 $ vcat $ intersperse divider $ map chomp defs' return $ labelText <> text marker <> cr <> contents <> cr -- | Convert list of Pandoc block elements to markdown. -- cgit v1.2.3 From c1710f9bde6d84da4a40c825da558714cf058e25 Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Fri, 18 Nov 2011 19:44:15 -0800 Subject: Skip raw HTML blocks in asciidoc. --- src/Text/Pandoc/Writers/Asciidoc.hs | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/Text/Pandoc/Writers/Asciidoc.hs b/src/Text/Pandoc/Writers/Asciidoc.hs index a4ed7f98d..91930ac68 100644 --- a/src/Text/Pandoc/Writers/Asciidoc.hs +++ b/src/Text/Pandoc/Writers/Asciidoc.hs @@ -123,8 +123,6 @@ blockToAsciidoc opts (Para inlines) = do then text "\\" else empty return $ esc <> contents <> blankline -blockToAsciidoc _ (RawBlock f str) | f == "html" || f == "docbook" = do - return $ blankline $$ "+++" $$ text str $$ "+++" <> blankline blockToAsciidoc _ (RawBlock _ _) = return empty blockToAsciidoc _ HorizontalRule = return $ blankline <> text "'''''" <> blankline -- cgit v1.2.3 From 4c122be58a66283dd31c2a357099637c945055a6 Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Fri, 18 Nov 2011 19:46:12 -0800 Subject: Updated asciidoc test. The test output still contains some mistakes. --- tests/writer.asciidoc | 555 +++++++++++++++++++++----------------------------- 1 file changed, 229 insertions(+), 326 deletions(-) diff --git a/tests/writer.asciidoc b/tests/writer.asciidoc index 60a9518a7..514c72976 100644 --- a/tests/writer.asciidoc +++ b/tests/writer.asciidoc @@ -1,10 +1,11 @@ Pandoc Test Suite ================= -John MacFarlane; Anonymous -July 17, 2006 +:author: John MacFarlane +:author: Anonymous +:date: July 17, 2006 -This is a set of tests for pandoc. Most of them are adapted from John Gruber's -markdown test suite. +This is a set of tests for pandoc. Most of them are adapted from John +Gruber’s markdown test suite. ''''' @@ -14,7 +15,7 @@ Headers Level 2 with an link:/url[embedded link] ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Level 3 with *emphasis* +Level 3 with _emphasis_ ^^^^^^^^^^^^^^^^^^^^^^^ Level 4 @@ -34,7 +35,7 @@ Level 3 with no blank line Level 2 -------- +~~~~~~~ with no blank line @@ -45,9 +46,9 @@ Paragraphs Here’s a regular paragraph. -In Markdown 1.0.0 and earlier. Version 8. This line turns into a list item. -Because a hard-wrapped line in the middle of a paragraph looked like a list -item. +In Markdown 1.0.0 and earlier. Version 8. This line turns into a list +item. Because a hard-wrapped line in the middle of a paragraph looked +like a list item. Here’s one with a bullet. \* criminey. @@ -65,28 +66,34 @@ __________________________________________ This is a block quote. It is pretty short. __________________________________________ ------------------------- +______________________ +-- Code in a block quote: - sub status { - print "working"; - } ------------------------- +-------------------- +sub status { + print "working"; +} +-------------------- A list: -. item one -. item two +1. item one +2. item two Nested block quotes: ______ nested ______ -nested + ______ +nested ______ +-- +______________________ + This should not be a block quote: 2 \> 1. And a following paragraph. @@ -98,7 +105,7 @@ Code Blocks Code: ----- +-------------------------------------- ---- (should be four hyphens) sub status { @@ -106,15 +113,15 @@ sub status { } this code block is indented by one tab ----- +-------------------------------------- And: ----- +-------------------------------------------- this code block is indented by two tabs These should not be escaped: \$ \\ \> \[ \{ ----- +-------------------------------------------- ''''' @@ -126,7 +133,6 @@ Unordered Asterisks tight: -[options="compact"] * asterisk 1 * asterisk 2 * asterisk 3 @@ -134,14 +140,11 @@ Asterisks tight: Asterisks loose: * asterisk 1 - * asterisk 2 - * asterisk 3 Pluses tight: -[options="compact"] * Plus 1 * Plus 2 * Plus 3 @@ -149,14 +152,11 @@ Pluses tight: Pluses loose: * Plus 1 - * Plus 2 - * Plus 3 Minuses tight: -[options="compact"] * Minus 1 * Minus 2 * Minus 3 @@ -164,9 +164,7 @@ Minuses tight: Minuses loose: * Minus 1 - * Minus 2 - * Minus 3 Ordered @@ -174,43 +172,35 @@ Ordered Tight: -[options="compact"] -1. First -2. Second -3. Third +1. First +2. Second +3. Third and: -[options="compact"] -1. One -2. Two -3. Three +1. One +2. Two +3. Three Loose using tabs: -1. First - -2. Second - -3. Third +1. First +2. Second +3. Third and using spaces: -1. One - -2. Two - -3. Three +1. One +2. Two +3. Three Multiple paragraphs: -1. Item 1, graf one. +1. Item 1, graf one. + Item 1. graf two. The quick brown fox jumped over the lazy dog’s back. - -2. Item 2. - -3. Item 3. +2. Item 2. +3. Item 3. Nested ~~~~~~ @@ -221,70 +211,54 @@ Nested Here’s another: -1. First -2. Second: - [options="compact"] - * Fee - * Fie - * Foe - -3. Third +1. First +2. Second: +* Fee +* Fie +* Foe +3. Third Same thing but with paragraphs: -1. First - -2. Second: - - [options="compact"] - * Fee - * Fie - * Foe - +1. First +2. Second: +* Fee +* Fie +* Foe 3. Third Tabs and spaces ~~~~~~~~~~~~~~~ * this is a list item indented with tabs - * this is a list item indented with spaces - ** this is an example list item indented with tabs - ** this is an example list item indented with spaces Fancy list markers ~~~~~~~~~~~~~~~~~~ -[start=2] -2. begins with 2 -3. and now 3 +2. begins with 2 +3. and now 3 + with a continuation -+ -[start=4] -4. sublist with roman numerals, starting with 4 -5. more items - A. a subsublist - B. a subsublist +iv. sublist with roman numerals, starting with 4 +v. more items +A. a subsublist +B. a subsublist Nesting: -A. Upper Alpha - 1. Upper Roman. - + - [start=6] - 6. Decimal start with 6 - + - [start=3] - c. Lower alpha with paren +A. Upper Alpha +I. Upper Roman. +6. Decimal start with 6 +c. Lower alpha with paren Autonumbering: -1. Autonumber. -2. More. - 1. Nested. +1. Autonumber. +2. More. +1. Nested. Should not be a list item: @@ -299,217 +273,160 @@ Definition Lists Tight using spaces: -apple - ~ red fruit -orange - ~ orange fruit -banana - ~ yellow fruit +apple:: + red fruit +orange:: + orange fruit +banana:: + yellow fruit Tight using tabs: -apple - ~ red fruit -orange - ~ orange fruit -banana - ~ yellow fruit +apple:: + red fruit +orange:: + orange fruit +banana:: + yellow fruit Loose: -apple - ~ red fruit - -orange - ~ orange fruit - -banana - ~ yellow fruit +apple:: + red fruit +orange:: + orange fruit +banana:: + yellow fruit Multiple blocks with italics: -*apple* - ~ red fruit - - contains seeds, crisp, pleasant to taste - -*orange* - ~ orange fruit - - { orange code block } - - > orange block quote +_apple_:: + red fruit + + + contains seeds, crisp, pleasant to taste +_orange_:: + orange fruit + + +--------------------- +{ orange code block } +--------------------- + + + __________________ + orange block quote + __________________ Multiple definitions, tight: -apple - ~ red fruit - ~ computer -orange - ~ orange fruit - ~ bank +apple:: + red fruit + + + computer +orange:: + orange fruit + + + bank Multiple definitions, loose: -apple - ~ red fruit - - ~ computer - -orange - ~ orange fruit - - ~ bank +apple:: + red fruit + + + computer +orange:: + orange fruit + + + bank Blank line after term, indented marker, alternate markers: -apple - ~ red fruit - - ~ computer - -orange - ~ orange fruit - - 1. sublist - 2. sublist +apple:: + red fruit + + + computer +orange:: + orange fruit + + + 1. sublist + 2. sublist HTML Blocks ----------- Simple block on one line: -
foo -
- And nested without indentation: -
-
-
foo -
-
-
bar -
-
- Interpreted markdown in a table: - - - - - -
-This is *emphasized* - -And this is **strong** -
- - - +This is _emphasized_ +And this is *strong* Here’s a simple block: -
- foo -
- This should be a code block, though: -
- foo -
+------- +
+ foo +
+------- As should this: -
foo
+-------------- +
foo
+-------------- Now, nested: -
-
-
- foo -
-
-
- This should just be an HTML comment: - - Multiline: - - - - Code block: - +---------------- + +---------------- Just plain comment, with trailing spaces on the line: - - Code: -
- -Hr’s: - -
- -
- +------
+------ -
- -
- -
- -
- -
- -
+Hr’s: ''''' Inline Markup ------------- -This is *emphasized*, and so *is this*. +This is _emphasized_, and so _is this_. -This is **strong**, and so **is this**. +This is *strong*, and so *is this*. -An *[emphasized link](/url)*. +An _link:/url[emphasized link]_. -***This is strong and em.*** +*_This is strong and em._* -So is ***this*** word. +So is *_this_* word. -***This is strong and em.*** +*_This is strong and em._* -So is ***this*** word. +So is *_this_* word. This is code: `>`, `$`, `\`, `\$`, ``. -~~This is *strikeout*.~~ +[line-through]*This is _strikeout_.* -Superscripts: a^bc^d a^*hello*^ a^hello there^. +Superscripts: a^bc^d a^_hello_^ a^hello there^. Subscripts: H~2~O, H~23~O, H~many of them~O. @@ -521,16 +438,16 @@ spaces: a\^b c\^d, a\~b c\~d. Smart quotes, ellipses, dashes ------------------------------ -“Hello,” said the spider. “‘Shelob’ is my name.” +``Hello,'' said the spider. ```Shelob' is my name.'' -‘A’, ‘B’, and ‘C’ are letters. +`A', `B', and `C' are letters. -‘Oak,’ ‘elm,’ and ‘beech’ are names of trees. So is ‘pine.’ +`Oak,' `elm,' and `beech' are names of trees. So is `pine.' -‘He said, “I want to go.”’ Were you alive in the 70’s? +`He said, ``I want to go.''' Were you alive in the 70’s? -Here is some quoted ‘`code`’ and a “[quoted -link](http://example.com/?foo=1&bar=2)”. +Here is some quoted ``code`' and a +``http://example.com/?foo=1&bar=2[quoted link]''. Some dashes: one—two — three—four — five. @@ -543,32 +460,27 @@ Ellipses…and…and…. LaTeX ----- -- \cite[22-23]{smith.1899} -- $2+2=4$ -- $x \in y$ -- $\alpha \wedge \omega$ -- $223$ -- $p$-Tree -- Here’s some display math: - $$\frac{d}{dx}f(x)=\lim_{h\to 0}\frac{f(x+h)-f(x)}{h}$$ -- Here’s one that has a line break in it: $\alpha + \omega \times x^2$. +* +* latexmath:[$2+2=4$] +* latexmath:[$x \in y$] +* latexmath:[$\alpha \wedge \omega$] +* latexmath:[$223$] +* latexmath:[$p$]-Tree +* Here’s some display math: +latexmath:[$$\frac{d}{dx}f(x)=\lim_{h\to 0}\frac{f(x+h)-f(x)}{h}$$] +* Here’s one that has a line break in it: +latexmath:[$\alpha + \omega \times x^2$]. These shouldn’t be math: -- To get the famous equation, write `$e = mc^2$`. -- $22,000 is a *lot* of money. So is $34,000. (It worked if “lot” is - emphasized.) -- Shoes ($20) and socks ($5). -- Escaped `$`: $73 *this should be emphasized* 23$. +* To get the famous equation, write `$e = mc^2$`. +* $22,000 is a _lot_ of money. So is $34,000. (It worked if ``lot'' is +emphasized.) +* Shoes ($20) and socks ($5). +* Escaped `$`: $73 _this should be emphasized_ 23$. Here’s a LaTeX table: -\begin{tabular}{|l|l|}\hline -Animal & Number \\ \hline -Dog & 2 \\ -Cat & 1 \\ \hline -\end{tabular} - ''''' Special Characters @@ -576,11 +488,11 @@ Special Characters Here is some unicode: -- I hat: Î -- o umlaut: ö -- section: § -- set membership: ∈ -- copyright: © +* I hat: Î +* o umlaut: ö +* section: § +* set membership: ∈ +* copyright: © AT&T has an ampersand in their name. @@ -600,7 +512,7 @@ Asterisk: \* Underscore: \_ -Left brace: { +Left brace: \{ Right brace: } @@ -620,7 +532,7 @@ Period: . Bang: ! -Plus: + +Plus: \+ Minus: - @@ -632,123 +544,114 @@ Links Explicit ~~~~~~~~ -Just a [URL](/url/). +Just a link:/url/[URL]. -[URL and title](/url/ "title"). +link:/url/[URL and title]. -[URL and title](/url/ "title preceded by two spaces"). +link:/url/[URL and title]. -[URL and title](/url/ "title preceded by a tab"). +link:/url/[URL and title]. -[URL and title](/url/ "title with "quotes" in it") +link:/url/[URL and title] -[URL and title](/url/ "title with single quotes") +link:/url/[URL and title] -[with\_underscore](/url/with_underscore) +link:/url/with_underscore[with\_underscore] -[Email link](mailto:nobody@nowhere.net) +mailto:nobody@nowhere.net[Email link] -[Empty](). +link:[Empty]. Reference ~~~~~~~~~ -Foo [bar](/url/). +Foo link:/url/[bar]. -Foo [bar](/url/). +Foo link:/url/[bar]. -Foo [bar](/url/). +Foo link:/url/[bar]. -With [embedded [brackets]](/url/). +With link:/url/[embedded [brackets]]. -[b](/url/) by itself should be a link. +link:/url/[b] by itself should be a link. -Indented [once](/url). +Indented link:/url[once]. -Indented [twice](/url). +Indented link:/url[twice]. -Indented [thrice](/url). +Indented link:/url[thrice]. This should [not][] be a link. - [not]: /url +----------- +[not]: /url +----------- -Foo [bar](/url/ "Title with "quotes" inside"). +Foo link:/url/[bar]. -Foo [biz](/url/ "Title with "quote" inside"). +Foo link:/url/[biz]. With ampersands ~~~~~~~~~~~~~~~ -Here’s a [link with an ampersand in the URL](http://example.com/?foo=1&bar=2). +Here’s a http://example.com/?foo=1&bar=2[link with an ampersand in the +URL]. -Here’s a link with an amersand in the link text: -[AT&T](http://att.com/ "AT&T"). +Here’s a link with an amersand in the link text: http://att.com/[AT&T]. -Here’s an [inline link](/script?foo=1&bar=2). +Here’s an link:/script?foo=1&bar=2[inline link]. -Here’s an [inline link in pointy braces](/script?foo=1&bar=2). +Here’s an link:/script?foo=1&bar=2[inline link in pointy braces]. Autolinks ~~~~~~~~~ -With an ampersand: +With an ampersand: http://example.com/?foo=1&bar=2 -- In a list? -- -- It should. +* In a list? +* http://example.com/ +* It should. -An e-mail address: +An e-mail address: nobody@nowhere.net -> Blockquoted: +________________________________ +Blockquoted: http://example.com/ +________________________________ Auto-links should not occur here: `` - or here: +------------------------------ +or here: +------------------------------ ''''' Images ------ -From “Voyage dans la Lune” by Georges Melies (1902): +From ``Voyage dans la Lune'' by Georges Melies (1902): -![lalune](lalune.jpg "Voyage dans la Lune") +image:lalune.jpg[lalune,title="Voyage dans la Lune"] -Here is a movie ![movie](movie.jpg) icon. +Here is a movie image:movie.jpg[movie] icon. ''''' Footnotes --------- -Here is a footnote reference,[^1] and another.[^2] This should *not* be a -footnote reference, because it contains a space.[\^my note] Here is an inline -note.[^3] +Here is a footnote reference,footnote:[Here is the footnote. It can go +anywhere after the footnote reference. It need not be placed at the end +of the document.] and another.[multiblock footnote omitted] This should +_not_ be a footnote reference, because it contains a space.[\^my note] +Here is an inline note.footnote:[This is _easier_ to type. Inline notes +may contain http://google.com[links] and `]` verbatim characters, as +well as [bracketed text].] -> Notes can go in quotes.[^4] +___________________________________________ +Notes can go in quotes.footnote:[In quote.] +___________________________________________ -1. And in list items.[^5] +1. And in list items.footnote:[In list.] This paragraph should not be part of the note, as it is not indented. - -[^1]: Here is the footnote. It can go anywhere after the footnote reference. - It need not be placed at the end of the document. - -[^2]: Here’s the long note. This one contains multiple blocks. - - Subsequent blocks are indented to show that they belong to the footnote - (as with list items). - - { } - - If you want, you can indent every line, but you can also be lazy and just - indent the first line of each block. - -[^3]: This is *easier* to type. Inline notes may contain - [links](http://google.com) and `]` verbatim characters, as well as - [bracketed text]. - -[^4]: In quote. - -[^5]: In list. -- cgit v1.2.3 From 679e94e53d36efa24507cae960533a6a0f9053e8 Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Fri, 18 Nov 2011 19:50:45 -0800 Subject: Updated tests for correct col width. --- tests/tables.asciidoc | 8 ++++---- tests/writer.asciidoc | 29 ++++++++++++++--------------- 2 files changed, 18 insertions(+), 19 deletions(-) diff --git a/tests/tables.asciidoc b/tests/tables.asciidoc index 842a9b8c4..38daca192 100644 --- a/tests/tables.asciidoc +++ b/tests/tables.asciidoc @@ -52,20 +52,20 @@ Multiline table without caption: Table without column headers: [cols=">,<,^,>",] -|======================================================================= +|============================================================================= |12 |12 |12 |12 |123 |123 |123 |123 |1 |1 |1 |1 -|======================================================================= +|============================================================================= Multiline table without column headers: [width="78%",cols="^21%,<17%,>20%,42%",] -|======================================================================= +|============================================================================= |First |row |12.0 |Example of a row that spans multiple lines. |Second |row |5.0 |Here's another one. Note the blank line between rows. -|======================================================================= +|============================================================================= diff --git a/tests/writer.asciidoc b/tests/writer.asciidoc index 514c72976..af27e02ce 100644 --- a/tests/writer.asciidoc +++ b/tests/writer.asciidoc @@ -4,8 +4,8 @@ Pandoc Test Suite :author: Anonymous :date: July 17, 2006 -This is a set of tests for pandoc. Most of them are adapted from John -Gruber’s markdown test suite. +This is a set of tests for pandoc. Most of them are adapted from John Gruber’s +markdown test suite. ''''' @@ -46,9 +46,9 @@ Paragraphs Here’s a regular paragraph. -In Markdown 1.0.0 and earlier. Version 8. This line turns into a list -item. Because a hard-wrapped line in the middle of a paragraph looked -like a list item. +In Markdown 1.0.0 and earlier. Version 8. This line turns into a list item. +Because a hard-wrapped line in the middle of a paragraph looked like a list +item. Here’s one with a bullet. \* criminey. @@ -446,8 +446,8 @@ Smart quotes, ellipses, dashes `He said, ``I want to go.''' Were you alive in the 70’s? -Here is some quoted ``code`' and a -``http://example.com/?foo=1&bar=2[quoted link]''. +Here is some quoted ``code`' and a ``http://example.com/?foo=1&bar=2[quoted +link]''. Some dashes: one—two — three—four — five. @@ -594,8 +594,7 @@ Foo link:/url/[biz]. With ampersands ~~~~~~~~~~~~~~~ -Here’s a http://example.com/?foo=1&bar=2[link with an ampersand in the -URL]. +Here’s a http://example.com/?foo=1&bar=2[link with an ampersand in the URL]. Here’s a link with an amersand in the link text: http://att.com/[AT&T]. @@ -641,12 +640,12 @@ Footnotes --------- Here is a footnote reference,footnote:[Here is the footnote. It can go -anywhere after the footnote reference. It need not be placed at the end -of the document.] and another.[multiblock footnote omitted] This should -_not_ be a footnote reference, because it contains a space.[\^my note] -Here is an inline note.footnote:[This is _easier_ to type. Inline notes -may contain http://google.com[links] and `]` verbatim characters, as -well as [bracketed text].] +anywhere after the footnote reference. It need not be placed at the end of the +document.] and another.[multiblock footnote omitted] This should _not_ be a +footnote reference, because it contains a space.[\^my note] Here is an inline +note.footnote:[This is _easier_ to type. Inline notes may contain +http://google.com[links] and `]` verbatim characters, as well as [bracketed +text].] ___________________________________________ Notes can go in quotes.footnote:[In quote.] -- cgit v1.2.3