Outputs RDoc markup as HTML.
- A
 - C
 - E
 - G
 - H
 - I
 - L
 - N
 - P
 - S
 - T
 
Creates a new formatter that will output HTML
# File lib/rdoc/markup/to_html.rb, line 44 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 is a 
special is a potential link.  The following schemes are
handled:
- mailto:
 - 
Inserted as-is.
 - http:
 - 
Links are checked to see if they reference an image. If so, that image gets inserted using an
<img>tag. Otherwise a conventional<a href>is used. link:- 
Reference to a local file relative to the output directory.
 
special is an rdoc-schemed link that will be converted into a
hyperlink.
For the rdoc-ref scheme the named reference will be returned
without creating a link.
For the rdoc-label scheme the footnote and label prefixes are
stripped when creating a link.  All other contents will be linked verbatim.
# File lib/rdoc/markup/to_html.rb, line 102 def handle_special_RDOCLINK special url = special.text case url when /\Ardoc-ref:/ $' when /\Ardoc-label:/ text = $' text = case text when /\Alabel-/ then $' when /\Afootmark-/ then "^#{$'}" when /\Afoottext-/ then "*#{$'}" else text end gen_url url, text else url =~ /\Ardoc-[a-z]+:/ $' end end
This special is a link where the label is different from the
URL label[url] or {long label}[url]
| LIST_TYPE_TO_HTML | = | { :BULLET => ['<ul>', '</ul>'], :LABEL => ['<dl class="rdoc-list label-list">', '</dl>'], :LALPHA => ['<ol style="list-style-type: lower-alpha">', '</ol>'], :NOTE => ['<dl class="rdoc-list note-list">', '</dl>'], :NUMBER => ['<ol>', '</ol>'], :UALPHA => ['<ol style="list-style-type: upper-alpha">', '</ol>'], } | 
Maps RDoc::Markup::Parser::LIST_TOKENS types to HTML tags  | 
            ||
| [RW] | code_object | The RDoc::CodeObject HTML is being generated for. This is used to generate namespaced URI fragments  | 
          
| [RW] | from_path | Path to this document for relative links  | 
          
CGI-escapes text
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 298 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 "<a#{id} href=\"#{url}\">#{text.sub(%r{^#{scheme}:/*}i, '')}</a>" end end
Determines the HTML list element for list_type and
open_tag
Returns the HTML end-tag for list_type
Returns the HTML tag for list_type, possible using a label
from list_item
# File lib/rdoc/markup/to_html.rb, line 331 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
Converts item to HTML using RDoc::Text#to_html
Adds blank_line to the output
Adds block_quote to the output
Adds heading to the output.  The headings greater than 6 are
trimmed to level 6.
# File lib/rdoc/markup/to_html.rb, line 262 def accept_heading heading level = [6, heading.level].min label = heading.aref label = [@code_object.aref, label].compact.join '-' if @code_object and @code_object.respond_to? :aref @res << "\n<h#{level} id=\"#{label}\">" @res << to_html(heading.text) unless @options.pipe then @res << "<span><a href=\"##{label}\">¶</a>" @res << " <a href=\"#documentation\">↑</a></span>" end @res << "</h#{level}>\n" end
Finishes consumption of list
Finishes consumption of list_item
Prepares the visitor for consuming list_item
Prepares the visitor for consuming list
Adds paragraph to the output
Adds raw to the output
Adds rule to the output
Adds verbatim to the output
# File lib/rdoc/markup/to_html.rb, line 186 def accept_verbatim verbatim text = verbatim.text.rstrip @res << if verbatim.ruby? or parseable? text then begin tokens = RDoc::RubyLex.tokenize text, @options html = RDoc::TokenStream.to_html tokens "\n<pre class=\"ruby\">#{html}</pre>\n" rescue RDoc::RubyLex::Error "\n<pre>#{CGI.escapeHTML text}</pre>\n" end else "\n<pre>#{CGI.escapeHTML text}</pre>\n" end end
Returns the generated output