Class: RDoc::Markup::ToHtml
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Subclasses:
|
|
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
Formatter
|
|
Instance Chain:
self,
::RDoc::Text,
Formatter
|
|
Inherits: |
RDoc::Markup::Formatter
|
Defined in: | lib/rdoc/markup/to_html.rb |
Overview
Outputs RDoc markup as HTML.
Constant Summary
-
LIST_TYPE_TO_HTML =
Maps Parser::LIST_TOKENS types to HTML tags
{ :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>'], }
::RDoc::Text - Included
Utilities
-
#code_object
rw
The ::RDoc::CodeObject HTML is being generated for.
-
#convert_string(text)
CGI-escapes
text
-
#from_path
rw
Path to this document for relative links.
-
#gen_url(url, text)
Generate a link to
url
with contenttext
. -
#html_list_name(list_type, open_tag)
Determines the HTML list element for
list_type
andopen_tag
-
#init_tags
Maps attributes to HTML tags.
-
#list_end_for(list_type)
Returns the HTML end-tag for
list_type
-
#list_item_start(list_item, list_type)
Returns the HTML tag for
list_type
, possible using a label fromlist_item
-
#parseable?(text) ⇒ Boolean
Returns true if text is valid ruby syntax.
-
#to_html(item)
Converts
item
to HTML using Text#to_html
Special Handling
-
#handle_special_HARD_BREAK(special)
special
is a
. -
#handle_special_HYPERLINK(special)
special
is a potential link. -
#handle_special_RDOCLINK(special)
special
is an rdoc-schemed link that will be converted into a hyperlink. -
#handle_special_TIDYLINK(special)
This
special
is a link where the label is different from the URLlabel[url]
or{url long label}
.
Visitor
-
#accept_blank_line(blank_line)
Adds
blank_line
to the output. -
#accept_block_quote(block_quote)
Adds
block_quote
to the output. -
#accept_heading(heading)
Adds
heading
to the output. -
#accept_list_end(list)
Finishes consumption of #list
-
#accept_list_item_end(list_item)
Finishes consumption of
list_item
-
#accept_list_item_start(list_item)
Prepares the visitor for consuming
list_item
-
#accept_list_start(list)
Prepares the visitor for consuming #list
-
#accept_paragraph(paragraph)
Adds
paragraph
to the output. -
#accept_raw(raw)
Adds
raw
to the output. -
#accept_rule(rule)
Adds
rule
to the output. -
#accept_verbatim(verbatim)
Adds
verbatim
to the output. -
#end_accepting
Returns the generated output.
-
#start_accepting
Prepares the visitor for HTML generation.
Class Method Summary
-
.new(options, markup = nil) ⇒ ToHtml
constructor
Creates a new formatter that will output HTML.
Formatter - Inherited
.gen_relative_url | Converts a target url to one that is relative to a given path. |
.new | Creates a new Formatter. |
Instance Attribute Summary
Instance Method Summary
::RDoc::Text - Included
#expand_tabs | Expands tab characters in |
#flush_left | Flush |
#markup | Convert a string in markup format into HTML. |
#normalize_comment | Strips hashes, expands tabs then flushes |
#parse | Normalizes |
#snippet | The first |
#strip_hashes | Strips leading # characters from |
#strip_newlines | Strips leading and trailing n characters from |
#strip_stars | Strips /* */ style comments. |
#to_html | Converts ampersand, dashes, ellipsis, quotes, copyright and registered trademark symbols in |
#wrap | Wraps |
Formatter - Inherited
#accept_document | Adds |
|
#add_special_RDOCLINK | Adds a special for links of the form rdoc-…: |
|
#add_special_TIDYLINK | Adds a special for links of the form |
Add a new set of tags for an attribute. |
#annotate | Allows |
|
#convert | Marks up |
|
#convert_flow | Converts flow items |
|
#convert_special | Converts added specials. |
|
#convert_string | Converts a string to be fancier if desired. |
|
#ignore | Use ignore in your subclass to ignore the content of a node. |
|
#off_tags | Turns off tags for |
|
#on_tags | Turns on tags for |
|
#parse_url | Extracts and a scheme, url and an anchor id from |
|
#tt? | Is |
Constructor Details
.new(options, markup = nil) ⇒ ToHtml
Creates a new formatter that will output HTML
# File 'lib/rdoc/markup/to_html.rb', line 45
def initialize , 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 end
Instance Attribute Details
#code_object (rw)
The ::RDoc::CodeObject HTML is being generated for. This is used to generate namespaced URI fragments
# File 'lib/rdoc/markup/to_html.rb', line 33
attr_accessor :code_object
#from_path (rw)
Path to this document for relative links
# File 'lib/rdoc/markup/to_html.rb', line 38
attr_accessor :from_path
Instance Method Details
#accept_blank_line(blank_line)
Adds blank_line
to the output
# File 'lib/rdoc/markup/to_html.rb', line 269
def accept_blank_line(blank_line) # @res << annotate("<p />") << "\n" end
#accept_block_quote(block_quote)
Adds block_quote
to the output
# File 'lib/rdoc/markup/to_html.rb', line 172
def accept_block_quote block_quote @res << "\n<blockquote>" block_quote.parts.each do |part| part.accept self end @res << "</blockquote>\n" end
#accept_heading(heading)
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
#accept_list_end(list)
Finishes consumption of #list
# File 'lib/rdoc/markup/to_html.rb', line 240
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)
Finishes consumption of list_item
# File 'lib/rdoc/markup/to_html.rb', line 262
def accept_list_item_end(list_item) @in_list_entry[-1] = list_end_for(@list.last) end
#accept_list_item_start(list_item)
Prepares the visitor for consuming list_item
# File 'lib/rdoc/markup/to_html.rb', line 251
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)
Prepares the visitor for consuming #list
# File 'lib/rdoc/markup/to_html.rb', line 231
def accept_list_start(list) @list << list.type @res << html_list_name(list.type, true) @in_list_entry.push false end
#accept_paragraph(paragraph)
Adds paragraph
to the output
# File 'lib/rdoc/markup/to_html.rb', line 185
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
#accept_raw(raw)
Adds raw
to the output
# File 'lib/rdoc/markup/to_html.rb', line 298
def accept_raw raw @res << raw.parts.join("\n") end
#accept_rule(rule)
Adds rule
to the output
# File 'lib/rdoc/markup/to_html.rb', line 224
def accept_rule rule @res << "<hr>\n" end
#accept_verbatim(verbatim)
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
#convert_string(text)
CGI-escapes text
# File 'lib/rdoc/markup/to_html.rb', line 307
def convert_string(text) CGI.escapeHTML text end
#end_accepting
Returns the generated output
# File 'lib/rdoc/markup/to_html.rb', line 165
def end_accepting @res.join end
#gen_url(url, 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
#handle_special_HARD_BREAK(special)
special
is a
# File 'lib/rdoc/markup/to_html.rb', line 96
def handle_special_HARD_BREAK special '<br>' end
#handle_special_HYPERLINK(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 112
def handle_special_HYPERLINK(special) url = special.text gen_url url, url end
#handle_special_RDOCLINK(special)
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 127
def handle_special_RDOCLINK special handle_RDOCLINK special.text end
#handle_special_TIDYLINK(special)
This special
is a link where the label is different from the URL label[url]
or {url long label}
# 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
#html_list_name(list_type, open_tag)
Determines the HTML list element for list_type
and open_tag
# File 'lib/rdoc/markup/to_html.rb', line 336
def html_list_name(list_type, open_tag) = LIST_TYPE_TO_HTML[list_type] raise RDoc::Error, "Invalid list type: #{list_type.inspect}" unless [open_tag ? 0 : 1] end
#init_tags
Maps attributes to HTML tags
# File 'lib/rdoc/markup/to_html.rb', line 345
def add_tag :BOLD, "<strong>", "</strong>" add_tag :TT, "<code>", "</code>" add_tag :EM, "<em>", "</em>" end
#list_end_for(list_type)
Returns the HTML end-tag for list_type
#list_item_start(list_item, 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
#parseable?(text) ⇒ Boolean
Returns true if text is valid ruby syntax
# File 'lib/rdoc/markup/to_html.rb', line 385
def parseable? text eval("BEGIN {return true}\n#{text}") rescue SyntaxError false end
#start_accepting
Prepares the visitor for HTML generation
# File 'lib/rdoc/markup/to_html.rb', line 156
def start_accepting @res = [] @in_list_entry = [] @list = [] end
#to_html(item)
Converts item
to HTML using Text#to_html
# File 'lib/rdoc/markup/to_html.rb', line 394
def to_html item super convert_flow @am.flow item end