maruku 0.5.3 → 0.5.4

data/docs/maruku.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>

data/docs/maruku.md

@@ -13,7 +13,7 @@ Mar**u**k**u**: a Markdown-superset interpreter
 
 [Maruku] is a Markdown interpreter written in [Ruby].
 
-> [Last release](#release_notes) is version 0.5.3 -- 2007-02-05.
+> [Last release](#release_notes) is version 0.5.4 -- 2007-02-18.
 >
 > Use this command to update:
 >

data/docs/proposal.html

@@ -20,20 +20,17 @@
 
 <p>The first character in the curly braces must be a colon, optionally followed by a space:</p>
 
-<pre><code>{: ref .class #id}
-</code></pre>
+<pre><code>{: ref .class #id}</code></pre>
 
 <p>The old syntax was <code>{ref .class #id}</code>.</p>
 
 <p>For ALDs, the new syntax is:</p>
 
-<pre><code>{:ref_id: key=val .class #id }
-</code></pre>
+<pre><code>{:ref_id: key=val .class #id }</code></pre>
 
 <p>instead of:</p>
 
-<pre><code>{ref_id}: key=val .class #id 
-</code></pre>
+<pre><code>{ref_id}: key=val .class #id </code></pre>
 
 <p>Converters that don&#8217;t use this syntax may just ignore everything which is in curly braces and starts with &#8221;:&#8221;.</p>
 </li>
@@ -44,8 +41,7 @@
 <pre><code>Paragraph 1
 
 {:par2}
-Paragraph 2
-</code></pre>
+Paragraph 2</code></pre>
 
 <p>is equivalent to:</p>
 
@@ -88,8 +84,7 @@ Paragraph 2
 
 Paragraph *with emphasis*{: class=c1}
 second line of paragraph
-{: class=c1}
-</code></pre>
+{: class=c1}</code></pre>
 
 <p>In this example, the three IALs refer to the header, the emphasis span, and the entire paragraph, respectively.</p>
 
@@ -101,15 +96,13 @@ Paragraph *with emphasis*{:c1}
 second line of paragraph
 {:c1}
 
-{:c1: class=c1}
-</code></pre>
+{:c1: class=c1}</code></pre>
 
 <h2 id='attribute_lists'><span class='maruku_section_number'>2. </span>Attribute lists</h2>
 
 <p>This is an example attribute list, which shows everything you can put inside:</p>
 
-<pre><code>{: key1=val key2=&quot;long val&quot; #myid .class1 .class2 ref1 ref2}
-</code></pre>
+<pre><code>{: key1=val key2=&quot;long val&quot; #myid .class1 .class2 ref1 ref2}</code></pre>
 
 <p>More in particular, an attribute list is a whitespace-separated list of elements of 4 different kinds:</p>
 
@@ -147,8 +140,7 @@ second line of paragraph
 <pre><code>{: #myid .class1 .class2} 
 {: id=myid class=class1 .class2}
 {: id=myid class=&quot;class1 class2&quot;}
-{: id=myid class=&quot;will be overridden&quot; class=class1 .class2}
-</code></pre>
+{: id=myid class=&quot;will be overridden&quot; class=class1 .class2}</code></pre>
 
 <h2 id='where_to_put_inline_attribute_lists'><span class='maruku_section_number'>3. </span>Where to put inline attribute lists</h2>
 
@@ -162,16 +154,14 @@ Line 2 of the paragraph.
 
 A quote with a citation url:
 &gt; Who said that?
-{: cite=google.com}
-</code></pre>
+{: cite=google.com}</code></pre>
 
 <p>Note: empty lines between the block and the IAL are not tolerated. So this is not legal:</p>
 
 <pre><code>This is a paragraph.
 Line 2 of the paragraph.
 
-{: #myid .myclass}
-</code></pre>
+{: #myid .myclass}</code></pre>
 
 <p>Attribute lists may be indented up to 3 spaces:</p>
 
@@ -191,8 +181,7 @@ Paragraph2
 <pre><code>### Header ###     {: #myid}
 
 Header     {: #myid .myclass}
-------
-</code></pre>
+------</code></pre>
 
 <p>or, as like other block-level elements, on the line below:</p>
 
@@ -201,8 +190,7 @@ Header     {: #myid .myclass}
 
 Header     
 ------
-{: #myid .myclass}
-</code></pre>
+{: #myid .myclass}</code></pre>
 
 <h3 id='for_spanlevel_elements'><span class='maruku_section_number'>3.3. </span>For span-level elements</h3>
 
@@ -217,18 +205,15 @@ Header
 
 <p>This works also for links, like this:</p>
 
-<pre><code>This is [a link][ref]{:#myid rel=abc rev=abc}
-</code></pre>
+<pre><code>This is [a link][ref]{:#myid rel=abc rev=abc}</code></pre>
 
 <p>For images, this:</p>
 
-<pre><code>This is ![Alt text](url &quot;fresh carrots&quot;)
-</code></pre>
+<pre><code>This is ![Alt text](url &quot;fresh carrots&quot;)</code></pre>
 
 <p>is equivalent to:</p>
 
-<pre><code>This is ![Alt text](url){:title=&quot;fresh carrots&quot;}
-</code></pre>
+<pre><code>This is ![Alt text](url){:title=&quot;fresh carrots&quot;}</code></pre>
 
 <h2 id='using_tags'><span class='maruku_section_number'>4. </span>Using attributes lists definition</h2>
 
@@ -248,8 +233,7 @@ Header
 
 Blah blah blah.
 
-{:ref: #myhead .myclass lang=fr}
-</code></pre>
+{:ref: #myhead .myclass lang=fr}</code></pre>
 
 <p>Of course, more than one IAL can reference the same ALD:</p>
 
@@ -257,9 +241,7 @@ Blah blah blah.
 ...
 # Header 2 #      {:1}
 
-{:1: .myclass lang=fr}
-
-</code></pre>
+{:1: .myclass lang=fr}</code></pre>
 
 <h2 id='the_rules'><span class='maruku_section_number'>5. </span>The rules</h2>
 
@@ -271,7 +253,7 @@ Blah blah blah.
 </li>
 
 <li>
-<p>Everywhere else, <strong>all</strong> PUNCTUATION characters <strong>can</strong> be escaped, and <strong>must</strong> be escaped when they could trigger links, tables, etc</p>
+<p>Everywhere else, <strong>all</strong> PUNCTUATION characters <strong>can</strong> be escaped, and <strong>must</strong> be escaped when they could trigger links, tables, etc.</p>
 
 <p>A punctuation character is anything not a letter, a number, or whitespace (<code>[^a-zA-Z0-9\s\n]</code>).</p>
 </li>
@@ -301,8 +283,7 @@ Blah blah blah.
 <li>
 <p>There is an exception for backward compatibility, in links/images titles:</p>
 
-<pre><code>[text](url &quot;title&quot;with&quot;quotes&quot;)
-</code></pre>
+<pre><code>[text](url &quot;title&quot;with&quot;quotes&quot;)</code></pre>
 
 <p>The exception is not valid for attribute lists and in other contexts, where you have to use the canonical syntax.</p>
 </li>
@@ -334,8 +315,7 @@ s.gsub(r, &#39;&#39;) # ignore metadata</code></pre>
 {: skipped=&quot;\}&quot; val=\} bar} 
 
 for me 
-{: also this} 
-</code></pre>
+{: also this} </code></pre>
 
 <p>the result is:</p>
 
@@ -343,4 +323,4 @@ for me
  
 
 for me </code></pre>
-<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/lib/maruku.rb

@@ -126,8 +126,13 @@ require 'maruku/output/to_latex_entities'
 # Pretty print
 require 'maruku/output/to_markdown'
 
+# S5 slides
+require 'maruku/output/s5/to_s5'
+require 'maruku/output/s5/fancy'
+
 # Exporting to text: strips all formatting (not complete)
 require 'maruku/output/to_s'
 
 # class Maruku is the global interface
 require 'maruku/maruku'
+

data/lib/maruku/attributes.rb

@@ -192,9 +192,10 @@ module MaRuKu; module In; module Markdown; module SpanLevelParser
 	end
 	
 	
+	# We need a helper
+	def is_ial(e); e.kind_of? MDElement and e.node_type == :ial end
+
 	def merge_ial(elements, src, con)	
-		# We need a helper
-		def is_ial(e); e.kind_of? MDElement and e.node_type == :ial end
 
 		# Apply each IAL to the element before
 		elements.each_with_index do |e, i| 

data/lib/maruku/defaults.rb

@@ -31,8 +31,10 @@ Globals = {
 	:maruku_signature => true,
 	:code_background_color => '#fef',
 	:code_show_spaces => false,
+	:html_math_output_mathml => true, # also set :html_math_engine
 	:html_math_engine => 'none', #ritex, itex2mml
 	
+	:html_math_output_png => false, 	
 	:html_png_engine => 'none',
 	:html_png_dir => 'pngs',
 	:html_png_url => 'pngs/',
@@ -44,7 +46,7 @@ Globals = {
 	:latex_cjk => false,
 	
 	:debug_keep_ials => false,
-	
+	:doc_prefix => ''
 }
 
 class MDElement

data/lib/maruku/ext/math.rb

@@ -9,3 +9,33 @@ require 'maruku/ext/math/mathml_engines/none'
 require 'maruku/ext/math/mathml_engines/ritex'
 require 'maruku/ext/math/mathml_engines/itex2mml'
 require 'maruku/ext/math/mathml_engines/blahtex'
+
+
+=begin maruku_doc
+Attribute: math_enabled
+Scope: global, document
+Summary: Enables parsing of LaTeX math 
+
+To explicitly disable the math parsing:
+
+	Maruku.new(string, {:math_enabled => false})
+	{:ruby}
+	
+=end
+
+MaRuKu::Globals[:math_enabled] = true
+
+
+=begin maruku_doc
+Attribute: math_numbered
+Scope: global, document
+Summary: Math openings which should be numerated
+
+Array containing any of `'\\['`, `'\\begin{equation}'`, `'$$'`.
+
+	MaRuKu::Globals[math_numbered] = ['\\[']
+	
+=end
+
+
+MaRuKu::Globals[:math_numbered] = [] 

data/lib/maruku/ext/math/elements.rb

@@ -4,7 +4,7 @@ module MaRuKu; class MDElement
 		self.md_el(:inline_math, [], meta={:math=>math})
 	end
 
-	def md_equation(math, label=nil)
+	def md_equation(math, label, numerate)
 		reglabel= /\\label\{(\w+)\}/
 		if math =~ reglabel
 			label = $1
@@ -12,9 +12,10 @@ module MaRuKu; class MDElement
 		end
 #		puts "Found label = #{label} math #{math.inspect} "
 		num = nil
-		if label && @doc #take number
+		if (label || numerate) && @doc #take number
 			@doc.eqid2eq ||= {}	
 			num = @doc.eqid2eq.size + 1
+			label = "eq#{num}" if not label      # FIXME do id for document
 		end
 		e = self.md_el(:equation, [], meta={:math=>math, :label=>label,:num=>num})
 		if label && @doc #take number

data/lib/maruku/ext/math/parsing.rb

@@ -1,70 +1,90 @@
 module MaRuKu
+	
 	class MDDocument
 		# Hash equation id (String) to equation element (MDElement)
 		attr_accessor :eqid2eq
+		
+		def is_math_enabled? 
+			get_setting :math_enabled
+		end
 	end
 end
 
 
-	# At least one slash inside
-	#RegInlineMath1 = /\$([^\$]*[\\][^\$]*)\$/
-	# No spaces around the delimiters
-	#RegInlineMath2 = /\$([^\s\$](?:[^\$]*[^\s\$])?)\$/
-	#RegInlineMath = Regexp::union(RegInlineMath1,RegInlineMath2)
-
 	# Everything goes; takes care of escaping the "\$" inside the expression
 	RegInlineMath = /\${1}((?:[^\$]|\\\$)+)\$/
 	
-	MaRuKu::In::Markdown::
-	register_span_extension(:chars => ?$, :regexp => RegInlineMath) do 
-		|doc, src, con|
-		if m = src.read_regexp(RegInlineMath)
-			math = m.captures.compact.first
-			con.push doc.md_inline_math(math)
-			true
-		else
-			#puts "not math: #{src.cur_chars 10}"
-			false
-		end
-	end
+	MaRuKu::In::Markdown::register_span_extension(
+		:chars => ?$, 
+		:regexp => RegInlineMath, 
+		:handler => lambda { |doc, src, con|
+			return false if not doc.is_math_enabled?
+		
+			if m = src.read_regexp(RegInlineMath)
+				math = m.captures.compact.first
+				con.push doc.md_inline_math(math)
+				true
+			else
+				#puts "not math: #{src.cur_chars 10}"
+				false
+			end
+		}
+	)
+	
 	
-	EquationStart = /^[ ]{0,3}(?:\\\[|\$\$)(.*)$/
+	MathOpen1 = Regexp.escape('\\begin{equation}')
+	MathClose1 = Regexp.escape('\\end{equation}')
+	MathOpen2 = Regexp.escape('\\[')
+	MathClose2 = Regexp.escape('\\]')
+	MathOpen3 = Regexp.escape('$$')
+	MathClose3 = Regexp.escape('$$')
 	
 	EqLabel = /(?:\((\w+)\))/
-	OneLineEquation = /^[ ]{0,3}(?:\\\[|\$\$)(.*)(?:\\\]|\$\$)\s*#{EqLabel}?\s*$/
-	EquationEnd = /^(.*)(?:\\\]|\$\$)\s*#{EqLabel}?\s*$/
+	EquationOpen = /#{MathOpen1}|#{MathOpen2}|#{MathOpen3}/
+	EquationClose = /#{MathClose1}|#{MathClose2}|#{MathClose3}/
+	
+	# $1 is opening, $2 is tex
+	EquationStart = /^[ ]{0,3}(#{EquationOpen})(.*)$/
+	# $1 is tex, $2 is closing, $3 is tex
+	EquationEnd = /^(.*)(#{EquationClose})\s*#{EqLabel}?\s*$/
+	# $1 is opening, $2 is tex, $3 is closing, $4 is label
+	OneLineEquation = /^[ ]{0,3}(#{EquationOpen})(.*)(#{EquationClose})\s*#{EqLabel}?\s*$/
 
-	MaRuKu::In::Markdown::
-	register_block_extension(:regexp  => EquationStart) do |doc, src, con|
-#		puts "Equation :#{self}"
-		first = src.shift_line
-		if first =~ OneLineEquation
-			math = $1
-			label = $2 
-			con.push doc.md_equation($1, $2)
-		else
-			first =~ EquationStart
-			math = $1
-			label = nil
-			while true
-				if not src.cur_line
-					maruku_error "Stream finished while reading equation\n\n"+
-					add_tabs(math,1,'$> '), src, con
-					break
-				end
-				line = src.shift_line
-				if line =~ EquationEnd
-					math += $1 + "\n"
-					label = $2 if $2
-					break
-				else
-					math += line + "\n"
+	MaRuKu::In::Markdown::register_block_extension(
+		:regexp  => EquationStart,
+		:handler => lambda { |doc, src, con|
+			return false if not doc.is_math_enabled?
+			first = src.shift_line
+			if first =~ OneLineEquation
+				opening, tex, closing, label = $1, $2, $3, $4
+				numerate = doc.get_setting(:math_numbered).include?(opening)
+				con.push doc.md_equation(tex, label, numerate)
+			else
+				first =~ EquationStart
+				opening, tex = $1, $2
+				
+				numerate = doc.get_setting(:math_numbered).include?(opening)
+				label = nil
+				while true
+					if not src.cur_line
+						doc.maruku_error("Stream finished while reading equation\n\n"+
+							doc.add_tabs(tex,1,'$> '), src, con)
+						break
+					end
+					line = src.shift_line
+					if line =~ EquationEnd
+						tex_line, closing = $1, $2
+						label = $3 if $3
+						tex += tex_line + "\n"
+						break
+					else
+						tex += line + "\n"
+					end
 				end
+				con.push doc.md_equation(tex, label, numerate)
 			end
-			con.push doc.md_equation(math, label)
-		end
-		true
-	end
+			true
+		})
 		
 		
 	# This adds support for \eqref
@@ -72,11 +92,14 @@ end
 	RegEqPar = /\(eq:(\w+)\)/
 	RegEqref = Regexp::union(RegEqrefLatex, RegEqPar)
 	
-	MaRuKu::In::Markdown::
-	register_span_extension(:chars => [?\\, ?(], :regexp => RegEqref) do 
-		|doc, src, con|
-		eqid = src.read_regexp(RegEqref).captures.compact.first
-		r = doc.md_el(:eqref, [], meta={:eqid=>eqid})
-		con.push r
-	 	true 
-	end
+	MaRuKu::In::Markdown::register_span_extension(
+		:chars => [?\\, ?(], 
+		:regexp => RegEqref,
+		:handler => lambda { |doc, src, con|
+			return false if not doc.is_math_enabled?
+			eqid = src.read_regexp(RegEqref).captures.compact.first
+			r = doc.md_el(:eqref, [], meta={:eqid=>eqid})
+			con.push r
+	 		true 
+		}
+	)