class RDoc::Markup::ToHtml

Outputs RDoc markup as HTML.

Public Class Methods

new(options, markup = nil) click to toggle source

Creates a new formatter that will output HTML

Calls superclass method RDoc::Markup::Formatter.new
# File lib/rdoc/markup/to_html.rb, line 45
def initialize options, markup = nil
  super

  @code_object = nil
  @from_path = ''
  @in_list_entry = nil
  @list = nil
  @th = nil
  @hard_break = "<br>\n"

  # external links
  @markup.add_special(/(?:link:|https?:|mailto:|ftp:|irc:|www\.)\S+\w/,
                      :HYPERLINK)

  add_special_RDOCLINK
  add_special_TIDYLINK

  init_tags
end

Special Handling

↑ top

Public Instance Methods

handle_special_HARD_BREAK(special) click to toggle source

special is a

# File lib/rdoc/markup/to_html.rb, line 96
def handle_special_HARD_BREAK special
  '<br>'
end

Utilities

↑ top

Constants

LIST_TYPE_TO_HTML

Maps RDoc::Markup::Parser::LIST_TOKENS types to HTML tags

Attributes

code_object[RW]

The RDoc::CodeObject HTML is being generated for. This is used to generate namespaced URI fragments

from_path[RW]

Path to this document for relative links

Public Instance Methods

convert_string(text) click to toggle source

CGI-escapes text

# File lib/rdoc/markup/to_html.rb, line 307
def convert_string(text)
  CGI.escapeHTML text
end
gen_url(url, text) click to toggle source

Generate a link to url with content text. Handles the special cases for img: and link: described under #handle_special_HYPERLINK

# File lib/rdoc/markup/to_html.rb, line 315
def gen_url url, text
  scheme, url, id = parse_url url

  if %w[http https link].include?(scheme) and
     url =~ /\.(gif|png|jpg|jpeg|bmp)$/ then
    "<img src=\"#{url}\" />"
  else
    text = text.sub %r%^#{scheme}:/*%i, ''
    text = text.sub %r%^[*\^](\d+)$%,   '\1'

    link = "<a#{id} href=\"#{url}\">#{text}</a>"

    link = "<sup>#{link}</sup>" if /"foot/ =~ id

    link
  end
end
html_list_name(list_type, open_tag) click to toggle source

Determines the HTML list element for list_type and open_tag

# File lib/rdoc/markup/to_html.rb, line 336
def html_list_name(list_type, open_tag)
  tags = LIST_TYPE_TO_HTML[list_type]
  raise RDoc::Error, "Invalid list type: #{list_type.inspect}" unless tags
  tags[open_tag ? 0 : 1]
end
init_tags() click to toggle source

Maps attributes to HTML tags

# File lib/rdoc/markup/to_html.rb, line 345
def init_tags
  add_tag :BOLD, "<strong>", "</strong>"
  add_tag :TT,   "<code>",   "</code>"
  add_tag :EM,   "<em>",     "</em>"
end
list_end_for(list_type) click to toggle source

Returns the HTML end-tag for list_type

# File lib/rdoc/markup/to_html.rb, line 371
def list_end_for(list_type)
  case list_type
  when :BULLET, :LALPHA, :NUMBER, :UALPHA then
    "</li>"
  when :LABEL, :NOTE then
    "</dd>"
  else
    raise RDoc::Error, "Invalid list type: #{list_type.inspect}"
  end
end
list_item_start(list_item, list_type) click to toggle source

Returns the HTML tag for list_type, possible using a label from list_item

# File lib/rdoc/markup/to_html.rb, line 355
def list_item_start(list_item, list_type)
  case list_type
  when :BULLET, :LALPHA, :NUMBER, :UALPHA then
    "<li>"
  when :LABEL, :NOTE then
    Array(list_item.label).map do |label|
      "<dt>#{to_html label}\n"
    end.join << "<dd>"
  else
    raise RDoc::Error, "Invalid list type: #{list_type.inspect}"
  end
end
parseable?(text) click to toggle source

Returns true if text is valid ruby syntax

# File lib/rdoc/markup/to_html.rb, line 385
def parseable? text
  eval("BEGIN {return true}\n#{text}")
rescue SyntaxError
  false
end
to_html(item) click to toggle source

Converts item to HTML using RDoc::Text#to_html

Calls superclass method RDoc::Text#to_html
# File lib/rdoc/markup/to_html.rb, line 394
def to_html item
  super convert_flow @am.flow item
end

Visitor

↑ top

Public Instance Methods

accept_blank_line(blank_line) click to toggle source

Adds blank_line to the output

# File lib/rdoc/markup/to_html.rb, line 269
def accept_blank_line(blank_line)
  # @res << annotate("<p />") << "\n"
end
accept_block_quote(block_quote) click to toggle source

Adds block_quote to the output

# File lib/rdoc/markup/to_html.rb, line 172
def accept_block_quote block_quote
  @res << "\n<blockquote>"

  block_quote.parts.each do |part|
    part.accept self
  end

  @res << "</blockquote>\n"
end
accept_heading(heading) click to toggle source

Adds heading to the output. The headings greater than 6 are trimmed to level 6.

# File lib/rdoc/markup/to_html.rb, line 277
def accept_heading heading
  level = [6, heading.level].min

  label = heading.label @code_object

  @res << if @options.output_decoration
            "\n<h#{level} id=\"#{label}\">"
          else
            "\n<h#{level}>"
          end
  @res << to_html(heading.text)
  unless @options.pipe then
    @res << "<span><a href=\"##{label}\">&para;</a>"
    @res << " <a href=\"#top\">&uarr;</a></span>"
  end
  @res << "</h#{level}>\n"
end
accept_list_end(list) click to toggle source

Finishes consumption of list

# File lib/rdoc/markup/to_html.rb, line 240
def accept_list_end(list)
  @list.pop
  if tag = @in_list_entry.pop
    @res << tag
  end
  @res << html_list_name(list.type, false) << "\n"
end
accept_list_item_end(list_item) click to toggle source

Finishes consumption of list_item

# File lib/rdoc/markup/to_html.rb, line 262
def accept_list_item_end(list_item)
  @in_list_entry[-1] = list_end_for(@list.last)
end
accept_list_item_start(list_item) click to toggle source

Prepares the visitor for consuming list_item

# File lib/rdoc/markup/to_html.rb, line 251
def accept_list_item_start(list_item)
  if tag = @in_list_entry.last
    @res << tag
  end

  @res << list_item_start(list_item, @list.last)
end
accept_list_start(list) click to toggle source

Prepares the visitor for consuming list

# File lib/rdoc/markup/to_html.rb, line 231
def accept_list_start(list)
  @list << list.type
  @res << html_list_name(list.type, true)
  @in_list_entry.push false
end
accept_paragraph(paragraph) click to toggle source

Adds paragraph to the output

# File lib/rdoc/markup/to_html.rb, line 185
def accept_paragraph paragraph
  @res << "\n<p>"
  text = paragraph.text @hard_break
  text = text.gsub(/\r?\n/, ' ')
  @res << wrap(to_html(text))
  @res << "</p>\n"
end
accept_raw(raw) click to toggle source

Adds raw to the output

# File lib/rdoc/markup/to_html.rb, line 298
def accept_raw raw
  @res << raw.parts.join("\n")
end
accept_rule(rule) click to toggle source

Adds rule to the output

# File lib/rdoc/markup/to_html.rb, line 224
def accept_rule rule
  @res << "<hr>\n"
end
accept_verbatim(verbatim) click to toggle source

Adds verbatim to the output

# File lib/rdoc/markup/to_html.rb, line 196
def accept_verbatim verbatim
  text = verbatim.text.rstrip

  klass = nil

  content = if verbatim.ruby? or parseable? text then
              begin
                tokens = RDoc::RubyLex.tokenize text, @options
                klass  = ' class="ruby"'

                RDoc::TokenStream.to_html tokens
              rescue RDoc::RubyLex::Error
                CGI.escapeHTML text
              end
            else
              CGI.escapeHTML text
            end

  if @options.pipe then
    @res << "\n<pre><code>#{CGI.escapeHTML text}</code></pre>\n"
  else
    @res << "\n<pre#{klass}>#{content}</pre>\n"
  end
end
end_accepting() click to toggle source

Returns the generated output

# File lib/rdoc/markup/to_html.rb, line 165
def end_accepting
  @res.join
end
start_accepting() click to toggle source

Prepares the visitor for HTML generation

# File lib/rdoc/markup/to_html.rb, line 156
def start_accepting
  @res = []
  @in_list_entry = []
  @list = []
end