maruku 0.2.6 → 0.2.7

data/docs/maruku.md

@@ -283,6 +283,29 @@ These can also be separated by newlines:
 
 	Paragraph 1 is a warning
 
+
+### Shortcuts ###
+
+This:
+
+	@ .xyz
+	Paragraph
+
+is equivalent to:
+
+	@ class: xyz
+	Paragraph
+
+This:
+
+	@ #xyz
+	Paragraph
+
+is equivalent to:
+
+	@ id: xyz
+	Paragraph
+
 Also, if the value is not present, it defaults to `true`:
 
 	@ test
@@ -293,8 +316,9 @@ Also, if the value is not present, it defaults to `true`:
 
 
 
+@ #metalist
 
-### List of meta-data  ### {#metalist} 
+### List of meta-data  ### 
 
 [listings]: http://www.ctan.org/tex-archive/macros/latex/contrib/listings/
 

data/lib/maruku.rb

@@ -14,6 +14,9 @@ require 'maruku/string_utils'
 # Code for creating a table of contents
 require 'maruku/toc'
 
+# Version and URL
+require 'maruku/version'
+
 
 # Exporting to html
 require 'maruku/to_html'

data/lib/maruku/string_utils.rb

@@ -10,7 +10,7 @@ class Maruku
 		a
 	end
 	
-	## This parses email headers. Returns an hash. hash['data'] is the message
+	# This parses email headers. Returns an hash. hash['data'] is the message.
 	def parse_email_headers(s)
 		keys={}
 		match = (s =~ /((\w+: .*\n)+)\n/)
@@ -30,16 +30,26 @@ class Maruku
 		keys
 	end
 	
+	# `.xyz` => class: xyz
+	# `#xyz` => id: xyz
 	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
 		
-		k = k.strip.downcase.gsub(' ','_')
+		# `.xyz` => class: xyz
+		if k =~ /^\.([\w\d]+)/
+			return :class, $1
+		# `#xyz` => id: xyz
+		elsif k =~ /^\#([\w\d]+)/
+			return :id, $1
+		else
+			# check synonyms
+			v = true if ['yes','true'].include?(v.to_s.downcase)
+			v = false if ['no','false'].include?(v.to_s.downcase)
 		
-		return k, v
+			k = k.downcase.gsub(' ','_')
+			return k, v
+		end
 	end
 	
 	# Returns the number of leading spaces, considering that

data/lib/maruku/structures.rb

@@ -1,13 +1,42 @@
+# I did not want to have a class for each possible element. 
+# Instead I opted to have the class "MDElement"
+# that represents eveything in the document (paragraphs, headers, etc).
+#
+# You can tell what it is by the variable `node_type`. 
+#
+# In the instance-variable `children` there are the children. These
+# can be of class 1) String or 2) MDElement. 
+#
+# The @doc variable points to the document to which the MDElement
+# belongs (which is an instance of Maruku, subclass of MDElement).
+#
+# Meta data is specified the hash `meta`. Keys are symbols (downcased, with
+# spaces substituted by underscores)
+#
+# For example, if you write in the source document.
+# 
+#     Title: test document
+#     My property: value
+#     
+#     content content
+#
+# You can access `value` by writing:
+#
+#     @doc.meta[:my_property] # => 'value'
+#
+# from whichever MDElement.
 
 class MDElement 
-	# Allowed: :document, :paragraph, :ul, :ol, :li, :li_span, :strong, :emphasis, :link
+	# XXX List not complete
+	# Allowed: :document, :paragraph, :ul, :ol, :li, 
+	# :li_span, :strong, :emphasis, :link, :email
 	attr_accessor :node_type
 	# Children are either Strings or MDElement
 	attr_accessor :children
 	# Hash for metadata
 	# contains :id for :link1
 	# :li :want_my_paragraph
-	# :header: :level
+	#  :header: :level
 	# code, inline_code: :raw_code
 	attr_accessor :meta
 	# reference of containing document (document has list of ref)
@@ -34,8 +63,11 @@ class Maruku < MDElement
 end
 
 class MDElement
+	
+	# This represents a section in the TOC.
 	class Section
-		attr_accessor :section_level # a Fixnum, is == header_element.meta[:level]
+		# a Fixnum, is == header_element.meta[:level]
+		attr_accessor :section_level 
 		
 		# An array of fixnum, like [1,2,5] for Section 1.2.5
 		attr_accessor :section_number 

data/lib/maruku/to_latex_strings.rb

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

data/lib/maruku/version.rb

@@ -0,0 +1,6 @@
+
+class Maruku
+	Version = '0.2.7'
+	
+	MarukuURL = 'http://maruku.rubyforge.org/'
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.8.10
 specification_version: 1
 name: maruku
 version: !ruby/object:Gem::Version 
-  version: 0.2.6
-date: 2006-12-27 00:00:00 +01:00
+  version: 0.2.7
+date: 2006-12-27
 summary: A Markdown interpreter in Ruby
 require_paths: 
-- lib
+  - lib
 email: andrea@rubyforge.org
 homepage: http://maruku.rubyforge.org
 rubyforge_project: 
@@ -18,80 +18,75 @@ bindir: bin
 has_rdoc: false
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
   version: 
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
-- Andrea Censi
+  - Andrea Censi
 files: 
-- lib/maruku.rb
-- lib/maruku/parse_block.rb
-- lib/maruku/parse_span.rb
-- lib/maruku/string_utils.rb
-- lib/maruku/structures.rb
-- 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
-- tests/abbreviations.md
-- tests/blank.md
-- tests/code.md
-- tests/code2.md
-- tests/code3.md
-- tests/email.md
-- tests/entities.md
-- tests/escaping.md
-- tests/extra_dl.md
-- tests/extra_header_id.md
-- tests/extra_table1.md
-- tests/footnotes.md
-- tests/headers.md
-- tests/hrule.md
-- tests/images.md
-- tests/inline_html.md
-- tests/links.md
-- tests/list1.md
-- tests/list2.md
-- tests/list3.md
-- tests/lists.md
-- tests/lists_ol.md
-- tests/misc_sw.md
-- tests/one.md
-- tests/paragraphs.md
-- tests/sss06.md
-- tests/test.md
-- tests/bugs/code_in_links.md
-- bin/maruku
-- bin/marutex
+  - lib/maruku.rb
+  - lib/maruku/parse_block.rb
+  - lib/maruku/parse_span.rb
+  - lib/maruku/string_utils.rb
+  - lib/maruku/structures.rb
+  - 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
+  - lib/maruku/version.rb
+  - docs/markdown_syntax.md
+  - docs/maruku.md
+  - docs/todo.md
+  - tests/abbreviations.md
+  - tests/blank.md
+  - tests/code.md
+  - tests/code2.md
+  - tests/code3.md
+  - tests/email.md
+  - tests/entities.md
+  - tests/escaping.md
+  - tests/extra_dl.md
+  - tests/extra_header_id.md
+  - tests/extra_table1.md
+  - tests/footnotes.md
+  - tests/headers.md
+  - tests/hrule.md
+  - tests/images.md
+  - tests/inline_html.md
+  - tests/links.md
+  - tests/list1.md
+  - tests/list2.md
+  - tests/list3.md
+  - tests/lists.md
+  - tests/lists_ol.md
+  - tests/misc_sw.md
+  - tests/one.md
+  - tests/paragraphs.md
+  - tests/sss06.md
+  - tests/test.md
+  - tests/bugs/code_in_links.md
+  - bin/maruku
+  - bin/marutex
 test_files: []
-
 rdoc_options: []
-
 extra_rdoc_files: []
-
 executables: 
-- maruku
-- marutex
+  - maruku
+  - marutex
 extensions: []
-
 requirements: []
-
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: syntax
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.0.0
-    version: 
+  - !ruby/object:Gem::Dependency 
+    name: syntax
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Version::Requirement 
+      requirements: 
+        - 
+          - ">="
+          - !ruby/object:Gem::Version 
+            version: 1.0.0
+      version: