maruku 0.4.2.1 → 0.5.0

data/lib/maruku/input/parse_span_better.rb

@@ -32,17 +32,17 @@ module MaRuKu; module In; module Markdown; module SpanLevelParser
 	
 	EscapedCharInInlineCode = [?\\,?`]
 
-	def parse_lines_as_span(lines)
-		parse_span_better lines.join("\n")
+	def parse_lines_as_span(lines, parent=nil)
+		parse_span_better lines.join("\n"), parent
 	end
 
-	def parse_span_better(string)
+	def parse_span_better(string, parent=nil)
 		if not string.kind_of? String then 
 			error "Passed #{string.class}." end
 
 		st = (string + "")
 		st.freeze
-		src = CharSource.new(st)
+		src = CharSource.new(st, parent)
 		read_span(src, EscapedCharInText, [nil])
 	end
 		
@@ -67,7 +67,12 @@ module MaRuKu; module In; module Markdown; module SpanLevelParser
 			break if exit_on_chars && exit_on_chars.include?(c)
 			break if exit_on_strings && exit_on_strings.any? {|x| src.cur_chars_are x}
 			
-			case c
+			# check if there are extensions
+			if check_span_extensions(src, con)
+				next
+			end
+			
+			case c = src.cur_char	
 			when ?\ # it's space (32)
 				if src.cur_chars_are "  \n"
 					src.ignore_chars(3)
@@ -190,7 +195,6 @@ module MaRuKu; module In; module Markdown; module SpanLevelParser
 				src.ignore_char # {
 				interpret_extension(src, con, [?}])
 				src.ignore_char # }
-				
 			when nil
 				maruku_error ("Unclosed span (waiting for %s"+
 				 "#{exit_on_strings.inspect})") % [
@@ -509,6 +513,7 @@ module MaRuKu; module In; module Markdown; module SpanLevelParser
 			(src.next_char == ?[ or src.next_char == ?( )
 			src.shift_char
 		end
+		
 		case src.cur_char
 		when ?(
 			src.ignore_char # opening (
@@ -552,6 +557,11 @@ module MaRuKu; module In; module Markdown; module SpanLevelParser
 		when ?[ # link ref
 			ref_id = read_ref_id(src,con)
 			if ref_id
+				if ref_id.size == 0
+					ref_id =  children.to_s.downcase.gsub(' ','_')
+				else
+					ref_id = ref_id.downcase
+				end	
 				con.push_element md_link(children, ref_id)
 			else 
 				maruku_error "Could not read ref_id", src, con
@@ -560,8 +570,9 @@ module MaRuKu; module In; module Markdown; module SpanLevelParser
 				con.push_elements children
 				return
 			end
-		else # no stuff
-			con.push_elements children
+		else # empty [link]
+			id = children.to_s.downcase.gsub(' ','_')
+			con.push_element md_link(children, id)
 		end
 	end # read link
 

data/lib/maruku/input/type_detection.rb

@@ -44,11 +44,12 @@ module MaRuKu; module Strings
 		return :definition       if l =~ Definition
 		# I had a bug with emails and urls at the beginning of the 
 		# line that were mistaken for raw_html
-		return :text     if l=~EMailAddress or l=~ URL
+		return :text if l=~ /^#{EMailAddress}/
+		return :text if l=~ /^<http:/
 		# raw html is like PHP Markdown Extra: at most three spaces before
 		return :xml_instr if l =~ %r{^\s*<\?}
 		return :raw_html if l =~ %r{^[ ]?[ ]?[ ]?</?\s*\w+}
-		return :raw_html if l =~ %r{[ ]{0,3}<\!\-\-}
+		return :raw_html if l =~ %r{^[ ]?[ ]?[ ]?<\!\-\-}
 		return :ulist    if l =~ /^\s?([\*\-\+])\s+.*\w+/
 		return :olist    if l =~ /^\s?\d+\..*\w+/
 		return :header1  if l =~ /^(=)+/ 
@@ -64,9 +65,11 @@ module MaRuKu; module Strings
 			return :ald   if l =~ AttributeDefinitionList
 			return :ial   if l =~ InlineAttributeList
 #		end
+#		return :equation_end if l =~ EquationEnd
 		return :text # else, it's just text
 	end
 
+		
 	# $1 = id   $2 = attribute list
 	AttributeDefinitionList = /^\s{0,3}\{([\w\d\s]+)\}:\s*(.*)\s*$/
 	# 
@@ -135,5 +138,4 @@ module MaRuKu; module Strings
 
 
 	EMailAddress = /<([^:]+@[^:]+)>/
-	URL = /^<http:/
 end end

data/lib/maruku/output/to_html.rb

@@ -21,11 +21,6 @@
 
 require 'rexml/document'
 
-require 'rubygems'
-require 'syntax'
-require 'syntax/convertors/html'
-
-
 class String
 	# A string is rendered into HTML by creating
 	# a REXML::Text node. REXML takes care of all the encoding.
@@ -43,7 +38,6 @@ end
 # This module groups all functions related to HTML export.
 module MaRuKu; module Out; module HTML
 	include REXML
-	include MaRuKu::Defaults
 	
 	# Render as an HTML fragment (no head, just the content of BODY). (returns a string)
 	def to_html(context={})
@@ -81,12 +75,76 @@ module MaRuKu; module Out; module HTML
 		# containing code.
 		doc.write(xml,indent,transitive=true,ie_hack);
 				
-		xhtml10strict  = "<?xml version='1.0' encoding='utf-8'?>
+		xhtml10strict  = "
+<?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'>\n"
-		xhtml10strict + xml
+		
+		xhtml11strict_mathml2 = '<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN"
+               "http://www.w3.org/TR/MathML2/dtd/xhtml-math11-f.dtd" [
+  <!ENTITY mathml "http://www.w3.org/1998/Math/MathML">
+]>
+'
+
+xhtml11_mathml2_svg11 = 
+'<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC
+    "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN"
+    "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd">
+'
+
+		xhtml11_mathml2_svg11 + xml
 	end
 	
+	def xml_newline() Text.new("\n") end
+		
+
+=begin maruku_doc
+Attribute: title
+Scope: document
+
+Sets the title of the document.
+If a title is not specified, the first header will be used.
+
+These should be equivalent:
+
+	Title: my document
+
+	Content
+
+and
+
+	my document
+	===========
+
+	Content
+
+In both cases, the title is set to "my document".
+=end
+
+=begin maruku_doc
+Attribute: subject
+Scope: document
+
+Synonim for `title`.
+=end
+
+
+=begin maruku_doc
+Attribute: css
+Scope: document
+Output: HTML
+Summary: Activates CSS stylesheets for HTML.
+
+`css` should be a space-separated list of urls.
+
+Example:
+	
+	CSS: style.css math.css
+
+=end
+
 	# Render to a complete HTML document (returns a REXML document tree)
 	def to_html_document_tree
 		doc = Document.new(nil,{:respect_whitespace =>:all})
@@ -94,34 +152,41 @@ module MaRuKu; module Out; module HTML
 		
 		root = Element.new('html', doc)
 		root.add_namespace('http://www.w3.org/1999/xhtml')
-		
+		root.add_namespace('svg', "http://www.w3.org/2000/svg" )
 		lang = self.attributes[:lang] || 'en'
-		root.attributes['lang'] = lang
 		root.attributes['xml:lang'] = lang
 		
+		root << xml_newline
 		head = Element.new 'head', root
 		
 			#<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8">
 			me = Element.new 'meta', head
 			me.attributes['http-equiv'] = 'Content-type'
-			me.attributes['content'] = 'text/html; charset=utf-8'	
+#			me.attributes['content'] = 'text/html;charset=utf-8'	
+			me.attributes['content'] = 'application/xhtml+xml;charset=utf-8'	
 		
+
 			# Create title element
 			doc_title = self.attributes[:title] || self.attributes[:subject] || ""
 			title = Element.new 'title', head
 				title << Text.new(doc_title)
 				
 			
-			css = self.attributes[:css]
-			if css
+			
+			if css_list = self.attributes[:css]
+				css_list.split.each do |css|
 				# <link type="text/css" rel="stylesheet" href="..." />
 				link = Element.new 'link'
 				link.attributes['type'] = 'text/css'
 				link.attributes['rel'] = 'stylesheet'
 				link.attributes['href'] = css
-				head << link
+				head << link 
+				head << xml_newline
+				end
 			end
-			
+		
+		root << xml_newline
+		
 		body = Element.new 'body'
 		
 			children_to_html.each do |e|
@@ -135,7 +200,7 @@ module MaRuKu; module Out; module HTML
 			
 			# When we are rendering a whole document, we add a signature 
 			# at the bottom. 
-			if get_boolean_setting(:maruku_signature)
+			if get_setting(:maruku_signature)
 				body << maruku_html_signature 
 			end
 			
@@ -144,33 +209,18 @@ module MaRuKu; module Out; module HTML
 		doc
 	end
 	
-	def add_whitespace(element)
-		blocks = ['p','pre','h1','h2','h3','h4','h5','h6',
-			'style','table','div','ul','ol','li','dl','dt',
-			'head','blockquote','tr','thead','td','dd','title',
-			'link','hr']
-			
-		element.get_elements( "//*" ).each do |e|
-			if blocks.include? e.name
-				e.parent.insert_before(e, Text.new("\n"))
-				e.parent.insert_after(e, Text.new("\n"))
-			end
-		end
-
-		element.get_elements( "//br" ).each do |e|
-			e.parent.insert_after(e, Text.new("\n"))
-		end
-	end
-	
 	# returns "st","nd","rd" or "th" as appropriate
 	def day_suffix(day)
-		return 'th' if day == 11
-		case day%10
-			when 1; 'st'
-			when 2; 'nd'
-			when 3; 'rd'
-			else 'th'
-		end
+		s = {
+			1 => 'st',
+			2 => 'nd',
+			3 => 'rd',
+			21 => 'st',
+			22 => 'nd',
+			23 => 'rd',
+			31 => 'st'
+		}
+		return s[day] || 'th';
 	end
 
 	# formats a nice date
@@ -191,7 +241,7 @@ module MaRuKu; module Out; module HTML
 				span << Text.new('Created by ')
 				a = Element.new('a', span)
 					a.attributes['href'] = 'http://maruku.rubyforge.org'
-					a.attributes['title'] = 'Maruku: a Markdown interpreter for Ruby'
+					a.attributes['title'] = 'Maruku: a Markdown-superset interpreter for Ruby'
 					a << Text.new('Maruku')
 				span << Text.new(nice_date+".")
 		div
@@ -229,8 +279,8 @@ module MaRuKu; module Out; module HTML
 	# renders children as html and wraps into an element of given name
 	# 
 	# Sets 'id' if meta is set
-	def wrap_as_element(name)
-		m = create_html_element name
+	def wrap_as_element(name, attributes_to_copy=[])
+		m = create_html_element(name, attributes_to_copy)
 			children_to_html.each do |e| m << e; end
 			
 #			m << Comment.new( "{"+self.al.to_md+"}") if not self.al.empty?
@@ -238,11 +288,40 @@ module MaRuKu; module Out; module HTML
 		m
 	end
 	
-	def create_html_element(name)
+=begin maruku_doc
+Attribute: id
+Scope: element
+Output: LaTeX, HTML
+
+It is copied as a standard HTML attribute.
+
+Moreover, it used as a label name for hyperlinks in both HTML and
+in PDF.
+
+=end
+
+=begin maruku_doc
+Attribute: class
+Scope: element
+Output: HTML
+
+It is copied as a standard HTML attribute.
+=end
+
+=begin maruku_doc
+Attribute: style
+Scope: element
+Output: HTML
+
+It is copied as a standard HTML attribute.
+=end
+	
+	StandardAttributes = [:id, :style, :class]
+	def create_html_element(name, attributes_to_copy=[])
 		m = Element.new name
-			if (v=@attributes[:id]   ) then m.attributes['id'   ] = v.to_s end
-			if (v=@attributes[:style]) then m.attributes['style'] = v.to_s end
-			if (v=@attributes[:class]) then m.attributes['class'] = v.to_s end
+			(StandardAttributes+attributes_to_copy).each do |a|
+				if v = @attributes[a] then m.attributes[a.to_s] = v.to_s end
+			end
 		m
 	end
 
@@ -266,9 +345,20 @@ module MaRuKu; module Out; module HTML
 	def to_html_strong;    wrap_as_element('strong')           end
 	def to_html_emphasis;  wrap_as_element('em')               end
 
+=begin maruku_doc
+Attribute: use_numbered_headers
+Scope: document
+Summary: Activates the numbering of headers.
+
+If `true`, section headers will be numbered.
+
+In LaTeX export, the numbering of headers is managed
+by Maruku, to have the same results in both HTML and LaTeX.
+=end
+
 	# nil if not applicable, else string
 	def section_number
-		return nil if not @doc.attributes[:use_numbered_headers]
+		return nil if not get_setting(:use_numbered_headers)
 		
 		n = @attributes[:section_number]
 		if n && (not n.empty?)
@@ -307,17 +397,58 @@ module MaRuKu; module Out; module HTML
 		Text.new(source, true, nil, false )
 	end
 		
+=begin maruku_doc
+Attribute: html_use_syntax
+Scope: global, document, element
+Output: HTML
+Summary: Enables the use of the `syntax` package.
+Related: lang, code_lang
+Default: <?mrk md_code(Globals[:html_use_syntax].to_s) ?>
+
+If true, the `syntax` package is used. It supports the `ruby` and `xml`
+languages. Remember to set the `lang` attribute of the code block.
+
+Examples:
+
+		require 'maruku'
+	{:lang=ruby html_use_syntax=true}
+
+and 
+	
+		<div style="text-align:center">Div</div>
+	{:lang=html html_use_syntax=true}
+
+produces:
+
+	require 'maruku'
+{:lang=ruby html_use_syntax=true}
+
+and
+
+	<div style="text-align:center">Div</div>
+{:lang=html html_use_syntax=true}
+
+=end
+
 	def to_html_code; 
 		source = self.raw_code
 
 		lang = self.attributes[:lang] || @doc.attributes[:code_lang] 
 
 		lang = 'xml' if lang=='html'
-		use_syntax = get_setting(:html_use_syntax)
+
+
+		use_syntax = get_setting :html_use_syntax
 		
 		element = 
 		if use_syntax && lang
 			begin
+				if not $syntax_loaded
+					require 'rubygems'
+					require 'syntax'
+					require 'syntax/convertors/html'
+					$syntax_loaded = true
+				end
 				convertor = Syntax::Convertors::HTML.for_syntax lang
 				
 				# eliminate trailing newlines otherwise Syntax crashes
@@ -328,6 +459,10 @@ module MaRuKu; module Out; module HTML
 				pre = Document.new(html, {:respect_whitespace =>:all}).root
 				pre.attributes['class'] = lang
 				pre
+			rescue LoadError => e
+				maruku_error "Could not load package 'syntax'.\n"+
+					"Please install it, for example using 'gem install syntax'."
+				to_html_code_using_pre(source)	
 			rescue Object => e
 				maruku_error"Error while using the syntax library for code:\n#{source.inspect}"+
 				 "Lang is #{lang} object is: \n"+
@@ -341,13 +476,33 @@ module MaRuKu; module Out; module HTML
 			to_html_code_using_pre(source)
 		end
 		
-		color = get_setting(:code_background_color,DEFAULT_CODE_COLOR)
-		if color != DEFAULT_CODE_COLOR
+		color = get_setting(:code_background_color)
+		if color != Globals[:code_background_color]
 			element.attributes['style'] = "background-color: #{color};"
 		end
 		element
 	end
 	
+=begin maruku_doc
+Attribute: code_background_color
+Scope: global, document, element
+Summary: Background color for code blocks.
+
+The format is either a named color (`green`, `red`) or a CSS color
+of the form `#ff00ff`. 
+
+* for **HTML output**, the value is put straight in the `background-color` CSS 
+  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
+  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}`.
+
+=end
+	
+	
 	def to_html_code_using_pre(source)
 		pre = create_html_element  'pre'
 		code = Element.new 'code', pre
@@ -358,10 +513,12 @@ module MaRuKu; module Out; module HTML
 		s  = s.gsub(/\&apos;/,'&#39;') # IE bug
 		s  = s.gsub(/'/,'&#39;') # IE bug
 
-		show_spaces = get_setting(:code_show_spaces) 
-		if show_spaces
-			s.gsub!(/\t/,'&raquo;'+'&nbsp;'*3)
-			s.gsub!(/ /,'&not;')
+		if get_setting(:code_show_spaces) 
+			# 187 = raquo
+			# 160 = nbsp
+			# 172 = not
+			s.gsub!(/\t/,'&#187;'+'&#160;'*3)
+			s.gsub!(/ /,'&#172;')
 		end
 
 		text = Text.new(s, respect_ws=true, parent=nil, raw=true )
@@ -375,8 +532,8 @@ module MaRuKu; module Out; module HTML
 			source = self.raw_code
 			pre << source2html(source) 
 			
-			color = get_setting(:code_background_color, DEFAULT_CODE_COLOR)
-			if color != DEFAULT_CODE_COLOR
+			color = get_setting(:code_background_color)
+			if color != Globals[:code_background_color]
 				pre.attributes['style'] = "background-color: #{color};"
 			end
 			
@@ -395,10 +552,6 @@ module MaRuKu; module Out; module HTML
 	def to_html_link
 		a =  wrap_as_element 'a'
 		id = self.ref_id
-		# if empty, use text
-		if id.size == 0
-			id = children.to_s.downcase
-		end
 		
 		if ref = @doc.refs[id]
 			url = ref[:url]
@@ -406,7 +559,8 @@ module MaRuKu; module Out; module HTML
 			a.attributes['href'] = url if url
 			a.attributes['title'] = title if title
 		else
-			maruku_error"Could not find ref_id = #{id.inspect} for #{self.inspect}"
+			maruku_error "Could not find ref_id = #{id.inspect} for #{self.inspect}\n"+
+				"Available refs are #{@doc.refs.keys.inspect}"
 			tell_user "Not creating a link for ref_id = #{id.inspect}."
 			return wrap_as_element('span')
 		end
@@ -460,7 +614,9 @@ module MaRuKu; module Out; module HTML
 		id = self.ref_id
 		if ref = @doc.refs[id]
 			url = ref[:url]
-			a.attributes['src'] = url
+			title = ref[:title]
+			a.attributes['src'] = url.to_s
+			a.attributes['alt'] = title.to_s
 			[:title, :class, :style].each do |s| 
 				a.attributes[s.to_s] = ref[s] if ref[s]
 			end
@@ -483,7 +639,7 @@ module MaRuKu; module Out; module HTML
 		title = self.title
 		a =  create_html_element 'img'
 			a.attributes['src'] = url
-			a.attributes['title'] = title if title
+			a.attributes['alt'] = title.to_s
 		return a
 	end
 
@@ -578,22 +734,35 @@ module MaRuKu; module Out; module HTML
 						tr<<x 
 					end
 						
-				tbody << tr
+				tbody << tr << Text.new("\n")
 			end
 			table << tbody
 		table
 	end
 	
 	def to_html_head_cell; wrap_as_element('th') end
-	def to_html_cell; wrap_as_element('td') end
+	def to_html_cell
+		if @attributes[:scope]
+			wrap_as_element('th', [:scope])
+		else
+			wrap_as_element('td')
+		end
+ 	end
 	
 	def to_html_entity 
+		MaRuKu::Out::Latex.need_entity_table
+      
 		entity_name = self.entity_name
 		
+		if (e = MaRuKu::Out::Latex::ENTITY_TABLE[entity_name]) && e.html_num
+			entity_name = e.html_num
+		end
+		
 		# Fix for Internet Explorer
 		if entity_name == 'apos'
 			entity_name = 39
 		end
+
 		
 		if entity_name.kind_of? Fixnum
 #			Entity.new(entity_name)