Outputs RDoc markup as HTML.
Creates a new formatter that will output HTML
# File lib/rdoc/markup/to_html.rb, line 68 def initialize markup = nil super @code_object = nil @from_path = '' @in_list_entry = nil @list = nil @th = nil # external links @markup.add_special(/((link:|https?:|mailto:|ftp:|www\.)\S+\w)/, :HYPERLINK) # internal links @markup.add_special(/rdoc-[a-z]+:\S+/, :RDOCLINK) # and links of the form <text>[<url>] @markup.add_special(/(((\{.*?\})|\b\S+?)\[\S+?\])/, :TIDYLINK) init_tags end
These methods handle special markup added by RDoc::Markup#add_special.
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.
# File lib/rdoc/markup/to_html.rb, line 105 def handle_special_HYPERLINK(special) url = special.text gen_url url, url end
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 120 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]
# File lib/rdoc/markup/to_html.rb, line 148 def handle_special_TIDYLINK(special) text = special.text return text unless text =~ /\{(.*?)\}\[(.*?)\]/ or text =~ /(\S+)\[(.*?)\]/ label = $1 url = $2 gen_url url, label end
Maps RDoc::Markup::Parser::LIST_TOKENS types to HTML tags
The RDoc::CodeObject HTML is being generated for. This is used to generate namespaced URI fragments
Path to this document for relative links
CGI escapes text
# File lib/rdoc/markup/to_html.rb, line 292 def convert_string(text) CGI.escapeHTML text end
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 300 def gen_url url, text if url =~ /^rdoc-label:([^:]*)(?::(.*))?/ then type = "link" path = "##{$1}" id = " id=\"#{$2}\"" if $2 elsif 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#{id} href=\"#{url}\">#{text.sub(%r{^#{type}:/*}, '')}</a>" end end
Determines the HTML list element for list_type
and
open_tag
# File lib/rdoc/markup/to_html.rb, line 333 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
Returns the HTML end-tag for list_type
# File lib/rdoc/markup/to_html.rb, line 366 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
Returns the HTML tag for list_type
, possible using a label
from list_item
# File lib/rdoc/markup/to_html.rb, line 352 def list_item_start(list_item, list_type) case list_type when :BULLET, :LALPHA, :NUMBER, :UALPHA then "<li>" when :LABEL, :NOTE then "<dt>#{to_html list_item.label}\n<dd>" else raise RDoc::Error, "Invalid list type: #{list_type.inspect}" end end
Returns true if Ripper is available it can create a sexp from
text
# File lib/rdoc/markup/to_html.rb, line 380 def parseable? text text =~ /\b(def|class|module|require)\b|=>|\{\s?\||do \|/ end
Converts item
to HTML using RDoc::Text#to_html
# File lib/rdoc/markup/to_html.rb, line 387 def to_html item super convert_flow @am.flow item end
Converts a target url to one that is relative to a given path
# File lib/rdoc/markup/to_html.rb, line 42 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
These methods implement the HTML visitor.
Adds blank_line
to the output
# File lib/rdoc/markup/to_html.rb, line 260 def accept_blank_line(blank_line) # @res << annotate("<p />") << "\n" end
Adds heading
to the output. The headings greater than 6 are
trimmed to level 6.
# File lib/rdoc/markup/to_html.rb, line 268 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) @res << "</h#{level}>\n" end
Finishes consumption of list
# File lib/rdoc/markup/to_html.rb, line 231 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
Finishes consumption of list_item
# File lib/rdoc/markup/to_html.rb, line 253 def accept_list_item_end(list_item) @in_list_entry[-1] = list_end_for(@list.last) end
Prepares the visitor for consuming list_item
# File lib/rdoc/markup/to_html.rb, line 242 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
Prepares the visitor for consuming list
# File lib/rdoc/markup/to_html.rb, line 222 def accept_list_start(list) @list << list.type @res << html_list_name(list.type, true) @in_list_entry.push false end
Adds paragraph
to the output
# File lib/rdoc/markup/to_html.rb, line 181 def accept_paragraph(paragraph) @res << "\n<p>" @res << wrap(to_html(paragraph.text)) @res << "</p>\n" end
Adds raw
to the output
# File lib/rdoc/markup/to_html.rb, line 283 def accept_raw raw @res << raw.parts.join("\n") end
Adds rule
to the output
# File lib/rdoc/markup/to_html.rb, line 213 def accept_rule(rule) size = rule.weight size = 10 if size > 10 @res << "<hr style=\"height: #{size}px\">\n" end
Adds verbatim
to the output
# File lib/rdoc/markup/to_html.rb, line 190 def accept_verbatim verbatim text = verbatim.text.rstrip @res << if verbatim.ruby? or parseable? text then options = RDoc::RDoc.current.options if RDoc::RDoc.current begin tokens = RDoc::RubyLex.tokenize text, options "\n<pre class=\"ruby\">" "#{RDoc::TokenStream.to_html tokens}" "</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
# File lib/rdoc/markup/to_html.rb, line 174 def end_accepting @res.join end
Prepares the visitor for HTML generation
# File lib/rdoc/markup/to_html.rb, line 165 def start_accepting @res = [] @in_list_entry = [] @list = [] end