In Files

  • rdoc/markup/to_html.rb

Class/Module Index [+]

Quicksearch

RDoc::Markup::ToHtml

Outputs RDoc markup as HTML

Public Class Methods

new(markup = nil) click to toggle source

Creates a new formatter that will output HTML

 
               # File rdoc/markup/to_html.rb, line 65
def initialize markup = nil
  super

  @th = nil
  @in_list_entry = nil
  @list = nil
  @from_path = ''

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

  # and links of the form  <text>[<url>]
  @markup.add_special(/(((\{.*?\})|\b\S+?)\[\S+?\])/, :TIDYLINK)

  init_tags
end
            

Special Handling ↑ top

Public Instance Methods

Utilities ↑ top

Constants

LIST_TYPE_TO_HTML

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

Attributes

from_path[RW]

Path to this document for relative links

Public Class Methods

gen_relative_url(path, target) click to toggle source

Converts a target url to one that is relative to a given path

 
               # File rdoc/markup/to_html.rb, line 39
def self.gen_relative_url(path, target)
  from        = File.dirname path
  to, to_file = File.split target

  from = from.split "/"
  to   = to.split "/"

  from.delete '.'
  to.delete '.'

  while from.size > 0 and to.size > 0 and from[0] == to[0] do
    from.shift
    to.shift
  end

  from.fill ".."
  from.concat to
  from << to_file
  File.join(*from)
end
            

Public Instance Methods

convert_string(text) click to toggle source

CGI escapes text

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

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

 
               # File rdoc/markup/to_html.rb, line 239
def gen_url(url, text)
  if url =~ /([A-Za-z]+):(.*)/ then
    type = $1
    path = $2
  else
    type = "http"
    path = url
    url  = "http://#{url}"
  end

  if type == "link" then
    url = if path[0, 1] == '#' then # is this meaningful?
            path
          else
            self.class.gen_relative_url @from_path, path
          end
  end

  if (type == "http" or type == "https" or type == "link") and
     url =~ /\.(gif|png|jpg|jpeg|bmp)$/ then
    "<img src=\"#{url}\" />"
  else
    "<a href=\"#{url}\">#{text.sub(%r{^#{type}:/*}, '')}</a>"
  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 rdoc/markup/to_html.rb, line 268
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 rdoc/markup/to_html.rb, line 277
def init_tags
  add_tag :BOLD, "<b>",  "</b>"
  add_tag :TT,   "<tt>", "</tt>"
  add_tag :EM,   "<em>", "</em>"
end
            
list_end_for(list_type) click to toggle source

Returns the HTML end-tag for list_type

 
               # File rdoc/markup/to_html.rb, line 303
def list_end_for(list_type)
  case list_type
  when :BULLET, :LALPHA, :NUMBER, :UALPHA then
    "</li>"
  when :LABEL then
    "</dd>"
  when :NOTE then
    "</td></tr>"
  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 rdoc/markup/to_html.rb, line 287
def list_item_start(list_item, list_type)
  case list_type
  when :BULLET, :LALPHA, :NUMBER, :UALPHA then
    "<li>"
  when :LABEL then
    "<dt>#{to_html list_item.label}</dt>\n<dd>"
  when :NOTE then
    "<tr><td class=\"rdoc-term\"><p>#{to_html list_item.label}</p></td>\n<td>"
  else
    raise RDoc::Error, "Invalid list type: #{list_type.inspect}"
  end
end
            
to_html(item) click to toggle source

Converts item to HTML using RDoc::Text#to_html

 
               # File rdoc/markup/to_html.rb, line 319
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 rdoc/markup/to_html.rb, line 206
def accept_blank_line(blank_line)
  # @res << annotate("<p />") << "\n"
end
            
accept_heading(heading) click to toggle source

Adds heading to the output

 
               # File rdoc/markup/to_html.rb, line 213
def accept_heading(heading)
  @res << "\n<h#{heading.level}>"
  @res << to_html(heading.text)
  @res << "</h#{heading.level}>\n"
end
            
accept_list_end(list) click to toggle source

Finishes consumption of list

 
               # File rdoc/markup/to_html.rb, line 177
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 rdoc/markup/to_html.rb, line 199
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 rdoc/markup/to_html.rb, line 188
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 rdoc/markup/to_html.rb, line 168
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 rdoc/markup/to_html.rb, line 141
def accept_paragraph(paragraph)
  @res << "\n<p>"
  @res << wrap(to_html(paragraph.text))
  @res << "</p>\n"
end
            
accept_raw(raw) click to toggle source

Adds raw to the output

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

Adds rule to the output

 
               # File rdoc/markup/to_html.rb, line 159
def accept_rule(rule)
  size = rule.weight
  size = 10 if size > 10
  @res << "<hr style=\"height: #{size}px\">\n"
end
            
accept_verbatim(verbatim) click to toggle source

Adds verbatim to the output

 
               # File rdoc/markup/to_html.rb, line 150
def accept_verbatim(verbatim)
  @res << "\n<pre>"
  @res << CGI.escapeHTML(verbatim.text.rstrip)
  @res << "</pre>\n"
end
            
end_accepting() click to toggle source

Returns the generated output

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

Prepares the visitor for HTML generation

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