docs/exd.html in maruku-0.5.3 vs docs/exd.html in maruku-0.5.4
- old
+ new
@@ -23,19 +23,19 @@
<h2>Attribute documentation</h2>
<h3 id='class'>Attribute <code>class</code></h3>
-<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 303:</p>
+<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 316:</p>
<p>It is copied as a standard HTML attribute.</p>
<h3 id='code_background_color'>Attribute <code>code_background_color</code></h3>
<p class='maruku-att-default'>Default: <code>"#fef"</code></p>
-<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 495:</p>
+<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 553:</p>
<p>The format is either a named color (<code>green</code>, <code>red</code>) or a CSS color of the form <code>#ff00ff</code>.</p>
<ul>
<li>
@@ -72,18 +72,26 @@
»   ¬»   Tab,¬space,¬tab
»   »   »   Tab,¬tab,¬tab¬and¬all¬is¬green!</code></pre>
<h3 id='css'>Attribute <code>css</code></h3>
-<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 134:</p>
+<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 144:</p>
<p><code>css</code> should be a space-separated list of urls.</p>
<p>Example:</p>
<pre><code>CSS: style.css math.css</code></pre>
+<h3 id='doc_prefix'>Attribute <code>doc_prefix</code></h3>
+
+<p class='maruku-att-default'>Default: <code>""</code></p>
+
+<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 128:</p>
+
+<p>String to disambiguate footnote links.</p>
+
<h3 id='encoding'>Attribute <code>encoding</code></h3>
<p class='maruku-att-origin'>Read from file <code>input/parse_doc.rb</code>, line 35:</p>
<p>If the <code>encoding</code> attribute is specified, then the content will be converted from the specified encoding to UTF-8.</p>
@@ -98,11 +106,11 @@
<p>Select the rendering engine for math.</p>
<p>If you want to use your custom engine <code>foo</code>, then set:</p>
-<pre><code class='markdown' lang='markdown'>HTML math engine: foo</code></pre>
+<pre lang='markdown'><code class='markdown' lang='markdown'>HTML math engine: foo</code></pre>
<p>and then implement two functions:</p>
<pre><code>def convert_to_mathml_foo(kind, tex)
...
@@ -114,34 +122,32 @@
<p class='maruku-att-origin'>Read from file <code>ext/math/to_html.rb</code>, line 24:</p>
<p>Same thing as <code>html_math_engine</code>, only for PNG output.</p>
-<pre><code class='ruby' lang='ruby'>def convert_to_png_foo(kind, tex)
+<pre lang='ruby'><code class='ruby' lang='ruby'>def convert_to_png_foo(kind, tex)
# same thing
...
end</code></pre>
<h3 id='html_use_syntax'>Attribute <code>html_use_syntax</code></h3>
<p class='maruku-att-default'>Default: <code>false</code></p>
-<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 402:</p>
+<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 459:</p>
<p>If true, the <code>syntax</code> package is used. It supports the <code>ruby</code> and <code>xml</code> languages. Remember to set the <code>lang</code> attribute of the code block.</p>
<p>Examples:</p>
<pre><code> require 'maruku'
-{:lang=ruby html_use_syntax=true}
-</code></pre>
+{:lang=ruby html_use_syntax=true}</code></pre>
<p>and</p>
<pre><code> <div style="text-align:center">Div</div>
-{:lang=html html_use_syntax=true}
-</code></pre>
+{:lang=html html_use_syntax=true}</code></pre>
<p>produces:</p>
<pre><code class='ruby' lang='ruby'><span class='ident'>require</span> <span class='punct'>'</span><span class='string'>maruku</span><span class='punct'>'</span></code></pre>
@@ -149,11 +155,11 @@
<pre><code class='xml' lang='xml'><span class='punct'><</span><span class='tag'>div</span> <span class='attribute'>style</span><span class='punct'>="</span><span class='string'>text-align:center</span><span class='punct'>"></span>Div<span class='punct'></</span><span class='tag'>div</span><span class='punct'>></span></code></pre>
<h3 id='id'>Attribute <code>id</code></h3>
-<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 291:</p>
+<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 304:</p>
<p>It is copied as a standard HTML attribute.</p>
<p>Moreover, it used as a label name for hyperlinks in both HTML and in PDF.</p>
@@ -183,12 +189,11 @@
<p>If the <code>latex_preamble</code> attribute is specified, then its value will be used as a custom preamble.</p>
<p>For example:</p>
<pre><code>Title: My document
-Latex preamble: preamble.tex
-</code></pre>
+Latex preamble: preamble.tex</code></pre>
<p>will produce:</p>
<pre><code>...
\input{preamble.tex}
@@ -204,12 +209,11 @@
<ul>
<li>
<p>If the <code>lang</code> attribute for the code block has been specified, it gets passed to the <code>listings</code> package using the <code>lstset</code> macro. The default lang for code blocks is specified through the <code>code_lang</code> attribute.</p>
-<pre><code>\lstset{language=ruby}
-</code></pre>
+<pre><code>\lstset{language=ruby}</code></pre>
<p>Please refer to the documentation of the <code>listings</code> package for supported languages.</p>
<p>If a language is not supported, the <code>listings</code> package will emit a warning during the compilation. Just press enter and nothing wrong will happen.</p>
</li>
@@ -231,42 +235,57 @@
<p class='maruku-att-origin'>Read from file <code>output/to_latex.rb</code>, line 45:</p>
<p>If false, Maruku does not append a signature to the generated file.</p>
+<h3 id='math_enabled'>Attribute <code>math_enabled</code></h3>
+
+<p class='maruku-att-origin'>Read from file <code>ext/math.rb</code>, line 14:</p>
+
+<p>To explicitly disable the math parsing:</p>
+
+<pre><code>Maruku.new(string, {:math_enabled => false})
+{:ruby}</code></pre>
+
+<h3 id='math_numbered'>Attribute <code>math_numbered</code></h3>
+
+<p class='maruku-att-origin'>Read from file <code>ext/math.rb</code>, line 29:</p>
+
+<p>Array containing any of <code>'\\['</code>, <code>'\\begin{equation}'</code>, <code>'$$'</code>.</p>
+
+<pre><code>MaRuKu::Globals[math_numbered] = ['\\[']</code></pre>
+
<h3 id='style'>Attribute <code>style</code></h3>
-<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 311:</p>
+<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 324:</p>
<p>It is copied as a standard HTML attribute.</p>
<h3 id='subject'>Attribute <code>subject</code></h3>
-<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 126:</p>
+<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 136:</p>
<p>Synonim for <code>title</code>.</p>
<h3 id='title'>Attribute <code>title</code></h3>
-<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 103:</p>
+<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 105:</p>
<p>Sets the title of the document. If a title is not specified, the first header will be used.</p>
<p>These should be equivalent:</p>
<pre><code>Title: my document
-Content
-</code></pre>
+Content</code></pre>
<p>and</p>
<pre><code>my document
===========
-Content
-</code></pre>
+Content</code></pre>
<p>In both cases, the title is set to “my document”.</p>
<h3 id='unsafe_features'>Attribute <code>unsafe_features</code></h3>
@@ -278,11 +297,11 @@
<h3 id='use_numbered_headers'>Attribute <code>use_numbered_headers</code></h3>
<p class='maruku-att-default'>Default: <code>false</code></p>
-<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 348:</p>
+<p class='maruku-att-origin'>Read from file <code>output/to_html.rb</code>, line 405:</p>
<p>If <code>true</code>, section headers will be numbered.</p>
<p>In LaTeX export, the numbering of headers is managed by Maruku, to have the same results in both HTML and LaTeX.</p>
-<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>