gitdown 0.0.1

data/doc/tests.page

@@ -0,0 +1,52 @@
+---
+title: Tests and Benchmark
+---
+
+# Tests
+
+There exist several test suites for testing the correctness of a Markdown implementation. The
+original [Markdown Test Suite] is the standard which one needs to test against. The [PHP Markdown
+suite][MDTest] contains the original test suite and several more tests (some specifically geared
+towards the extension of the PHP Markdown Extra package). I have used the latter test tool to
+roughly verify that kramdown is able to parse standard Markdown. However, since the syntax used by
+kramdown varies slightly from standard Markdown most of the tests fail - which is fine. When looking
+at the differences one can see that the failures result from these differences.
+
+Besides using the above mentioned test suite kramdown comes with its own set of tests which is used
+to verify that the implementation matches the kramdown specification.
+
+If you believe you have found a bug in the implementation, please follow these steps:
+
+* Check the syntax page and see if the behaviour is not intended.
+
+* If the behaviour is not intended and it seems that kramdown should parse some text in another
+  fashion, please open a bug report and attach two files: one with the text and one with the HTML
+  conversion you think is correct.
+
+
+# Benchmark
+
+kramdown comes with a small benchmark to test how fast it is in regard to four other Ruby Markdown
+implementations: Maruku, BlueFeather, BlueCloth and RDiscount. The first two are written using only
+Ruby, the latter two use the C discount library for the actual hard work (which makes them really
+fast but they do not provide additional syntax elements). As one can see below, kramdown is
+currently (November 2010) ~3-4x faster than Maruku, ~4-5x faster than BlueFeather but ~30x slower
+than BlueCloth and rdiscount:
+
+<pre><code>
+{execute_cmd: {command: "ruby -Ilib -rubygems benchmark/benchmark.rb", process_output: false, escape_html: true}}
+</code>
+</pre>
+
+And here are some graphs which show the execution times of the various kramdown releases on
+different Ruby interpreters:
+
+![ruby 1.8.5p231]({relocatable: img/graph-ruby-1.8.5-231.png})
+![ruby 1.8.6p399]({relocatable: img/graph-ruby-1.8.6-399.png})
+![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})
+![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/doc/virtual

@@ -0,0 +1,2 @@
+rdoc/index.html:
+  title: API Documentation

data/lib/kramdown.rb

@@ -0,0 +1,23 @@
+# -*- 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 'kramdown/document'

data/lib/kramdown/compatibility.rb

@@ -0,0 +1,35 @@
+# -*- 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/>.
+#++
+#
+# All the code in this file is backported from Ruby 1.8.7 sothat kramdown works under 1.8.5
+#
+# :stopdoc:
+
+if RUBY_VERSION == '1.8.5'
+  require 'rexml/parsers/baseparser'
+  module REXML
+    module Parsers
+      class BaseParser
+        UNAME_STR= "(?:#{NCNAME_STR}:)?#{NCNAME_STR}"
+      end
+    end
+  end
+end

data/lib/kramdown/converter.rb

@@ -0,0 +1,41 @@
+# -*- 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/>.
+#++
+#
+
+module Kramdown
+
+  # This module contains all available converters, i.e. classes that take a root Element and convert
+  # it to a specific output format. The result is normally a string. For example, the
+  # Converter::Html module converts an element tree into valid HTML.
+  #
+  # Converters use the Base class for common functionality (like applying a template to the output)
+  # \- see its API documentation for how to create a custom converter class.
+  module Converter
+
+    autoload :Base, 'kramdown/converter/base'
+    autoload :Html, 'kramdown/converter/html'
+    autoload :Latex, 'kramdown/converter/latex'
+    autoload :Kramdown, 'kramdown/converter/kramdown'
+    autoload :Toc, 'kramdown/converter/toc'
+
+  end
+
+end

data/lib/kramdown/converter/base.rb

@@ -0,0 +1,169 @@
+# -*- 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 'erb'
+
+module Kramdown
+
+  module Converter
+
+    # == \Base class for converters
+    #
+    # This class serves as base class for all converters. It provides methods that can/should be
+    # used by all converters (like #generate_id) as well as common functionality that is
+    # automatically applied to the result (for example, embedding the output into a template).
+    #
+    # A converter object is used as a throw-away object, i.e. it is only used for storing the needed
+    # state information during conversion. Therefore one can't instantiate a converter object
+    # directly but only use the Base::convert method.
+    #
+    # == Implementing a converter
+    #
+    # Implementing a new converter is rather easy: just derive a new class from this class and put
+    # it in the Kramdown::Converter module (the latter is only needed if auto-detection should work
+    # properly). Then you need to implement the #convert method which has to contain the conversion
+    # code for converting an element and has to return the conversion result.
+    #
+    # The actual transformation of the document tree can be done in any way. However, writing one
+    # method per element type is a straight forward way to do it - this is how the Html and Latex
+    # converters do the transformation.
+    #
+    # Have a look at the Base::convert method for additional information!
+    class Base
+
+      # Can be used by a converter for storing arbitrary information during the conversion process.
+      attr_reader :data
+
+      # The hash with the conversion options.
+      attr_reader :options
+
+      # The root element that is converted.
+      attr_reader :root
+
+      # The warnings array.
+      attr_reader :warnings
+
+      # Initialize the converter with the given +root+ element and +options+ hash.
+      def initialize(root, options)
+        @options = options
+        @root = root
+        @data = {}
+        @warnings = []
+      end
+      private_class_method(:new, :allocate)
+
+      # Convert the element tree +tree+ and return the resulting conversion object (normally a
+      # string) and an array with warning messages. The parameter +options+ specifies the conversion
+      # options that should be used.
+      #
+      # Initializes a new instance of the calling class and then calls the #convert method with
+      # +tree+ as parameter. If the +template+ option is specified and non-empty, the result is
+      # rendered into the specified template. The template resolution is done in the following way:
+      #
+      # 1. Look in the current working directory for the template.
+      #
+      # 2. Append +.convertername+ (e.g. +.html+) to the template name and look for the resulting
+      #    file in the current working directory.
+      #
+      # 3. Append +.convertername+ to the template name and look for it in the kramdown data
+      #    directory.
+      def self.convert(tree, options = {})
+        converter = new(tree, ::Kramdown::Options.merge(options.merge(tree.options[:options] || {})))
+        result = converter.convert(tree)
+        result = apply_template(converter, result) if !converter.options[:template].empty?
+        [result, converter.warnings]
+      end
+
+      # Convert the element +el+ and return the resulting object.
+      #
+      # This is the only method that has to be implemented by sub-classes!
+      def convert(el)
+        raise NotImplementedError
+      end
+
+      # Apply the +template+ using +body+ as the body string.
+      def self.apply_template(converter, body) # :nodoc:
+        erb = ERB.new(get_template(converter.options[:template]))
+        obj = Object.new
+        obj.instance_variable_set(:@converter, converter)
+        obj.instance_variable_set(:@body, body)
+        erb.result(obj.instance_eval{binding})
+      end
+
+      # Return the template specified by +template+.
+      def self.get_template(template) # :nodoc:
+        format_ext = '.' + self.name.split(/::/).last.downcase
+        shipped = File.join(::Kramdown.data_dir, template + format_ext)
+        if File.exist?(template)
+          File.read(template)
+        elsif File.exist?(template + format_ext)
+          File.read(template + format_ext)
+        elsif File.exist?(shipped)
+          File.read(shipped)
+        else
+          raise "The specified template file #{template} does not exist"
+        end
+      end
+
+      # Add the given warning +text+ to the warning array.
+      def warning(text)
+        @warnings << text
+      end
+
+      # Return +true+ if the header element +el+ should be used for the table of contents (as
+      # specified by the +toc_levels+ option).
+      def in_toc?(el)
+        @options[:toc_levels].include?(el.options[:level])
+      end
+
+      # Generate an unique alpha-numeric ID from the the string +str+ for use as a header ID.
+      #
+      # Uses the option +auto_id_prefix+: the value of this option is prepended to every generated
+      # ID.
+      def generate_id(str)
+        gen_id = str.gsub(/^[^a-zA-Z]+/, '')
+        gen_id.tr!('^a-zA-Z0-9 -', '')
+        gen_id.tr!(' ', '-')
+        gen_id.downcase!
+        gen_id = 'section' if gen_id.length == 0
+        @used_ids ||= {}
+        if @used_ids.has_key?(gen_id)
+          gen_id += '-' << (@used_ids[gen_id] += 1).to_s
+        else
+          @used_ids[gen_id] = 0
+        end
+        @options[:auto_id_prefix] + gen_id
+      end
+
+      SMART_QUOTE_INDICES = {:lsquo => 0, :rsquo => 1, :ldquo => 2, :rdquo => 3} # :nodoc:
+
+      # Return the entity that represents the given smart_quote element.
+      def smart_quote_entity(el)
+        res = @options[:smart_quotes][SMART_QUOTE_INDICES[el.value]]
+        ::Kramdown::Utils::Entities.entity(res)
+      end
+
+    end
+
+  end
+
+end

data/lib/kramdown/converter/html.rb

@@ -0,0 +1,410 @@
+# -*- 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 HTML.
+    #
+    # You can customize the HTML converter by sub-classing it and overriding the +convert_NAME+
+    # methods. Each such method takes the following parameters:
+    #
+    # [+el+] The element of type +NAME+ to be converted.
+    #
+    # [+indent+] A number representing the current amount of spaces for indent (only used for
+    #            block-level elements).
+    #
+    # The return value of such a method has to be a string containing the element +el+ formatted as
+    # HTML element.
+    class Html < Base
+
+      begin
+        require 'coderay'
+
+        # Highlighting via coderay is available if this constant is +true+.
+        HIGHLIGHTING_AVAILABLE = true
+      rescue LoadError
+        HIGHLIGHTING_AVAILABLE = false  # :nodoc:
+      end
+
+      include ::Kramdown::Utils::Html
+
+
+      # The amount of indentation used when nesting HTML tags.
+      attr_accessor :indent
+
+      # Initialize the HTML converter with the given Kramdown document +doc+.
+      def initialize(root, options)
+        super
+        @footnote_counter = @footnote_start = @options[:footnote_nr]
+        @footnotes = []
+        @toc = []
+        @toc_code = nil
+        @indent = 2
+        @stack = []
+      end
+
+      # The mapping of element type to conversion method.
+      DISPATCHER = Hash.new {|h,k| h[k] = "convert_#{k}"}
+
+      # Dispatch the conversion of the element +el+ to a +convert_TYPE+ method using the +type+ of
+      # the element.
+      def convert(el, indent = -@indent)
+        send(DISPATCHER[el.type], el, indent)
+      end
+
+      # Return the converted content of the children of +el+ as a string. The parameter +indent+ has
+      # to be the amount of indentation used for the element +el+.
+      #
+      # Pushes +el+ onto the @stack before converting the child elements and pops it from the stack
+      # afterwards.
+      def inner(el, indent)
+        result = ''
+        indent += @indent
+        @stack.push(el)
+        el.children.each do |inner_el|
+          result << send(DISPATCHER[inner_el.type], inner_el, indent)
+        end
+        @stack.pop
+        result
+      end
+
+      def convert_blank(el, indent)
+        "\n"
+      end
+
+      def convert_text(el, indent)
+        escape_html(el.value, :text)
+      end
+
+      def convert_p(el, indent)
+        if el.options[:transparent]
+          inner(el, indent)
+        else
+          "#{' '*indent}<p#{html_attributes(el.attr)}>#{inner(el, indent)}</p>\n"
+        end
+      end
+
+      def convert_codeblock(el, indent)
+        if el.attr['lang'] && HIGHLIGHTING_AVAILABLE
+          attr = el.attr.dup
+          opts = {:wrap => @options[:coderay_wrap], :line_numbers => @options[:coderay_line_numbers],
+            :line_number_start => @options[:coderay_line_number_start], :tab_width => @options[:coderay_tab_width],
+            :bold_every => @options[:coderay_bold_every], :css => @options[:coderay_css]}
+          result = CodeRay.scan(el.value, attr.delete('lang').to_sym).html(opts).chomp << "\n"
+          "#{' '*indent}<div#{html_attributes(attr)}>#{result}#{' '*indent}</div>\n"
+        else
+          result = escape_html(el.value)
+          result.chomp!
+          if el.attr['class'].to_s =~ /\bshow-whitespaces\b/
+            result.gsub!(/(?:(^[ \t]+)|([ \t]+$)|([ \t]+))/) do |m|
+              suffix = ($1 ? '-l' : ($2 ? '-r' : ''))
+              m.scan(/./).map do |c|
+                case c
+                when "\t" then "<span class=\"ws-tab#{suffix}\">\t</span>"
+                when " " then "<span class=\"ws-space#{suffix}\">&#8901;</span>"
+                end
+              end.join('')
+            end
+          end
+          "#{' '*indent}<pre#{html_attributes(el.attr)}><code>#{result}\n</code></pre>\n"
+        end
+      end
+
+      def convert_blockquote(el, indent)
+        "#{' '*indent}<blockquote#{html_attributes(el.attr)}>\n#{inner(el, indent)}#{' '*indent}</blockquote>\n"
+      end
+
+      def convert_header(el, indent)
+        attr = el.attr.dup
+        if @options[:auto_ids] && !attr['id']
+          attr['id'] = generate_id(el.options[:raw_text])
+        end
+        @toc << [el.options[:level], attr['id'], el.children] if attr['id'] && in_toc?(el)
+        "#{' '*indent}<h#{el.options[:level]}#{html_attributes(attr)}>#{inner(el, indent)}</h#{el.options[:level]}>\n"
+      end
+
+      def convert_hr(el, indent)
+        "#{' '*indent}<hr />\n"
+      end
+
+      def convert_ul(el, indent)
+        if !@toc_code && (el.options[:ial][:refs].include?('toc') rescue nil) && (el.type == :ul || el.type == :ol)
+          @toc_code = [el.type, el.attr, (0..128).to_a.map{|a| rand(36).to_s(36)}.join]
+          @toc_code.last
+        else
+          "#{' '*indent}<#{el.type}#{html_attributes(el.attr)}>\n#{inner(el, indent)}#{' '*indent}</#{el.type}>\n"
+        end
+      end
+      alias :convert_ol :convert_ul
+      alias :convert_dl :convert_ul
+
+      def convert_li(el, indent)
+        output = ' '*indent << "<#{el.type}" << html_attributes(el.attr) << ">"
+        res = inner(el, indent)
+        if el.children.empty? || (el.children.first.type == :p && el.children.first.options[:transparent])
+          output << res << (res =~ /\n\Z/ ? ' '*indent : '')
+        else
+          output << "\n" << res << ' '*indent
+        end
+        output << "</#{el.type}>\n"
+      end
+      alias :convert_dd :convert_li
+
+      def convert_dt(el, indent)
+        "#{' '*indent}<dt#{html_attributes(el.attr)}>#{inner(el, indent)}</dt>\n"
+      end
+
+      # A list of all HTML tags that need to have a body (even if the body is empty).
+      HTML_TAGS_WITH_BODY=['div', 'span', 'script', 'iframe', 'textarea', 'a'] # :nodoc:
+
+      def convert_html_element(el, indent)
+        res = inner(el, indent)
+        if el.options[:category] == :span
+          "<#{el.value}#{html_attributes(el.attr)}" << (!res.empty? || HTML_TAGS_WITH_BODY.include?(el.value) ? ">#{res}</#{el.value}>" : " />")
+        else
+          output = ''
+          output << ' '*indent if @stack.last.type != :html_element || @stack.last.options[:content_model] != :raw
+          output << "<#{el.value}#{html_attributes(el.attr)}"
+          if !res.empty? && el.options[:content_model] != :block
+            output << ">#{res}</#{el.value}>"
+          elsif !res.empty?
+            output << ">\n#{res.chomp}\n"  << ' '*indent << "</#{el.value}>"
+          elsif HTML_TAGS_WITH_BODY.include?(el.value)
+            output << "></#{el.value}>"
+          else
+            output << " />"
+          end
+          output << "\n" if @stack.last.type != :html_element || @stack.last.options[:content_model] != :raw
+          output
+        end
+      end
+
+      def convert_xml_comment(el, indent)
+        if el.options[:category] == :block && (@stack.last.type != :html_element || @stack.last.options[:content_model] != :raw)
+          ' '*indent << el.value << "\n"
+        else
+          el.value
+        end
+      end
+      alias :convert_xml_pi :convert_xml_comment
+
+      def convert_table(el, indent)
+        "#{' '*indent}<table#{html_attributes(el.attr)}>\n#{inner(el, indent)}#{' '*indent}</table>\n"
+      end
+
+      def convert_thead(el, indent)
+        "#{' '*indent}<#{el.type}#{html_attributes(el.attr)}>\n#{inner(el, indent)}#{' '*indent}</#{el.type}>\n"
+      end
+      alias :convert_tbody :convert_thead
+      alias :convert_tfoot :convert_thead
+      alias :convert_tr  :convert_thead
+
+      ENTITY_NBSP = ::Kramdown::Utils::Entities.entity('nbsp') # :nodoc:
+
+      def convert_td(el, indent)
+        res = inner(el, indent)
+        type = (@stack[-2].type == :thead ? :th : :td)
+        attr = el.attr
+        alignment = @stack[-3].options[:alignment][@stack.last.children.index(el)]
+        if alignment != :default
+          attr = el.attr.dup
+          attr['style'] = (attr.has_key?('style') ? "#{attr['style']}; ": '') << "text-align: #{alignment}"
+        end
+        "#{' '*indent}<#{type}#{html_attributes(attr)}>#{res.empty? ? entity_to_str(ENTITY_NBSP) : res}</#{type}>\n"
+      end
+
+      def convert_comment(el, indent)
+        if el.options[:category] == :block
+          "#{' '*indent}<!-- #{el.value} -->\n"
+        else
+          "<!-- #{el.value} -->"
+        end
+      end
+
+      def convert_br(el, indent)
+        "<br />"
+      end
+
+      def convert_a(el, indent)
+        res = inner(el, indent)
+        attr = el.attr.dup
+        if attr['href'] =~ /^mailto:/
+          attr['href'] = obfuscate('mailto') << ":" << obfuscate(attr['href'].sub(/^mailto:/, ''))
+          res = obfuscate(res)
+        end
+        "<a#{html_attributes(attr)}>#{res}</a>"
+      end
+
+      def convert_img(el, indent)
+        "<img#{html_attributes(el.attr)} />"
+      end
+
+      def convert_codespan(el, indent)
+        if el.attr['lang'] && HIGHLIGHTING_AVAILABLE
+          attr = el.attr.dup
+          result = CodeRay.scan(el.value, attr.delete('lang').to_sym).html(:wrap => :span, :css => @options[:coderay_css]).chomp
+          "<code#{html_attributes(attr)}>#{result}</code>"
+        else
+          "<code#{html_attributes(el.attr)}>#{escape_html(el.value)}</code>"
+        end
+      end
+
+      def convert_footnote(el, indent)
+        number = @footnote_counter
+        @footnote_counter += 1
+        @footnotes << [el.options[:name], el.value]
+        "<sup id=\"fnref:#{el.options[:name]}\"><a href=\"#fn:#{el.options[:name]}\" rel=\"footnote\">#{number}</a></sup>"
+      end
+
+      def convert_raw(el, indent)
+        if !el.options[:type] || el.options[:type].empty? || el.options[:type].include?('html')
+          el.value + (el.options[:category] == :block ? "\n" : '')
+        else
+          ''
+        end
+      end
+
+      def convert_em(el, indent)
+        "<#{el.type}#{html_attributes(el.attr)}>#{inner(el, indent)}</#{el.type}>"
+      end
+      alias :convert_strong :convert_em
+
+      def convert_entity(el, indent)
+        entity_to_str(el.value, el.options[:original])
+      end
+
+      TYPOGRAPHIC_SYMS = {
+        :mdash => [::Kramdown::Utils::Entities.entity('mdash')],
+        :ndash => [::Kramdown::Utils::Entities.entity('ndash')],
+        :hellip => [::Kramdown::Utils::Entities.entity('hellip')],
+        :laquo_space => [::Kramdown::Utils::Entities.entity('laquo'), ::Kramdown::Utils::Entities.entity('nbsp')],
+        :raquo_space => [::Kramdown::Utils::Entities.entity('nbsp'), ::Kramdown::Utils::Entities.entity('raquo')],
+        :laquo => [::Kramdown::Utils::Entities.entity('laquo')],
+        :raquo => [::Kramdown::Utils::Entities.entity('raquo')]
+      } # :nodoc:
+      def convert_typographic_sym(el, indent)
+        TYPOGRAPHIC_SYMS[el.value].map {|e| entity_to_str(e)}.join('')
+      end
+
+      def convert_smart_quote(el, indent)
+        entity_to_str(smart_quote_entity(el))
+      end
+
+      def convert_math(el, indent)
+        block = (el.options[:category] == :block)
+        "<script type=\"math/tex#{block ? '; mode=display' : ''}\">#{el.value}</script>#{block ? "\n" : ''}"
+      end
+
+      def convert_abbreviation(el, indent)
+        title = @root.options[:abbrev_defs][el.value]
+        "<abbr#{!title.empty? ? " title=\"#{title}\"" : ''}>#{el.value}</abbr>"
+      end
+
+      def convert_root(el, indent)
+        result = inner(el, indent)
+        result << footnote_content
+        if @toc_code
+          toc_tree = generate_toc_tree(@toc, @toc_code[0], @toc_code[1] || {})
+          text = if toc_tree.children.size > 0
+                   convert(toc_tree, 0)
+                 else
+                   ''
+                 end
+          result.sub!(/#{@toc_code.last}/, text)
+        end
+        result
+      end
+
+      # Generate and return an element tree for the table of contents.
+      def generate_toc_tree(toc, type, attr)
+        sections = Element.new(type, nil, attr)
+        sections.attr['id'] ||= 'markdown-toc'
+        stack = []
+        toc.each do |level, id, children|
+          li = Element.new(:li, nil, nil, {:level => level})
+          li.children << Element.new(:p, nil, nil, {:transparent => true})
+          a = Element.new(:a, nil, {'href' => "##{id}"})
+          a.children.concat(children)
+          li.children.last.children << a
+          li.children << Element.new(type)
+
+          success = false
+          while !success
+            if stack.empty?
+              sections.children << li
+              stack << li
+              success = true
+            elsif stack.last.options[:level] < li.options[:level]
+              stack.last.children.last.children << li
+              stack << li
+              success = true
+            else
+              item = stack.pop
+              item.children.pop unless item.children.last.children.size > 0
+            end
+          end
+        end
+        while !stack.empty?
+          item = stack.pop
+          item.children.pop unless item.children.last.children.size > 0
+        end
+        sections
+      end
+
+      # Obfuscate the +text+ by using HTML entities.
+      def obfuscate(text)
+        result = ""
+        text.each_byte do |b|
+          result << (b > 128 ? b.chr : "&#%03d;" % b)
+        end
+        result.force_encoding(text.encoding) if RUBY_VERSION >= '1.9'
+        result
+      end
+
+      # Return a HTML ordered list with the footnote content for the used footnotes.
+      def footnote_content
+        ol = Element.new(:ol)
+        ol.attr['start'] = @footnote_start if @footnote_start != 1
+        @footnotes.each do |name, data|
+          li = Element.new(:li, nil, {'id' => "fn:#{name}"})
+          li.children = Marshal.load(Marshal.dump(data.children))
+          ol.children << li
+
+          ref = Element.new(:raw, "<a href=\"#fnref:#{name}\" rel=\"reference\">&#8617;</a>")
+          if li.children.last.type == :p
+            para = li.children.last
+          else
+            li.children << (para = Element.new(:p))
+          end
+          para.children << ref
+        end
+        (ol.children.empty? ? '' : "<div class=\"footnotes\">\n#{convert(ol, 2)}</div>\n")
+      end
+
+    end
+
+  end
+end