maruku 0.4.2.1 → 0.5.0

data/bin/maruku

@@ -4,8 +4,12 @@ require 'maruku'
 require 'optparse'
 
 export = :html
+break_on_error = false
+using_math = false
+using_mathml = false
+output_file = nil
 
-OptionParser.new do |opts|
+opt = OptionParser.new do |opts|
 	opts.banner = "Usage: maruku [options] [file1.md [file2.md ..."
 
 	opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
@@ -13,10 +17,29 @@ OptionParser.new do |opts|
 	opts.on("-u", "--[no-]unsafe", "Use unsafe features") do |v|
 		MaRuKu::Globals[:unsafe_features] = v end
 
-	
+	opts.on("-b", "Break on error") do |v|
+		break_on_error = true end
+
+
+	opts.on("-i", "--math-images ENGINE", "Uses ENGINE to render TeX to PNG.") do |s|
+		using_math = true
+		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|
+		using_math = true
+		using_mathml = true
+		MaRuKu::Globals[:html_math_engine] = s
+	end
+
+	opts.on("-o", "--output FILE", "Output filename") do |s|
+		output_file = s
+	end
 
-	opts.on_tail("--pdf",  "Write PDF" ) do export = :pdf  end
+	opts.on_tail("--pdf",  "Write PDF","First writes LaTeX, then calls pdflatex." ) do export = :pdf  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
 	opts.on_tail("--inspect",  "Shows the parsing result" ) do export = :inspect  end
 
@@ -30,7 +53,20 @@ OptionParser.new do |opts|
 		exit
 	end
 
-end.parse!
+end
+
+begin 
+opt.parse!
+rescue OptionParser::InvalidOption=>e
+	$stderr.puts e
+	$stderr.puts opt
+	exit
+end
+
+if using_math
+	$stderr.puts "Using Math extensions."
+	require 'maruku/ext/math'
+end
 
 #p ARGV
 #p MaRuKu::Globals
@@ -54,38 +90,48 @@ end
 inputs.each do |f, input|
 	
 		# create Maruku
-		doc = Maruku.new(input, {:on_error=>:warning})
+		params = {}
+		params[:on_error] = break_on_error ? :raise : :warning
 
-		out=""; prefix = "?"
+		t = Time.now
+		doc = Maruku.new(input, params)
+		$stderr.puts "Parsing in %.2f seconds." % (Time.now-t)
+
+		out=""; suffix = "?"
+		t = Time.now
 		case export
 		when :html 
-			prefix='html'
+			suffix = using_mathml ? 'xhtml' : 'html'
 			out = doc.to_html_document( {:indent => -1})
 		when :html_frag 
-			prefix='html_frag'
+			suffix='html_frag'
 			out = doc.to_html( {:indent => -1})
 		when :pdf, :tex
-			prefix='tex'
+			suffix='tex'
 			out = doc.to_latex_document
 		when :tex_frag
-			prefix='html_frag'
+			suffix='html_frag'
 			out = doc.to_latex
 		when :inspect
-			prefix='.txt'
+			suffix='.txt'
 			out = doc.inspect
 		when :markdown
-			prefix='pretty_md'
+			suffix='pretty_md'
 			out = doc.to_markdown
 		end
+		$stderr.puts "Rendering in %.2f seconds." % (Time.now-t)
 			
 		# write to file or stdout
 		if f
-			dir = File.dirname(f)
-			job = File.join(dir, File.basename(f, File.extname(f)))
-			filename = job + "." + prefix
-
-			$stderr.puts "Writing to #{filename}"
-			File.open(filename,'w') do |f| f.puts out end
+			
+			if not output_file 
+				dir = File.dirname(f)
+				job = File.join(dir, File.basename(f, File.extname(f)))
+				output_file = job + "." + suffix
+			end
+			
+			$stderr.puts "Writing to #{output_file}"
+			File.open(output_file,'w') do |f| f.puts out end
 			
 			if export == :pdf
 				cmd = "pdflatex '#{job}' -interaction=nonstopmode "+
@@ -95,7 +141,7 @@ inputs.each do |f, input|
 				system cmd
 			end
 		else # write to stdout
-			$stdout.write out
+			$stdout.puts out
 		end
 	end
-	
+	

data/bin/marutest

@@ -50,6 +50,11 @@ def run_test(filename, its_ok, verbose=true)
 	# split the input in sections
 	
 	stuff = input.split(SPLIT)
+	if stuff.size == 1
+		stuff[2] = stuff[0]
+		stuff[0] = "Write a comment here"
+		stuff[1] = "{} # params "
+	end
 
 	comment   = stuff.shift
 	params_s = stuff.shift
@@ -87,7 +92,7 @@ def run_test(filename, its_ok, verbose=true)
 	end
 
 	File.open(output_html, 'w') do |f|
-		f.write actual[:to_html]
+		f.write doc.to_html_document
 	end
 
 		begin
@@ -149,7 +154,7 @@ def run_test(filename, its_ok, verbose=true)
 	
 	f.write comment
 	f.write "\n*** Parameters: ***\n"
-	f.write params.inspect
+	f.write params_s
 	f.write "\n*** Markdown input: ***\n"
 	f.write markdown
 
@@ -312,6 +317,11 @@ def marutest
 end
 
 
+if ARGV.empty?
+	puts "marutest is a tool for running Maruku's unittest."
+	exit
+end
+
 marutest
 
 

data/docs/changelog.html

@@ -1,8 +1,185 @@
-<?xml version='1.0' encoding='utf-8'?>
-<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
-'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
-<html lang='en' xml:lang='en' xmlns='http://www.w3.org/1999/xhtml'><head><meta content='text/html; charset=utf-8' http-equiv='Content-type' /><title></title></head><body>
-<h4 id='changes_in_041_aka_typographer'>Changes in 0.4.1 aka &ldquo;Typographer&rdquo;</h4>
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC
+    "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN"
+    "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd">
+<html xmlns:svg='http://www.w3.org/2000/svg' xml:lang='en' xmlns='http://www.w3.org/1999/xhtml'>
+<head><meta content='application/xhtml+xml;charset=utf-8' http-equiv='Content-type' /><title></title><link href='style.css' rel='stylesheet' type='text/css' />
+</head>
+<body>
+<h4 id='last'>Changes in the development version and <strong>experimental</strong> features</h4>
+<!--	This is the [math syntax specification][math]. -->
+<ul>
+<li>
+<p><em>Jan. 22</em> With very minimal changes, Maruku now works in JRuby. It is very slow, though.</p>
+
+<p>Some benchmarks:</p>
+
+<ul>
+<li>
+<p>G4 1.5GhZ, Ruby 1.8.5:</p>
+<pre><code>Maruku (to_html): parsing 0.65 sec + rendering 0.40 sec = 1.04 sec
+Maruku (to_latex): parsing 0.70 sec + rendering 0.21 sec = 0.91 sec</code></pre></li>
+
+<li>
+<p>G4 1.5GhZ, JRuby 1.9.2:</p>
+<pre><code>Maruku (to_html): parsing 4.77 sec + rendering 2.24 sec = 7.01 sec
+Maruku (to_latex): parsing 4.04 sec + rendering 1.12 sec = 5.16 sec</code></pre></li>
+</ul>
+</li>
+
+<li>
+<p><em>Jan. 21</em> Integration of Blahtex. PNG export of formula and alignment works ok in Mozilla, Safari, Camino, Opera. IE7 is acting strangely.</p>
+</li>
+
+<li>
+<p>Support for LaTeX-style formula input, and export to MathML.</p>
+
+<p><a href='http://golem.ph.utexas.edu/~distler'>Jacques Distler</a> is integrating Maruku into Instiki (a Ruby On Rails-based wiki software), as to have a Ruby wiki with proper math support. You know, these physicists like all those funny symbols.</p>
+
+<ul>
+<li>
+<p>To have the MathML export, it is needed to install one of:</p>
+
+<ul>
+<li><span>RiTeX</span> (<code>gem install ritex</code>)</li>
+
+<li><a href='http://golem.ph.utexas.edu/~distler/blog/itex2MML.html'>itex2MML</a> supports much more complex formulas than Ritex.</li>
+
+<li>PNG for old browser is not here yet. The plan is to use BlahTeX.</li>
+</ul>
+</li>
+</ul>
+</li>
+
+<li>
+<p>Command line options for the <code>maruku</code> command:</p>
+<pre><code>Usage: maruku [options] [file1.md [file2.md ...
+    -v, --[no-]verbose               Run verbosely
+    -u, --[no-]unsafe                Use unsafe features
+    -b                               Break on error
+    -m, --math-engine ENGINE         Uses ENGINE to render MathML
+        --pdf                        Write PDF
+        --html                       Write HTML
+        --tex                        Write LaTeX
+        --inspect                    Shows the parsing result
+        --version                    Show version
+    -h, --help                       Show this message</code></pre></li>
+
+<li>
+<p>Other things:</p>
+
+<ul>
+<li>
+<p>Created the embryo of an extension system. Please don&#8217;t use it yet, as probably the API is bound to change.</p>
+</li>
+
+<li>
+<p>There are a couple of hidden features&#8230;</p>
+</li>
+</ul>
+</li>
+</ul>
+
+<h4 id='stable'>Changes in 0.5.0</h4>
+
+<ul>
+<li>
+<p>Syntax changes:</p>
+
+<ul>
+<li>
+<p>Compatibility with newest Markdown.pl: <code>[text]</code> as a synonim of <code>[text][]</code>.</p>
+</li>
+
+<li>
+<p>Meta data: the first IAL in a span environment now refers to the parent. This makes it possible to set attributes for cells:</p>
+<pre><code>Head           |  Head |
+---------------+-------+--
+{:r}  Hello    + ...
+
+{: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>
+</ul>
+</li>
+
+<li>
+<p>New settings:</p>
+
+<ul>
+<li>Disable the Maruku signature by setting <code>maruku signature: false</code></li>
+</ul>
+</li>
+
+<li>
+<p>Stricter doctype. By the way &#8211; did I mention it? &#8211; <strong>Maruku HTML has always been proper validating XHTML strict</strong> (if a page does not validate, please report it as a bug).</p>
+
+<p>Of course, this only matters when using <code>maruku</code> as a standalone program.</p>
+
+<ul>
+<li>I have updated the XHTML DTD used to support MathML: currently using XHTML+MathML+SVG.</li>
+
+<li>Content-type set to <code>application/xhtml+xml</code></li>
+
+<li>All entities are written as numeric entities.</li>
+</ul>
+</li>
+
+<li>
+<p>Bug fixes</p>
+
+<ul>
+<li>Many fixes in the code handling the sanitizing of inline HTML.</li>
+
+<li><code>markdown=1</code> did not propagate to children.</li>
+
+<li>LaTeX: An exception was raised if an unknown entity was used.</li>
+</ul>
+</li>
+</ul>
+
+<h4 id='changes_in_042'>Changes in 0.4.2</h4>
+
+<ul>
+<li>
+<p>Adapted syntax to the <a href='http://maruku.rubyforge.org/proposal.html'>new meta-data proposal</a>.</p>
+</li>
+
+<li>
+<p>Changes in LaTeX export:</p>
+
+<ul>
+<li>
+<p>Links to external URLs are blue by default.</p>
+</li>
+
+<li>
+<p>New attributes: <code>latex_preamble</code> to add a custom preamble, and <code>latex_cjk</code> to add packages for UTF-8 Japanese characters. (<strong>support for this is still shaky</strong>). Example:</p>
+<pre><code>Title: my document
+LaTeX CJK: true
+LaTeX preamble: preamble.tex
+
+Content</code></pre></li>
+</ul>
+</li>
+
+<li>
+<p>Bug fixes</p>
+
+<ul>
+<li>
+<p>Images were not given <code>id</code> or <code>class</code> attributes.</p>
+</li>
+
+<li>
+<p>Fixed bug in LaTeX export with handling of <code>&lt;</code>,<code>&gt;</code> enclosed URLs: <code>&lt;google.com&gt;</code>.</p>
+</li>
+</ul>
+</li>
+</ul>
+
+<h4 id='changes_in_041_aka_typographer'>Changes in 0.4.1 aka &#8220;Typographer&#8221;</h4>
 
 <ul>
 <li>
@@ -10,7 +187,7 @@
 <pre><code>&#39;Twas a &quot;test&quot; to &#39;remember&#39; -- in the &#39;90s 
 --- while I was &lt;&lt;ok&gt;&gt;. She was 6\&quot;12\&#39;.</code></pre>
 <blockquote>
-<p>&lsquo;Twas a &ldquo;test&rdquo; to &lsquo;remember&rsquo; &ndash; in the &rsquo;90s &mdash; while I was &laquo;ok&raquo;. She was 6&quot;12&#39;.</p>
+<p>&#8216;Twas a &#8220;test&#8221; to &#8216;remember&#8217; &#8211; in the &#8217;90s &#8212; while I was &#171;ok&#187;. She was 6&#34;12&#39;.</p>
 </blockquote>
 
 <p>I adapted the code from RubyPants.</p>
@@ -30,7 +207,7 @@
 \usepackage[cjkjis]{ucs}
 \usepackage[utf8x]{inputenc}
 </code></pre>
-<p>Nevertheless, I could only get bitmap fonts working &ndash; probably it&rsquo;s a problem with my setup.</p>
+<p>Nevertheless, I could only get bitmap fonts working &#8211; probably it&#8217;s a problem with my setup.</p>
 
 <p>A quick test: 日本、中国、ひらがな、カタカナ。</p>
 </li>
@@ -59,7 +236,7 @@
 
 <li>Created <a href='http://maruku.rubyforge.org/rdoc/'>the RDOC documentation</a>.</li>
 
-<li>The <code>add_whitespace</code> method took too much time &ndash; it was O(n^2).</li>
+<li>The <code>add_whitespace</code> method took too much time &#8211; it was O(n^2).</li>
 
 <li>Added unit-tests for block-level elements.</li>
 </ul>
@@ -121,11 +298,11 @@ Maruku (to_latex):   parsing 0.49 sec + rendering 0.25 sec = 0.73 sec</code></pr
 <p>(日本のガルは 大好き、でも、日本語は難しですから、そうぞ 英語話すガルを おしえてください).</p>
 </blockquote>
 
-<p>In the LaTeX version, these do not appear. I know how to do LaTeX with ISO-8859-1 encoding (European characters), but I&rsquo;m struggling with half-baked solutions for UTF-8 encoded documents.</p>
+<p>In the LaTeX version, these do not appear. I know how to do LaTeX with ISO-8859-1 encoding (European characters), but I&#8217;m struggling with half-baked solutions for UTF-8 encoded documents.</p>
 </li>
 
 <li>
-<p>Implement the <span>new meta-data proposal</span>.</p>
+<p>Implement the <a href='http://maruku.rubyforge.org/proposal.html'>new meta-data proposal</a>.</p>
 </li>
 
 <li>
@@ -144,16 +321,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>
-
-<h4 id='changes_in_0213'>Changes in 0.2.13</h4>
-
-<ul>
-<li>better handling of inline HTML code.</li>
-
-<li>Handle HTML comments.</li>
-
-<li>Sanitizes HR and IMG tags if you don&rsquo;t close them.</li>
-
-<li>documentation included in HTML format</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 interpreter for Ruby'>Maruku</a> at 20:19 on Thursday, January 11st, 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 14:12 on Tuesday, January 23rd, 2007.</span></div></body></html>

data/docs/changelog.md

@@ -1,3 +1,126 @@
+CSS: style.css
+LaTeX CJK: true
+
+#### Changes in the development version and **experimental** features  ####     {#last}
+
+[Jacques Distler]: http://golem.ph.utexas.edu/~distler
+[itex2MML]:  http://golem.ph.utexas.edu/~distler/blog/itex2MML.html
+[math]: http://rubyforge.maruku.org/math.html
+<!--	This is the [math syntax specification][math]. -->
+
+*	*Jan. 22*  With very minimal changes, Maruku now works in JRuby. 
+	It is very slow, though.
+
+	Some benchmarks:
+
+	*	G4 1.5GhZ, Ruby 1.8.5:
+	
+			Maruku (to_html): parsing 0.65 sec + rendering 0.40 sec = 1.04 sec
+			Maruku (to_latex): parsing 0.70 sec + rendering 0.21 sec = 0.91 sec
+
+	*	G4 1.5GhZ, JRuby 1.9.2:
+
+			Maruku (to_html): parsing 4.77 sec + rendering 2.24 sec = 7.01 sec
+			Maruku (to_latex): parsing 4.04 sec + rendering 1.12 sec = 5.16 sec
+
+*	*Jan. 21*  Integration of Blahtex. PNG export of formula and alignment works
+	ok in Mozilla, Safari, Camino, Opera. IE7 is acting strangely.
+
+*	Support for LaTeX-style formula input, and export to MathML. 
+
+	[Jacques Distler] is integrating Maruku into Instiki (a Ruby On Rails-based wiki software), as to have a Ruby wiki with proper math support. You know, these physicists like all those funny symbols.
+
+	*	To have the MathML export, it is needed to install one of:
+	
+		* 	[RiTeX]   (`gem install ritex`) 
+		* 	[itex2MML] supports much more complex formulas than Ritex.
+		* 	PNG for old browser is not here yet. The plan is to use
+			BlahTeX.
+
+
+*	Command line options for the `maruku` command:
+
+		Usage: maruku [options] [file1.md [file2.md ...
+		    -v, --[no-]verbose               Run verbosely
+		    -u, --[no-]unsafe                Use unsafe features
+		    -b                               Break on error
+		    -m, --math-engine ENGINE         Uses ENGINE to render MathML
+		        --pdf                        Write PDF
+		        --html                       Write HTML
+		        --tex                        Write LaTeX
+		        --inspect                    Shows the parsing result
+		        --version                    Show version
+		    -h, --help                       Show this message
+
+*	Other things:
+	
+	*	Created the embryo of an extension system. Please don't use it
+		yet, as probably the API is bound to change.
+
+	*	There are a couple of hidden features...
+
+#### Changes in 0.5.0 ####    {#stable}
+
+*	Syntax changes:
+
+	*	Compatibility with newest Markdown.pl: `[text]` as a synonim of `[text][]`.
+
+	*	Meta data: the first IAL in a span environment now refers to the parent.
+		This makes it possible to set attributes for cells:
+
+			Head           |  Head |
+			---------------+-------+--
+			{:r}  Hello    + ...
+
+			{:r: scope='row'}
+
+		The first cell will have the `scope` attribute set to `row`.
+
+*	New settings:
+
+	*	Disable the Maruku signature by setting `maruku signature: false`
+
+*	Stricter doctype. By the way -- did I mention it? -- 
+	**Maruku HTML has always been proper validating XHTML strict** 
+	(if a page does not validate, please report it as a bug).
+
+	Of course, this only matters when using `maruku` as a standalone
+	program.
+
+	*	I have updated the XHTML DTD used to support MathML: 
+		currently using XHTML+MathML+SVG.
+	*	Content-type set to `application/xhtml+xml`	
+	*	All entities are written as numeric entities.
+
+*	Bug fixes
+
+	*	Many fixes in the code handling the sanitizing of inline HTML.
+	*	`markdown=1` did not propagate to children.
+	*	LaTeX: An exception was raised if an unknown entity was used.
+
+#### Changes in 0.4.2 ####    
+
+*	Adapted syntax to the [new meta-data proposal][proposal].
+
+*	Changes in LaTeX export: 
+
+	*	Links to external URLs are blue by default.
+
+	*	New attributes: `latex_preamble` to add a custom preamble,
+		and `latex_cjk` to add packages for UTF-8 Japanese characters.
+		(**support for this is still shaky**). Example:
+	
+			Title: my document
+			LaTeX CJK: true
+			LaTeX preamble: preamble.tex
+		
+			Content
+
+*	Bug fixes
+
+	+ Images were not given `id` or `class` attributes.
+
+	+ Fixed bug in LaTeX export with handling of `<`,`>` enclosed URLs: `<google.com>`.
 
 #### Changes in 0.4.1 aka "Typographer" ####
 
@@ -105,9 +228,9 @@ Immediate TODO-list:
 
 *	Support for images in PDF.
 
-#### Changes in 0.2.13 ####
 
-- better handling of inline HTML code.
-- Handle HTML comments.
-- Sanitizes HR and IMG tags if you don't close them.
-- documentation included in HTML format
+[proposal]: http://maruku.rubyforge.org/proposal.html
+[contact]: http://www.dis.uniroma1.it/~acensi/contact.html
+[markdown-discuss]: http://six.pairlist.net/mailman/listinfo/markdown-discuss
+[tracker]: http://rubyforge.org/tracker/?group_id=2795
+