Outputs RDoc markup as HTML.
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
These methods handle special markup added by RDoc::Markup#add_special.
special is a <br>
# File lib/rdoc/markup/to_html.rb, line 71 def handle_special_HARD_BREAK special '<br>' end
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 87 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 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]
# File lib/rdoc/markup/to_html.rb, line 130 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
CGI-escapes text
# File lib/rdoc/markup/to_html.rb, line 298 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 306 def gen_url url, text scheme, url, id = parse_url url if ]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
# File lib/rdoc/markup/to_html.rb, line 320 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 355 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 339 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
These methods implement the HTML visitor.
Adds blank_line to the output
# File lib/rdoc/markup/to_html.rb, line 262 def accept_blank_line(blank_line) # @res << annotate("<p />") << "\n" end
Adds block_quote to the output
# File lib/rdoc/markup/to_html.rb, line 163 def accept_block_quote block_quote @res << "\n<blockquote>" block_quote.parts.each do |part| part.accept self end @res << "</blockquote>\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 270 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
# File lib/rdoc/markup/to_html.rb, line 233 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 255 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 244 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 224 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 176 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
Adds raw to the output
# File lib/rdoc/markup/to_html.rb, line 289 def accept_raw raw @res << raw.parts.join("\n") end
Adds rule to the output
# File lib/rdoc/markup/to_html.rb, line 215 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 187 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
Generated with the Darkfish Rdoc Generator 2.