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 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 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.
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 135 def handle_special_TIDYLINK(special) text = special.text return text unless text =~ /^\{(.*)\}\[(.*?)\]$/ or text =~ /^(\S+)\[(.*?)\]$/ label = $1 url = $2 label = handle_RDOCLINK label if /^rdoc-image:/ =~ label gen_url url, label end
| 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 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
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 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
Returns true if text is valid ruby syntax
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 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}\">¶</a>" @res << " <a href=\"#top\">↑</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 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
Returns the generated output