maruku 0.5.3 → 0.5.4

data/bin/maruku

@@ -23,11 +23,15 @@ opt = OptionParser.new do |opts|
 
 	opts.on("-i", "--math-images ENGINE", "Uses ENGINE to render TeX to PNG.") do |s|
 		using_math = true
+		MaRuKu::Globals[:html_math_output_png] = true
+		MaRuKu::Globals[:html_math_output_mathml] = false
 		MaRuKu::Globals[:html_png_engine] = s
 		$stderr.puts "Using png engine #{s}."
 	end
 
 	opts.on("-m", "--math-engine ENGINE", "Uses ENGINE to render MathML") do |s|
+		MaRuKu::Globals[:html_math_output_png] = false
+		MaRuKu::Globals[:html_math_output_mathml] = true
 		using_math = true
 		using_mathml = true
 		MaRuKu::Globals[:html_math_engine] = s
@@ -38,6 +42,7 @@ opt = OptionParser.new do |opts|
 	end
 
 	opts.on_tail("--pdf",  "Write PDF","First writes LaTeX, then calls pdflatex." ) do export = :pdf  end
+	opts.on_tail("--s5", "Write S5 slideshow") do export = :s5 end
 	opts.on_tail("--html", "Write HTML") do export = :html end
 	opts.on_tail("--html-frag", "Write the contents of the BODY.") do export = :html_frag end
 	opts.on_tail("--tex",  "Write LaTeX" ) do export = :tex  end
@@ -101,23 +106,26 @@ inputs.each do |f, input|
 		t = Time.now
 		case export
 		when :html 
-			suffix = using_mathml ? 'xhtml' : 'html'
+			suffix = using_mathml ? '.xhtml' : '.html'
 			out = doc.to_html_document( {:indent => -1})
 		when :html_frag 
-			suffix='html_frag'
+			suffix='.html_frag'
 			out = doc.to_html( {:indent => -1})
 		when :pdf, :tex
-			suffix='tex'
+			suffix='.tex'
 			out = doc.to_latex_document
 		when :tex_frag
-			suffix='html_frag'
+			suffix='.html_frag'
 			out = doc.to_latex
 		when :inspect
 			suffix='.txt'
 			out = doc.inspect
 		when :markdown
-			suffix='pretty_md'
+			suffix='.pretty_md'
 			out = doc.to_markdown
+		when :s5
+			suffix='_s5slides.html'
+			out = doc.to_s5
 		end
 		$stderr.puts "Rendering in %.2f seconds." % (Time.now-t)
 			
@@ -127,7 +135,7 @@ inputs.each do |f, input|
 			if not output_file 
 				dir = File.dirname(f)
 				job = File.join(dir, File.basename(f, File.extname(f)))
-				output_file = job + "." + suffix
+				output_file = job  + suffix
 			end
 			
 			$stderr.puts "Writing to #{output_file}"

data/bin/marutest

@@ -1,6 +1,9 @@
 #!/usr/bin/env ruby
 
 require 'maruku'
+require 'maruku/textile2'
+
+$marutest_language = :markdown
 
 #MARKER = "\n***EOF***\n"
 SPLIT = %r{\n\*\*\*[^\*]+\*\*\*\n}m
@@ -9,6 +12,16 @@ def marker(x)
 	"\n*** Output of #{x} ***\n"
 end
 
+def write_lines(i, j, lines, prefix, i_star)
+	i = [i, 0].max
+	j = [j, lines.size-1].min
+	for a in i..j
+		l = lines[a].gsub(/\t/,'  ')
+		puts( ("%s %3d" % [prefix, a]) + 
+			(a==i_star ? " -->" : "    ")+lines[a])
+	end
+end
+
 # a = expected   b = found 
 def equals(a, b)
 	a = a.split("\n")
@@ -20,15 +33,6 @@ def equals(a, b)
 		if la != lb
 			puts "\n"
 			
-			def write_lines(i, j, lines, prefix, i_star)
-				i = [i, 0].max
-				j = [j, lines.size-1].min
-				for a in i..j
-					l = lines[a].gsub(/\t/,'  ')
-					puts ("%s %3d" % [prefix, a]) + 
-						(a==i_star ? " -->" : "    ")+lines[a]
-				end
-			end
 			
 			write_lines(i-3, i+3, a, "expected", i )
 			write_lines(i-3, i+3, b, "   found", i )
@@ -74,7 +78,12 @@ def run_test(filename, its_ok, verbose=true)
 	crashed = []
 	actual = {}
 	
-	doc = Maruku.new(markdown, params)
+	doc = 
+		if $marutest_language == :markdown
+			Maruku.new(markdown, params)
+		else
+			MaRuKu.textile2(markdown, params)
+		end
 
 	for s in TOTEST
 		begin

data/docs/changelog.html

@@ -86,7 +86,51 @@ Maruku (to_latex): parsing 4.04 sec + rendering 1.12 sec = 5.16 sec</code></pre>
 </li>
 </ul>
 
-<h4 id='stable'>Changes in 0.5.3</h4>
+<h4 id='stable'>Changes in 0.5.4</h4>
+
+<ul>
+<li>
+<p>Features:</p>
+
+<ul>
+<li>
+<p><a href='http://www.w3.org/TR/html4/index/attributes.html'>All HTML attributes</a> are supported.</p>
+
+<pre><code>&gt;  Science is a wonderful thing if one does not
+&gt;  have to earn one&#39;s living at it.
+{: cite=&quot;http://en.wikiquote.org/wiki/Albert_Einstein&quot;}</code></pre>
+</li>
+
+<li>
+<p>Attribute <code>doc_prefix</code>.</p>
+</li>
+
+<li>
+<p>Math:</p>
+
+<ul>
+<li><code>\begin{equation}</code> and <code>\end{equation}</code> are understood.</li>
+
+<li>Math parsing enabled per-instance using the <code>math_enabled</code> attribute.</li>
+
+<li><code>math_numbered</code> attribute.</li>
+</ul>
+</li>
+</ul>
+</li>
+
+<li>
+<p>Bug fixes:</p>
+
+<ul>
+<li>Runs quietly with <code>ruby -w</code>.</li>
+
+<li>Fixed a bug which could cause data-loss when reading indented lines.</li>
+</ul>
+</li>
+</ul>
+
+<h4 id='changes_in_053'>Changes in 0.5.3</h4>
 
 <ul>
 <li>
@@ -177,8 +221,7 @@ Maruku (to_latex): parsing 4.04 sec + rendering 1.12 sec = 5.16 sec</code></pre>
 ---------------+-------+--
 {:r}  Hello    + ...
 
-{:r: scope=&#39;row&#39;}
-</code></pre>
+{:r: scope=&#39;row&#39;}</code></pre>
 
 <p>The first cell will have the <code>scope</code> attribute set to <code>row</code>.</p>
 </li>
@@ -291,8 +334,7 @@ Content</code></pre>
 
 <pre><code>\usepackage[C40]{fontenc}
 \usepackage[cjkjis]{ucs}
-\usepackage[utf8x]{inputenc}
-</code></pre>
+\usepackage[utf8x]{inputenc}</code></pre>
 
 <p>Nevertheless, I could only get bitmap fonts working &#8211; probably it&#8217;s a problem with my setup.</p>
 
@@ -358,8 +400,7 @@ Maruku (to_latex):   parsing 0.49 sec + rendering 0.25 sec = 0.73 sec</code></pr
 
 <p>The default action is to warn and try to continue. If you do this:</p>
 
-<pre><code>Maruku.new(string, {:on_error =&gt; :raise})
-</code></pre>
+<pre><code>Maruku.new(string, {:on_error =&gt; :raise})</code></pre>
 
 <p>then syntax errors will cause an exception to be raised (you can catch this and retry).</p>
 </li>
@@ -412,4 +453,4 @@ Maruku (to_latex):   parsing 0.49 sec + rendering 0.25 sec = 0.73 sec</code></pr
 <p>Support for images in PDF.</p>
 </li>
 </ul>
-<div class='maruku_signature'><hr /><span style='font-size: small; font-style: italic'>Created by <a href='http://maruku.rubyforge.org' title='Maruku: a Markdown-superset interpreter for Ruby'>Maruku</a> at 15:31 on Monday, February 05th, 2007.</span></div></body></html>
+<div class='maruku_signature'><hr /><span style='font-size: small; font-style: italic'>Created by <a href='http://maruku.rubyforge.org' title='Maruku: a Markdown-superset interpreter for Ruby'>Maruku</a> at 13:34 on Sunday, February 18th, 2007.</span></div></body></html>

data/docs/changelog.md

@@ -60,7 +60,31 @@ HTML use syntax: true
 
 	*	There are a couple of hidden, unsafe, features that are not enabled by default.
 
-#### Changes in 0.5.3 ####   {#stable}
+#### Changes in 0.5.4 ####  {#stable}
+
+*	Features:
+
+	*	[All HTML attributes](http://www.w3.org/TR/html4/index/attributes.html) are supported. 
+	
+			>  Science is a wonderful thing if one does not
+			>  have to earn one's living at it.
+			{: cite="http://en.wikiquote.org/wiki/Albert_Einstein"}
+
+	*	Attribute `doc_prefix`.
+	
+	*	Math:
+		
+		*	`\begin{equation}` and `\end{equation}` are understood.
+		*	Math parsing enabled per-instance using the `math_enabled` attribute.
+		*	`math_numbered` attribute.
+		
+*	Bug fixes:
+
+	*	Runs quietly with `ruby -w`.
+	*	Fixed a bug which could cause data-loss when reading indented lines.
+
+
+#### Changes in 0.5.3 ####  
 
 *	Features:
 
@@ -69,6 +93,7 @@ HTML use syntax: true
 		`border`, `cellspacing`, `cellpadding`).
 		
 		The next version will hopefully use all HTML attributes.
+		
 
 	<!-- A version of Markdown that is more Japanese or something --> 
 	

data/docs/entity_test.html

@@ -255,4 +255,4 @@
 &#160;&#160;&#160;<code style='background-color: #eef;'>&amp;mu;</code> &#956; (<code style='background-color: #ffe;'>$\mu$</code>) 
 &#160;&#160;&#160;<code style='background-color: #eef;'>&amp;hellip;</code> &#8230; (<code style='background-color: #ffe;'>\ldots</code>) 
 &#160;&#160;&#160;</p>
-<div class='maruku_signature'><hr /><span style='font-size: small; font-style: italic'>Created by <a href='http://maruku.rubyforge.org' title='Maruku: a Markdown-superset interpreter for Ruby'>Maruku</a> at 14:11 on Monday, February 05th, 2007.</span></div></body></html>
+<div class='maruku_signature'><hr /><span style='font-size: small; font-style: italic'>Created by <a href='http://maruku.rubyforge.org' title='Maruku: a Markdown-superset interpreter for Ruby'>Maruku</a> at 13:32 on Sunday, February 18th, 2007.</span></div></body></html>

data/docs/exd.html

@@ -25,7 +25,7 @@ Expanded documentation (Markdown format)
 
 <h3 id='class'>Attribute <code>class</code></h3>
 
-<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 303:</p>
+<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 316:</p>
 
 <p>It is copied as a standard HTML attribute.</p>
 
@@ -33,7 +33,7 @@ Expanded documentation (Markdown format)
 
 <p class='maruku-att-default'>Default: <code>&quot;#fef&quot;</code></p>
 
-<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 495:</p>
+<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 553:</p>
 
 <p>The format is either a named color (<code>green</code>, <code>red</code>) or a CSS color of the form <code>#ff00ff</code>.</p>
 
@@ -74,7 +74,7 @@ Expanded documentation (Markdown format)
 
 <h3 id='css'>Attribute <code>css</code></h3>
 
-<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 134:</p>
+<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 144:</p>
 
 <p><code>css</code> should be a space-separated list of urls.</p>
 
@@ -82,6 +82,14 @@ Expanded documentation (Markdown format)
 
 <pre><code>CSS: style.css math.css</code></pre>
 
+<h3 id='doc_prefix'>Attribute <code>doc_prefix</code></h3>
+
+<p class='maruku-att-default'>Default: <code>&quot;&quot;</code></p>
+
+<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 128:</p>
+
+<p>String to disambiguate footnote links.</p>
+
 <h3 id='encoding'>Attribute <code>encoding</code></h3>
 
 <p class='maruku-att-origin'>Read from file <code>input/parse_doc.rb</code>, line 35:</p>
@@ -100,7 +108,7 @@ Expanded documentation (Markdown format)
 
 <p>If you want to use your custom engine <code>foo</code>, then set:</p>
 
-<pre><code class='markdown' lang='markdown'>HTML math engine: foo</code></pre>
+<pre lang='markdown'><code class='markdown' lang='markdown'>HTML math engine: foo</code></pre>
 
 <p>and then implement two functions:</p>
 
@@ -116,7 +124,7 @@ end</code></pre>
 
 <p>Same thing as <code>html_math_engine</code>, only for PNG output.</p>
 
-<pre><code class='ruby' lang='ruby'>def convert_to_png_foo(kind, tex)
+<pre lang='ruby'><code class='ruby' lang='ruby'>def convert_to_png_foo(kind, tex)
 	# same thing
 	...
 end</code></pre>
@@ -125,21 +133,19 @@ end</code></pre>
 
 <p class='maruku-att-default'>Default: <code>false</code></p>
 
-<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 402:</p>
+<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 459:</p>
 
 <p>If true, the <code>syntax</code> package is used. It supports the <code>ruby</code> and <code>xml</code> languages. Remember to set the <code>lang</code> attribute of the code block.</p>
 
 <p>Examples:</p>
 
 <pre><code>	require &#39;maruku&#39;
-{:lang=ruby html_use_syntax=true}
-</code></pre>
+{:lang=ruby html_use_syntax=true}</code></pre>
 
 <p>and</p>
 
 <pre><code>	&lt;div style=&quot;text-align:center&quot;&gt;Div&lt;/div&gt;
-{:lang=html html_use_syntax=true}
-</code></pre>
+{:lang=html html_use_syntax=true}</code></pre>
 
 <p>produces:</p>
 
@@ -151,7 +157,7 @@ end</code></pre>
 
 <h3 id='id'>Attribute <code>id</code></h3>
 
-<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 291:</p>
+<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 304:</p>
 
 <p>It is copied as a standard HTML attribute.</p>
 
@@ -185,8 +191,7 @@ end</code></pre>
 <p>For example:</p>
 
 <pre><code>Title: My document
-Latex preamble: preamble.tex
-</code></pre>
+Latex preamble: preamble.tex</code></pre>
 
 <p>will produce:</p>
 
@@ -206,8 +211,7 @@ Latex preamble: preamble.tex
 <li>
 <p>If the <code>lang</code> attribute for the code block has been specified, it gets passed to the <code>listings</code> package using the <code>lstset</code> macro. The default lang for code blocks is specified through the <code>code_lang</code> attribute.</p>
 
-<pre><code>\lstset{language=ruby}
-</code></pre>
+<pre><code>\lstset{language=ruby}</code></pre>
 
 <p>Please refer to the documentation of the <code>listings</code> package for supported languages.</p>
 
@@ -233,21 +237,38 @@ Latex preamble: preamble.tex
 
 <p>If false, Maruku does not append a signature to the generated file.</p>
 
+<h3 id='math_enabled'>Attribute <code>math_enabled</code></h3>
+
+<p class='maruku-att-origin'>Read from file <code>ext/math.rb</code>, line 14:</p>
+
+<p>To explicitly disable the math parsing:</p>
+
+<pre><code>Maruku.new(string, {:math_enabled =&gt; false})
+{:ruby}</code></pre>
+
+<h3 id='math_numbered'>Attribute <code>math_numbered</code></h3>
+
+<p class='maruku-att-origin'>Read from file <code>ext/math.rb</code>, line 29:</p>
+
+<p>Array containing any of <code>&#39;\\[&#39;</code>, <code>&#39;\\begin{equation}&#39;</code>, <code>&#39;$$&#39;</code>.</p>
+
+<pre><code>MaRuKu::Globals[math_numbered] = [&#39;\\[&#39;]</code></pre>
+
 <h3 id='style'>Attribute <code>style</code></h3>
 
-<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 311:</p>
+<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 324:</p>
 
 <p>It is copied as a standard HTML attribute.</p>
 
 <h3 id='subject'>Attribute <code>subject</code></h3>
 
-<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 126:</p>
+<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 136:</p>
 
 <p>Synonim for <code>title</code>.</p>
 
 <h3 id='title'>Attribute <code>title</code></h3>
 
-<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 103:</p>
+<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 105:</p>
 
 <p>Sets the title of the document. If a title is not specified, the first header will be used.</p>
 
@@ -255,16 +276,14 @@ Latex preamble: preamble.tex
 
 <pre><code>Title: my document
 
-Content
-</code></pre>
+Content</code></pre>
 
 <p>and</p>
 
 <pre><code>my document
 ===========
 
-Content
-</code></pre>
+Content</code></pre>
 
 <p>In both cases, the title is set to &#8220;my document&#8221;.</p>
 
@@ -280,9 +299,9 @@ Content
 
 <p class='maruku-att-default'>Default: <code>false</code></p>
 
-<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 348:</p>
+<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 405:</p>
 
 <p>If <code>true</code>, section headers will be numbered.</p>
 
 <p>In LaTeX export, the numbering of headers is managed by Maruku, to have the same results in both HTML and LaTeX.</p>
-<div class='maruku_signature'><hr /><span style='font-size: small; font-style: italic'>Created by <a href='http://maruku.rubyforge.org' title='Maruku: a Markdown-superset interpreter for Ruby'>Maruku</a> at 14:11 on Monday, February 05th, 2007.</span></div></body></html>
+<div class='maruku_signature'><hr /><span style='font-size: small; font-style: italic'>Created by <a href='http://maruku.rubyforge.org' title='Maruku: a Markdown-superset interpreter for Ruby'>Maruku</a> at 13:32 on Sunday, February 18th, 2007.</span></div></body></html>

data/docs/index.html

@@ -13,7 +13,7 @@
 <p><a href='http://maruku.rubyforge.org/'>Maruku</a> is a Markdown interpreter written in <a href='http://www.ruby-lang.org'>Ruby</a>.</p>
 
 <blockquote id='news'>
-<p><a href='#release_notes'>Last release</a> is version 0.5.3 &#8211; 2007-02-05.</p>
+<p><a href='#release_notes'>Last release</a> is version 0.5.4 &#8211; 2007-02-18.</p>
 
 <p>Use this command to update:</p>
 
@@ -134,8 +134,7 @@
 
 <pre><code>BlueCloth (to_html): parsing 0.01 sec + rendering 1.87 sec = 1.88 sec   (1.00x)
    Maruku (to_html): parsing 0.66 sec + rendering 0.43 sec = 1.09 sec   (1.73x)
-  Maruku (to_latex): parsing 0.67 sec + rendering 0.23 sec = 0.90 sec   (2.10x)
-</code></pre>
+  Maruku (to_latex): parsing 0.67 sec + rendering 0.23 sec = 0.90 sec   (2.10x)</code></pre>
 
 <p>Please note that Maruku has a lot more features and therefore is looking for much more patterns in the file.</p>
 
@@ -233,8 +232,7 @@ Content of the document</code></pre>
 <p>If you create a list, and then set the <code>toc</code> attribute, when rendering Maruku will create an auto-generated table of contents.</p>
 
 <pre><code>* This will become a table of contents (this text will be scraped).
-{:toc}
-</code></pre>
+{:toc}</code></pre>
 
 <p>You can see an example of this at the beginning of this document.</p>
 
@@ -323,4 +321,4 @@ I would love to have an equivalent in Ruby.
 
 --><div class='footnotes'><hr /><ol><li id='fn:1'>
 <p>I really was missing those.</p>
-<a href='#fnref:1' rev='footnote'>&#8617;</a></li></ol></div><div class='maruku_signature'><hr /><span style='font-size: small; font-style: italic'>Created by <a href='http://maruku.rubyforge.org' title='Maruku: a Markdown-superset interpreter for Ruby'>Maruku</a> at 15:30 on Monday, February 05th, 2007.</span></div></body></html>
+<a href='#fnref:1' rev='footnote'>&#8617;</a></li></ol></div><div class='maruku_signature'><hr /><span style='font-size: small; font-style: italic'>Created by <a href='http://maruku.rubyforge.org' title='Maruku: a Markdown-superset interpreter for Ruby'>Maruku</a> at 13:32 on Sunday, February 18th, 2007.</span></div></body></html>