maruku 0.5.0 → 0.5.1

data/docs/maruku.html

@@ -13,10 +13,12 @@
 <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.0 &#8211; 2007-01-23.</p>
+<p><a href='#release_notes'>Last release</a> is version 0.5.1 &#8211; 2007-01-24.</p>
 
 <p>Use this command to update:</p>
-<pre><code>$ gem update maruku</code></pre></blockquote>
+
+<pre><code>$ gem update maruku</code></pre>
+</blockquote>
 <hr />
 <p>Maruku allows you to write in an easy-to-read-and-write syntax, like this:</p>
 
@@ -73,13 +75,15 @@
 <p>The development site is <a href='http://rubyforge.org/projects/maruku/'>http://rubyforge.org/projects/maruku/</a>.</p>
 
 <p>Install with:</p>
-<pre><code>$ gem install maruku
-</code></pre>
+
+<pre style='background-color: #efefff;'><code class='sh' lang='sh'>$ gem install maruku</code></pre>
+
 <p>Released files can also be seen at <a href='http://rubyforge.org/frs/?group_id=2795'>http://rubyforge.org/frs/?group_id=2795</a>.</p>
 
 <p>Anonymous access to the repository is possible with:</p>
-<pre><code>$ svn checkout svn://rubyforge.org/var/svn/maruku/trunk
-</code></pre>
+
+<pre style='background-color: #efefff;'><code class='sh' lang='sh'>$ svn checkout svn://rubyforge.org/var/svn/maruku/trunk</code></pre>
+
 <p>If you want commit access to the repository, just create an account on Rubyforge and <a href='http://www.dis.uniroma1.it/~acensi/contact.html'>drop me a mail</a>.</p>
 
 <h3 id='bugs_report'><span class='maruku_section_number'>2.1. </span>Bugs report</h3>
@@ -91,26 +95,33 @@
 <h3 id='embedded_maruku'><span class='maruku_section_number'>3.1. </span>Embedded Maruku</h3>
 
 <p>This is the basic usage:</p>
-<pre><code>require &#39;rubygems&#39;
-require &#39;maruku&#39;
 
-doc = Maruku.new(markdown_string)
-puts doc.to_html
-</code></pre>
+<pre style='background-color: #efffef;'><code class='ruby' lang='ruby'><span class='ident'>require</span> <span class='punct'>&#39;</span><span class='string'>rubygems</span><span class='punct'>&#39;</span>
+<span class='ident'>require</span> <span class='punct'>&#39;</span><span class='string'>maruku</span><span class='punct'>&#39;</span>
+
+<span class='ident'>doc</span> <span class='punct'>=</span> <span class='constant'>Maruku</span><span class='punct'>.</span><span class='ident'>new</span><span class='punct'>(</span><span class='ident'>markdown_string</span><span class='punct'>)</span>
+<span class='ident'>puts</span> <span class='ident'>doc</span><span class='punct'>.</span><span class='ident'>to_html</span></code></pre>
+
 <p>The method <code>to_html</code> outputs only an HTML fragment, while the method <code>to_html_document</code> outputs a complete XHTML 1.0 document:</p>
-<pre><code>puts doc.to_html_document
-</code></pre>
+
+<pre style='background-color: #efffef;'><code class='ruby' lang='ruby'><span class='ident'>puts</span> <span class='ident'>doc</span><span class='punct'>.</span><span class='ident'>to_html_document</span></code></pre>
+
 <p>You can have the REXML document tree with:</p>
-<pre><code>tree = doc.to_html_document_tree
-</code></pre>
+
+<pre style='background-color: #efffef;'><code class='ruby' lang='ruby'><span class='ident'>tree</span> <span class='punct'>=</span> <span class='ident'>doc</span><span class='punct'>.</span><span class='ident'>to_html_document_tree</span></code></pre>
+
 <h3 id='from_the_command_line'><span class='maruku_section_number'>3.2. </span>From the command line</h3>
 
 <p>There is one command-line program installed: <code>maruku</code>.</p>
 
 <p>Without arguments, it converts Markdown to HTML:</p>
-<pre><code>$ maruku file.md  # creates file.html</code></pre>
+
+<pre style='background-color: #efefff;'><code class='sh' lang='sh'>$ maruku file.md  # creates file.html</code></pre>
+
 <p>With the <code>--pdf</code> arguments, it converts Markdown to LaTeX, then calls <code>pdflatex</code> to transform to PDF:</p>
-<pre><code>$ maruku --pdf file.md  # creates file.tex and file.pdf</code></pre>
+
+<pre style='background-color: #efefff;'><code class='sh' lang='sh'>$ maruku --pdf file.md  # creates file.tex and file.pdf</code></pre>
+
 <h2 id='maruku-and-bluecloth'><span class='maruku_section_number'>4. </span>Maruku and Bluecloth</h2>
 
 <p>The other Ruby implementation of Markdown is <a href='http://www.deveiate.org/projects/BlueCloth'>Bluecloth</a>.</p>
@@ -120,10 +131,12 @@ puts doc.to_html
 <p>Maruku is usually faster than Bluecloth. Bluecloth is faster for very small documents. Bluecloth sometimes chokes on very big documents (it is reported that the blame should be on Ruby&#8217;s regexp implementation).</p>
 
 <p>This is the canonical benchmark (the Markdown specification), executed with Ruby 1.8.5 on a Powerbook 1.5GhZ:</p>
+
 <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>
+
 <p>Please note that Maruku has a lot more features and therefore is looking for much more patterns in the file.</p>
 
 <h2 id='maruku_summary_of_features'><span class='maruku_section_number'>5. </span>Maruku summary of features</h2>
@@ -201,14 +214,16 @@ puts doc.to_html
 <p>See the <a href='exd.html'>documentation for supported attributes</a>.</p>
 
 <p>Meta-data for the document itself is specified through the use of email headers:</p>
-<pre><code>Title: A simple document containing meta-headers
+
+<pre style='background-color: #ffefef;'><code>Title: A simple document containing meta-headers
 CSS: style.css
 
-Content of the document
-</code></pre>
+Content of the document</code></pre>
+
 <p>When creating the document through</p>
-<pre><code>Maruku.new(s).to_html_document
-</code></pre>
+
+<pre style='background-color: #efffef;'><code class='ruby' lang='ruby'><span class='constant'>Maruku</span><span class='punct'>.</span><span class='ident'>new</span><span class='punct'>(</span><span class='ident'>s</span><span class='punct'>).</span><span class='ident'>to_html_document</span></code></pre>
+
 <p>the title and stylesheet are added as expected.</p>
 
 <p>Meta-data keys are assumed to be case-insensitive.</p>
@@ -216,9 +231,11 @@ Content of the document
 <h3 id='toc-generation'><span class='maruku_section_number'>5.2. </span>Automatic generation of the table of contents</h3>
 
 <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>
+
 <p>You can see an example of this at the beginning of this document.</p>
 
 <h3 id='entities'><span class='maruku_section_number'>5.3. </span>Use HTML entities</h3>
@@ -242,37 +259,47 @@ Content of the document
 <ul>
 <li>
 <p>tables</p>
-<pre><code>Col1 | Very very long head | Very very long head|
+
+<pre style='background-color: #ffefef;'><code>Col1 | Very very long head | Very very long head|
 -----|:-------------------:|-------------------:|
-cell | center-align        | right-align        |</code></pre><table><thead><tr><th>Col1</th><th>Very very long head</th><th>Very very long head</th></tr></thead><tbody><tr><td style='text-align: left;'>cell</td><td style='text-align: center;'>center-align</td><td style='text-align: right;'>right-align</td>
+cell | center-align        | right-align        |</code></pre>
+<table><thead><tr><th>Col1</th><th>Very very long head</th><th>Very very long head</th></tr></thead><tbody><tr><td style='text-align: left;'>cell</td><td style='text-align: center;'>center-align</td><td style='text-align: right;'>right-align</td>
 </tr></tbody></table></li>
 
 <li>
 <p>footnotes <sup id='fnref:1'><a href='#fn:1' rel='footnote'>1</a></sup></p>
-<pre><code>* footnotes [^foot]
 
-[^foot]: I really was missing those.</code></pre></li>
+<pre style='background-color: #ffefef;'><code>* footnotes [^foot]
+
+[^foot]: I really was missing those.</code></pre>
+</li>
 </ul>
 
 <ul>
 <li>
 <p>Markdown inside HTML elements</p>
-<pre><code>&lt;div markdown=&quot;1&quot; style=&quot;border: solid 1px black&quot;&gt;
+
+<pre><code class='xml' lang='xml'><span class='punct'>&lt;</span><span class='tag'>div</span> <span class='attribute'>markdown</span><span class='punct'>=&quot;</span><span class='string'>1</span><span class='punct'>&quot;</span> <span class='attribute'>style</span><span class='punct'>=&quot;</span><span class='string'>border: solid 1px black</span><span class='punct'>&quot;&gt;</span>
    This is a div with Markdown **strong text**
-&lt;/div&gt;</code></pre><div style='border: solid 1px black'>
+<span class='punct'>&lt;/</span><span class='tag'>div</span><span class='punct'>&gt;</span></code></pre>
+<div style='border: solid 1px black'>
 <p>This is a div with Markdown <strong>strong text</strong></p>
 </div></li>
 
 <li>
 <p>header ids</p>
-<pre><code>## Download ##     {#download}</code></pre>
+
+<pre style='background-color: #ffefef;'><code>## Download ##     {#download}</code></pre>
+
 <p>For example, <a href='#download'>a link to the download</a> header.</p>
 </li>
 
 <li>
 <p>definition lists</p>
-<pre><code>Definition list
+
+<pre style='background-color: #ffefef;'><code>Definition list
 : something very hard to parse</code></pre>
+
 <dl>
 <dt>Definition list</dt>
 
@@ -296,4 +323,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 14:11 on Tuesday, January 23rd, 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:51 on Wednesday, January 24th, 2007.</span></div></body></html>

data/docs/maruku.md

@@ -11,7 +11,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.0 -- 2007-01-23.
+> [Last release](#release_notes) is version 0.5.1 -- 2007-01-24.
 >
 > Use this command to update:
 >
@@ -94,7 +94,7 @@ Table of contents: (**auto-generated by Maruku!**)
 {:ruby:     lang=ruby code_background_color='#efffef'}
 {:shell:    lang=sh code_background_color='#efefff'}
 {:markdown: code_background_color='#ffefef'}
-{:html:     lang=html}
+{:html:     lang=xml}
 
 
 Release notes  {#release_notes}
@@ -121,16 +121,14 @@ The development site is <http://rubyforge.org/projects/maruku/>.
 Install with:
 
 	$ gem install maruku
-
-  {:shell}
+{:shell}
 
 Released files can also be seen at <http://rubyforge.org/frs/?group_id=2795>.
 
 Anonymous access to the repository is possible with:
 
 	$ svn checkout svn://rubyforge.org/var/svn/maruku/trunk
-
-  {:shell}
+{:shell}
 
 If you want commit access to the repository, just create an account on Rubyforge and [drop me a mail][contact].
 
@@ -151,20 +149,17 @@ This is the basic usage:
 
 	doc = Maruku.new(markdown_string)
 	puts doc.to_html
-
-  {:ruby}
+{:ruby}
 
 The method `to_html` outputs only an HTML fragment, while the method `to_html_document` outputs a complete XHTML 1.0 document:
 
 	puts doc.to_html_document
-
-  {:ruby}
+{:ruby}
 	
 You can have the REXML document tree with:
 
 	tree = doc.to_html_document_tree
-
-  {:ruby}
+{:ruby}
 
 ### From the command line ###
 
@@ -267,14 +262,12 @@ of email headers:
 	CSS: style.css
 	
 	Content of the document
-
-  {:markdown}
+{:markdown}
 
 When creating the document through 
 
 	Maruku.new(s).to_html_document
-
-  {:ruby}
+{:ruby}
 
 the title and stylesheet are added as expected.
 

data/docs/math.md

@@ -1,12 +1,22 @@
+Title: Math support in Maruku
 LaTeX preamble: math_preamble.tex
 LaTeX use listings: true
 CSS: math.css style.css
+use numbered headers: true
 
 Math support in Maruku
 ======================
 
+This document describes Maruku's support of inline LaTeX-style math.
 
-Introduction...
+At the moment, **these features are experimental**, are probably
+buggy and the syntax and implementation are bound to change in
+the near future.
+
+Also, there are many subtleties of which one must care for 
+correctly serving the XHTML+MathML document to browsers.
+In fact, *this documentation is __not__ enough to get you started*, 
+unless you feel very adventurous.
 
 * toc
 {:toc}
@@ -16,9 +26,9 @@ Syntax
 
 ### Inline math
 
-Inline math are comprised inside couples of `$`. 
+Inline math is contained inside couples of `$`. 
 
-Everything inside `$` will be passed as-is to LaTeX: no Markdown
+Everything inside will be passed as-is to LaTeX: no Markdown
 interpretation will take place.
 
 	Example: $x^{n}+y^{n} \neq z^{n}$ for $n \geq 3$
@@ -53,7 +63,7 @@ $$ \beth \Subset \bigtriangleup \bumpeq \ggg \pitchfork $$
 
 Create a label for an equation in two ways:
 
-*	LaTeX style
+*	LaTeX style:
 	
 		Consider \eqref{a}:
 	
@@ -94,50 +104,91 @@ Enabling the extension
 
 Use the `-m` option to choose the kind of output. Possible choices are:
 
-*	`-m itex2mml` 
+`--math-engine itex2mml` : Outputs MathML using [itex2mml](#using_itex2mml).  
+`--math-engine ritex` : Outputs MathML using [ritex](#using_ritex).  
+`--math-engine blahtex` : Outputs MathML using [blahtex](#using_blahtex).  
+`--math-images blahtex` : Outputs PNGs  using [blahtex](#using_blahtex).
 
-	[Instructions for itex2mml][itex2mml].
+### With embedded Maruku
 
-*	`-m ritex`
-*	`-m blahtex`
+You have to enable the math extension like this:
 
-*	`-mi blahtex`
+	require 'maruku'          # loads maruku
+	require 'maruku/ext/math' # loads the math extension
 
+Use the following to choose the engine:
 
-[itex2mml]: http://golem.ph.utexas.edu/~distler/code/itexToMML/
+	MaRuKu::Globals[:html_math_engine] = 'ritex'
+	MaRuKu::Globals[:html_png_engine] =  'blahtex'
+	
+Available MathML engines are 'none', 'itex2mml', 'blahtex'.
+'blahtex' is the only PNG engine available.
+	
+External libraries needed
+-------------------------
 
-### With embedded Maruku
+To output MathML or PNGs, it is needed to install one of the following libraries
 
-First, you have to enable the math extension.
+### Using `ritex` ### {#using_ritex}
 
-	require 'maruku'          # loads maruku
-	require 'maruku/ext/math' # loads the math extension
-	
+Install with 
 
-### MathML output 
+	$ gem install ritex
 
-...
+ritex's abilities are very limited, but it is the easiest to install.
 
-### PNG output ###
+### Using `itex2mml` ### {#using_itex2mml}
 
-Other parameters of interests are:
+itex2mml supports much more LaTeX commands/environments than ritex.
 
-*	`Globals[:math_png_dir]`
-*	`Globals[:math_png_dir_url]`
+Install itex2mml using the instructions at:
 
+> <http://golem.ph.utexas.edu/~distler/blog/itex2MML.html> 
 
-Advanced topics
----------------
+This is a summary of the available LaTeX commands:
 
-### Styling equations ####
+> <http://golem.ph.utexas.edu/~distler/blog/itex2MMLcommands.html>
+
+Moreover, [Jacques Distler] is integrating Maruku+itex2mml+[Instiki].
+You can find more information here:
+
+> <http://golem.ph.utexas.edu/~distler/blog/archives/001111.html>
+
+[Jacques Distler]: http://golem.ph.utexas.edu/~distler
+[instiki]: http://www.instiki.org
+
+### Using `blahtex` ### {#using_blahtex}
+
+Download from <http://www.blahtex.org>. Make sure you have
+the command-line `blahtex` in your path.
+
+
+Subtleties
+----------
+
+### Serving the right content/type ###
+
+
+* Mozilla wants files to have the `.xhtml` extension.
 
 ...
 
-### Aligning PNGs ####
+### Where PNGS are put ###
+
+*	`Globals[:math_png_dir]`
+
+*	`Globals[:math_png_dir_url]`
+
+
+### Styling equations ####
 
 ...
 
+### Aligning PNGs ####
 
 
+*	using `ex`
 
+*	**IE7 bug**
 
+...

data/docs/proposal.html

@@ -19,31 +19,41 @@
 <p>Changed the syntax for compatibility with a future extension mechanism.</p>
 
 <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>
+
 <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>
+
 <p>instead of:</p>
+
 <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>
 
 <li>
 <p>IAL can be put both <em>before</em> and <em>after</em> the element. There is no ambiguity as a blank line is needed between elements:</p>
+
 <pre><code>Paragraph 1
 
 {:par2}
 Paragraph 2
 </code></pre>
+
 <p>is equivalent to:</p>
+
 <pre><code>Paragraph 1
 
 Paragraph 2
-{:par2}</code></pre></li>
+{:par2}</code></pre>
+</li>
 
 <li>
 <p>Simplified rules for escaping.</p>
@@ -61,23 +71,30 @@ Paragraph 2
 <ol>
 <li>
 <p>inline attribute lists (IAL)</p>
-<pre><code>## Header ##       {: key=val .class #id ref_id}</code></pre></li>
+
+<pre><code>## Header ##       {: key=val .class #id ref_id}</code></pre>
+</li>
 
 <li>
 <p>attribute lists definitions (ALD)</p>
-<pre><code>{:ref_id: key=val .class #id}</code></pre></li>
+
+<pre><code>{:ref_id: key=val .class #id}</code></pre>
+</li>
 </ol>
 
 <p>Every span-level or block-level element can be followed by an IAL:</p>
+
 <pre><code>### Header ###     {: #header1 class=c1}
 
 Paragraph *with emphasis*{: class=c1}
 second line of paragraph
 {: class=c1}
 </code></pre>
+
 <p>In this example, the three IALs refer to the header, the emphasis span, and the entire paragraph, respectively.</p>
 
 <p>IALs can reference ALDs. The result of the following example is the same as the previous one:</p>
+
 <pre><code>### Header ###  {: #header1 c1}
 
 Paragraph *with emphasis*{:c1}
@@ -86,11 +103,14 @@ second line of paragraph
 
 {: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>
+
 <p>More in particular, an attribute list is a whitespace-separated list of elements of 4 different kinds:</p>
 
 <ol>
@@ -116,21 +136,26 @@ second line of paragraph
 <p><code>.myclass</code> means &#8220;add <code>myclass</code> to the current <code>class</code> attribute&#8221;.</p>
 
 <p>So these are equivalent:</p>
+
 <pre><code>{: .class1 .class2}
-{: class=&quot;class1 class2&quot;}</code></pre></li>
+{: class=&quot;class1 class2&quot;}</code></pre>
+</li>
 </ul>
 
 <p>The following attribute lists are equivalent:</p>
+
 <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>
+
 <h2 id='where_to_put_inline_attribute_lists'><span class='maruku_section_number'>3. </span>Where to put inline attribute lists</h2>
 
 <h3 id='for_blocklevel_elements'><span class='maruku_section_number'>3.1. </span>For block-level elements</h3>
 
 <p>For paragraphs and other block-level elements, IAL go <strong>after</strong> the element:</p>
+
 <pre><code>This is a paragraph.
 Line 2 of the paragraph.
 {: #myid .myclass}
@@ -139,13 +164,17 @@ A quote with a citation url:
 &gt; Who said that?
 {: 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>
+
 <p>Attribute lists may be indented up to 3 spaces:</p>
+
 <pre><code>Paragraph1
 &#172;{:ok}
 
@@ -154,15 +183,19 @@ Paragraph2
 
 Paragraph2
 &#172;&#172;&#172;{:ok}</code></pre>
+
 <h3 id='for_headers'><span class='maruku_section_number'>3.2. </span>For headers</h3>
 
 <p>For headers, you can put attribute lists on the same line:</p>
+
 <pre><code>### Header ###     {: #myid}
 
 Header     {: #myid .myclass}
 ------
 </code></pre>
+
 <p>or, as like other block-level elements, on the line below:</p>
+
 <pre><code>### Header ###     
 {: #myid}
 
@@ -170,24 +203,33 @@ Header
 ------
 {: #myid .myclass}
 </code></pre>
+
 <h3 id='for_spanlevel_elements'><span class='maruku_section_number'>3.3. </span>For span-level elements</h3>
 
 <p>For span-level elements, meta-data goes immediately <strong>after</strong> in the flow.</p>
 
 <p>For example, in this:</p>
+
 <pre><code>This is a *chunky paragraph*{: #id1}
 {: #id2}</code></pre>
+
 <p>the ID of the <code>em</code> element is set to <code>id1</code> and the ID of the paragraph is set to <code>id2</code>.</p>
 
 <p>This works also for links, like this:</p>
+
 <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>
+
 <p>is equivalent to:</p>
+
 <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>
 
 <p>In an attribute list, you can have:</p>
@@ -201,13 +243,16 @@ Header
 </ol>
 
 <p>Everything else is interpreted as a reference to an ALD.</p>
+
 <pre><code># Header #      {:ref}
 
 Blah blah blah.
 
 {:ref: #myhead .myclass lang=fr}
 </code></pre>
+
 <p>Of course, more than one IAL can reference the same ALD:</p>
+
 <pre><code># Header 1 #      {:1}
 ...
 # Header 2 #      {:1}
@@ -215,6 +260,7 @@ Blah blah blah.
 {:1: .myclass lang=fr}
 
 </code></pre>
+
 <h2 id='the_rules'><span class='maruku_section_number'>5. </span>The rules</h2>
 
 <h3 id='the_issue_of_escaping'><span class='maruku_section_number'>5.1. </span>The issue of escaping</h3>
@@ -239,7 +285,7 @@ Blah blah blah.
 </li>
 
 <li>
-<p>Inside <code>&apos;quoted values&apos;</code>, you <strong>must</strong> escape <code>&apos;</code>.</p>
+<p>Inside <code>&#39;quoted values&#39;</code>, you <strong>must</strong> escape <code>&#39;</code>.</p>
 </li>
 
 <li>
@@ -247,15 +293,17 @@ Blah blah blah.
 </li>
 </ul>
 
-<p><code>&quot;bah &apos;bah&apos; bah&quot;</code> = <code>&quot;bah \&apos;bah\&apos; bah&quot;</code> = <code>&apos;bah \&apos;bah\&apos; bah&apos;</code></p>
+<p><code>&quot;bah &#39;bah&#39; bah&quot;</code> = <code>&quot;bah \&#39;bah\&#39; bah&quot;</code> = <code>&#39;bah \&#39;bah\&#39; bah&#39;</code></p>
 
-<p><code>&apos;bah &quot;bah&quot; bah&apos;</code> = <code>&apos;bah \&quot;bah\&quot; bah&apos;</code> = <code>&quot;bah \&quot;bah\&quot; bah&quot;</code></p>
+<p><code>&#39;bah &quot;bah&quot; bah&#39;</code> = <code>&#39;bah \&quot;bah\&quot; bah&#39;</code> = <code>&quot;bah \&quot;bah\&quot; bah&quot;</code></p>
 </li>
 
 <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>
+
 <p>The exception is not valid for attribute lists and in other contexts, where you have to use the canonical syntax.</p>
 </li>
 </ol>
@@ -263,28 +311,36 @@ Blah blah blah.
 <h3 id='syntax_for_attribute_lists'><span class='maruku_section_number'>5.2. </span>Syntax for attribute lists</h3>
 
 <p>Consider the following attribute list:</p>
+
 <pre><code>{: key=value ref key2=&quot;quoted value&quot; }</code></pre>
-<p>In this string, <code>key</code>, <code>value</code>, and <code>ref</code> can be substituted by any string that does not contain whitespace, or the unescaped characters <code>}</code>,<code>=</code>,<code>&apos;</code>,<code>&quot;</code>.</p>
+
+<p>In this string, <code>key</code>, <code>value</code>, and <code>ref</code> can be substituted by any string that does not contain whitespace, or the unescaped characters <code>}</code>,<code>=</code>,<code>&#39;</code>,<code>&quot;</code>.</p>
 
 <p>Inside a quoted value you <strong>must</strong> escape the other kind of quote.</p>
 
 <p>Also, you <strong>must</strong> escape a closing curly brace <code>}</code> inside quoted values. This rule is for making life easier for interpreter that just want to skip the meta-data.</p>
 
 <p>If you don&#8217;t implement this syntax, you can get rid of the IAL by using this regular expression (this is written in Ruby):</p>
+
 <pre><code>r = /\{:(\\\}|[^\}])*\}/       
 
 s.gsub(r, &#39;&#39;) # ignore metadata</code></pre>
+
 <p>Basically: match everything contained in a couple of <code>{:</code> and <code>}</code>, taking care of escaping of <code>}</code>. This <code>\\\}|[^\}]</code> means: eat either any character which is not a <code>}</code> or an escape sequence <code>\}</code>.</p>
 
 <p>For this example,</p>
+
 <pre><code>this is 
 {: skipped=&quot;\}&quot; val=\} bar} 
 
 for me 
 {: also this} 
 </code></pre>
+
 <p>the result is:</p>
+
 <pre><code>this is 
  
 
-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 Tuesday, January 23rd, 2007.</span></div></body></html>
+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 13:49 on Wednesday, January 24th, 2007.</span></div></body></html>