maruku 0.2 → 0.2.1
Sign up to get free protection for your applications and to get access to all the features.
- data/bin/marutex +0 -1
- data/docs/Makefile +2 -2
- data/docs/index.html +7 -5
- data/docs/markdown_syntax.log +21 -21
- data/docs/markdown_syntax.pdf +0 -0
- data/docs/markdown_syntax.tex +110 -111
- data/docs/maruku.html +7 -5
- data/docs/maruku.log +30 -54
- data/docs/maruku.md +27 -13
- data/docs/maruku.pdf +0 -0
- data/docs/maruku.tex +75 -60
- data/docs/todo.md +1 -10
- data/lib/maruku/parse_span.rb +109 -38
- data/lib/maruku/to_latex.rb +23 -12
- data/tests/links.md +7 -0
- data/tests/sss06.md +10 -10
- metadata +1 -1
data/docs/maruku.html
CHANGED
@@ -1,7 +1,9 @@
|
|
1
1
|
<?xml version='1.0'?>
|
2
2
|
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
|
3
3
|
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
|
4
|
-
<html lang='en' xml:lang='en' xmlns='http://www.w3.org/1999/xhtml'><head><title>Maruku, a Markdown interpreter</title><link href='style.css' rel='stylesheet' type='text/css' /></head><head><title>Maruku, a Markdown interpreter</title><link href='style.css' rel='stylesheet' type='text/css' /></head><body><h1>Mar<strong>u</strong>k<strong>u</strong>: a Markdown interpreter</h1><p>Maruku is a Markdown interpreter written in <a href='http://www.ruby-lang.org'>Ruby</a>.</p><p>Maruku allows you to write in an easy-to-read-and-write syntax, like this:</p><blockquote><p><a href='http://maruku.rubyforge.org/maruku.md'>This document in Markdown</a></p></blockquote><p>Then it can be translated to HTML:</p><blockquote><p><a href='http://maruku.rubyforge.org/maruku.html'>This document in HTML</a></p></blockquote><p>or Latex, which is then converted to PDF:</p><blockquote><p><a href='http://maruku.rubyforge.org/maruku.pdf'>This document in PDF</a></p></blockquote><p>Maruku implements the original <a href='http://daringfireball.net/projects/markdown/syntax'>Markdown syntax</a> (<a href='http://maruku.rubyforge.org/markdown_syntax.html'>HTML</a> or <a href='http://maruku.rubyforge.org/markdown_syntax.pdf'>PDF</a>, translated by Maruku).</p><p>Markdown implements also all the improvements in <a href='http://www.michelf.com/projects/php-markdown/extra/'>PHP Markdown Extra</a>.</p><p>Moreover, it implements ideas from <a href='http://fletcher.freeshell.org/wiki/MultiMarkdown'>MultiMarkdown</a>.</p><hr /><p><em>Table of contents</em>:</p><ul><li><p><a href='#download'>Download</a></p></li><li><p><a href='#usage'>Usage</a></p></li><li><p><a href='#extra'>Examples of PHP Markdown extra syntax</a></p></li><li><p><a href='#meta'>New metadata syntax</a></p></li><li><p><a href='#metalist'>List of metadata</a></p></li><li><p><a href='#maruku-and-bluecloth'>Maruku and Bluecloth</a></p></li><li><p><a href='#future'>Future developments</a></p><ul><li><a href='#future-export'>Export to other formats</a></li><li><a href='#future-syntax'>Syntax additions</a></li></ul></li></ul><hr /><h2 class='head' id='download'>Download</h2><p>The development site is <a href='http://
|
4
|
+
<html lang='en' xml:lang='en' xmlns='http://www.w3.org/1999/xhtml'><head><title>Maruku, a Markdown interpreter</title><link href='style.css' rel='stylesheet' type='text/css' /></head><head><title>Maruku, a Markdown interpreter</title><link href='style.css' rel='stylesheet' type='text/css' /></head><body><h1>Mar<strong>u</strong>k<strong>u</strong>: a Markdown interpreter</h1><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><p>Maruku allows you to write in an easy-to-read-and-write syntax, like this:</p><blockquote><p><a href='http://maruku.rubyforge.org/maruku.md'>This document in Markdown</a></p></blockquote><p>Then it can be translated to HTML:</p><blockquote><p><a href='http://maruku.rubyforge.org/maruku.html'>This document in HTML</a></p></blockquote><p>or Latex, which is then converted to PDF:</p><blockquote><p><a href='http://maruku.rubyforge.org/maruku.pdf'>This document in PDF</a></p></blockquote><p>Maruku implements the original <a href='http://daringfireball.net/projects/markdown/syntax'>Markdown syntax</a> (<a href='http://maruku.rubyforge.org/markdown_syntax.html'>HTML</a> or <a href='http://maruku.rubyforge.org/markdown_syntax.pdf'>PDF</a>, translated by Maruku).</p><p>Markdown implements also all the improvements in <a href='http://www.michelf.com/projects/php-markdown/extra/'>PHP Markdown Extra</a>.</p><p>Moreover, it implements ideas from <a href='http://fletcher.freeshell.org/wiki/MultiMarkdown'>MultiMarkdown</a>.</p><h3>Authors</h3><p>Maruku has been developed so far by <a href='http://www.dis.uniroma1.it/~acensi/'>Andrea Censi</a>. Contributors are most welcome!</p><hr /><p><em>Table of contents</em>:</p><ul><li><p><a href='#download'>Download</a></p></li><li><p><a href='#usage'>Usage</a></p></li><li><p><a href='#extra'>Examples of PHP Markdown extra syntax</a></p></li><li><p><a href='#meta'>New metadata syntax</a></p></li><li><p><a href='#metalist'>List of metadata</a></p></li><li><p><a href='#maruku-and-bluecloth'>Maruku and Bluecloth</a></p></li><li><p><a href='#future'>Future developments</a></p><ul><li><a href='#future-export'>Export to other formats</a></li><li><a href='#future-syntax'>Syntax additions</a></li></ul></li></ul><hr /><h2 class='head' id='download'>Download</h2><p>The development site is <a href='http://rubyforge.org/projects/maruku/'>http://rubyforge.org/projects/maruku/</a>.</p><p>Download current <a href='http://rubygems.rubyforge.org/'>gem</a> at <a href='http://rubyforge.org/frs/?group_id=2795'>http://rubyforge.org/frs/?group_id=2795</a> or try to install with:</p><pre style='background-color: #f0f0e0;'>$ gem install maruku
|
5
|
+
</pre><p>Anonymous access to the repository is possible with:</p><pre style='background-color: #f0f0e0;'>$ svn checkout svn://rubyforge.org/var/svn/maruku
|
6
|
+
</pre><p>If you want commit-access, just create an account on Rubyforge and <a href='http://www.dis.uniroma1.it/~acensi/contact.html'>drop me a mail</a>.</p><h2>Usage</h2><p>This is the basic usage:</p><pre class='ruby' style='background-color: #f0f0e0;'><span class='ident'>require</span> <span class='punct'>'</span><span class='string'>maruku</span><span class='punct'>'</span>
|
5
7
|
|
6
8
|
<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>
|
7
9
|
<span class='ident'>puts</span> <span class='ident'>doc</span><span class='punct'>.</span><span class='ident'>to_html</span>
|
@@ -14,14 +16,14 @@
|
|
14
16
|
</pre><h2 id='extra'>Examples of PHP Markdown Extra syntax</h2><ul><li><p>tables</p><pre style='background-color: #f0f0e0;'>Col1 | Very very long head | Very very long head|
|
15
17
|
-----|:-------------------:|-------------------:|
|
16
18
|
cell | center-align | right-align |
|
17
|
-
</pre><table class='example'><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 style='background-color: #f0f0e0;'>*footnotes [^foot]
|
19
|
+
</pre><table class='example'><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 style='background-color: #f0f0e0;'>* footnotes [^foot]
|
18
20
|
|
19
21
|
[^foot]: I really was missing those.</pre></li><li><p>Markdown inside HTML elememnts</p></li></ul><pre class='xml' style='background-color: #f0f0e0;'><span class='punct'><</span><span class='tag'>div</span> <span class='attribute'>markdown</span><span class='punct'>="</span><span class='string'>1</span><span class='punct'>"</span> <span class='attribute'>style</span><span class='punct'>="</span><span class='string'>border: solid 1px black</span><span class='punct'>"></span>
|
20
22
|
This is a div with Markdown **strong text**
|
21
23
|
<span class='punct'></</span><span class='tag'>div</span><span class='punct'>></span>
|
22
24
|
</pre><div style='border: solid 1px black'><p>This is a div with Markdown <strong>strong text</strong></p></div><ul><li><p>header ids</p><pre style='background-color: #f0f0e0;'>## Header ## {#id}</pre><p>For example, <a href='#download'>a link to the download</a> header.</p></li><li><p>definition lists</p><pre style='background-color: #f0f0e0;'>Definition list
|
23
25
|
: something very hard to parse
|
24
|
-
</pre><dl><dt>Definition list</dt><dd>something very hard to parse</dd></dl></li><li><p>abbreviations or <abbr title='Simple an abbreviation'>ABB</abbr> for short.</p></li></ul><h2 id='maruku-and-bluecloth'>Maruku and Bluecloth</h2><p>The other Ruby implementation of Markdown is <a href='http://www.deveiate.org/projects/BlueCloth'>Bluecloth</a>.</p><p>Maruku is much different in philosophy from Bluecloth: the biggest difference is that <em>parsing</em> is separated from <em>rendering</em>. In Maruku, an in-memory representation of the Markdown document is created. Instead, Bluecloth mantains the document in memory as a String at all times, and does a series of <tt style='background-color: #f0f0e0;'>gsub</tt> to transform to HTML
|
26
|
+
</pre><dl><dt>Definition list</dt><dd>something very hard to parse</dd></dl></li><li><p>abbreviations or <abbr title='Simple an abbreviation'>ABB</abbr> for short.</p></li></ul><h2 id='maruku-and-bluecloth'>Maruku and Bluecloth</h2><p>The other Ruby implementation of Markdown is <a href='http://www.deveiate.org/projects/BlueCloth'>Bluecloth</a>.</p><p>Maruku is much different in philosophy from Bluecloth: the biggest difference is that <em>parsing</em> is separated from <em>rendering</em>. In Maruku, an in-memory representation of the Markdown document is created. Instead, Bluecloth mantains the document in memory as a String at all times, and does a series of <tt style='background-color: #f0f0e0;'>gsub</tt> to transform to HTML.</p><p>The in-memory representation makes it very easy to export to various formats (altough, for, now)</p><p>Other improvements over Bluecloth:</p><ul><li><p>the HTML output is provided also as a <tt style='background-color: #f0f0e0;'>REXML</tt> document tree.</p></li><li><p>PHP Markdown Syntax support.</p></li></ul><h2 id='meta'>New meta-data syntax</h2><p>Maruku implements a syntax that allows to attach "meta" information to objects.</p><h3>Meta-data for the document</h3><p>Meta-data for the document itself is specified through the use of email headers:</p><pre style='background-color: #f0f0e0;'>Title: A simple document containing meta-headers
|
25
27
|
CSS: style.css
|
26
28
|
|
27
29
|
Content of the document
|
@@ -47,7 +49,7 @@ Paragraph 1 is a warning
|
|
47
49
|
</pre><p>Also, if the value is not present, it defaults to <tt style='background-color: #f0f0e0;'>true</tt>:</p><pre style='background-color: #f0f0e0;'>@ test
|
48
50
|
|
49
51
|
This paragraph has the attribute 'test' set.
|
50
|
-
</pre><hr /><h2 id='metalist'>List of meta-data</h2><dl><dt><strong><tt style='background-color: #f0f0e0;'>title</tt>, <tt style='background-color: #f0f0e0;'>subject</tt></strong></dt><dd><p>(document) Sets the title of the document
|
52
|
+
</pre><hr /><h2 id='metalist'>List of meta-data</h2><dl><dt><strong><tt style='background-color: #f0f0e0;'>title</tt>, <tt style='background-color: #f0f0e0;'>subject</tt></strong></dt><dd><p>(document) Sets the title of the document (HTML: used in the <tt style='background-color: #f0f0e0;'>TITLE</tt> element).</p></dd><dt><strong><tt style='background-color: #f0f0e0;'>css</tt></strong></dt><dd><p>(document, HTML) Url of stylesheet.</p></dd><dt><strong><tt style='background-color: #f0f0e0;'>html_use_syntax</tt></strong></dt><dd><p>(document, HTML) Use the <a href='http://syntax.rubyforge.org/'><tt style='background-color: #f0f0e0;'>syntax</tt> library</a> to add source highlighting.</p></dd><dt><strong><tt style='background-color: #f0f0e0;'>latex_use_listings</tt></strong></dt><dd><p>(document, LaTex) Use fancy <tt style='background-color: #f0f0e0;'>listing</tt> package for better displaying code blocks.</p></dd><dt><strong><tt style='background-color: #f0f0e0;'>style</tt>, <tt style='background-color: #f0f0e0;'>id</tt>, <tt style='background-color: #f0f0e0;'>class</tt></strong></dt><dd><p>(any block object, HTML) Standard CSS attributes are copied.</p></dd><dt><strong><tt style='background-color: #f0f0e0;'>lang</tt></strong></dt><dd><p>(code blocks) Name of programming language (<tt style='background-color: #f0f0e0;'>ruby</tt>) for syntax highlighting (does not work yet)</p><p>Default for this is <tt style='background-color: #f0f0e0;'>code_lang</tt> in document.</p></dd><dt><strong><tt style='background-color: #f0f0e0;'>code_show_spaces</tt></strong></dt><dd><p>Shows tabs and newlines (default is read in the document object).</p></dd><dt><strong><tt style='background-color: #f0f0e0;'>code_background_color</tt></strong></dt><dd><p>Background color for code blocks. (default is read in the document object).</p><p>The format is either a named color (<tt style='background-color: #f0f0e0;'>green</tt>, <tt style='background-color: #f0f0e0;'>red</tt>) or a CSS color of the form <tt style='background-color: #f0f0e0;'>#ff00ff</tt>.</p><ul><li><p>for <strong>HTML output</strong>, the value is put straight in the <tt style='background-color: #f0f0e0;'>background-color</tt> CSS property of the block.</p></li><li><p>for <strong>LaTeX output</strong>, if it is a named color, it must be a color accepted by the latex <tt style='background-color: #f0f0e0;'>color</tt> packages. If it is of the form <tt style='background-color: #f0f0e0;'>#ff00ff</tt>, Maruku defines a color using the <tt style='background-color: #f0f0e0;'>\color[rgb]{r,g,b}</tt> macro.</p><p>For example, for <tt style='background-color: #f0f0e0;'>#0000ff</tt>, the macro is called as: <tt style='background-color: #f0f0e0;'>\color[rgb]{0,0,1}</tt>.</p></li></ul></dd></dl><h3>Examples</h3><p>An example of this is the following:</p><pre style='background-color: #f0f0e0;'>@¬code_show_spaces;¬code_background_color:¬green
|
51
53
|
|
52
54
|
» ¬One¬space
|
53
55
|
» ¬¬Two¬spaces
|
@@ -71,4 +73,4 @@ This is an equation with label:
|
|
71
73
|
|
72
74
|
$ \alpha = \beta + \gamma $ (eq:1)
|
73
75
|
|
74
|
-
This is a reference to equation: please see (eq:1)</pre></li></ul><div class='footnotes'><hr /><ol><li id='fn:1'><p>I really was missing those.<a href='#fnref:1' rev='footnote'>↩</a></p></li
|
76
|
+
This is a reference to equation: please see (eq:1)</pre></li></ul><div class='footnotes'><hr /><ol><li id='fn:1'><p>I really was missing those.<a href='#fnref:1' rev='footnote'>↩</a></p></li></ol></div></body></html>
|
data/docs/maruku.log
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
This is pdfeTeX, Version 3.141592-1.21a-2.2 (Web2C 7.5.4) (format=pdflatex 2005.12.27) 25 DEC 2006
|
1
|
+
This is pdfeTeX, Version 3.141592-1.21a-2.2 (Web2C 7.5.4) (format=pdflatex 2005.12.27) 25 DEC 2006 21:06
|
2
2
|
entering extended mode
|
3
3
|
**./maruku
|
4
4
|
(./maruku.tex
|
@@ -194,88 +194,64 @@ loading : Context Support Macros / PDF (2004.03.26)
|
|
194
194
|
\MPnumerator=\count113
|
195
195
|
\everyMPtoPDFconversion=\toks21
|
196
196
|
)
|
197
|
-
LaTeX Font Info: Try loading font information for OMS+cmr on input line
|
197
|
+
LaTeX Font Info: Try loading font information for OMS+cmr on input line 50.
|
198
198
|
(/sw/share/texmf-dist/tex/latex/base/omscmr.fd
|
199
199
|
File: omscmr.fd 1999/05/25 v2.5h Standard LaTeX font definitions
|
200
200
|
)
|
201
201
|
LaTeX Font Info: Font shape `OMS/cmr/m/n' in size <10> not available
|
202
|
-
(Font) Font shape `OMS/cmsy/m/n' tried instead on input line
|
202
|
+
(Font) Font shape `OMS/cmsy/m/n' tried instead on input line 50.
|
203
|
+
[1
|
203
204
|
|
205
|
+
{/Users/andrea/.texmf-var/fonts/map/pdftex/updmap/pdftex.map}]
|
204
206
|
(/sw/share/texmf-dist/tex/latex/listings/lstlang1.sty
|
205
207
|
File: lstlang1.sty 2004/09/05 1.3 listings language file
|
206
208
|
)
|
207
209
|
(/sw/share/texmf-dist/tex/latex/listings/lstlang2.sty
|
208
210
|
File: lstlang2.sty 2004/09/05 1.3 listings language file
|
209
|
-
) [
|
210
|
-
|
211
|
-
{/Users/andrea/.texmf-var/fonts/map/pdftex/updmap/pdftex.map}]
|
211
|
+
) [2]
|
212
212
|
LaTeX Font Info: External font `cmex10' loaded for size
|
213
|
-
(Font) <7> on input line
|
213
|
+
(Font) <7> on input line 191.
|
214
214
|
LaTeX Font Info: External font `cmex10' loaded for size
|
215
|
-
(Font) <5> on input line
|
215
|
+
(Font) <5> on input line 191.
|
216
216
|
LaTeX Font Info: External font `cmex10' loaded for size
|
217
|
-
(Font) <8> on input line
|
217
|
+
(Font) <8> on input line 198.
|
218
218
|
LaTeX Font Info: External font `cmex10' loaded for size
|
219
|
-
(Font) <6> on input line
|
219
|
+
(Font) <6> on input line 198.
|
220
220
|
|
221
221
|
(/sw/share/texmf-dist/tex/latex/listings/lstlang1.sty
|
222
222
|
File: lstlang1.sty 2004/09/05 1.3 listings language file
|
223
223
|
)
|
224
224
|
(/sw/share/texmf-dist/tex/latex/listings/lstmisc.sty
|
225
225
|
File: lstmisc.sty 2004/09/07 1.3 (Carsten Heinz)
|
226
|
-
)
|
226
|
+
)
|
227
227
|
LaTeX Font Info: Font shape `OT1/cmtt/bx/n' in size <8> not available
|
228
|
-
(Font) Font shape `OT1/cmtt/m/n' tried instead on input line
|
229
|
-
[3] [4]
|
230
|
-
Overfull \hbox (12.2479pt too wide) in paragraph at lines
|
228
|
+
(Font) Font shape `OT1/cmtt/m/n' tried instead on input line 221.
|
229
|
+
[3] [4] [5]
|
230
|
+
Overfull \hbox (12.2479pt too wide) in paragraph at lines 437--438
|
231
231
|
[]\OT1/cmr/m/n/10 for \OT1/cmr/bx/n/10 HTML out-put\OT1/cmr/m/n/10 , the value
|
232
232
|
is put straight in the [][][][][][]
|
233
233
|
[]
|
234
234
|
|
235
|
-
|
236
|
-
|
237
|
-
|
238
|
-
|
239
|
-
|
240
|
-
|
241
|
-
(/sw/share/texmf-dist/tex/latex/listings/lstlang3.sty
|
242
|
-
File: lstlang3.sty 2004/09/05 1.3 listings language file
|
243
|
-
)
|
244
|
-
(/sw/share/texmf-dist/tex/latex/listings/lstlang1.sty
|
245
|
-
File: lstlang1.sty 2004/09/05 1.3 listings language file
|
246
|
-
)
|
247
|
-
(/sw/share/texmf-dist/tex/latex/listings/lstlang2.sty
|
248
|
-
File: lstlang2.sty 2004/09/05 1.3 listings language file
|
249
|
-
)
|
250
|
-
(/sw/share/texmf-dist/tex/latex/listings/lstlang3.sty
|
251
|
-
File: lstlang3.sty 2004/09/05 1.3 listings language file
|
252
|
-
)
|
253
|
-
(/sw/share/texmf-dist/tex/latex/listings/lstlang1.sty
|
254
|
-
File: lstlang1.sty 2004/09/05 1.3 listings language file
|
255
|
-
)
|
256
|
-
(/sw/share/texmf-dist/tex/latex/listings/lstlang2.sty
|
257
|
-
File: lstlang2.sty 2004/09/05 1.3 listings language file
|
258
|
-
)
|
259
|
-
(/sw/share/texmf-dist/tex/latex/listings/lstlang3.sty
|
260
|
-
File: lstlang3.sty 2004/09/05 1.3 listings language file
|
261
|
-
)
|
262
|
-
(/sw/share/texmf-dist/tex/latex/listings/lstmisc.sty
|
263
|
-
File: lstmisc.sty 2004/09/07 1.3 (Carsten Heinz)
|
264
|
-
) [5]
|
235
|
+
|
236
|
+
Overfull \hbox (22.13806pt too wide) in paragraph at lines 442--443
|
237
|
+
[]\OT1/cmr/m/n/10 For ex-am-ple, for [][][][][][], the macro is called as: [][]
|
238
|
+
[][][][].
|
239
|
+
[]
|
240
|
+
|
265
241
|
(/sw/share/texmf-dist/tex/latex/listings/lstlang1.sty
|
266
242
|
File: lstlang1.sty 2004/09/05 1.3 listings language file
|
267
243
|
) [6] [7] (./maruku.aux) )
|
268
244
|
Here is how much of TeX's memory you used:
|
269
|
-
|
270
|
-
|
271
|
-
|
272
|
-
|
245
|
+
4423 strings out of 94500
|
246
|
+
60941 string characters out of 1176113
|
247
|
+
134257 words of memory out of 1000000
|
248
|
+
7438 multiletter control sequences out of 10000+50000
|
273
249
|
8353 words of font info for 30 fonts, out of 500000 for 2000
|
274
250
|
580 hyphenation exceptions out of 1000
|
275
|
-
|
251
|
+
27i,8n,59p,646b,1581s stack positions out of 1500i,500n,5000p,200000b,5000s
|
276
252
|
PDF statistics:
|
277
|
-
|
278
|
-
|
253
|
+
228 PDF objects out of 300000
|
254
|
+
139 named destinations out of 131072
|
279
255
|
17 words of extra memory for PDF output out of 65536
|
280
256
|
|
281
257
|
! pdfTeX warning (dest): name{future-export} has been referenced but does not e
|
@@ -288,7 +264,7 @@ placed by a fixed one
|
|
288
264
|
ts/type1/bluesky/cm/cmr6.pfb></sw/share/texmf-dist/fonts/type1/bluesky/cm/cmr7.
|
289
265
|
pfb></sw/share/texmf-dist/fonts/type1/bluesky/cm/cmtt10.pfb></sw/share/texmf-di
|
290
266
|
st/fonts/type1/bluesky/cm/cmtt8.pfb></sw/share/texmf-dist/fonts/type1/bluesky/c
|
291
|
-
m/
|
292
|
-
/texmf-dist/fonts/type1/bluesky/cm/
|
267
|
+
m/cmsy10.pfb></sw/share/texmf-dist/fonts/type1/bluesky/cm/cmti10.pfb></sw/share
|
268
|
+
/texmf-dist/fonts/type1/bluesky/cm/cmbx10.pfb></sw/share/texmf-dist/fonts/type1
|
293
269
|
/bluesky/cm/cmr10.pfb></sw/share/texmf-dist/fonts/type1/bluesky/cm/cmbx12.pfb>
|
294
|
-
Output written on maruku.pdf (7 pages,
|
270
|
+
Output written on maruku.pdf (7 pages, 120937 bytes).
|
data/docs/maruku.md
CHANGED
@@ -6,7 +6,9 @@ html_use_syntax: true
|
|
6
6
|
Mar**u**k**u**: a Markdown interpreter
|
7
7
|
======================================
|
8
8
|
|
9
|
-
Maruku is a Markdown interpreter written in [Ruby][].
|
9
|
+
[Maruku][] is a Markdown interpreter written in [Ruby][].
|
10
|
+
|
11
|
+
[maruku]: <http://maruku.rubyforge.org/>
|
10
12
|
|
11
13
|
Maruku allows you to write in an easy-to-read-and-write syntax, like this:
|
12
14
|
|
@@ -29,6 +31,12 @@ in [PHP Markdown Extra][].
|
|
29
31
|
|
30
32
|
Moreover, it implements ideas from [MultiMarkdown][].
|
31
33
|
|
34
|
+
### Authors ###
|
35
|
+
|
36
|
+
Maruku has been developed so far by [Andrea Censi][].
|
37
|
+
Contributors are most welcome!
|
38
|
+
|
39
|
+
[Andrea Censi]: http://www.dis.uniroma1.it/~acensi/
|
32
40
|
|
33
41
|
* * *
|
34
42
|
|
@@ -51,11 +59,20 @@ Moreover, it implements ideas from [MultiMarkdown][].
|
|
51
59
|
Download {#download}
|
52
60
|
--------
|
53
61
|
|
54
|
-
The development site is <http://
|
62
|
+
The development site is <http://rubyforge.org/projects/maruku/>.
|
63
|
+
|
64
|
+
Download current [gem][] at <http://rubyforge.org/frs/?group_id=2795> or
|
65
|
+
try to install with:
|
66
|
+
|
67
|
+
$ gem install maruku
|
55
68
|
|
56
|
-
|
69
|
+
Anonymous access to the repository is possible with:
|
57
70
|
|
71
|
+
$ svn checkout svn://rubyforge.org/var/svn/maruku
|
58
72
|
|
73
|
+
If you want commit-access, just create an account on Rubyforge and [drop me a mail][drop].
|
74
|
+
|
75
|
+
[drop]: http://www.dis.uniroma1.it/~acensi/contact.html
|
59
76
|
[gem]: http://rubygems.rubyforge.org/
|
60
77
|
|
61
78
|
Usage
|
@@ -120,7 +137,7 @@ Examples of PHP Markdown Extra syntax {#extra}
|
|
120
137
|
|
121
138
|
* footnotes [^foot]
|
122
139
|
|
123
|
-
*footnotes [^foot]
|
140
|
+
* footnotes [^foot]
|
124
141
|
|
125
142
|
[^foot]: I really was missing those.
|
126
143
|
|
@@ -167,7 +184,7 @@ difference is that *parsing* is separated from *rendering*.
|
|
167
184
|
In Maruku, an in-memory representation of the Markdown
|
168
185
|
document is created. Instead, Bluecloth mantains the document in
|
169
186
|
memory as a String at all times, and does a series of `gsub`
|
170
|
-
to transform to HTML.
|
187
|
+
to transform to HTML.
|
171
188
|
|
172
189
|
[^1]: "a different philosophy" stands for "ugly" `:-)`
|
173
190
|
|
@@ -271,16 +288,14 @@ List of meta-data {#metalist}
|
|
271
288
|
|
272
289
|
|
273
290
|
**`title`, `subject`**
|
274
|
-
: (document) Sets the title of the document
|
291
|
+
: (document) Sets the title of the document (HTML: used in the `TITLE` element).
|
275
292
|
|
276
293
|
**`css`**
|
277
294
|
: (document, HTML) Url of stylesheet.
|
278
295
|
|
279
|
-
**`
|
296
|
+
**`html_use_syntax`**
|
280
297
|
: (document, HTML) Use the [`syntax` library][syntax] to add source highlighting.
|
281
298
|
|
282
|
-
[syntax]: http://syntax.rubyforge.org/
|
283
|
-
|
284
299
|
**`latex_use_listings`**
|
285
300
|
: (document, LaTex) Use fancy `listing` package for better displaying code blocks.
|
286
301
|
|
@@ -306,12 +321,11 @@ List of meta-data {#metalist}
|
|
306
321
|
|
307
322
|
* for **LaTeX output**, if it is a named color, it must be a color accepted
|
308
323
|
by the latex `color` packages. If it is of the form `#ff00ff`, Maruku
|
309
|
-
defines a color using the `\
|
324
|
+
defines a color using the `\color[rgb]{r,g,b}` macro.
|
310
325
|
|
311
|
-
For example, for `#0000ff`, the macro is called as:
|
326
|
+
For example, for `#0000ff`, the macro is called as: `\color[rgb]{0,0,1}`.
|
312
327
|
|
313
|
-
|
314
|
-
\definecolor{DummyName}{rgb}{0,0,1}
|
328
|
+
[syntax]: http://syntax.rubyforge.org/
|
315
329
|
|
316
330
|
|
317
331
|
### Examples ###
|
data/docs/maruku.pdf
CHANGED
Binary file
|
data/docs/maruku.tex
CHANGED
@@ -9,7 +9,7 @@
|
|
9
9
|
\begin{document}
|
10
10
|
\section*{Mar{\bf u}k{\bf u}: a Markdown interpreter}
|
11
11
|
|
12
|
-
Maruku is a Markdown interpreter written in \href{http://www.ruby-lang.org}{Ruby}.
|
12
|
+
\href{http://maruku.rubyforge.org/>}{Maruku} is a Markdown interpreter written in \href{http://www.ruby-lang.org}{Ruby}.
|
13
13
|
|
14
14
|
Maruku allows you to write in an easy-to-read-and-write syntax, like this:
|
15
15
|
|
@@ -38,6 +38,10 @@ Markdown implements also all the improvements in \href{http://www.michelf.com/pr
|
|
38
38
|
|
39
39
|
Moreover, it implements ideas from \href{http://fletcher.freeshell.org/wiki/MultiMarkdown}{MultiMarkdown}.
|
40
40
|
|
41
|
+
\subsubsection*{Authors}
|
42
|
+
|
43
|
+
Maruku has been developed so far by \href{http://www.dis.uniroma1.it/~acensi/}{Andrea Censi}. Contributors are most welcome!
|
44
|
+
|
41
45
|
|
42
46
|
\vspace{.5em} \hrule \vspace{.5em}
|
43
47
|
{\em Table of contents}:
|
@@ -75,17 +79,36 @@ Moreover, it implements ideas from \href{http://fletcher.freeshell.org/wiki/Mult
|
|
75
79
|
\vspace{.5em} \hrule \vspace{.5em}
|
76
80
|
\hypertarget{download}{}\subsection*{{Download}}
|
77
81
|
|
78
|
-
The development site is \href{http://
|
82
|
+
The development site is \href{http://rubyforge.org/projects/maruku/}{http://rubyforge.org/projects/maruku/}.
|
83
|
+
|
84
|
+
Download current \href{http://rubygems.rubyforge.org/}{gem} at \href{http://rubyforge.org/frs/?group_id=2795}{http://rubyforge.org/frs/?group\_id=2795} or try to install with:
|
85
|
+
|
86
|
+
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
87
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
88
|
+
\lstset{basicstyle=\ttfamily\footnotesize}
|
89
|
+
\lstset{language={}}
|
90
|
+
|
91
|
+
\begin{lstlisting}
|
92
|
+
$ gem install maruku
|
93
|
+
|
94
|
+
\end{lstlisting}Anonymous access to the repository is possible with:
|
79
95
|
|
80
|
-
|
96
|
+
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
97
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
98
|
+
\lstset{basicstyle=\ttfamily\footnotesize}
|
99
|
+
\lstset{language={}}
|
100
|
+
|
101
|
+
\begin{lstlisting}
|
102
|
+
$ svn checkout svn://rubyforge.org/var/svn/maruku
|
103
|
+
|
104
|
+
\end{lstlisting}If you want commit-access, just create an account on Rubyforge and \href{http://www.dis.uniroma1.it/~acensi/contact.html}{drop me a mail}.
|
81
105
|
|
82
106
|
\subsection*{Usage}
|
83
107
|
|
84
108
|
This is the basic usage:
|
85
109
|
|
86
110
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
87
|
-
\
|
88
|
-
\lstset{backgroundcolor=\color{maruku_color0}}
|
111
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
89
112
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
90
113
|
\lstset{language=ruby}
|
91
114
|
|
@@ -98,7 +121,7 @@ puts doc.to_html
|
|
98
121
|
\end{lstlisting}or, if you install through RubyGems,
|
99
122
|
|
100
123
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
101
|
-
\lstset{backgroundcolor=\color{
|
124
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
102
125
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
103
126
|
\lstset{language=ruby}
|
104
127
|
|
@@ -109,7 +132,7 @@ require 'maruku'
|
|
109
132
|
\end{lstlisting}This outputs a complete XHTML 1.0 document:
|
110
133
|
|
111
134
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
112
|
-
\lstset{backgroundcolor=\color{
|
135
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
113
136
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
114
137
|
\lstset{language=ruby}
|
115
138
|
|
@@ -118,7 +141,7 @@ puts doc.to_html_document
|
|
118
141
|
\end{lstlisting}You can have the REXML document tree with:
|
119
142
|
|
120
143
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
121
|
-
\lstset{backgroundcolor=\color{
|
144
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
122
145
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
123
146
|
\lstset{language=ruby}
|
124
147
|
|
@@ -127,22 +150,22 @@ tree = doc.to_html_document_tree
|
|
127
150
|
|
128
151
|
\end{lstlisting}\subsubsection*{From the command line}
|
129
152
|
|
130
|
-
There are two command-line programs installed: \colorbox{
|
153
|
+
There are two command-line programs installed: \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char109\char97\char114\char117\char107\char117} and \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char109\char97\char114\char117\char116\char101\char120}
|
131
154
|
|
132
|
-
\colorbox{
|
155
|
+
\colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char109\char97\char114\char117\char107\char117} converts Markdown in HTML:
|
133
156
|
|
134
157
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
135
|
-
\lstset{backgroundcolor=\color{
|
158
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
136
159
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
137
160
|
\lstset{language={}}
|
138
161
|
|
139
162
|
\begin{lstlisting}
|
140
163
|
$ maruku file.md # creates file.html
|
141
164
|
|
142
|
-
\end{lstlisting}\colorbox{
|
165
|
+
\end{lstlisting}\colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char109\char97\char114\char117\char116\char101\char120} converts Markdown in TeX, then calls \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char112\char100\char102\char108\char97\char116\char101\char120} to transform to PDF:
|
143
166
|
|
144
167
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
145
|
-
\lstset{backgroundcolor=\color{
|
168
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
146
169
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
147
170
|
\lstset{language={}}
|
148
171
|
|
@@ -156,7 +179,7 @@ $ marutex file.md # creates file.tex and file.pdf
|
|
156
179
|
\item tables
|
157
180
|
|
158
181
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
159
|
-
\lstset{backgroundcolor=\color{
|
182
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
160
183
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
161
184
|
\lstset{language={}}
|
162
185
|
|
@@ -175,12 +198,12 @@ cell¢er-align&right-align\\
|
|
175
198
|
\item footnotes \footnote{I really was missing those.}
|
176
199
|
|
177
200
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
178
|
-
\lstset{backgroundcolor=\color{
|
201
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
179
202
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
180
203
|
\lstset{language={}}
|
181
204
|
|
182
205
|
\begin{lstlisting}
|
183
|
-
*footnotes [^foot]
|
206
|
+
* footnotes [^foot]
|
184
207
|
|
185
208
|
[^foot]: I really was missing those.
|
186
209
|
\end{lstlisting}
|
@@ -190,7 +213,7 @@ cell¢er-align&right-align\\
|
|
190
213
|
|
191
214
|
\end{itemize}
|
192
215
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
193
|
-
\lstset{backgroundcolor=\color{
|
216
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
194
217
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
195
218
|
\lstset{language=html}
|
196
219
|
|
@@ -203,7 +226,7 @@ cell¢er-align&right-align\\
|
|
203
226
|
\item header ids
|
204
227
|
|
205
228
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
206
|
-
\lstset{backgroundcolor=\color{
|
229
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
207
230
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
208
231
|
\lstset{language={}}
|
209
232
|
|
@@ -215,7 +238,7 @@ cell¢er-align&right-align\\
|
|
215
238
|
\item definition lists
|
216
239
|
|
217
240
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
218
|
-
\lstset{backgroundcolor=\color{
|
241
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
219
242
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
220
243
|
\lstset{language={}}
|
221
244
|
|
@@ -237,14 +260,14 @@ Definition list
|
|
237
260
|
|
238
261
|
The other Ruby implementation of Markdown is \href{http://www.deveiate.org/projects/BlueCloth}{Bluecloth}.
|
239
262
|
|
240
|
-
Maruku is much different in philosophy from Bluecloth: the biggest difference is that {\em parsing} is separated from {\em rendering}. In Maruku, an in-memory representation of the Markdown document is created. Instead, Bluecloth mantains the document in memory as a String at all times, and does a series of \colorbox{
|
263
|
+
Maruku is much different in philosophy from Bluecloth: the biggest difference is that {\em parsing} is separated from {\em rendering}. In Maruku, an in-memory representation of the Markdown document is created. Instead, Bluecloth mantains the document in memory as a String at all times, and does a series of \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char103\char115\char117\char98} to transform to HTML.
|
241
264
|
|
242
265
|
The in-memory representation makes it very easy to export to various formats (altough, for, now)
|
243
266
|
|
244
267
|
Other improvements over Bluecloth:
|
245
268
|
|
246
269
|
\begin{itemize}%
|
247
|
-
\item the HTML output is provided also as a \colorbox{
|
270
|
+
\item the HTML output is provided also as a \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char82\char69\char88\char77\char76} document tree.
|
248
271
|
|
249
272
|
|
250
273
|
\item PHP Markdown Syntax support.
|
@@ -261,7 +284,7 @@ Maruku implements a syntax that allows to attach "meta" information to objects.
|
|
261
284
|
Meta-data for the document itself is specified through the use of email headers:
|
262
285
|
|
263
286
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
264
|
-
\lstset{backgroundcolor=\color{
|
287
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
265
288
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
266
289
|
\lstset{language={}}
|
267
290
|
|
@@ -274,7 +297,7 @@ Content of the document
|
|
274
297
|
\end{lstlisting}When creating the document through
|
275
298
|
|
276
299
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
277
|
-
\lstset{backgroundcolor=\color{
|
300
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
278
301
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
279
302
|
\lstset{language=ruby}
|
280
303
|
|
@@ -290,7 +313,7 @@ Maruku introduces a new syntax for attaching metadata to paragraphs, tables, and
|
|
290
313
|
For example, consider the creation of two paragraphs:
|
291
314
|
|
292
315
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
293
|
-
\lstset{backgroundcolor=\color{
|
316
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
294
317
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
295
318
|
\lstset{language={}}
|
296
319
|
|
@@ -302,7 +325,7 @@ Paragraph 2
|
|
302
325
|
\end{lstlisting}Now you really want to attach a 'class' attribute to the paragraphs (for example for CSS styling). Maruku allows you to use:
|
303
326
|
|
304
327
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
305
|
-
\lstset{backgroundcolor=\color{
|
328
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
306
329
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
307
330
|
\lstset{language={}}
|
308
331
|
|
@@ -313,10 +336,10 @@ Paragraph 1 is a warning
|
|
313
336
|
Paragraph 2
|
314
337
|
|
315
338
|
|
316
|
-
\end{lstlisting}You can add more by separating with a \colorbox{
|
339
|
+
\end{lstlisting}You can add more by separating with a \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char59}:
|
317
340
|
|
318
341
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
319
|
-
\lstset{backgroundcolor=\color{
|
342
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
320
343
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
321
344
|
\lstset{language={}}
|
322
345
|
|
@@ -329,13 +352,13 @@ Paragraph 1 is a warning
|
|
329
352
|
\begin{enumerate}%
|
330
353
|
\item newline
|
331
354
|
\item an at-symbol '@'
|
332
|
-
\item a series of name-value pairs. Each name-value is separated by a colon \colorbox{
|
355
|
+
\item a series of name-value pairs. Each name-value is separated by a colon \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char58}, pairs are separated by semi-colons \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char59}
|
333
356
|
|
334
357
|
\end{enumerate}
|
335
358
|
Many declaration can be used, and they refer to {\em the following} object:
|
336
359
|
|
337
360
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
338
|
-
\lstset{backgroundcolor=\color{
|
361
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
339
362
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
340
363
|
\lstset{language={}}
|
341
364
|
|
@@ -347,7 +370,7 @@ Paragraph 1 is a warning
|
|
347
370
|
\end{lstlisting}These can also be separated by newlines:
|
348
371
|
|
349
372
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
350
|
-
\lstset{backgroundcolor=\color{
|
373
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
351
374
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
352
375
|
\lstset{language={}}
|
353
376
|
|
@@ -358,10 +381,10 @@ Paragraph 1 is a warning
|
|
358
381
|
|
359
382
|
Paragraph 1 is a warning
|
360
383
|
|
361
|
-
\end{lstlisting}Also, if the value is not present, it defaults to \colorbox{
|
384
|
+
\end{lstlisting}Also, if the value is not present, it defaults to \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char116\char114\char117\char101}:
|
362
385
|
|
363
386
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
364
|
-
\lstset{backgroundcolor=\color{
|
387
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
365
388
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
366
389
|
\lstset{language={}}
|
367
390
|
|
@@ -376,56 +399,49 @@ This paragraph has the attribute 'test' set.
|
|
376
399
|
|
377
400
|
\begin{description}
|
378
401
|
|
379
|
-
\item[{\bf \colorbox{
|
402
|
+
\item[{\bf \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char116\char105\char116\char108\char101}, \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char115\char117\char98\char106\char101\char99\char116}}] (document) Sets the title of the document (HTML: used in the \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char84\char73\char84\char76\char69} element).
|
380
403
|
|
381
404
|
|
382
405
|
|
383
|
-
\item[{\bf \colorbox{
|
406
|
+
\item[{\bf \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char99\char115\char115}}] (document, HTML) Url of stylesheet.
|
384
407
|
|
385
408
|
|
386
409
|
|
387
|
-
\item[{\bf \colorbox{
|
410
|
+
\item[{\bf \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char104\char116\char109\char108\char95\char117\char115\char101\char95\char115\char121\char110\char116\char97\char120}}] (document, HTML) Use the \href{http://syntax.rubyforge.org/}{\colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char115\char121\char110\char116\char97\char120} library} to add source highlighting.
|
388
411
|
|
389
412
|
|
390
413
|
|
391
|
-
\item[{\bf \colorbox{
|
414
|
+
\item[{\bf \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char108\char97\char116\char101\char120\char95\char117\char115\char101\char95\char108\char105\char115\char116\char105\char110\char103\char115}}] (document, LaTex) Use fancy \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char108\char105\char115\char116\char105\char110\char103} package for better displaying code blocks.
|
392
415
|
|
393
416
|
|
394
417
|
|
395
|
-
\item[{\bf \colorbox{
|
418
|
+
\item[{\bf \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char115\char116\char121\char108\char101}, \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char105\char100}, \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char99\char108\char97\char115\char115}}] (any block object, HTML) Standard CSS attributes are copied.
|
396
419
|
|
397
420
|
|
398
421
|
|
399
|
-
\item[{\bf \colorbox{
|
422
|
+
\item[{\bf \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char108\char97\char110\char103}}] (code blocks) Name of programming language (\colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char114\char117\char98\char121}) for syntax highlighting (does not work yet)
|
400
423
|
|
401
|
-
Default for this is \colorbox{
|
424
|
+
Default for this is \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char99\char111\char100\char101\char95\char108\char97\char110\char103} in document.
|
402
425
|
|
403
426
|
|
404
427
|
|
405
|
-
\item[{\bf \colorbox{
|
428
|
+
\item[{\bf \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char99\char111\char100\char101\char95\char115\char104\char111\char119\char95\char115\char112\char97\char99\char101\char115}}] Shows tabs and newlines (default is read in the document object).
|
406
429
|
|
407
430
|
|
408
431
|
|
409
|
-
\item[{\bf \colorbox{
|
432
|
+
\item[{\bf \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char99\char111\char100\char101\char95\char98\char97\char99\char107\char103\char114\char111\char117\char110\char100\char95\char99\char111\char108\char111\char114}}] Background color for code blocks. (default is read in the document object).
|
410
433
|
|
411
|
-
The format is either a named color (\colorbox{
|
434
|
+
The format is either a named color (\colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char103\char114\char101\char101\char110}, \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char114\char101\char100}) or a CSS color of the form \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char35\char102\char102\char48\char48\char102\char102}.
|
412
435
|
|
413
436
|
\begin{itemize}%
|
414
|
-
\item for {\bf HTML output}, the value is put straight in the \colorbox{
|
437
|
+
\item for {\bf HTML output}, the value is put straight in the \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char98\char97\char99\char107\char103\char114\char111\char117\char110\char100\char45\char99\char111\char108\char111\char114} CSS property of the block.
|
415
438
|
|
416
439
|
|
417
|
-
\item for {\bf LaTeX output}, if it is a named color, it must be a color accepted by the latex \colorbox{
|
440
|
+
\item for {\bf LaTeX output}, if it is a named color, it must be a color accepted by the latex \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char99\char111\char108\char111\char114} packages. If it is of the form \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char35\char102\char102\char48\char48\char102\char102}, Maruku defines a color using the \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char92\char99\char111\char108\char111\char114\char91\char114\char103\char98\char93\char123\char114\char44\char103\char44\char98\char125} macro.
|
418
441
|
|
419
|
-
For example, for \colorbox{
|
442
|
+
For example, for \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char35\char48\char48\char48\char48\char102\char102}, the macro is called as: \colorbox[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}{\tt \char92\char99\char111\char108\char111\char114\char91\char114\char103\char98\char93\char123\char48\char44\char48\char44\char49\char125}.
|
420
443
|
|
421
|
-
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
422
|
-
\lstset{backgroundcolor=\color{maruku_color0}}
|
423
|
-
\lstset{basicstyle=\ttfamily\footnotesize}
|
424
|
-
\lstset{language=tex}
|
425
444
|
|
426
|
-
\begin{lstlisting}
|
427
|
-
\definecolor{DummyName}{rgb}{0,0,1}
|
428
|
-
\end{lstlisting}
|
429
445
|
|
430
446
|
\end{itemize}
|
431
447
|
|
@@ -435,7 +451,7 @@ For example, for \colorbox{maruku_color0}{\tt \char35\char48\char48\char48\char4
|
|
435
451
|
An example of this is the following:
|
436
452
|
|
437
453
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=true,showtabs=true}
|
438
|
-
\lstset{backgroundcolor=\color{
|
454
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
439
455
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
440
456
|
\lstset{language={}}
|
441
457
|
|
@@ -463,7 +479,7 @@ An example of this is the following:
|
|
463
479
|
\end{lstlisting}Example with css-style color:
|
464
480
|
|
465
481
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
466
|
-
\lstset{backgroundcolor=\color{
|
482
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
467
483
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
468
484
|
\lstset{language={}}
|
469
485
|
|
@@ -475,8 +491,7 @@ An example of this is the following:
|
|
475
491
|
\end{lstlisting}produces:
|
476
492
|
|
477
493
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
478
|
-
\
|
479
|
-
\lstset{backgroundcolor=\color{maruku_color1}}
|
494
|
+
\lstset{backgroundcolor=\color[rgb]{0.270588235294118,0.337254901960784,0.470588235294118}}
|
480
495
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
481
496
|
\lstset{language={}}
|
482
497
|
|
@@ -486,7 +501,7 @@ A strange color
|
|
486
501
|
\end{lstlisting}Or highlighting (does not work well yet):
|
487
502
|
|
488
503
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
489
|
-
\lstset{backgroundcolor=\color{
|
504
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
490
505
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
491
506
|
\lstset{language={}}
|
492
507
|
|
@@ -497,7 +512,7 @@ A strange color
|
|
497
512
|
\end{lstlisting}produces:
|
498
513
|
|
499
514
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
500
|
-
\lstset{backgroundcolor=\color{
|
515
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
501
516
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
502
517
|
\lstset{language=xml}
|
503
518
|
|
@@ -518,7 +533,7 @@ Things I'm thinking about:
|
|
518
533
|
\item a syntax for commenting parts of the document:
|
519
534
|
|
520
535
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
521
|
-
\lstset{backgroundcolor=\color{
|
536
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
522
537
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
523
538
|
\lstset{language={}}
|
524
539
|
|
@@ -529,7 +544,7 @@ This is a paragraph
|
|
529
544
|
\item choose a syntax for adding math:
|
530
545
|
|
531
546
|
\lstset{columns=fixed,frame=shadowbox}\lstset{showspaces=false,showtabs=false}
|
532
|
-
\lstset{backgroundcolor=\color{
|
547
|
+
\lstset{backgroundcolor=\color[rgb]{0.941176470588235,0.941176470588235,0.87843137254902}}
|
533
548
|
\lstset{basicstyle=\ttfamily\footnotesize}
|
534
549
|
\lstset{language={}}
|
535
550
|
|