kramdown 0.13.3 → 0.13.4

data/CONTRIBUTERS

@@ -1,6 +1,10 @@
   Count Name
 ======= ====
-    472 Thomas Leitner <t_leitner@gmx.at>
+    483 Thomas Leitner <t_leitner@gmx.at>
+      3 gettalong <t_leitner@gmx.at>
       3 Ben Armston <ben.armston@googlemail.com>
       3 Alex Marandon <contact@alexmarandon.com>
+      1 Postmodern <postmodern.mod3@gmail.com>
+      1 John Croisant <jacius@gmail.com>
+      1 Joe Fiorini <joe@faithfulgeek.org>
       1 Damien Pollet <damien.pollet@gmail.com>

data/ChangeLog

@@ -1,3 +1,195 @@
+commit 2a93cbc0e1bbe705159c645ae617538bad125394
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Fri Dec 16 18:26:32 2011 +0100
+
+    Updated release notes, version number and benchmark graphs
+
+doc/img/graph-jruby-1.6.0-330.png
+doc/img/graph-ruby-1.8.5-231.png
+doc/img/graph-ruby-1.8.6-399.png
+doc/img/graph-ruby-1.8.7-249.png
+doc/img/graph-ruby-1.8.7-302.png
+doc/img/graph-ruby-1.9.2p136-136.png
+doc/img/graph-ruby-1.9.3p0-0.png
+doc/index.page
+doc/news/release_0_13_4.page
+doc/news/release_0_X_X.page
+doc/tests.page
+lib/kramdown/version.rb
+
+commit dbbabbc5b61b67ed0d22c1aa4a6b17608ed771e6
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Tue Dec 13 17:25:53 2011 +0100
+
+    Fixed test case to work with coderay 1.0
+
+test/testcases/block/12_extension/options3.html
+
+commit 6828b83435c30676185d675dc7b6054846606df0
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Tue Dec 13 17:25:31 2011 +0100
+
+    Updated Rakefile and setup.rb
+    
+    * Use gem package task supplied by rubygems
+    * Add coderay as development dependency
+    * Fix warning in setup.rb because of Config::CONFIG use
+
+Rakefile
+setup.rb
+
+commit bb7e82ce3f5213830fa6387e6c790a75b919dd38
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Tue Dec 13 17:23:51 2011 +0100
+
+    Fixed problem with different Array#delete_if internals on Ruby 1.9.3
+    
+    See http://redmine.ruby-lang.org/issues/5752
+
+lib/kramdown/parser/html.rb
+
+commit cd253a5e9d4dcfe55c12caf9257e4f1fb6113943
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sun Dec 11 15:40:35 2011 +0100
+
+    Fixed warnings on Ruby 1.9.3
+
+lib/kramdown/converter/html.rb
+lib/kramdown/parser/html.rb
+lib/kramdown/parser/kramdown.rb
+lib/kramdown/parser/kramdown/header.rb
+lib/kramdown/parser/kramdown/html.rb
+lib/kramdown/parser/kramdown/smart_quotes.rb
+test/test_files.rb
+
+commit e71cc414755e51c3336551e3f011f2f39ea601ee
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sun Dec 11 15:32:52 2011 +0100
+
+    Fixed test cases to correctly behave with new footnote rel output
+
+test/testcases/block/12_extension/options.html
+test/testcases/block/12_extension/options2.html
+test/testcases/block/14_table/table_with_footnote.html
+
+commit b3b2ebc233160f4f649f0d0aed070d7540781c4f
+Merge: a58ba5b ef70112
+Author: gettalong <t_leitner@gmx.at>
+Date:   Sun Dec 11 06:26:18 2011 -0800
+
+    Merge pull request #4 from joefiorini/master
+    
+    HTML5 Compatibility for Footnotes
+    
+    Replacing the rev='footnote' with rel='reference'.
+
+commit a58ba5b364081e896e2a49cc06db5aec643f8bb4
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sun Dec 11 12:38:37 2011 +0100
+
+    Fixed bug RF#29426: Content of <style> tags is treated as raw text now
+
+lib/kramdown/parser/html.rb
+test/testcases/block/09_html/parse_as_raw.html
+test/testcases/block/09_html/parse_as_raw.htmlinput
+test/testcases/block/09_html/parse_as_raw.text
+
+commit 14800a606565ff7d1759fea9815be1f9eff9b633
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sun Dec 11 12:27:52 2011 +0100
+
+    Fixed bug RF#29350: Parsing of HTML tags with mismatched case now works
+
+lib/kramdown/parser/html.rb
+lib/kramdown/parser/kramdown/html.rb
+test/test_files.rb
+test/testcases/block/09_html/parse_as_raw.htmlinput
+test/testcases/block/09_html/parse_as_raw.text
+test/testcases/block/09_html/parse_as_span.htmlinput
+test/testcases/block/09_html/parse_as_span.text
+test/testcases/block/09_html/parse_block_html.text
+test/testcases/span/05_html/normal.html
+test/testcases/span/05_html/normal.text
+
+commit b585efb3086c3462a573b57d060dfd203070bcc1
+Merge: 64a4e7e 3a72b72
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sat Sep 24 14:41:34 2011 +0200
+
+    Merge branch 'master' of github.com:gettalong/kramdown
+
+commit 3a72b72564d4f788fa1423dd8eb1089e355b0a4c
+Merge: e6c1b12 df5e705
+Author: gettalong <t_leitner@gmx.at>
+Date:   Sat Sep 24 05:28:10 2011 -0700
+
+    Merge pull request #5 from jacius/span
+    
+    span tags must have a separate closing tag to be valid HTML.
+
+commit e6c1b12fa45c7b3284c4b41247ade9ff4b4379a4
+Merge: 9188906 1270445
+Author: gettalong <t_leitner@gmx.at>
+Date:   Sat Sep 24 05:24:32 2011 -0700
+
+    Merge pull request #6 from postmodern/patch-1
+    
+    Fixed a typo. --output not --ouput
+
+commit 12704459192bdcbf9b02d1d90483c8d835f3e9f1
+Author: Postmodern <postmodern.mod3@gmail.com>
+Date:   Thu Aug 4 18:57:59 2011 -0700
+
+    Fixed a typo. --output not --ouput
+
+bin/kramdown
+
+commit df5e705ef41ca2c47b5b0d54509cdfb80c2d5f4d
+Author: John Croisant <jacius@gmail.com>
+Date:   Sun Jul 10 23:52:35 2011 -0500
+
+    span tags must have a separate closing tag to be valid HTML.
+    
+    "<span />" is invalid markup in HTML 4 and 5, but valid in XHTML.
+    "<span></span>" is valid in all three, so it should be used instead.
+
+lib/kramdown/converter/html.rb
+test/testcases/span/05_html/normal.html
+test/testcases/span/05_html/normal.text
+
+commit ef7011229e7d93c31c22468e5cfd797051ac280c
+Author: Joe Fiorini <joe@faithfulgeek.org>
+Date:   Wed May 11 02:08:38 2011 -0400
+
+    Replace rev attribute for HTML5 compatibility
+
+lib/kramdown/converter/html.rb
+test/testcases/span/04_footnote/footnote_nr.html
+test/testcases/span/04_footnote/markers.html
+
+commit 64a4e7e61da0d720ffd702fd6c45cefafc568d24
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Tue May 10 20:47:16 2011 +0200
+
+    Added a TOC converter
+    
+    The TOC converter can be used to get an element tree containing the
+    table of contents. Since it uses a custom element type the resulting
+    tree cannot be fed directly to any converter.
+
+doc/news/release_0_X_X.page
+lib/kramdown/converter.rb
+lib/kramdown/converter/toc.rb
+
+commit 5ed13d24d9375771e3a0bd0d4fbe779d0043563b
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Tue May 10 07:42:23 2011 +0200
+
+    Extracted Element class into own file and made some small doc fixes
+
+lib/kramdown/document.rb
+lib/kramdown/element.rb
+
 commit 91889069d843273d5847330cdce4b1068e74108f
 Author: Thomas Leitner <t_leitner@gmx.at>
 Date:   Fri May 6 15:39:50 2011 +0200

data/Rakefile

@@ -3,7 +3,7 @@
 # load all optional developer libraries
 begin
   require 'rubygems'
-  require 'rake/gempackagetask'
+  require 'rubygems/package_task'
 rescue LoadError
 end
 
@@ -196,6 +196,7 @@ EOF
       s.require_path = 'lib'
       s.executables = ['kramdown']
       s.default_executable = 'kramdown'
+      s.add_development_dependency 'coderay', '~> 1.0.0'
 
       #### Documentation
 
@@ -211,7 +212,7 @@ EOF
       s.rubyforge_project = 'kramdown'
     end
 
-    Rake::GemPackageTask.new(spec) do |pkg|
+    Gem::PackageTask.new(spec) do |pkg|
       pkg.need_zip = true
       pkg.need_tar = true
     end
@@ -233,7 +234,7 @@ EOF
       rf.configure
       rf.login
 
-      rf.userconfig["release_notes"] = REL_PAGE.blocks['content'].content.force_encoding('ASCII-8BIT')
+      rf.userconfig["release_notes"] = REL_PAGE.blocks['content'].content
       rf.userconfig["preformatted"] = false
 
       files = %w[.gem .tgz .zip].collect {|ext| "pkg/kramdown-#{Kramdown::VERSION}" + ext}

data/VERSION

@@ -1 +1 @@
-0.13.3
+0.13.4

data/bin/kramdown

@@ -35,7 +35,7 @@ OptionParser.new do |opts|
   opts.separator ""
 
   opts.on("-i", "--input ARG", "Specify the input format: kramdown (default) or html") {|v| options[:input] = v}
-  opts.on("-o", "--ouput ARG", "Specify the output format: html (default), kramdown or latex") {|v| format = v}
+  opts.on("-o", "--output ARG", "Specify the output format: html (default), kramdown or latex") {|v| format = v}
 
   opts.on("-v", "--version", "Show the version of kramdown") do
     puts Kramdown::VERSION

data/doc/index.page

@@ -90,7 +90,7 @@ It is probably the fastest pure-Ruby Markdown converter available (January 2011)
 faster than [Maruku] and about 5x faster than [BlueFeather].
 
 <p class="a-center">
-The latest version of kramdown is <b>0.13.3</b> and it was released on <b>2011-05-06</b>.
+The latest version of kramdown is <b>0.13.4</b> and it was released on <b>2011-12-16</b>.
 </p>
 
 [PHP Markdown Extra]: http://michelf.com/projects/php-markdown/extra/

data/doc/tests.page

@@ -46,7 +46,7 @@ different Ruby interpreters:
 ![ruby 1.8.7p249]({relocatable: img/graph-ruby-1.8.7-249.png})
 ![ruby 1.8.7p302]({relocatable: img/graph-ruby-1.8.7-302.png})
 ![ruby 1.9.2p136]({relocatable: img/graph-ruby-1.9.2p136-136.png})
-![jruby 1.6.0]({relocatable: img/graph-jruby-1.6.0-330.png})
+![ruby 1.9.3p0]({relocatable: img/graph-ruby-1.9.3p0-0.png})
 
 [Markdown Test Suite]: http://daringfireball.net/projects/downloads/MarkdownTest_1.0.zip
 [MDTest]: http://www.michelf.com/docs/projets/mdtest-1.0.zip

data/lib/kramdown/converter.rb

@@ -34,6 +34,7 @@ module Kramdown
     autoload :Html, 'kramdown/converter/html'
     autoload :Latex, 'kramdown/converter/latex'
     autoload :Kramdown, 'kramdown/converter/kramdown'
+    autoload :Toc, 'kramdown/converter/toc'
 
   end
 

data/lib/kramdown/converter/html.rb

@@ -45,7 +45,7 @@ module Kramdown
 
         # Highlighting via coderay is available if this constant is +true+.
         HIGHLIGHTING_AVAILABLE = true
-      rescue LoadError => e
+      rescue LoadError
         HIGHLIGHTING_AVAILABLE = false  # :nodoc:
       end
 
@@ -178,7 +178,7 @@ module Kramdown
       end
 
       # A list of all HTML tags that need to have a body (even if the body is empty).
-      HTML_TAGS_WITH_BODY=['div', 'script', 'iframe', 'textarea', 'a'] # :nodoc:
+      HTML_TAGS_WITH_BODY=['div', 'span', 'script', 'iframe', 'textarea', 'a'] # :nodoc:
 
       def convert_html_element(el, indent)
         res = inner(el, indent)
@@ -393,7 +393,7 @@ module Kramdown
           li.children = Marshal.load(Marshal.dump(data.children))
           ol.children << li
 
-          ref = Element.new(:raw, "<a href=\"#fnref:#{name}\" rev=\"footnote\">&#8617;</a>")
+          ref = Element.new(:raw, "<a href=\"#fnref:#{name}\" rel=\"reference\">&#8617;</a>")
           if li.children.last.type == :p
             para = li.children.last
           else

data/lib/kramdown/converter/toc.rb

@@ -0,0 +1,82 @@
+# -*- coding: utf-8 -*-
+#
+#--
+# Copyright (C) 2009-2010 Thomas Leitner <t_leitner@gmx.at>
+#
+# This file is part of kramdown.
+#
+# kramdown is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#++
+#
+
+require 'rexml/parsers/baseparser'
+
+module Kramdown
+
+  module Converter
+
+    # Converts a Kramdown::Document to an element tree that represents the table of contents.
+    #
+    # The returned tree consists of Element objects of type :toc where the root element is just used
+    # as container object. Each :toc element contains as value the wrapped :header element and under
+    # the attribute key :id the header ID that should be used (note that this ID may not exist in
+    # the wrapped element).
+    #
+    # Since the TOC tree consists of special :toc elements, one cannot directly feed this tree to
+    # other converters!
+    class Toc < Base
+
+      def initialize(root, options)
+        super
+        @toc = Element.new(:toc)
+        @stack = []
+        @options[:template] = ''
+      end
+
+      def convert(el)
+        if el.type == :header && in_toc?(el)
+          attr = el.attr.dup
+          attr['id'] = generate_id(el.options[:raw_text]) if @options[:auto_ids] && !attr['id']
+          add_to_toc(el, attr['id'], @toc) if attr['id']
+        else
+          el.children.each {|child| convert(child)}
+        end
+        @toc
+      end
+
+      private
+
+      def add_to_toc(el, id, toc)
+        toc_element = Element.new(:toc, el, :id => id)
+
+        success = false
+        while !success
+          if @stack.empty?
+            @toc.children << toc_element
+            @stack << toc_element
+            success = true
+          elsif @stack.last.value.options[:level] < el.options[:level]
+            @stack.last.children << toc_element
+            @stack << toc_element
+            success = true
+          else
+            @stack.pop
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/lib/kramdown/document.rb

@@ -23,6 +23,7 @@
 require 'kramdown/compatibility'
 
 require 'kramdown/version'
+require 'kramdown/element'
 require 'kramdown/error'
 require 'kramdown/parser'
 require 'kramdown/converter'
@@ -112,499 +113,5 @@ module Kramdown
 
   end
 
-
-  # Represents all elements in the element tree.
-  #
-  # kramdown only uses this one class for representing all available elements in an element tree
-  # (paragraphs, headers, emphasis, ...). The type of element can be set via the #type accessor.
-  #
-  # Following is a description of all supported element types.
-  #
-  # == Structural Elements
-  #
-  # === :root
-  #
-  # [Category] None
-  # [Usage context] As the root element of a document
-  # [Content model] Block-level elements
-  #
-  # Represents the root of a kramdown document.
-  #
-  # The root element contains the following option keys:
-  #
-  # :encoding:: When running on Ruby 1.9 this key has to be set to the encoding used for the text
-  #             parts of the kramdown document.
-  #
-  # :abbrev_defs:: This key may be used to store the mapping of abbreviation to abbreviation
-  #                definition.
-  #
-  #
-  # === :blank
-  #
-  # [Category] Block-level element
-  # [Usage context] Where block-level elements are expected
-  # [Content model] Empty
-  #
-  # Represents one or more blank lines. It is not allowed to have two or more consecutive blank
-  # elements.
-  #
-  # The +value+ field may contain the original content of the blank lines.
-  #
-  #
-  # === :p
-  #
-  # [Category] Block-level element
-  # [Usage context] Where block-level elements are expected
-  # [Content model] Span-level elements
-  #
-  # Represents a paragraph.
-  #
-  # If the option :transparent is +true+, this element just represents a block of text. I.e. this
-  # element just functions as a container for span-level elements.
-  #
-  #
-  # === :header
-  #
-  # [Category] Block-level element
-  # [Usage context] Where block-level elements are expected
-  # [Content model] Span-level elements
-  #
-  # Represents a header.
-  #
-  # The option :level specifies the header level and has to contain a number between 1 and \6. The
-  # option :raw_text has to contain the raw header text.
-  #
-  #
-  # === :blockquote
-  #
-  # [Category] Block-level element
-  # [Usage context] Where block-level elements are expected
-  # [Content model] Block-level elements
-  #
-  # Represents a blockquote.
-  #
-  #
-  # === :codeblock
-  #
-  # [Category] Block-level element
-  # [Usage context] Where block-level elements are expected
-  # [Content model] Empty
-  #
-  # Represents a code block, i.e. a block of text that should be used as-is.
-  #
-  # The +value+ field has to contain the content of the code block.
-  #
-  #
-  # === :ul
-  #
-  # [Category] Block-level element
-  # [Usage context] Where block-level elements are expected
-  # [Content model] One or more :li elements
-  #
-  # Represents an unordered list.
-  #
-  #
-  # === :ol
-  #
-  # [Category] Block-level element
-  # [Usage context] Where block-level elements are expected
-  # [Content model] One or more :li elements
-  #
-  # Represents an ordered list.
-  #
-  #
-  # === :li
-  #
-  # [Category] None
-  # [Usage context] Inside :ol and :ul elements
-  # [Content model] Block-level elements
-  #
-  # Represents a list item of an ordered or unordered list.
-  #
-  #
-  # === :dl
-  #
-  # [Category] Block-level element
-  # [Usage context] Where block-level elements are expected
-  # [Content model] One or more groups each consisting of one or more :dt elements followed by one
-  #                 or more :dd elements.
-  #
-  # Represents a definition list which contains groups consisting of terms and definitions for them.
-  #
-  #
-  # === :dt
-  #
-  # [Category] None
-  # [Usage context] Before :dt or :dd elements inside a :dl elment
-  # [Content model] Span-level elements
-  #
-  # Represents the term part of a term-definition group in a definition list.
-  #
-  #
-  # === :dd
-  #
-  # [Category] None
-  # [Usage context] After :dt or :dd elements inside a :dl elment
-  # [Content model] Block-level elements
-  #
-  # Represents the definition part of a term-definition group in a definition list.
-  #
-  #
-  # === :hr
-  #
-  # [Category] Block-level element
-  # [Usage context] Where block-level elements are expected
-  # [Content model] None
-  #
-  # Represents a horizontal line.
-  #
-  #
-  # === :table
-  #
-  # [Category] Block-level element
-  # [Usage context] Where block-level elements are expected
-  # [Content model] Zero or one :thead elements, one or more :tbody elements, zero or one :tfoot
-  #                 elements
-  #
-  # Represents a table. Each table row (i.e. :tr element) of the table has to contain the same
-  # number of :td elements.
-  #
-  # The option :alignment has to be an array containing the alignment values, exactly one for each
-  # column of the table. The possible alignment values are :left, :center, :right and :default.
-  #
-  #
-  # === :thead
-  #
-  # [Category] None
-  # [Usage context] As first element inside a :table element
-  # [Content model] One or more :tr elements
-  #
-  # Represents the table header.
-  #
-  #
-  # === :tbody
-  #
-  # [Category] None
-  # [Usage context] After a :thead element but before a :tfoot element inside a :table element
-  # [Content model] One or more :tr elements
-  #
-  # Represents a table body.
-  #
-  #
-  # === :tfoot
-  #
-  # [Category] None
-  # [Usage context] As last element inside a :table element
-  # [Content model] One or more :tr elements
-  #
-  # Represents the table footer.
-  #
-  #
-  # === :tr
-  #
-  # [Category] None
-  # [Usage context] Inside :thead, :tbody and :tfoot elements
-  # [Content model] One or more :td elements
-  #
-  # Represents a table row.
-  #
-  #
-  # === :td
-  #
-  # [Category] None
-  # [Usage context] Inside :tr elements
-  # [Content model] As child of :thead/:tr span-level elements, as child of :tbody/:tr and
-  #                 :tfoot/:tr block-level elements
-  #
-  # Represents a table cell.
-  #
-  #
-  # === :math
-  #
-  # [Category] Block/span-level element
-  # [Usage context] Where block/span-level elements are expected
-  # [Content model] None
-  #
-  # Represents mathematical text that is written in LaTeX.
-  #
-  # The +value+ field has to contain the actual mathematical text.
-  #
-  # The option :category has to be set to either :span or :block depending on the context where the
-  # element is used.
-  #
-  #
-  # == Text Markup Elements
-  #
-  # === :text
-  #
-  # [Category] Span-level element
-  # [Usage context] Where span-level elements are expected
-  # [Content model] None
-  #
-  # Represents text.
-  #
-  # The +value+ field has to contain the text itself.
-  #
-  #
-  # === :br
-  #
-  # [Category] Span-level element
-  # [Usage context] Where span-level elements are expected
-  # [Content model] None
-  #
-  # Represents a hard line break.
-  #
-  #
-  # === :a
-  #
-  # [Category] Span-level element
-  # [Usage context] Where span-level elements are expected
-  # [Content model] Span-level elements
-  #
-  # Represents a link to an URL.
-  #
-  # The attribute +href+ has to be set to the URL to which the link points. The attribute +title+
-  # optionally contains the title of the link.
-  #
-  #
-  # === :img
-  #
-  # [Category] Span-level element
-  # [Usage context] Where span-level elements are expected
-  # [Content model] None
-  #
-  # Represents an image.
-  #
-  # The attribute +src+ has to be set to the URL of the image. The attribute +alt+ has to contain a
-  # text description of the image. The attribute +title+ optionally contains the title of the image.
-  #
-  #
-  # === :codespan
-  #
-  # [Category] Span-level element
-  # [Usage context] Where span-level elements are expected
-  # [Content model] None
-  #
-  # Represents verbatim text.
-  #
-  # The +value+ field has to contain the content of the code span.
-  #
-  #
-  # === :footnote
-  #
-  # [Category] Span-level element
-  # [Usage context] Where span-level elements are expected
-  # [Content model] None
-  #
-  # Represents a footnote marker.
-  #
-  # The +value+ field has to contain an element whose children are the content of the footnote. The
-  # option :name has to contain a valid and unique footnote name. A valid footnote name consists of
-  # a word character or a digit and then optionally followed by other word characters, digits or
-  # dashes.
-  #
-  #
-  # === :em
-  #
-  # [Category] Span-level element
-  # [Usage context] Where span-level elements are expected
-  # [Content model] Span-level elements
-  #
-  # Represents emphasis of its contents.
-  #
-  #
-  # === :strong
-  #
-  # [Category] Span-level element
-  # [Usage context] Where span-level elements are expected
-  # [Content model] Span-level elements
-  #
-  # Represents strong importance for its contents.
-  #
-  #
-  # === :entity
-  #
-  # [Category] Span-level element
-  # [Usage context] Where span-level elements are expected
-  # [Content model] None
-  #
-  # Represents an HTML entity.
-  #
-  # The +value+ field has to contain an instance of Kramdown::Utils::Entities::Entity. The option
-  # :original can be used to store the original representation of the entity.
-  #
-  #
-  # === :typographic_sym
-  #
-  # [Category] Span-level element
-  # [Usage context] Where span-level elements are expected
-  # [Content model] None
-  #
-  # Represents a typographic symbol.
-  #
-  # The +value+ field needs to contain a Symbol representing the specific typographic symbol from
-  # the following list:
-  #
-  # :mdash:: An mdash character (---)
-  # :ndash:: An ndash character (--)
-  # :hellip:: An ellipsis (...)
-  # :laquo:: A left guillemet (<<)
-  # :raquo:: A right guillemet (>>)
-  # :laquo_space:: A left guillemet with a space (<< )
-  # :raquo_space:: A right guillemet with a space ( >>)
-  #
-  #
-  # === :smart_quote
-  #
-  # [Category] Span-level element
-  # [Usage context] Where span-level elements are expected
-  # [Content model] None
-  #
-  # Represents a quotation character.
-  #
-  # The +value+ field needs to contain a Symbol representing the specific quotation character:
-  #
-  # :lsquo:: Left single quote
-  # :rsquo:: Right single quote
-  # :ldquo:: Left double quote
-  # :rdquo:: Right double quote
-  #
-  #
-  # === :abbreviation
-  #
-  # [Category] Span-level element
-  # [Usage context] Where span-level elements are expected
-  # [Content model] None
-  #
-  # Represents a text part that is an abbreviation.
-  #
-  # The +value+ field has to contain the text part that is the abbreviation. The definition of the
-  # abbreviation is stored in the :root element of the document.
-  #
-  #
-  # == Other Elements
-  #
-  # === :html_element
-  #
-  # [Category] Block/span-level element
-  # [Usage context] Where block/span-level elements or raw HTML elements are expected
-  # [Content model] Depends on the element
-  #
-  # Represents an HTML element.
-  #
-  # The +value+ field has to contain the name of the HTML element the element is representing.
-  #
-  # The option :category has to be set to either :span or :block depending on the whether the
-  # element is a block-level or a span-level element. The option :content_model has to be set to the
-  # content model for the element (either :block if it contains block-level elements, :span if it
-  # contains span-level elements or :raw if it contains raw content).
-  #
-  #
-  # === :xml_comment
-  #
-  # [Category] Block/span-level element
-  # [Usage context] Where block/span-level elements are expected or in raw HTML elements
-  # [Content model] None
-  #
-  # Represents an XML/HTML comment.
-  #
-  # The +value+ field has to contain the whole XML/HTML comment including the delimiters.
-  #
-  # The option :category has to be set to either :span or :block depending on the context where the
-  # element is used.
-  #
-  #
-  # === :xml_pi
-  #
-  # [Category] Block/span-level element
-  # [Usage context] Where block/span-level elements are expected or in raw HTML elements
-  # [Content model] None
-  #
-  # Represents an XML/HTML processing instruction.
-  #
-  # The +value+ field has to contain the whole XML/HTML processing instruction including the
-  # delimiters.
-  #
-  # The option :category has to be set to either :span or :block depending on the context where the
-  # element is used.
-  #
-  #
-  # === :comment
-  #
-  # [Category] Block/span-level element
-  # [Usage context] Where block/span-level elements are expected
-  # [Content model] None
-  #
-  # Represents a comment.
-  #
-  # The +value+ field has to contain the comment.
-  #
-  # The option :category has to be set to either :span or :block depending on the context where the
-  # element is used.
-  #
-  #
-  # === :raw
-  #
-  # [Category] Block/span-level element
-  # [Usage context] Where block/span-level elements are expected
-  # [Content model] None
-  #
-  # Represents a raw string that should not be modified. For example, the element could contain some
-  # HTML code that should be output as-is without modification and escaping.
-  #
-  # The +value+ field has to contain the actual raw text.
-  #
-  # The option :category has to be set to either :span or :block depending on the context where the
-  # element is used. The option :type can be set to an array of strings to define for which
-  # converters the raw string is valid.
-  class Element
-
-    # A symbol representing the element type. For example, :p or :blockquote.
-    attr_accessor :type
-
-    # The value of the element. The interpretation of this field depends on the type of the element.
-    # Many elements don't use this field.
-    attr_accessor :value
-
-    # The child elements of this element.
-    attr_accessor :children
-
-
-    # Create a new Element object of type +type+. The optional parameters +value+, +attr+ and
-    # +options+ can also be set in this constructor for convenience.
-    def initialize(type, value = nil, attr = nil, options = nil)
-      @type, @value, @attr, @options = type, value, (Utils::OrderedHash.new.merge!(attr) if attr), options
-      @children = []
-    end
-
-    # The attributes of the element. Uses an Utils::OrderedHash to retain the insertion order.
-    def attr
-      @attr ||= Utils::OrderedHash.new
-    end
-
-    # The options hash for the element. It is used for storing arbitray options.
-    def options
-      @options ||= {}
-    end
-
-    def inspect #:nodoc:
-      "<kd:#{@type}#{@value.nil? ? '' : ' ' + @value.inspect} #{@attr.inspect}#{options.empty? ? '' : ' ' + @options.inspect}#{@children.empty? ? '' : ' ' + @children.inspect}>"
-    end
-
-    CATEGORY = {} # :nodoc:
-    [:blank, :p, :header, :blockquote, :codeblock, :ul, :ol, :dl, :table, :hr].each {|b| CATEGORY[b] = :block}
-    [:text, :a, :br, :img, :codespan, :footnote, :em, :strong, :entity, :typographic_sym,
-     :smart_quote, :abbreviation].each {|b| CATEGORY[b] = :span}
-
-    # Return the category of +el+ which can be :block, :span or +nil+.
-    #
-    # Most elements have a fixed category, however, some elements can either appear in a block-level
-    # or a span-level context. These elements need to have the option :category correctly set.
-    def self.category(el)
-      CATEGORY[el.type] || el.options[:category]
-    end
-
-  end
-
 end