Class RDoc::Markup::ToHtml
In: lib/rdoc/markup/to_html.rb
Parent: RDoc::Markup::Formatter

Methods

accept_blank_line   accept_heading   accept_list_end   accept_list_item   accept_list_start   accept_paragraph   accept_rule   accept_verbatim   add_tag   annotate   end_accepting   gen_url   handle_special_HYPERLINK   handle_special_TIDYLINK   init_tags   new   start_accepting   wrap  

Constants

LIST_TYPE_TO_HTML = { :BULLET => %w[<ul> </ul>], :NUMBER => %w[<ol> </ol>], :UPPERALPHA => %w[<ol> </ol>], :LOWERALPHA => %w[<ol> </ol>], :LABELED => %w[<dl> </dl>], :NOTE => %w[<table> </table>], }
InlineTag = Struct.new(:bit, :on, :off)

Public Class methods

Public Instance methods

add_tag(name, start, stop)

Add a new set of HTML tags for an attribute. We allow separate start and end tags for flexibility.

annotate(tag)

Given an HTML tag, decorate it with class information and the like if required. This is a no-op in the base class, but is overridden in HTML output classes that implement style sheets.

gen_url(url, text)

Generate a hyperlink for url, labeled with text. Handle the special cases for img: and link: described under handle_special_HYPEDLINK

handle_special_HYPERLINK(special)

And we‘re invoked with a potential external hyperlink mailto: just gets inserted. 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. We also support a special type of hyperlink, link:, which is a reference to a local file whose path is relative to the —op directory.

handle_special_TIDYLINK(special)

Here‘s a hypedlink where the label is different to the URL 

 <label>[url] or {long label}[url]
init_tags()

Set up the standard mapping of attributes to HTML tags

start_accepting()

Here‘s the client side of the visitor pattern

wrap(txt, line_len = 76)

This is a higher speed (if messier) version of wrap

[Validate]

ruby-doc.org is hosted and maintained by James Britt and Happy Camper Studios, a Ruby application development company in Phoenix, Arizona. The site was created in 2002 as part of the Ruby Documentation Project to promote the Ruby language and to help other Ruby hackers.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.