class Kramdown::Converter::Html
HTML element.
The return value of such a method has to be a string containing the element el
formatted as
block-level elements).
[indent
] A number representing the current amount of spaces for indent (only used for
[el
] The element of type NAME
to be converted.convert_NAME
methods. Each such method takes the following parameters:
You can customize the HTML converter by sub-classing it and overriding the
Converts a Kramdown::Document to HTML.
def convert(el, indent = -@indent)
Dispatch the conversion of the element +el+ to a convert_TYPE method using the
def convert(el, indent = -@indent) send(DISPATCHER[el.type], el, indent) end
def convert_a(el, indent)
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_abbreviation(el, indent)
def convert_abbreviation(el, indent) title = @root.options[:abbrev_defs][el.value] "<abbr#{!title.empty? ? " title=\"#{title}\"" : ''}>#{el.value}</abbr>" end
def convert_blank(el, indent)
def convert_blank(el, indent) "\n" end
def convert_blockquote(el, indent)
def convert_blockquote(el, indent) "#{' '*indent}<blockquote#{html_attributes(el.attr)}>\n#{inner(el, indent)}#{' '*indent}</blockquote>\n" end
def convert_br(el, indent)
def convert_br(el, indent) "<br />" end
def convert_codeblock(el, indent)
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}\">⋅</span>" end end.join('') end end "#{' '*indent}<pre#{html_attributes(el.attr)}><code>#{result}\n</code></pre>\n" end end
def convert_codespan(el, indent)
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_comment(el, indent)
def convert_comment(el, indent) if el.options[:category] == :block "#{' '*indent}<!-- #{el.value} -->\n" else "<!-- #{el.value} -->" end end
def convert_dt(el, indent)
def convert_dt(el, indent) "#{' '*indent}<dt#{html_attributes(el.attr)}>#{inner(el, indent)}</dt>\n" end
def convert_em(el, indent)
def convert_em(el, indent) "<#{el.type}#{html_attributes(el.attr)}>#{inner(el, indent)}</#{el.type}>" end
def convert_entity(el, indent)
def convert_entity(el, indent) entity_to_str(el.value, el.options[:original]) end
def convert_footnote(el, indent)
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_header(el, indent)
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)
def convert_hr(el, indent) "#{' '*indent}<hr />\n" end
def convert_html_element(el, indent)
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_img(el, indent)
def convert_img(el, indent) "<img#{html_attributes(el.attr)} />" end
def convert_li(el, indent)
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
def convert_math(el, indent)
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_p(el, indent)
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_raw(el, indent)
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_root(el, indent)
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
def convert_smart_quote(el, indent)
def convert_smart_quote(el, indent) entity_to_str(smart_quote_entity(el)) end
def convert_table(el, indent)
def convert_table(el, indent) if el.options[:alignment].all? {|a| a == :default} alignment = '' else alignment = el.options[:alignment].map do |a| "#{' '*(indent + @indent)}" << (a == :default ? "<col />" : "<col align=\"#{a}\" />") << "\n" end.join('') end "#{' '*indent}<table#{html_attributes(el.attr)}>\n#{alignment}#{inner(el, indent)}#{' '*indent}</table>\n" end
def convert_td(el, indent)
def convert_td(el, indent) res = inner(el, indent) type = (@stack[-2].type == :thead ? :th : :td) "#{' '*indent}<#{type}#{html_attributes(el.attr)}>#{res.empty? ? entity_to_str(ENTITY_NBSP) : res}</#{type}>\n" end
def convert_text(el, indent)
def convert_text(el, indent) escape_html(el.value, :text) end
def convert_thead(el, indent)
def convert_thead(el, indent) "#{' '*indent}<#{el.type}#{html_attributes(el.attr)}>\n#{inner(el, indent)}#{' '*indent}</#{el.type}>\n" end
def convert_typographic_sym(el, indent)
def convert_typographic_sym(el, indent) TYPOGRAPHIC_SYMS[el.value].map {|e| entity_to_str(e)}.join('') end
def convert_ul(el, indent)
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
def convert_xml_comment(el, indent)
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
def footnote_content
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}\" rev=\"footnote\">↩</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
def generate_toc_tree(toc, type, attr)
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
def initialize(root, options)
def initialize(root, options) super @footnote_counter = @footnote_start = @options[:footnote_nr] @footnotes = [] @toc = [] @toc_code = nil @indent = 2 @stack = [] end
def inner(el, indent)
Pushes +el+ onto the @stack before converting the child elements and pops it from
to be the amount of indentation used for the element +el+.
Return the converted content of the children of +el+ as a string. The parameter +indent+ has
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 obfuscate(text)
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