rpeg-multimarkdown 0.1.1 → 0.2

data/lib/peg_multimarkdown.rb

@@ -3,25 +3,25 @@ require 'peg_multimarkdown.so'
 # Front-end to fletcher penney's peg-multimarkdown implementation of MultiMarkdown
 #
 # A simple processor:
-#   >>> puts MultiMarkdown.new("Hello, World.").to_html
-#   <p>Hello, World.</p>
+#     >> puts MultiMarkdown.new("Hello, World.").to_html
+#     <p>Hello, World.</p>
 #
 # With other stuff:
-#   >>> puts MultiMarkdown.new("_Hello -- World!_", :smart, :filter_html).to_html
-#   <p><em>Hello World!</em></p>
+#     >> puts MultiMarkdown.new("_Hello World!_", :smart, :filter_html).to_html
+#     <p><em>Hello World!</em></p>
 #
 class PEGMultiMarkdown
 
   # Original MultiMarkdown formatted text.
   attr_reader :text
 
-  # Set true to have smarty-like quote translation performed.
+  # Set `true` to have smarty-like quote translation performed.
   attr_accessor :smart
 
-  # Set true to have footnotes processed.
+  # Set `true` to have footnotes processed.
   attr_accessor :notes
 
-  # Do not output <style> tags included in the source text.
+  # Do not output `<style>` tags included in the source text.
   attr_accessor :filter_styles
 
   # Do not output any raw HTML included in the source text.
@@ -36,20 +36,20 @@ class PEGMultiMarkdown
   # Included for compatibility with RedCloth's interface.
   attr_accessor :fold_lines
 
-  # Create a new MultiMarkdown processor. The +text+ argument is a string
+  # Create a new MultiMarkdown processor. The `text` argument is a string
   # containing MultiMarkdown text. Variable other arguments may be supplied to
   # set various processing options:
   #
-  # * <tt>:smart</tt> - Enable SmartyPants processing.
-  # * <tt>:notes</tt> - Enable footnotes.
-  # * <tt>:filter_styles</tt> - Do not output <style> tags included in the
+  # * `:smart` - Enable SmartyPants processing.
+  # * `:notes` - Enable footnotes.
+  # * `:filter_styles` - Do not output `<style>` tags included in the
   #   source text.
-  # * <tt>:filter_html</tt> - Do not output raw HTML included in the
+  # * `:filter_html` - Do not output raw HTML included in the
   #   source text.
-  # * <tt>:process_html</tt> - Process MultiMarkdown code inside HTML tags.
-  # * <tt>:compatibility</tt> - Process MultiMarkdown code in Markdown 
-  #   compatibility mode.
-  # * <tt>:fold_lines</tt> - RedCloth compatible line folding (not used).
+  # * `:process_html` - Process MultiMarkdown code inside HTML tags.
+  # * `:compatibility` - Process MultiMarkdown code in Markdown 
+  #   compatibility mode (disables all other extensions)
+  # * `:fold_lines` - RedCloth compatible line folding (not used).
   #
   def initialize(text, *extensions)
     @text = text

data/test/MultiMarkdownTest/BeamerTests/Beamer-Tables.tex

@@ -13,7 +13,7 @@
 \setlength{\tymax}{0.5\linewidth}
 \centering
 \small
-\begin{tabular}{@{}lcc@{}} \toprule
+\begin{tabulary}{\textwidth}{@{}LCC@{}} \toprule
 Features&MultiMarkdown&Crayons\\
 \midrule
 Melts in warm places&No&Yes\\
@@ -26,7 +26,7 @@ Minimum markup for maximum quality?&Yes&No\\
 
 \bottomrule
 
-\end{tabular}
+\end{tabulary}
 \end{minipage}
 \end{table}
 

data/test/MultiMarkdownTest/CompatibilityTests/Automatic Labels.html

@@ -0,0 +1,35 @@
+<p>latex input: mmd-article-header
+Title: MultiMarkdown Autoreference Test<br/>
+base header level: 2
+latex input: mmd-article-begin-doc
+latex footer: mmd-memoir-footer</p>
+
+<h1>109&amp;^*&amp;#^() Must Start With Alpha</h1>
+
+<h1>Strip out &amp;^% characters ^&amp;*^</h1>
+
+<h1>Special Cross Reference Cases</h1>
+
+<h2>1 Cross-References: Special Characters!@#$%^&amp;*()&lt;&gt;</h2>
+
+<p>And now, link to [1 Cross-References: Special Characters!@#$%^&amp;*()&lt;&gt;][]</p>
+
+<h1>Setext 1</h1>
+
+<h2>Setext 2</h2>
+
+<h1>Atx 1</h1>
+
+<p>Link to [Setext 1].</p>
+
+<p>And [Setext 2].</p>
+
+<p>And [Atx 1].</p>
+
+<p>And [Atx 2] should fail.</p>
+
+<h1>Manual Header [label]</h1>
+
+<h1>Manual Header 2 [label2]</h1>
+
+<h2>Manual Header 3 [label3]</h2>

data/test/MultiMarkdownTest/CompatibilityTests/Automatic Labels.text

@@ -0,0 +1,45 @@
+latex input:		mmd-article-header
+Title:				MultiMarkdown Autoreference Test  
+base header level:	2
+latex input:		mmd-article-begin-doc
+latex footer:		mmd-memoir-footer
+
+# 109&^*&#^() Must Start With Alpha #
+
+# Strip out &^% characters ^&*^ #
+
+
+# Special Cross Reference Cases#
+
+## 1 Cross-References: Special Characters!@#$%^&*()<>##
+
+And now, link to [1 Cross-References: Special Characters!@#$%^&*()<>][]
+
+
+Setext 1
+========
+
+
+Setext 2
+--------
+
+#Atx 1 #
+
+
+Link to [Setext 1].
+
+And [Setext 2].
+
+And [Atx 1].
+
+And [Atx 2] should fail.
+
+
+# Manual Header [label] #
+
+
+Manual Header 2 [label2]
+========================
+
+Manual Header 3 [label3]
+------------------------

data/test/MultiMarkdownTest/CompatibilityTests/Base Header Level.html

@@ -0,0 +1,14 @@
+<p>latex input: mmd-article-header
+Title: MultiMarkdown Base Header Level Test<br/>
+latex mode: memoir
+Base Header Level: 2
+latex input: mmd-article-begin-doc
+latex footer: mmd-memoir-footer</p>
+
+<h1>This should be h2</h1>
+
+<h2>This should be h3</h2>
+
+<h5>This should be h6</h5>
+
+<h6>This should be h6 in HTML h7 in LaTeX</h6>

data/test/MultiMarkdownTest/CompatibilityTests/Base Header Level.text

@@ -0,0 +1,16 @@
+latex input:		mmd-article-header
+Title:				MultiMarkdown Base Header Level Test  
+latex mode:			memoir
+Base Header Level:	2
+latex input:		mmd-article-begin-doc
+latex footer:		mmd-memoir-footer
+
+# This should be h2 #
+
+## This should be h3 ##
+
+
+##### This should be h6 #####
+
+###### This should be h6 in HTML h7 in LaTeX ######
+

data/test/MultiMarkdownTest/CompatibilityTests/BibTeX.html

@@ -0,0 +1,9 @@
+<p>latex input: mmd-article-header
+Title: MultiMarkdown BibTeX Test<br/>
+BibTeX: bibtex
+latex input: mmd-article-begin-doc
+latex footer: mmd-memoir-footer</p>
+
+<p>This is a test of BibTeX Support.[#Knuth:1968]</p>
+
+<p>And a locator.[p. 123][#Knuth:1981]</p>

data/test/MultiMarkdownTest/CompatibilityTests/BibTeX.text

@@ -0,0 +1,10 @@
+latex input:	mmd-article-header
+Title:			MultiMarkdown BibTeX Test  
+BibTeX:			bibtex
+latex input:	mmd-article-begin-doc
+latex footer:	mmd-memoir-footer
+
+This is a test of BibTeX Support.[#Knuth:1968]
+
+And a locator.[p. 123][#Knuth:1981]
+

data/test/MultiMarkdownTest/CompatibilityTests/Citations.html

@@ -0,0 +1,40 @@
+<p>latex input: mmd-article-header
+Title: MultiMarkdown Citation Test<br/>
+CSS: http://fletcherpenney.net/css/document.css<br/>
+BibTex: fake
+latex input: mmd-article-begin-doc
+latex footer: mmd-memoir-footer</p>
+
+<p>This is a test of citations[#first] for[^note] MultiMarkdown[#second].</p>
+
+<p>And an unlisted citation.[#Author:1988].</p>
+
+<p>And now some repeats...[^note2]</p>
+
+<p>This is a test of citations[p. 123][#first] for MultiMarkdown[#second].</p>
+
+<p>And an unlisted citation[#Author:1988].</p>
+
+<p>Unlisted with locator.[test][#Author:1988]</p>
+
+<p>Empty locator.[#first][]</p>
+
+<p>Consecutive citations.[#first][#second]</p>
+
+<p>Consecutive citations.[#first][][#second][]</p>
+
+<p>An &quot;improperly&quot; formed citation.[][#second]</p>
+
+<p>And an &quot;improper&quot; sequence.[][#first][][#second]</p>
+
+<p>[not cited][#third]</p>
+
+<p>[#first]: John Doe. <em>A Totally Fake Book</em>. Vanity Press, 2006.</p>
+
+<p>[#second]: Jane Doe. <em>Another Totally Fake Book</em>. Vanity Press, 2008.</p>
+
+<p>[#third]: Jim Doe. <em>Yet Another Fake Book</em>. Vanity Press, 2010.</p>
+
+<p>[^note]: A footnote for good measure.</p>
+
+<p>[^note2]: And another footnote</p>

data/test/MultiMarkdownTest/CompatibilityTests/Citations.text

@@ -0,0 +1,42 @@
+latex input:		mmd-article-header
+Title:				MultiMarkdown Citation Test  
+CSS:				http://fletcherpenney.net/css/document.css  
+BibTex:				fake
+latex input:		mmd-article-begin-doc
+latex footer:		mmd-memoir-footer
+
+This is a test of citations[#first] for[^note] MultiMarkdown[#second].
+
+And an unlisted citation.[#Author:1988].
+
+And now some repeats...[^note2]
+
+This is a test of citations[p. 123][#first] for MultiMarkdown[#second].
+
+And an unlisted citation[#Author:1988].
+
+Unlisted with locator.[test][#Author:1988]
+
+Empty locator.[#first][]
+
+Consecutive citations.[#first][#second]
+
+Consecutive citations.[#first][][#second][]
+
+An "improperly" formed citation.[][#second]
+
+And an "improper" sequence.[][#first][][#second]
+
+
+[not cited][#third]
+
+
+[#first]: John Doe. *A Totally Fake Book*.  Vanity Press, 2006.
+
+[#second]: Jane Doe. *Another Totally Fake Book*.  Vanity Press, 2008.
+
+[#third]: Jim Doe. *Yet Another Fake Book*. Vanity Press, 2010.
+
+[^note]: A footnote for good measure.
+
+[^note2]: And another footnote

data/test/MultiMarkdownTest/CompatibilityTests/Definition Lists.html

@@ -0,0 +1,40 @@
+<p>latex input: mmd-article-header
+Title: MultiMarkdown Definition List Test<br/>
+latex input: mmd-article-begin-doc
+latex footer: mmd-memoir-footer</p>
+
+<p>Term 1
+Term 2
+: Definition a</p>
+
+<p>Term 3
+: Definition b
+: Definition c</p>
+
+<p>Term 1</p>
+
+<p>: This is a definition with two paragraphs. Lorem ipsum
+ dolor sit amet, consectetuer adipiscing elit. Aliquam
+ hendrerit mi posuere lectus.</p>
+
+<pre><code>Vestibulum enim wisi, viverra nec, fringilla in, laoreet
+vitae, risus.
+</code></pre>
+
+<p>: Second definition for term 1, also wrapped in a paragraph
+ because of the blank line preceding it.</p>
+
+<p>Term 2</p>
+
+<p>: This definition has a code block, a blockquote and a list.</p>
+
+<pre><code>    code block.
+
+&gt; block quote
+&gt; on two lines.
+
+1.  first list item
+2.  second list item
+</code></pre>
+
+<p>And this is a regular paragraph.</p>

data/test/MultiMarkdownTest/CompatibilityTests/Definition Lists.text

@@ -0,0 +1,39 @@
+latex input:	mmd-article-header
+Title:			MultiMarkdown Definition List Test  
+latex input:	mmd-article-begin-doc
+latex footer:	mmd-memoir-footer
+
+Term 1
+Term 2
+:   Definition a
+
+Term 3
+:   Definition b
+:	Definition c
+
+
+Term 1
+
+:   This is a definition with two paragraphs. Lorem ipsum 
+    dolor sit amet, consectetuer adipiscing elit. Aliquam 
+    hendrerit mi posuere lectus.
+
+    Vestibulum enim wisi, viverra nec, fringilla in, laoreet
+    vitae, risus.
+
+:   Second definition for term 1, also wrapped in a paragraph
+    because of the blank line preceding it.
+
+Term 2
+
+:   This definition has a code block, a blockquote and a list.
+
+        code block.
+
+    > block quote
+    > on two lines.
+
+    1.  first list item
+    2.  second list item
+
+And this is a regular paragraph.

data/test/MultiMarkdownTest/CompatibilityTests/Dutch.html

@@ -0,0 +1,17 @@
+<p>latex input: mmd-article-header<br/>
+Title: MultiMarkdown Dutch Test<br/>
+quoteslanguage: dutch<br/>
+latex input: mmd-article-begin-doc<br/>
+latex footer: mmd-memoir-footer </p>
+
+<p>'this is a single quote'</p>
+
+<p>&quot;this is a double quote&quot;</p>
+
+<p>this isn't an apostrophe.</p>
+
+<p>this is an em --- dash</p>
+
+<p>this is an en -- dash</p>
+
+<p>and an ellipsis...</p>

data/test/MultiMarkdownTest/CompatibilityTests/Dutch.text

@@ -0,0 +1,17 @@
+latex input:	mmd-article-header  
+Title:			MultiMarkdown Dutch Test  
+quoteslanguage:	dutch  
+latex input:	mmd-article-begin-doc  
+latex footer:	mmd-memoir-footer  
+
+'this is a single quote'
+
+"this is a double quote"
+
+this isn't an apostrophe.
+
+this is an em --- dash
+
+this is an en -- dash
+
+and an ellipsis...

data/test/MultiMarkdownTest/CompatibilityTests/Email.html

@@ -0,0 +1,40 @@
+<p>latex input: mmd-article-header<br/>
+Title: Email Test<br/>
+latex input: mmd-article-begin-doc<br/>
+latex footer: mmd-memoir-footer </p>
+
+<p>Link: <a href="&#x6d;&#x61;&#x69;&#108;&#116;&#111;&#58;&#117;&#x73;&#x65;&#114;&#x36;&#55;&#64;&#x65;&#x78;&#x61;&#x6d;&#112;&#108;&#x65;&#x2e;&#x63;&#x6f;&#109;">&#x75;&#x73;&#101;&#114;&#x36;&#x37;&#64;&#101;&#x78;&#97;&#x6d;&#x70;&#x6c;&#x65;&#x2e;&#x63;&#111;&#x6d;</a>.</p>
+
+<ul>
+<li>In a list?</li>
+<li><a href="&#109;&#x61;&#x69;&#108;&#x74;&#111;&#x3a;&#x75;&#x73;&#101;&#114;&#54;&#55;&#64;&#101;&#120;&#x61;&#109;&#112;&#x6c;&#101;&#x2e;&#x63;&#x6f;&#109;">&#117;&#x73;&#101;&#x72;&#x36;&#x37;&#x40;&#101;&#x78;&#97;&#x6d;&#x70;&#x6c;&#101;&#x2e;&#x63;&#x6f;&#x6d;</a></li>
+<li>It should.</li>
+</ul>
+
+<blockquote>
+<p>Blockquoted: <a href="&#x6d;&#97;&#x69;&#108;&#116;&#x6f;&#x3a;&#117;&#115;&#101;&#114;&#x36;&#55;&#64;&#x65;&#x78;&#x61;&#109;&#x70;&#108;&#x65;&#x2e;&#99;&#111;&#x6d;">&#x75;&#x73;&#x65;&#x72;&#54;&#55;&#x40;&#101;&#120;&#97;&#x6d;&#112;&#108;&#x65;&#46;&#x63;&#111;&#109;</a></p>
+</blockquote>
+
+<p>Auto-links should not occur here: <code>&lt;user67@example.com&gt;</code></p>
+
+<pre><code>or here: &lt;user67@example.com&gt;
+</code></pre>
+
+<p>And with the mailto bit:</p>
+
+<p>Link: <a href="&#109;&#97;&#x69;&#108;&#116;&#x6f;&#x3a;&#x75;&#115;&#x65;&#x72;&#54;&#x37;&#64;&#x65;&#120;&#97;&#109;&#x70;&#x6c;&#101;&#46;&#99;&#x6f;&#x6d;">&#117;&#x73;&#x65;&#114;&#x36;&#55;&#x40;&#101;&#x78;&#97;&#109;&#112;&#108;&#101;&#46;&#99;&#111;&#109;</a>.</p>
+
+<ul>
+<li>In a list?</li>
+<li><a href="&#x6d;&#97;&#105;&#108;&#116;&#x6f;&#x3a;&#x75;&#x73;&#x65;&#114;&#x36;&#x37;&#x40;&#101;&#x78;&#x61;&#109;&#112;&#108;&#x65;&#x2e;&#x63;&#111;&#109;">&#x75;&#x73;&#101;&#114;&#x36;&#55;&#64;&#101;&#x78;&#x61;&#x6d;&#x70;&#x6c;&#x65;&#x2e;&#x63;&#111;&#109;</a></li>
+<li>It should.</li>
+</ul>
+
+<blockquote>
+<p>Blockquoted: <a href="&#x6d;&#97;&#x69;&#x6c;&#x74;&#x6f;&#58;&#x75;&#115;&#x65;&#x72;&#54;&#x37;&#64;&#x65;&#120;&#97;&#109;&#112;&#x6c;&#x65;&#x2e;&#x63;&#x6f;&#x6d;">&#117;&#x73;&#x65;&#114;&#x36;&#55;&#64;&#101;&#x78;&#x61;&#109;&#112;&#108;&#x65;&#x2e;&#x63;&#x6f;&#x6d;</a></p>
+</blockquote>
+
+<p>Auto-links should not occur here: <code>&lt;mailto:user67@example.com&gt;</code></p>
+
+<pre><code>or here: &lt;mailto:user67@example.com&gt;
+</code></pre>