proposal.html in maruku-0.4.0

- old
+ new

@@ -1,118 +1,66 @@
 <?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>
-<title>Proposal for adding a meta-data syntax to Markdown</title>
-
-<link href='style.css' rel='stylesheet' type='text/css' />
-</head>
-<body>
+<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>Proposal for adding a meta-data syntax to Markdown</title><link href='style.css' rel='stylesheet' type='text/css' /></head><body>
 <h1 id='proposal_for_adding_a_metadata_syntax_to_markdown'>Proposal for adding a meta-data syntax to Markdown</h1>
 
 <p>This document describes a syntax for attaching meta-data to block-level elements (headers, paragraphs, code blocks,&hellip;), and to span-level elements (links, images,&hellip;).</p>
 
 <p>Last updated <strong>January 2nd, 2007</strong>: integrated topics discussed in mailing list.</p>
 
 <p><em>Table of contents:</em></p>
 
-<blockquote>
-<div class='maruku_toc'>
-<ul style='list-style: none;'>
-<li><span class='maruku_section_number'>1. </span><a href='#overview'>Overview</a></li>
+<blockquote><div class='maruku_toc'><ul style='list-style: none;'><li><span class='maruku_section_number'>1. </span><a href='#overview'>Overview</a></li><li><span class='maruku_section_number'>2. </span><a href='#attribute_lists'>Attribute lists</a><ul style='list-style: none;'><li><span class='maruku_section_number'>2.1. </span><a href='#class_id'><code>id</code> and <code>class</code> are special</a></li></ul></li><li><span class='maruku_section_number'>3. </span><a href='#where_to_put_inline_attribute_lists'>Where to put inline attribute lists</a><ul style='list-style: none;'><li><span class='maruku_section_number'>3.1. </span><a href='#for_blocklevel_elements'>For block-level elements</a></li><li><span class='maruku_section_number'>3.2. </span><a href='#for_headers'>For headers</a></li><li><span class='maruku_section_number'>3.3. </span><a href='#for_spanlevel_elements'>For span-level elements</a></li></ul></li><li><span class='maruku_section_number'>4. </span><a href='#using_tags'>Using attributes lists definition</a></li><li><span class='maruku_section_number'>5. </span><a href='#grammar'>The rules</a><ul style='list-style: none;'><li><span class='maruku_section_number'>5.1. </span><a href='#the_issue_of_escaping'>The issue of escaping</a></li><li><span class='maruku_section_number'>5.2. </span><a href='#syntax_for_attribute_lists'>Syntax for attribute lists</a></li></ul></li><li><span class='maruku_section_number'>6. </span><a href='#things_to_discuss'>Things to discuss</a></li><li><span class='maruku_section_number'>7. </span><a href='#design_rationale'>Design rationale</a></li></ul></div></blockquote>
 
-<li><span class='maruku_section_number'>2. </span><a href='#attribute_lists'>Attribute lists</a>
-<ul style='list-style: none;'>
-<li><span class='maruku_section_number'>2.1. </span><a href='#class_id'><code>id</code> and <code>class</code> are special</a></li>
-</ul>
-</li>
-
-<li><span class='maruku_section_number'>3. </span><a href='#where_to_put_inline_attribute_lists'>Where to put inline attribute lists</a>
-<ul style='list-style: none;'>
-<li><span class='maruku_section_number'>3.1. </span><a href='#for_blocklevel_elements'>For block-level elements</a></li>
-
-<li><span class='maruku_section_number'>3.2. </span><a href='#for_headers'>For headers</a></li>
-
-<li><span class='maruku_section_number'>3.3. </span><a href='#for_spanlevel_elements'>For span-level elements</a></li>
-</ul>
-</li>
-
-<li><span class='maruku_section_number'>4. </span><a href='#using_tags'>Using attributes lists definition</a></li>
-
-<li><span class='maruku_section_number'>5. </span><a href='#grammar'>The rules</a>
-<ul style='list-style: none;'>
-<li><span class='maruku_section_number'>5.1. </span><a href='#the_issue_of_escaping'>The issue of escaping</a></li>
-
-<li><span class='maruku_section_number'>5.2. </span><a href='#syntax_for_attribute_lists'>Syntax for attribute lists</a></li>
-</ul>
-</li>
-
-<li><span class='maruku_section_number'>6. </span><a href='#things_to_discuss'>Things to discuss</a></li>
-
-<li><span class='maruku_section_number'>7. </span><a href='#design_rationale'>Design rationale</a></li>
-</ul>
-</div>
-</blockquote>
-
 <h2 id='overview'><span class='maruku_section_number'>1. </span>Overview</h2>
 
 <p>This proposal describes two additions to the Markdown syntax:</p>
 
 <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}
 second line of paragraph
 {c1}
 
 {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>
 <li>key/value pairs (quoted if necessary)</li>
 
 <li><a href='#using_tags'>references to ALD</a> (<code>ref1</code>,<code>ref2</code>)</li>
 
 <li><a href='#class_id'>id specifiers</a> (<code>#myid</code>)</li>
 
-<li><a href='#class_id'>class specifiers</a> (<code>.myclass</code>) </li>
+<li><a href='#class_id'>class specifiers</a> (<code>.myclass</code>)</li>
 </ol>
 
 <h3 id='class_id'><span class='maruku_section_number'>2.1. </span><code>id</code> and <code>class</code> are special</h3>
 
 <p>For ID and classes there are special shortcuts:</p>
@@ -124,136 +72,109 @@
 
 <li>
 <p><code>.myclass</code> means &quot;add <code>myclass</code> to the current <code>class</code> attribute&quot;.</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}
 
 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 tollerated. 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
 &not;{ok}
 
 Paragraph2
 &not;&not;{ok}
 
 Paragraph2
-&not;&not;&not;{ok}
-</code></pre>
-
+&not;&not;&not;{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}
 
 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>
+<p>In an attribute list, you can have:</p>
 
 <ol>
 <li><code>key=value</code> pairs,</li>
 
 <li>id attributes (<code>#myid</code>)</li>
 
-<li>class attributes (<code>.myclass</code>) </li>
+<li>class attributes (<code>.myclass</code>)</li>
 </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}
 
 {1}: .myclass lang=fr
 
 </code></pre>
-
 <h2 id='grammar'><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>
 
 <ol>
@@ -298,22 +219,18 @@
 </li>
 </ul>
 </li>
 
 <li>
-<p>There is an exception for backward compatibility: </p>
-
-<pre><code>[text](url &quot;title&quot;with&quot;quotes&quot;)</code></pre>
-</li>
+<p>There is an exception for backward compatibility:</p>
+<pre><code>[text](url &quot;title&quot;with&quot;quotes&quot;)</code></pre></li>
 </ol>
 
 <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>Inside a quoted value, you <strong>may</strong> use <code>}</code>,<code>=</code> unescaped but you <strong>must</strong> escape the other kind of quote.</p>
 
 <h2 id='things_to_discuss'><span class='maruku_section_number'>6. </span>Things to discuss</h2>
@@ -321,21 +238,17 @@
 <ul>
 <li>
 <p>A syntax for creating <code>SPAN</code> elements in the paragraphs and setting their attributes.</p>
 
 <p>This is my proposal:</p>
-
 <pre><code>a long paragraph with [special words]{#myspan} that I want to
 highlight
 </code></pre>
-
 <p>should originate the following HTML:</p>
-
 <pre><code>&lt;p&gt;a long paragraph with &lt;span id=&quot;myspan&quot;&gt;special words&lt;/span&gt;
    that I want to highlight&lt;/p&gt;
 </code></pre>
-
 <p><strong><em>Note: I changed the old <code>{special words}{#myspan}</code> with <code>[special words]{#myspan}</code> which is less ambiguous.</em></strong></p>
 </li>
 
 <li>
 <blockquote>
@@ -345,22 +258,20 @@
 <p>Any opinion?</p>
 </li>
 
 <li>
 <p><strong>Default ALD for classes of elements.</strong> For example, an header of level 2 inherits automatically the attributes of <code>{header2}</code>, if it is defined.</p>
-
 <pre><code>## Header ##
 
 Paragraph..
 
 ## Second Header ## {.mah} 
 
 Paragraph..
 
 {header2}: .myclass
-{paragraph}: .withmargins</code></pre>
-</li>
+{paragraph}: .withmargins</code></pre></li>
 </ul>
 
 <p>In this example:</p>
 
 <ul>
@@ -388,10 +299,6 @@
 <blockquote>
 <p>No, because &apos;:&apos; is used for XML namespaces (<code>xml:lang=en</code>)</p>
 </blockquote>
 </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'>Maruku</a> at 00:21 on Wednesday, January 03rd, 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 interpreter'>Maruku</a> at 20:29 on Saturday, January 06th, 2007.</span></div></body></html>