maruku 0.2.4 → 0.2.5

data/bin/marutex

@@ -22,7 +22,10 @@ if File.basename($0) =~ /^marutex/
 
 		File.open(filename,'w') do |f| f.puts latex end
 
+		# run twice for cross references
 		system "pdflatex '#{job}'"
+		system "pdflatex '#{job}'"
+		
 #		system "open #{job}.pdf"
 	end
 end

data/docs/markdown_syntax.md

@@ -1,6 +1,8 @@
-CSS: style.css
+css: style.css
 latex_use_listings: true
 html_use_syntax: true
+use_numbered_headers: true
+
 
 Markdown: Syntax
 ================
@@ -14,28 +16,18 @@ This copy is translated using [Maruku][].
 [Here](http://daringfireball.net/projects/markdown/syntax) you can find
 the original  by `Markdown.pl`.
 
+> [This document in Markdown](http://maruku.rubyforge.org/markdown_syntax.md)
+>
+> [This document in HTML](http://maruku.rubyforge.org/markdown_syntax.html)
+>
+> [This document in PDF](http://maruku.rubyforge.org/markdown_syntax.pdf)
+
+
+Table of contents: (**auto-generated by Maruku!**)
+
+@toc 
 
-@ class: toc
-
-*   [Overview](#overview)
-    *   [Philosophy](#philosophy)
-    *   [Inline HTML](#html)
-    *   [Automatic Escaping for Special Characters](#autoescape)
-*   [Block Elements](#block)
-    *   [Paragraphs and Line Breaks](#p)
-    *   [Headers](#header)
-    *   [Blockquotes](#blockquote)
-    *   [Lists](#list)
-    *   [Code Blocks](#precode)
-    *   [Horizontal Rules](#hr)
-*   [Span Elements](#span)
-    *   [Links](#link)
-    *   [Emphasis](#em)
-    *   [Code](#code)
-    *   [Images](#img)
-*   [Miscellaneous](#misc)
-    *   [Backslash Escapes](#backslash)
-    *   [Automatic Links](#autolink)
+* This list will contain the toc (it doesn't matter what you write here)
 
 
 

data/docs/maruku.md

@@ -1,7 +1,7 @@
-Title: Maruku, a Markdown interpreter 
 CSS: style.css
-latex_use_listings: true
+LaTeX_use_listings: true
 html_use_syntax: true
+use_numbered_headers: true
 
 Mar**u**k**u**: a Markdown interpreter 
 ======================================
@@ -18,18 +18,26 @@ Then it can be translated to HTML:
 
 > [This document in HTML](http://maruku.rubyforge.org/maruku.html)
 	
-or Latex, which is then converted to PDF:
+or LaTeX, which is then converted to PDF:
 
 > [This document in PDF](http://maruku.rubyforge.org/maruku.pdf)
 
-Maruku implements the original [Markdown syntax][] 
+Maruku implements:
+
+* the original [Markdown syntax][] 
 ([HTML](http://maruku.rubyforge.org/markdown_syntax.html) or
 [PDF](http://maruku.rubyforge.org/markdown_syntax.pdf), translated by Maruku).
 
-Markdown implements also all the improvements 
-in [PHP Markdown Extra][]. 
+* all the improvements in [PHP Markdown Extra][]. 
+
+* a new [meta-data syntax](#meta)
+
+* some ideas from [MultiMarkdown][]
+  * attributes in image links
 
-Moreover, it implements ideas from [MultiMarkdown][].
+The [test directory][tests] is quite messy but it shows every capability.
+
+[tests]: http://maruku.rubyforge.org/tests/
 
 ### Authors ###
 
@@ -40,17 +48,11 @@ Contributors are most welcome!
 
 * * *
 
-*Table of contents*:
+Table of contents: (**auto-generated by Maruku!**)
+
+@toc 
 
-* [Download](#download)
-* [Usage](#usage)
-* [Examples of PHP Markdown extra syntax](#extra)
-* [New metadata syntax](#meta)
-* [List of metadata](#metalist)
-* [Maruku and Bluecloth](#maruku-and-bluecloth)
-* [Future developments](#future)
-  * [Export to other formats](#future-export)
-  * [Syntax additions](#future-syntax)
+* This list will contain the toc (it doesn't matter what you write here)
 
 * * *
 
@@ -61,7 +63,6 @@ Download       {#download}
 
 The development site is <http://rubyforge.org/projects/maruku/>.
 
-	
 Install with:
 
 	$ gem install maruku
@@ -95,7 +96,7 @@ This is the basic usage:
 	doc = Maruku.new(markdown_string)
 	puts doc.to_html
 
-The method `to_html` outputs only an HTML fragment, while the method `to_html_document` output a complete XHTML 1.0 document:
+The method `to_html` outputs only an HTML fragment, while the method `to_html_document` outputs a complete XHTML 1.0 document:
 
 @ lang: ruby
 
@@ -109,16 +110,16 @@ You can have the REXML document tree with:
 
 ### From the command line ###
 
-There are two command-line programs installed: `maruku` and `marutex`
+There are two command-line programs installed: `maruku` and `marutex`.
 
-`maruku` converts Markdown in HTML:
+* `maruku` converts Markdown to HTML:
 
-	$ maruku file.md  # creates file.html
+  	$ maruku file.md  # creates file.html
 
-`marutex` converts Markdown in TeX, then calls `pdflatex` to 
+* `marutex` converts Markdown to TeX, then calls `pdfLaTeX` to 
 transform to PDF:
 
-	$ marutex file.md  # creates file.tex and file.pdf
+  	$ marutex file.md  # creates file.tex and file.pdf
 
 
 Examples of PHP Markdown Extra syntax {#extra}
@@ -159,9 +160,14 @@ Examples of PHP Markdown Extra syntax {#extra}
 
 
 * header ids
-      ## Header ##     {#id}
+      ## Download ##     {#download}
   For example, [a link to the download](#download) header.
 
+  Note that you can use also the new [meta-data syntax](#meta) for the same purpose:
+
+  	@ id: download 
+  	## Header ##     
+
 * definition lists
 
   	Definition list
@@ -172,7 +178,7 @@ Examples of PHP Markdown Extra syntax {#extra}
 
 * abbreviations or ABB for short.
 
-*[ABB]: Simple an abbreviation
+*[ABB]: Simply an abbreviation
 
 
 
@@ -258,7 +264,7 @@ You can add more by separating with a `;`:
 A meta-data declaration is composed of 
 
 1. newline
-2. an at-symbol '@'
+2. an at-symbol `@`
 3. a series of name-value pairs. Each name-value is separated 
    by a colon `:`, pairs are separated by semi-colons `;` 
 
@@ -280,26 +286,34 @@ Also, if the value is not present, it defaults to `true`:
 
 	@ test
 
-	This paragraph has the attribute 'test' set.
+	This paragraph has the attribute `test` set to `true`.
+
+
+
 
 * * *
 
-List of meta-data       {#metalist}
------------------
 
 
 
+### List of meta-data  ### {#metalist} 
+
 **`title`, `subject`**
 : (document) Sets the title of the document (HTML: used in the `TITLE` element).
 
+**`use_numbered_headers`**
+: (document) If `true`, headers are numbered (just like this document). Default is `false`.
+
 **`css`**
 : (document, HTML) Url of stylesheet.
 
 **`html_use_syntax`**
-: (document, HTML) Use the [`syntax` library][syntax] to add source highlighting.
+: (document, HTML) If set, use the [`syntax` library][syntax] to add source highlighting.
 
 **`latex_use_listings`**
-: (document, LaTex) Use fancy `listing` package for better displaying code blocks.
+: (document, LaTeX) If set, use fancy `listing` package for better displaying code blocks.
+     
+     If not set,  use standard `verbatim` environment.
 
 **`style`, `id`, `class`**
 : (any block object, HTML) Standard CSS attributes are copied.
@@ -322,7 +336,7 @@ List of meta-data       {#metalist}
       property of the block.
 
     * for **LaTeX output**, if it is a named color, it must be a color accepted
-      by the latex `color` packages. If it is of the form `#ff00ff`, Maruku
+      by the LaTeX `color` packages. If it is of the form `#ff00ff`, Maruku
       defines a color using the `\color[rgb]{r,g,b}` macro. 
 
       For example, for `#0000ff`, the macro is called as: `\color[rgb]{0,0,1}`.
@@ -374,8 +388,41 @@ produces:
 @ lang: xml
 	<div style="text-align:center">Div</div>
 
+
+
 * * *
 
+Other Features
+--------------
+
+### Automatic generation of the table of contents ###
+
+If you create a list, and the set the `toc` attribute, when rendering
+Maruku will create an auto-generated table of contents.
+
+	@ toc
+	* This will become a table of contents
+
+You can see an example of this at the beginning of this document.
+
+### This header contains *emphasis* **strong text** and `code` ####
+
+Note that this header contains formatting and it still works, also
+in the table of contents.
+
+TODO list
+--------------------------
+
+
+* Export to HTML
+  * Include RubyPants
+
+* Export to PDF 
+  * support for images
+
+* Export to Markdown (pretty-printing)
+
+
 Future developments                              {#future}
 -------------------
 
@@ -384,6 +431,9 @@ However, they are written in Haskell and Perl, respectively.
 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:
@@ -404,7 +454,3 @@ Things I'm thinking about:
       This is a reference to equation: please see (eq:1)
 
 
-
-[Pandoc]: http://sophos.berkeley.edu/macfarlane/pandoc/
-[MultiMarkdown]: http://fletcher.freeshell.org/wiki/MultiMarkdown
-

data/docs/todo.md

@@ -1,3 +1,9 @@
 
-* include RubyPants
+* Export to HTML
+  * Include RubyPants
+
+* Export to PDF 
+  * support for images
+
+* Export to Markdown (pretty-printing)
 

data/lib/maruku.rb

@@ -11,6 +11,9 @@ require 'maruku/parse_span'
 # Ugly things kept in a closet
 require 'maruku/string_utils'
 
+# Code for creating a table of contents
+require 'maruku/toc'
+
 
 # Exporting to html
 require 'maruku/to_html'
@@ -18,3 +21,6 @@ require 'maruku/to_html'
 # Exporting to latex
 require 'maruku/to_latex'
 require 'maruku/to_latex_strings'
+
+# Exporting to text: strips all formatting (not complete)
+require 'maruku/to_s'

data/lib/maruku/parse_block.rb

@@ -21,6 +21,20 @@ class Maruku
 		
 		self.search_abbreviations
 		self.substitute_markdown_inside_raw_html
+		
+		toc = create_toc
+
+		# use title if not set
+		if not self.meta[:title] and toc.header_element
+			title = toc.header_element.to_s
+			self.meta[:title]  = title
+			puts "Set document title to #{title}"
+		end
+		
+		# save for later use
+		self.toc = toc
+		
+		#puts toc.inspect
 	end
 
 	def search_abbreviations
@@ -91,18 +105,9 @@ class Maruku
 						(next_line && next_line =~ TableSeparator)
 						output << read_table
 					elsif [:header1,:header2].include? next_line_node_type
-						e = create_md_element(:header)
-						line = shift_line.strip
-						if line =~ HeaderWithId 
-							line = $1.strip
-							e.meta[:id] = $2
-						end
-						e.children = parse_lines_as_span [ line ]
-
-						e.meta[:level] = cur_line_node_type == :header2 ? 2 : 1
-						shift_line
-
-						output << e
+						output << read_header12
+					
+					
 					elsif eventually_comes_a_def_list
 					 	definition = read_definition
 						if output.last && output.last.node_type == :definition_list
@@ -119,16 +124,7 @@ class Maruku
 					shift_line
 					output << create_md_element(:hrule)
 				when :header3
-					e = create_md_element(:header)
-					line = shift_line.strip
-					if line =~ HeaderWithId 
-						line = $1.strip
-						e.meta[:id] = $2
-					end
-					
-					e.meta[:level] = num_leading_hashes(line)
-					e.children =  parse_lines_as_span [strip_hashes(line)] 
-					output << e
+					output << read_header3
 				when :ulist, :olist
 					list_type = cur_line_node_type == :ulist ? :ul : :ol
 					li = read_list_item
@@ -205,6 +201,43 @@ class Maruku
 	def next_line; top.empty? ? nil : top[1] end
 	def next_line_node_type; (top.size >= 2) ? line_node_type(top[1]) : nil end
 	def shift_line; top.shift; end
+		
+	# reads a header (with ----- or ========)
+	def read_header12
+		e = create_md_element(:header)
+		line = shift_line.strip
+		if line =~ HeaderWithId 
+			line = $1.strip
+			e.meta[:id] = $2
+		end
+		e.children = parse_lines_as_span [ line ]
+
+		e.meta[:level] = cur_line_node_type == :header2 ? 2 : 1
+		shift_line
+
+		# generate an id if one is not provided
+		e.meta[:id] = e.generate_id if not e.meta[:id]
+
+		e
+	end
+
+	# reads a header like '#### header ####'
+	def read_header3
+		e = create_md_element(:header)
+		line = shift_line.strip
+		if line =~ HeaderWithId 
+			line = $1.strip
+			e.meta[:id] = $2
+		end
+		
+		e.meta[:level] = num_leading_hashes(line)
+		e.children =  parse_lines_as_span [strip_hashes(line)] 
+		
+		# generate an id if one is not provided
+		e.meta[:id] = e.generate_id if not e.meta[:id]
+
+		e
+	end
 	
 	
 	def read_raw_html
@@ -413,19 +446,22 @@ class Maruku
 	end
 	
 	# parse one metadata line
+	# TODO: read quote-delimited values
 	def parse_metadata(l)
 		hash = {}
 		# remove leading '@'
 		l = l[1, l.size].strip
 		l.split(';').each do |kv|
 			k, v = kv.split(':')
-			v ||= 'true'
-			k = k.strip.to_sym
-			hash[k] = v.strip
+			k, v = normalize_key_and_value(k, v)
+			
+			hash[k.to_sym] = v
 		end
 		hash 
 	end
 	
+
+	
 	def read_ref
 		line = shift_line
 		

data/lib/maruku/string_utils.rb

@@ -21,12 +21,27 @@ class Maruku
 			headers = $1
 			headers.split("\n").each do |l| 
 				k, v = l.split(':')
-				keys[k.strip.downcase.to_sym] = v.strip
+				k, v = normalize_key_and_value(k, v)
+				k = k.to_sym
+#				puts "K = #{k}, V=#{v}"
+				keys[k] = v
 			end
 		end
 		keys
 	end
 	
+	def normalize_key_and_value(k,v)
+		v = v ? v.strip : true # no value defaults to true
+
+		# check synonyms
+		v = true if ['yes','true'].include?(v.to_s.downcase)
+		v = false if ['no','false'].include?(v.to_s.downcase)
+		
+		k = k.strip.downcase.gsub(' ','_')
+		
+		return k, v
+	end
+	
 	# Returns the number of leading spaces, considering that
 	# a tab counts as `TabSize` spaces.
 	def number_of_leading_spaces(s)

data/lib/maruku/structures.rb

@@ -1,6 +1,6 @@
 
 class MDElement 
-	# Allowed: :document, :paragraph, :ul, :ol, :li, :li_span, :strong, :emphasis, :link1
+	# Allowed: :document, :paragraph, :ul, :ol, :li, :li_span, :strong, :emphasis, :link
 	attr_accessor :node_type
 	# Children are either Strings or MDElement
 	attr_accessor :children
@@ -22,10 +22,36 @@ class MDElement
 	
 end
 
-# The Maruku class holds static data for the document
+# The Maruku class represent the whole document 
+# and holds global data.
 
 class Maruku < MDElement
 	attr_accessor :refs
 	attr_accessor :footnotes
 	attr_accessor :abbreviations
+	# an instance of Section (see below)
+	attr_accessor :toc 
+end
+
+class MDElement
+	class Section
+		attr_accessor :section_level # a Fixnum, is == header_element.meta[:level]
+		
+		# An array of fixnum, like [1,2,5] for Section 1.2.5
+		attr_accessor :section_number 
+		
+		# reference to header (header has h.meta[:section] to self)
+		attr_accessor :header_element
+
+		# Array of immediate children of this element
+		attr_accessor :immediate_children
+		# Array of Section inside this section
+		attr_accessor :section_children
+		
+		
+		def initialize
+			@immediate_children = []
+			@section_children = []
+		end
+	end 
 end

data/lib/maruku/to_html.rb

@@ -82,7 +82,10 @@ class Maruku
 			if @doc.meta[:footnotes_used]
 				body << render_footnotes
 			end
-		
+			
+			# When we are rendering a whole document, we add a signature 
+			# at the bottom. 
+			body << maruku_html_signature
 			
 		root << head
 		root << body
@@ -90,6 +93,40 @@ class Maruku
 		doc
 	end
 	
+	# returns "st","nd","rd" or "th" as appropriate
+	def day_suffix(day)
+		case day%10
+			when 1; 'st'
+			when 2; 'nd'
+			when 3; 'rd'
+			else 'th'
+		end
+	end
+
+	# formats a nice date
+	def nice_date
+		t = Time.now
+		t.strftime(" at %H:%M on ")+
+		t.strftime("%A, %B %d")+
+		day_suffix(t.day)+
+		t.strftime(", %Y")
+	end
+	
+	def maruku_html_signature		
+		div = Element.new 'div'
+			div.attributes['class'] = 'maruku_signature'
+			Element.new 'hr', div
+			span = Element.new 'span', div
+				span.attributes['style'] = 'font-size: small; font-style: italic'
+				span << Text.new('Created by ')
+				a = Element.new('a', span)
+					a.attributes['href'] = 'http://maruku.rubyforge.org'
+					a.attributes['title'] = 'Maruku: a Markdown interpreter'
+					a << Text.new('Maruku')
+				span << Text.new(nice_date+".")
+		div
+	end
+	
 	def render_footnotes
 		div = Element.new 'div'
 		div.attributes['class'] = 'footnotes'
@@ -147,14 +184,58 @@ class MDElement
 	end
 
 	def to_html_paragraph; wrap_as_element('p')                end
-	def to_html_ul;        wrap_as_element('ul')               end
+	
+	def to_html_ul
+		if @meta[:toc]
+			# render toc
+			html_toc = @doc.toc.to_html
+			return html_toc
+		else
+			wrap_as_element('ul')               
+		end
+	end
+	
+	
 	def to_html_ol;        wrap_as_element('ol')               end
 	def to_html_li;        wrap_as_element('li')               end
 	def to_html_li_span;   wrap_as_element('li')               end
 	def to_html_quote;     wrap_as_element('blockquote')       end
 	def to_html_strong;    wrap_as_element('strong')           end
 	def to_html_emphasis;  wrap_as_element('em')               end
-	def to_html_header;    wrap_as_element "h#{@meta[:level]}" end
+
+	# nil if not applicable, else string
+	def section_number
+		return nil if not @doc.meta[:use_numbered_headers]
+		
+		if (s = @meta[:section]) and not s.section_number.empty?
+			 s.section_number.join('.')+". "
+		else
+			nil
+		end
+	end
+	
+	# nil if not applicable, else SPAN element
+	def render_section_number
+		# if we are bound to a section, add section number
+		if num = section_number
+			span = Element.new 'span'
+			span.attributes['class'] = 'maruku_section_number'
+			span << Text.new(section_number)
+			span
+		else
+			nil
+		end
+	end
+	
+	def to_html_header
+		element_name = "h#{@meta[:level]}" 
+		h = wrap_as_element element_name
+		
+		if span = render_section_number
+			h.insert_before(h.children.first, span)
+		end
+		h
+	end
 
 	def source2html(source)
 		source = source.gsub(/&/,'&amp;')

data/lib/maruku/to_latex.rb

@@ -16,12 +16,9 @@ class Maruku
 		end
 
 		body = to_latex
-
-		# I found a fix!! :-)
-		# ## xxx only if `...` is used in footnotes
-		# header += "\\usepackage{fancyvrb}\n"
-		# body = "\\VerbatimFootnotes\n"+body
 		
+		body += render_latex_signature
+
 "\\documentclass{article}
 
 #{header}
@@ -35,6 +32,16 @@ class Maruku
 \\end{document}
 "	
 	end
+	
+	
+	def render_latex_signature
+"\\vfill
+\\hrule
+\\vspace{1.2mm}
+\\begin{tiny}
+Created by \\href{http://maruku.rubyforge.org}{Maruku} #{self.nice_date}.
+\\end{tiny}"
+	end
 
 end
 
@@ -55,32 +62,6 @@ class MDElement
 		self.meta[name] || @doc.meta[name] || default
 	end
 	
-	# Returns the name to use and possibly a declaration to append
-	def define_color_if_necessary(color)
-		if color =~ /^\#(\w\w)(\w\w)(\w\w)$/
-			# init colors hash in document
-			hash = (@doc.meta[:defined_colors] ||= {})
-			if hash[color] then 
-				return hash[color], nil
-			else
-				r = $1.hex; g = $2.hex; b=$3.hex
-				
-				colorname = "maruku_color#{hash.size}"
-				
-				# convert from 0-255 to 0.0-1.0
-				r = r / 255.0 
-				g = g / 255.0 
-				b = b / 255.0 
-				declaration = "\\definecolor{#{colorname}}{rgb}{#{r},#{g},#{b}}\n"
-				hash[color] = colorname
-				
-				return colorname, declaration
-			end
-		else
-			color
-		end
-	end
-
 	# \color[named]{name} 	
 	# \color[rgb]{1,0.2,0.3} 
 	def latex_color(s, command='color')
@@ -137,23 +118,31 @@ class MDElement
 
 	def to_latex_header
 		h = TexHeaders[@meta[:level]] || 'paragraph'
-		s = 
-		# \hyperdef{category}{name}{text} 
-
-		if @meta[:id]
-			id = @meta[:id]
+		
+		title = children_to_latex
+		if number = section_number
+			title = number + title
+		end
+		
+		if id = @meta[:id]
+			# drop '#' at the beginning
 			if id[0,1] == '#' then id = [1,id.size] end
-			%{\\hypertarget{%s}{}\\%s*{{%s}}\n\n} % [ id,h,  children_to_latex]
-				
-#			s + "\\hypertarget{user}{#{id}}{link}"
+			%{\\hypertarget{%s}{}\\%s*{{%s}}\\label{%s}\n\n} % [ id, h, title, id ]
 		else
-			%{\\%s*{%s}\n\n} % [ h, children_to_latex]
+			%{\\%s*{%s}\n\n} % [ h, title]
 		end
 	end
 	
-	def to_latex_quote;        wrap_as_environment('quote')               end
 	
-	def to_latex_ul;        wrap_as_environment('itemize')               end
+	def to_latex_ul;       
+		if @meta[:toc]
+			@doc.toc.to_latex
+		else
+			wrap_as_environment('itemize')
+		end
+	end
+		   
+	def to_latex_quote;        wrap_as_environment('quote')               end
 	def to_latex_ol;        wrap_as_environment('enumerate')               end
 	def to_latex_li;        
 		"\\item #{children_to_latex}\n"  
@@ -203,7 +192,7 @@ class MDElement
 		ref = @doc.refs[id]
 		if not ref
 			$stderr.puts "Could not find id = '#{id}'"
-			return title.to_latex
+			return children_to_latex
 		else
 			url = ref[:url]
 			#title = ref[:title] || 'no title'
@@ -298,8 +287,7 @@ class MDElement
 		
 		s
 	end
-#	def to_latex_definition_term; "" end
-#	def to_latex_definition_data; "" end	
+	
 
 	def to_latex_abbreviation
 		children_to_latex

data/lib/maruku/to_latex_strings.rb

@@ -2,6 +2,7 @@ require 'rexml/document'
 
 
 class String
+	
 	# escapes special characters
 	def to_latex
 		s = self
@@ -10,10 +11,20 @@ class String
 		# better yet, we should use the catcode for {}
 		s = String.convert_entities(s)
 		s = s.gsub(/([\$\&\%\#\_])/) { |m| "\\#{m}" }
-#		s = s.gsub(/([\$\&\%\#\_\{\}])/) { |m| "\\#{m}" }
+
+		OtherGoodies.each do |k, v|
+			s.gsub!(k, v)
+		end
 		s
 	end
 	
+	# other things that are good on the eyes
+	OtherGoodies = {
+		'LaTeX' => '\\LaTeX', # XXX not if already \latex
+		'HTML' => '\\textsc{html}',
+		'PDF' => '\\textsc{pdf}'
+	}
+	
 	def String.convert_entities(s)
 		init_tables
 			

data/lib/maruku/to_s.rb

@@ -0,0 +1,22 @@
+
+
+class MDElement
+	
+	# Strips all formatting from the string
+	def to_s
+		 children_to_s
+	end
+	
+	def children_to_s
+		@children.join
+	end
+	
+	# Generate an id for headers. Assumes @children is set.
+	def generate_id
+		title = children_to_s
+		title.gsub!(/ /,'_')
+		title.downcase!
+		title.gsub!(/[^\w_]/,'')
+		title
+	end
+end

data/lib/maruku/toc.rb

@@ -0,0 +1,147 @@
+require 'rexml/document'
+
+class MDElement
+	class Section
+		def inspect(indent=1)
+			s = ""
+			if @header_element
+				s +=  "\_"*indent +  "(#{@section_level})>\t #{@section_number.join('.')} : "
+				s +=  @header_element.children_to_s + " (id: '#{@header_element.meta[:id]}')\n"
+			else
+				s += "Master\n"
+			end
+			
+			@section_children.each do |c|
+				s+=c.inspect(indent+1)
+			end
+			s
+		end
+		
+		# Numerate this section and its children
+		def numerate(a=[])
+			self.section_number = a
+			section_children.each_with_index do |c,i|
+				c.numerate(a.clone.push(i+1))
+			end
+		end
+		
+		include REXML
+		# Creates an HTML toc.
+		# Call this on the root 
+		def to_html
+			div = Element.new 'div'
+			div.attributes['class'] = 'maruku_toc'
+			div << create_toc
+			div
+		end
+		
+		def create_toc
+			ul = Element.new 'ul'
+			# let's remove the bullets
+			ul.attributes['style'] = 'list-style: none;' 
+			@section_children.each do |c|
+				li = Element.new 'li'
+				if span = c.header_element.render_section_number
+					li << span
+				end
+				a = c.header_element.wrap_as_element('a')
+					a.delete_attribute 'id'
+					a.attributes['href'] = "##{c.header_element.meta[:id]}"
+				li << a
+				li << c.create_toc if c.section_children.size>0
+				ul << li
+			end
+			ul
+		end
+
+		# Creates a latex toc.
+		# Call this on the root 
+		def to_latex
+			to_latex_rec + "\n\n"
+		end
+		
+		def to_latex_rec
+			s = ""
+			@section_children.each do |c|
+				s += "\\noindent"
+				number = c.header_element.section_number
+				s += number if number
+					text = c.header_element.children_to_latex
+					id = c.header_element.meta[:id]
+				s += "\\hyperlink{#{id}}{#{text}}"
+				s += "\\dotfill \\pageref*{#{id}} \\linebreak\n"
+				s += c.to_latex_rec  if c.section_children.size>0
+
+			end
+			s
+		end
+		
+	end
+end
+
+
+class MDElement
+	
+	
+	def create_toc
+		stack = []
+		
+		# the ancestor section
+		s = Section.new
+		s.section_level = 0
+
+		stack.push s
+	
+		i = 0;
+		while i < @children.size
+			
+			while i < @children.size 
+				if @children[i].node_type == :header
+					level = @children[i].meta[:level]
+					break if level <= stack.last.section_level+1
+				end
+				
+				stack.last.immediate_children.push @children[i]
+				i += 1
+			end
+
+			break if i>=@children.size
+			
+			header = @children[i]
+			level = header.meta[:level]
+			
+			if level > stack.last.section_level
+				# this level is inside
+				
+				s2 = Section.new
+				s2.section_level = level
+				s2.header_element = header
+				header.meta[:section] = s2
+				
+				stack.last.section_children.push s2
+				stack.push s2
+				
+				i+=1
+			elsif level == stack.last.section_level
+				# this level is a sibling
+				stack.pop
+			else 
+				# this level is a parent
+				stack.pop
+			end
+			
+		end
+
+		# If there is only one big header, then assume
+		# it is the master
+		if s.section_children.size == 1
+			s = s.section_children.first
+		end
+		
+		# Assign section numbers
+		s.numerate
+	
+		s
+	end
+	
+end

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: maruku
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  version: 0.2.5
 date: 2006-12-26 00:00:00 +01:00
 summary: A Markdown interpreter in Ruby
 require_paths: 
@@ -37,6 +37,8 @@ files:
 - lib/maruku/to_html.rb
 - lib/maruku/to_latex.rb
 - lib/maruku/to_latex_strings.rb
+- lib/maruku/to_s.rb
+- lib/maruku/toc.rb
 - docs/markdown_syntax.md
 - docs/maruku.md
 - docs/todo.md