In Files
- rdoc/markup/to_html.rb
Parent
Sections
Methods
- ::new
- #accept_blank_line
- #accept_block_quote
- #accept_heading
- #accept_list_end
- #accept_list_item_end
- #accept_list_item_start
- #accept_list_start
- #accept_paragraph
- #accept_raw
- #accept_rule
- #accept_verbatim
- #convert_string
- #end_accepting
- #gen_url
- #handle_special_HARD_BREAK
- #handle_special_HYPERLINK
- #handle_special_RDOCLINK
- #handle_special_TIDYLINK
- #html_list_name
- #init_tags
- #list_end_for
- #list_item_start
- #parseable?
- #start_accepting
- #to_html
Included Modules
Class/Module Index
- RDoc
- RDoc::Alias
- RDoc::AnonClass
- RDoc::AnyMethod
- RDoc::Attr
- RDoc::ClassModule
- RDoc::CodeObject
- RDoc::Comment
- RDoc::Constant
- RDoc::Context
- RDoc::Context::Section
- RDoc::CrossReference
- RDoc::ERBIO
- RDoc::ERBPartial
- RDoc::Encoding
- RDoc::Error
- RDoc::Extend
- RDoc::Generator
- RDoc::Generator::Darkfish
- RDoc::Generator::JsonIndex
- RDoc::Generator::Markup
- RDoc::Generator::POT
- RDoc::Generator::POT::MessageExtractor
- RDoc::Generator::POT::PO
- RDoc::Generator::POT::POEntry
- RDoc::Generator::RI
- RDoc::GhostMethod
- RDoc::I18n
- RDoc::I18n::Locale
- RDoc::I18n::Text
- RDoc::Include
- RDoc::Markdown
- RDoc::Markdown::Literals
- RDoc::Markup
- RDoc::Markup::AttrChanger
- RDoc::Markup::AttrSpan
- RDoc::Markup::AttributeManager
- RDoc::Markup::Attributes
- RDoc::Markup::BlankLine
- RDoc::Markup::BlockQuote
- RDoc::Markup::Document
- RDoc::Markup::Formatter
- RDoc::Markup::FormatterTestCase
- RDoc::Markup::HardBreak
- RDoc::Markup::Include
- RDoc::Markup::IndentedParagraph
- RDoc::Markup::List
- RDoc::Markup::ListItem
- RDoc::Markup::Paragraph
- RDoc::Markup::Parser
- RDoc::Markup::Parser::Error
- RDoc::Markup::Parser::ParseError
- RDoc::Markup::PreProcess
- RDoc::Markup::Raw
- RDoc::Markup::Rule
- RDoc::Markup::Special
- RDoc::Markup::TextFormatterTestCase
- RDoc::Markup::ToAnsi
- RDoc::Markup::ToBs
- RDoc::Markup::ToHtml
- RDoc::Markup::ToHtmlCrossref
- RDoc::Markup::ToHtmlSnippet
- RDoc::Markup::ToJoinedParagraph
- RDoc::Markup::ToLabel
- RDoc::Markup::ToMarkdown
- RDoc::Markup::ToRdoc
- RDoc::Markup::ToTableOfContents
- RDoc::Markup::ToTest
- RDoc::Markup::ToTtOnly
- RDoc::Markup::Verbatim
- RDoc::MetaMethod
- RDoc::MethodAttr
- RDoc::Mixin
- RDoc::NormalClass
- RDoc::NormalModule
- RDoc::Options
- RDoc::Parser
- RDoc::Parser::C
- RDoc::Parser::ChangeLog
- RDoc::Parser::Markdown
- RDoc::Parser::RD
- RDoc::Parser::Ruby
- RDoc::Parser::RubyTools
- RDoc::Parser::Simple
- RDoc::Parser::Text
- RDoc::RD
- RDoc::RD::BlockParser
- RDoc::RD::Inline
- RDoc::RD::InlineParser
- RDoc::RDoc
- RDoc::RI
- RDoc::RI::Driver
- RDoc::RI::Driver::Error
- RDoc::RI::Driver::NotFoundError
- RDoc::RI::Error
- RDoc::RI::Paths
- RDoc::RI::Task
- RDoc::Require
- RDoc::RubyLex
- RDoc::RubyLex::Error
- RDoc::RubyToken
- RDoc::RubygemsHook
- RDoc::Servlet
- RDoc::SingleClass
- RDoc::Stats
- RDoc::Stats::Normal
- RDoc::Stats::Quiet
- RDoc::Stats::Verbose
- RDoc::Store
- RDoc::Store::Error
- RDoc::Store::MissingFileError
- RDoc::Task
- RDoc::TestCase
- RDoc::Text
- RDoc::TokenStream
- RDoc::TomDoc
- RDoc::TopLevel
- RDocTask
- Test
RDoc::Markup::ToHtml
Outputs RDoc markup as HTML.
Public Class Methods
Creates a new formatter that will output HTML
# File 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 Handling ↑ top
Public Instance Methods
special
is a
# File rdoc/markup/to_html.rb, line 96 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 rdoc/markup/to_html.rb, line 112 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 rdoc/markup/to_html.rb, line 127 def handle_special_RDOCLINK special handle_RDOCLINK special.text end
This special
is a link where the label is different from the
URL label[url]
or {long label}[url]
# File 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
Utilities ↑ top
Constants
- LIST_TYPE_TO_HTML
Maps RDoc::Markup::Parser::LIST_TOKENS types to HTML tags
Attributes
The RDoc::CodeObject HTML is being generated for. This is used to generate namespaced URI fragments
Public Instance Methods
CGI-escapes text
# File rdoc/markup/to_html.rb, line 307 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 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
# File rdoc/markup/to_html.rb, line 336 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 rdoc/markup/to_html.rb, line 371 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 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
# File rdoc/markup/to_html.rb, line 385 def parseable? text eval("BEGIN {return true}\n#{text}") rescue SyntaxError false end
Converts item
to HTML using RDoc::Text#to_html
# File rdoc/markup/to_html.rb, line 394 def to_html item super convert_flow @am.flow item end
Visitor ↑ top
Public Instance Methods
Adds blank_line
to the output
# File rdoc/markup/to_html.rb, line 269 def accept_blank_line(blank_line) # @res << annotate("<p />") << "\n" end
Adds block_quote
to the output
# File 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
Adds heading
to the output. The headings greater than 6 are
trimmed to level 6.
# File 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
# File 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
Finishes consumption of list_item
# File rdoc/markup/to_html.rb, line 262 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 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
Prepares the visitor for consuming list
# File 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
Adds paragraph
to the output
# File 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
Adds raw
to the output
# File rdoc/markup/to_html.rb, line 298 def accept_raw raw @res << raw.parts.join("\n") end
Adds rule
to the output
# File rdoc/markup/to_html.rb, line 224 def accept_rule rule @res << "<hr>\n" end
Adds verbatim
to the output
# File 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