Class: RDoc::Markup::ToHtml
- Includes:
- Text
- Defined in:
- lib/rdoc/markup/to_html.rb
Overview
Outputs RDoc markup as HTML.
Direct Known Subclasses
Constant Summary collapse
- LIST_TYPE_TO_HTML =
Maps RDoc::Markup::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>'], }
Constants included from Text
Text::MARKUP_FORMAT, Text::TO_HTML_CHARACTERS
Instance Attribute Summary collapse
-
#code_object ⇒ Object
The RDoc::CodeObject HTML is being generated for.
-
#from_path ⇒ Object
Path to this document for relative links.
-
#in_list_entry ⇒ Object
readonly
:nodoc:.
-
#list ⇒ Object
readonly
:nodoc:.
-
#res ⇒ Object
readonly
:nodoc:.
Instance Method Summary collapse
-
#accept_blank_line(blank_line) ⇒ Object
Adds
blank_line
to the output. -
#accept_block_quote(block_quote) ⇒ Object
Adds
block_quote
to the output. -
#accept_heading(heading) ⇒ Object
Adds
heading
to the output. -
#accept_list_end(list) ⇒ Object
Finishes consumption of
list
. -
#accept_list_item_end(list_item) ⇒ Object
Finishes consumption of
list_item
. -
#accept_list_item_start(list_item) ⇒ Object
Prepares the visitor for consuming
list_item
. -
#accept_list_start(list) ⇒ Object
Prepares the visitor for consuming
list
. -
#accept_paragraph(paragraph) ⇒ Object
Adds
paragraph
to the output. -
#accept_raw(raw) ⇒ Object
Adds
raw
to the output. -
#accept_rule(rule) ⇒ Object
Adds
rule
to the output. -
#accept_verbatim(verbatim) ⇒ Object
Adds
verbatim
to the output. -
#convert_string(text) ⇒ Object
CGI-escapes
text
. -
#end_accepting ⇒ Object
Returns the generated output.
-
#gen_url(url, text) ⇒ Object
Generate a link to
url
with contenttext
. -
#handle_special_HARD_BREAK(special) ⇒ Object
special
is a<br>
. -
#handle_special_HYPERLINK(special) ⇒ Object
special
is a potential link. -
#handle_special_RDOCLINK(special) ⇒ Object
special
is an rdoc-schemed link that will be converted into a hyperlink. -
#handle_special_TIDYLINK(special) ⇒ Object
This
special
is a link where the label is different from the URLlabel[url]
or{long label}[url]
. -
#html_list_name(list_type, open_tag) ⇒ Object
Determines the HTML list element for
list_type
andopen_tag
. -
#init_tags ⇒ Object
Maps attributes to HTML tags.
-
#initialize(options, markup = nil) ⇒ ToHtml
constructor
Creates a new formatter that will output HTML.
-
#list_end_for(list_type) ⇒ Object
Returns the HTML end-tag for
list_type
. -
#list_item_start(list_item, list_type) ⇒ Object
Returns the HTML tag for
list_type
, possible using a label fromlist_item
. -
#parseable?(text) ⇒ Boolean
Returns true if Ripper is available it can create a sexp from
text
. -
#start_accepting ⇒ Object
Prepares the visitor for HTML generation.
-
#to_html(item) ⇒ Object
Converts
item
to HTML using RDoc::Text#to_html.
Methods included from Text
encode_fallback, #expand_tabs, #flush_left, #markup, #normalize_comment, #parse, #snippet, #strip_hashes, #strip_newlines, #strip_stars, #wrap
Methods inherited from Formatter
#accept_document, #add_special_RDOCLINK, #add_special_TIDYLINK, #add_tag, #annotate, #convert, #convert_flow, #convert_special, gen_relative_url, #ignore, #in_tt?, #off_tags, #on_tags, #parse_url, #tt?
Constructor Details
#initialize(options, markup = nil) ⇒ ToHtml
Creates a new formatter that will output HTML
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# File 'lib/rdoc/markup/to_html.rb', line 44 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 ⇒ Object
The RDoc::CodeObject HTML is being generated for. This is used to generate namespaced URI fragments
32 33 34 |
# File 'lib/rdoc/markup/to_html.rb', line 32 def code_object @code_object end |
#from_path ⇒ Object
Path to this document for relative links
37 38 39 |
# File 'lib/rdoc/markup/to_html.rb', line 37 def from_path @from_path end |
#in_list_entry ⇒ Object (readonly)
:nodoc:
25 26 27 |
# File 'lib/rdoc/markup/to_html.rb', line 25 def in_list_entry @in_list_entry end |
#list ⇒ Object (readonly)
:nodoc:
26 27 28 |
# File 'lib/rdoc/markup/to_html.rb', line 26 def list @list end |
#res ⇒ Object (readonly)
:nodoc:
24 25 26 |
# File 'lib/rdoc/markup/to_html.rb', line 24 def res @res end |
Instance Method Details
#accept_blank_line(blank_line) ⇒ Object
Adds blank_line
to the output
254 255 256 |
# File 'lib/rdoc/markup/to_html.rb', line 254 def accept_blank_line(blank_line) # @res << annotate("<p />") << "\n" end |
#accept_block_quote(block_quote) ⇒ Object
Adds block_quote
to the output
163 164 165 166 167 168 169 170 171 |
# 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 |
#accept_heading(heading) ⇒ Object
Adds heading
to the output. The headings greater than 6 are trimmed to level 6.
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
# File 'lib/rdoc/markup/to_html.rb', line 262 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 |
#accept_list_end(list) ⇒ Object
Finishes consumption of list
225 226 227 228 229 230 231 |
# File 'lib/rdoc/markup/to_html.rb', line 225 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) ⇒ Object
Finishes consumption of list_item
247 248 249 |
# File 'lib/rdoc/markup/to_html.rb', line 247 def accept_list_item_end(list_item) @in_list_entry[-1] = list_end_for(@list.last) end |
#accept_list_item_start(list_item) ⇒ Object
Prepares the visitor for consuming list_item
236 237 238 239 240 241 242 |
# File 'lib/rdoc/markup/to_html.rb', line 236 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) ⇒ Object
Prepares the visitor for consuming list
216 217 218 219 220 |
# File 'lib/rdoc/markup/to_html.rb', line 216 def accept_list_start(list) @list << list.type @res << html_list_name(list.type, true) @in_list_entry.push false end |
#accept_paragraph(paragraph) ⇒ Object
Adds paragraph
to the output
176 177 178 179 180 181 |
# File 'lib/rdoc/markup/to_html.rb', line 176 def accept_paragraph paragraph @res << "\n<p>" text = paragraph.text @hard_break @res << wrap(to_html(text)) @res << "</p>\n" end |
#accept_raw(raw) ⇒ Object
Adds raw
to the output
281 282 283 |
# File 'lib/rdoc/markup/to_html.rb', line 281 def accept_raw raw @res << raw.parts.join("\n") end |
#accept_rule(rule) ⇒ Object
Adds rule
to the output
207 208 209 210 211 |
# File 'lib/rdoc/markup/to_html.rb', line 207 def accept_rule(rule) size = rule.weight size = 10 if size > 10 @res << "<hr style=\"height: #{size}px\">\n" end |
#accept_verbatim(verbatim) ⇒ Object
Adds verbatim
to the output
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'lib/rdoc/markup/to_html.rb', line 186 def accept_verbatim verbatim text = verbatim.text.rstrip @res << if verbatim.ruby? or parseable? text then begin tokens = RDoc::RubyLex.tokenize text, @options html = RDoc::TokenStream.to_html tokens "\n<pre class=\"ruby\">#{html}</pre>\n" rescue RDoc::RubyLex::Error "\n<pre>#{CGI.escapeHTML text}</pre>\n" end else "\n<pre>#{CGI.escapeHTML text}</pre>\n" end end |
#convert_string(text) ⇒ Object
CGI-escapes text
290 291 292 |
# File 'lib/rdoc/markup/to_html.rb', line 290 def convert_string(text) CGI.escapeHTML text end |
#end_accepting ⇒ Object
Returns the generated output
156 157 158 |
# File 'lib/rdoc/markup/to_html.rb', line 156 def end_accepting @res.join end |
#gen_url(url, text) ⇒ Object
Generate a link to url
with content text
. Handles the special cases for img: and link: described under handle_special_HYPERLINK
298 299 300 301 302 303 304 305 306 307 |
# File 'lib/rdoc/markup/to_html.rb', line 298 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 "<a#{id} href=\"#{url}\">#{text.sub(%r{^#{scheme}:/*}i, '')}</a>" end end |
#handle_special_HARD_BREAK(special) ⇒ Object
special
is a <br>
71 72 73 |
# File 'lib/rdoc/markup/to_html.rb', line 71 def handle_special_HARD_BREAK special '<br>' end |
#handle_special_HYPERLINK(special) ⇒ Object
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.
87 88 89 90 91 |
# File 'lib/rdoc/markup/to_html.rb', line 87 def handle_special_HYPERLINK(special) url = special.text gen_url url, url end |
#handle_special_RDOCLINK(special) ⇒ Object
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.
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 |
# 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 |
#handle_special_TIDYLINK(special) ⇒ Object
This special
is a link where the label is different from the URL label[url]
or {long label}[url]
130 131 132 133 134 135 136 137 138 |
# 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 |
#html_list_name(list_type, open_tag) ⇒ Object
Determines the HTML list element for list_type
and open_tag
312 313 314 315 316 |
# File 'lib/rdoc/markup/to_html.rb', line 312 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 ⇒ Object
Maps attributes to HTML tags
321 322 323 324 325 |
# File 'lib/rdoc/markup/to_html.rb', line 321 def add_tag :BOLD, "<strong>", "</strong>" add_tag :TT, "<code>", "</code>" add_tag :EM, "<em>", "</em>" end |
#list_end_for(list_type) ⇒ Object
Returns the HTML end-tag for list_type
347 348 349 350 351 352 353 354 355 356 |
# File 'lib/rdoc/markup/to_html.rb', line 347 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 |
#list_item_start(list_item, list_type) ⇒ Object
Returns the HTML tag for list_type
, possible using a label from list_item
331 332 333 334 335 336 337 338 339 340 341 342 |
# File 'lib/rdoc/markup/to_html.rb', line 331 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 Ripper is available it can create a sexp from text
361 362 363 364 |
# File 'lib/rdoc/markup/to_html.rb', line 361 def parseable? text text =~ /\b(def|class|module|require) |=>|\{\s?\||do \|/ and text !~ /<%|%>/ end |
#start_accepting ⇒ Object
Prepares the visitor for HTML generation
147 148 149 150 151 |
# File 'lib/rdoc/markup/to_html.rb', line 147 def start_accepting @res = [] @in_list_entry = [] @list = [] end |
#to_html(item) ⇒ Object
Converts item
to HTML using RDoc::Text#to_html
369 370 371 |
# File 'lib/rdoc/markup/to_html.rb', line 369 def to_html item super convert_flow @am.flow item end |