docs/proposal.html in maruku-0.5.3 vs docs/proposal.html in maruku-0.5.4
- old
+ new
@@ -18,36 +18,32 @@
<li>
<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>
+<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’t use this syntax may just ignore everything which is in curly braces and starts with ”:”.</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>
+Paragraph 2</code></pre>
<p>is equivalent to:</p>
<pre><code>Paragraph 1
@@ -86,12 +82,11 @@
<pre><code>### Header ### {: #header1 class=c1}
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>
<p>IALs can reference ALDs. The result of the following example is the same as the previous one:</p>
@@ -99,19 +94,17 @@
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="long val" #myid .class1 .class2 ref1 ref2}
-</code></pre>
+<pre><code>{: key1=val key2="long val" #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>
@@ -145,12 +138,11 @@
<p>The following attribute lists are equivalent:</p>
<pre><code>{: #myid .class1 .class2}
{: id=myid class=class1 .class2}
{: id=myid class="class1 class2"}
-{: id=myid class="will be overridden" class=class1 .class2}
-</code></pre>
+{: id=myid class="will be overridden" 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>
@@ -160,20 +152,18 @@
Line 2 of the paragraph.
{: #myid .myclass}
A quote with a citation url:
> 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>
<pre><code>Paragraph1
¬{:ok}
@@ -189,22 +179,20 @@
<p>For headers, you can put attribute lists on the same line:</p>
<pre><code>### Header ### {: #myid}
Header {: #myid .myclass}
-------
-</code></pre>
+------</code></pre>
<p>or, as like other block-level elements, on the line below:</p>
<pre><code>### Header ###
{: #myid}
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>
<p>For span-level elements, meta-data goes immediately <strong>after</strong> in the flow.</p>
@@ -215,22 +203,19 @@
<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>
+<pre><code>This is [a link][ref]{:#myid rel=abc rev=abc}</code></pre>
<p>For images, this:</p>
-<pre><code>This is 
-</code></pre>
+<pre><code>This is </code></pre>
<p>is equivalent to:</p>
-<pre><code>This is {:title="fresh carrots"}
-</code></pre>
+<pre><code>This is {:title="fresh carrots"}</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>
@@ -246,34 +231,31 @@
<pre><code># Header # {:ref}
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>
<pre><code># Header 1 # {:1}
...
# Header 2 # {:1}
-{:1: .myclass lang=fr}
+{:1: .myclass lang=fr}</code></pre>
-</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>
<ol>
<li>
<p>No escaping in code spans/blocks.</p>
</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>
<li>
@@ -299,12 +281,11 @@
</li>
<li>
<p>There is an exception for backward compatibility, in links/images titles:</p>
-<pre><code>[text](url "title"with"quotes")
-</code></pre>
+<pre><code>[text](url "title"with"quotes")</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>
@@ -332,15 +313,14 @@
<pre><code>this is
{: skipped="\}" val=\} bar}
for me
-{: also this}
-</code></pre>
+{: 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 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>