maruku 0.2.5 → 0.2.6

data/docs/maruku.md

@@ -116,7 +116,7 @@ There are two command-line programs installed: `maruku` and `marutex`.
 
   	$ maruku file.md  # creates file.html
 
-* `marutex` converts Markdown to TeX, then calls `pdfLaTeX` to 
+* `marutex` converts Markdown to LaTeX, then calls `pdflatex` to 
 transform to PDF:
 
   	$ marutex file.md  # creates file.tex and file.pdf
@@ -235,6 +235,7 @@ When creating the document through
 
 the title and stylesheet are added as expected.
 
+Meta-data keys are assumed to be case-insensitive.
 
 ### Meta-data for elements ###
 
@@ -288,9 +289,6 @@ Also, if the value is not present, it defaults to `true`:
 
 	This paragraph has the attribute `test` set to `true`.
 
-
-
-
 * * *
 
 
@@ -298,6 +296,8 @@ Also, if the value is not present, it defaults to `true`:
 
 ### List of meta-data  ### {#metalist} 
 
+[listings]: http://www.ctan.org/tex-archive/macros/latex/contrib/listings/
+
 **`title`, `subject`**
 : (document) Sets the title of the document (HTML: used in the `TITLE` element).
 
@@ -308,10 +308,10 @@ Also, if the value is not present, it defaults to `true`:
 : (document, HTML) Url of stylesheet.
 
 **`html_use_syntax`**
-: (document, HTML) If set, use the [`syntax` library][syntax] to add source highlighting.
+: (document, HTML) If set, use the [Ruby `syntax` library][syntax] to add source highlighting.
 
 **`latex_use_listings`**
-: (document, LaTeX) If set, use fancy `listing` package for better displaying code blocks.
+: (document, LaTeX) If set, use the fancy [`listings` package][listings] for better displaying code blocks.
      
      If not set,  use standard `verbatim` environment.
 
@@ -319,9 +319,13 @@ Also, if the value is not present, it defaults to `true`:
 : (any block object, HTML) Standard CSS attributes are copied.
 
 **`lang`**
-: (code blocks) Name of programming language (`ruby`) for syntax highlighting (does not work yet)
+: (code blocks) Name of programming language (`ruby`) for syntax highlighting.
 
       Default for this is `code_lang` in document.
+      
+      Syntax highlighting is delegated to the [`syntax` library][syntax] for
+      HTML output and to the [`listings` package][listings] for LaTeX output.
+
 
 **`code_show_spaces`**
 : Shows tabs and newlines (default is read in the document object).
@@ -415,7 +419,13 @@ TODO list
 
 
 * Export to HTML
-  * Include RubyPants
+  1. Add `-split` options to `maruku` that splits the document over multiple 
+     pages. 
+
+     This should require the possibility of specifying a template for navigational
+     elements. Investigate template engine.
+
+  2. Include RubyPants
 
 * Export to PDF 
   * support for images
@@ -434,23 +444,91 @@ I would love to have an equivalent in Ruby.
 [Pandoc]: http://sophos.berkeley.edu/macfarlane/pandoc/
 [MultiMarkdown]: http://fletcher.freeshell.org/wiki/MultiMarkdown
 
-### Syntax improvements ###                     {#future-syntax}
 
-Things I'm thinking about:
+### A syntax for specifying meta-data for span-level elements ###
+
+Maybe something like this:
+  
+	This is a paragraph. The second line of this paragraph has
+	the last element {with meta data}@ class: important_span
+	and the paragraph continues...
+
+So the idea is:
+
+* Only elements at the end of the line can have meta data.
+* Syntax is:
+  1. Opening brace `{`.
+  2. Any string that does not contain the sequence `}@`.
+  3. Closing brace and at-symbol `}@`.
+  4 Attributes specification like the block-level metadata.
+
+Other examples:
+
+	Lorem ipsum dolor sit amet, consectetuer adipiscing 
+	elit. Donec sit amet sapien vitae augue {interdum hendrerit.}@  id: special
+	Maecenas tempor ultrices nisl. Praesent laoreet tortor sit
+	amet est. Praesent in nisl eu libero sodales bibendum.
+
+Or, we could allow metadata specified **after the text**.
+In the following, three fragments are marked as "special", 
+and, after their containing block-level elements, their 
+attributes are set:
+
+	Lorem ipsum dolor sit @{amet}, consectetuer adipiscing 
+	elit. Donec sit amet sapien vitae augue @{interdum hendrerit.}
+	Maecenas tempor ultrices nisl. @{Praesent laoreet tortor sit
+	amet est.} Praesent in nisl eu libero sodales bibendum.
+
+	@{1} id: amet
+	@{2} style: "font-style: bold"
+	@{3} class: warning
+
+We can be much liberal in the syntax. For example, instead of 
+numeric references to the part in the text, we could write:
+
+	Lorem ipsum dolor sit @{amet}, consectetuer adipiscing 
+	elit. Donec sit amet sapien vitae augue @{interdum hendrerit.}
+	Maecenas tempor ultrices nisl. @{Praesent laoreet tortor sit
+	amet est.} Praesent in nisl eu libero sodales bibendum.
+
+	@{amet} id: amet
+	@{interdum ...} style: "font-style: bold"
+	@{Praesent ...} class: warning
+
+with `...` acting as a wildcard, to match a long phrase (`{	Praesent laoreet tortor sit amet est.}`) without specifying the full text.
+
+I feel this is very readable and not intrusive. But then again,
+subjective tastes vary. Let me know of any comments and suggestions.
+I want to wait for feedback before implementing this.
+
+### A syntax for commenting parts of the document ###
+
+	This is a paragraph
+	% This is a comment
+
+Or `%` on a line by itself comments the following block:
+
+	% The following paragraph is ignored
+	
+	%
+	Lorem ipsum dolor sit amet, consectetuer adipiscing 
+	elit. Donec sit amet sapien vitae augue interdum hendrerit.
+	Maecenas tempor ultrices nisl. Praesent laoreet tortor sit
+	amet est. Praesent in nisl eu libero sodales bibendum.
+
+	This paragraph is not ignored.
 
-* a syntax for commenting parts of the document:
+### A syntax for adding math ###
 
-      This is a paragraph
-      % This is a comment
+Something inspired from LaTeX should be familiar to all:
 
-* choose a syntax for adding math:
+	This is inline math: $\alpha$
 
-      This is inline math: $\alpha$
 
-      This is an equation with label:
+	This is an equation with label:
 
-      $ \alpha = \beta + \gamma  $        (eq:1)
+	$ \alpha = \beta + \gamma  $        (eq:1)
 
-      This is a reference to equation: please see (eq:1)
+	This is a reference to equation: please see (eq:1)
 
 

data/lib/maruku/to_latex.rb

@@ -23,6 +23,7 @@ class Maruku
 
 #{header}
 \\usepackage{hyperref}
+\\usepackage{xspace}
 %\\usepackage[x11names]{xcolor}
 \\usepackage[usenames,dvipsnames]{color}
 \\usepackage[margin=1in]{geometry}

data/lib/maruku/to_latex_strings.rb

@@ -20,9 +20,9 @@ class String
 	
 	# other things that are good on the eyes
 	OtherGoodies = {
-		'LaTeX' => '\\LaTeX', # XXX not if already \latex
-		'HTML' => '\\textsc{html}',
-		'PDF' => '\\textsc{pdf}'
+		/(\s)LaTeX/ => '\1\\LaTeX\\xspace', # XXX not if already \latex
+		'HTML' => '\\textsc{html}\\xspace',
+		'PDF' => '\\textsc{pdf}\\xspace'
 	}
 	
 	def String.convert_entities(s)

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: maruku
 version: !ruby/object:Gem::Version 
-  version: 0.2.5
-date: 2006-12-26 00:00:00 +01:00
+  version: 0.2.6
+date: 2006-12-27 00:00:00 +01:00
 summary: A Markdown interpreter in Ruby
 require_paths: 
 - lib