<?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><link href='style.css' rel='stylesheet' type='text/css' /></head><body>
<h1>Auto-extracted documentation</h1>
<p>This documentation is auto-generated by reading from the Ruby source for <code>maruku</code> by the program <code>docs/exd/exd.rb</code>.</p>
<p>It is important to have documentation near the code!</p>
<p>Each block is delimited by <code>=begin</code> and <code>=end</code> blocks and is a Markdown document:</p>
<pre><code>...
=begin maruku_doc
Attribute: att1
Summary: summary for attribute
Expanded documentation (Markdown format)
=end
...</code></pre>
<h2>Attribute documentation</h2>
<h3 id='encoding'>Attribute <code>encoding</code></h3>
<p>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>
<p>Conversion happens using the <code>iconv</code> library.</p>
<h3 id='exec'>Attribute <code>exec</code></h3>
<p>Read from file <code>input/parse_doc.rb</code>, line 86:</p>
<p>Disabled by default because of security concerns.</p>
<h3 id='latex_cjk'>Attribute <code>latex_cjk</code></h3>
<p>Read from file <code>output/to_latex.rb</code>, line 56:</p>
<p>If the <code>latex_cjk</code> attribute is specified, then appropriate headers are added to the LaTeX preamble to support Japanese fonts. You have to have these fonts installed – and this can be a pain.</p>
<p>If <code>latex_cjk</code> is specified, this is added to the preamble:</p>
<?mrk md_codeblock(Maruku::MDDocument::Latex_preamble_enc_cjk)?>
<p>while the default is to add this:</p>
<?mrk md_codeblock(Maruku::MDDocument::Latex_preamble_enc_utf8)?>
<h3 id='latex_preamble'>Attribute <code>latex_preamble</code></h3>
<p>Read from file <code>output/to_latex.rb</code>, line 78:</p>
<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>
<p>will produce:</p>
<pre><code>...
\input{preamble.tex}
...</code></pre>
<h3 id='latex_use_listings'>Attribute <code>latex_use_listings</code></h3>
<p>Read from file <code>output/to_latex.rb</code>, line 181:</p>
<p>If the <code>latex_use_listings</code> attribute is specified, then code block are rendered using the <code>listings</code> package. Otherwise, a standard <code>verbatim</code> environment is used.</p>
<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>
<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>
<li>
<p>If the <code>code_show_spaces</code> is specified, than spaces and tabs will be shown using the macro:</p>
<pre><code>\lstset{showspaces=true,showtabs=true}</code></pre></li>
<li>
<p>The background color is given by <code>code_background_color</code>.</p>
</li>
</ul>
<h2>Other misc. documentation</h2>
<p>This other documentation are other bits and pieces found in the code that are not related to attributes.</p>
<p>Admissible formats:</p>
<pre><code>green
#abc
#aabbcc</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 interpreter for Ruby'>Maruku</a> at 10:34 on Tuesday, January 09th, 2007.</span></div></body></html>