RDoc::Markup::ToFlow

Constants

InlineTag
LIST_TYPE_TO_HTML

Public Class Methods

new() click to toggle source

 
               # File rdoc/markup/to_flow.rb, line 38
def initialize
  super

  init_tags
end

Public Instance Methods

accept_blank_line(am, fragment) click to toggle source

 
               # File rdoc/markup/to_flow.rb, line 113
def accept_blank_line(am, fragment)
  # @res << annotate("<p />") << "\n"
end

accept_heading(am, fragment) click to toggle source

 
               # File rdoc/markup/to_flow.rb, line 117
def accept_heading(am, fragment)
  @res << Flow::H.new(fragment.head_level, convert_flow(am.flow(fragment.txt)))
end

accept_list_end(am, fragment) click to toggle source

 
               # File rdoc/markup/to_flow.rb, line 105
def accept_list_end(am, fragment)
  @res = @list_stack.pop
end

accept_list_item(am, fragment) click to toggle source

 
               # File rdoc/markup/to_flow.rb, line 109
def accept_list_item(am, fragment)
  @res << Flow::LI.new(fragment.param, convert_flow(am.flow(fragment.txt)))
end

accept_list_start(am, fragment) click to toggle source

 
               # File rdoc/markup/to_flow.rb, line 98
def accept_list_start(am, fragment)
  @list_stack.push(@res)
  list = Flow::LIST.new(fragment.type)
  @res << list
  @res = list
end

accept_paragraph(am, fragment) click to toggle source

 
               # File rdoc/markup/to_flow.rb, line 84
def accept_paragraph(am, fragment)
  @res << Flow::P.new((convert_flow(am.flow(fragment.txt))))
end

accept_rule(am, fragment) click to toggle source

 
               # File rdoc/markup/to_flow.rb, line 92
def accept_rule(am, fragment)
  size = fragment.param
  size = 10 if size > 10
  @res << Flow::RULE.new(size)
end

accept_verbatim(am, fragment) click to toggle source

 
               # File rdoc/markup/to_flow.rb, line 88
def accept_verbatim(am, fragment)
  @res << Flow::VERB.new((convert_flow(am.flow(fragment.txt))))
end

add_tag(name, start, stop) click to toggle source

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

 
               # File rdoc/markup/to_flow.rb, line 59
def add_tag(name, start, stop)
  @attr_tags << InlineTag.new(RDoc::Markup::Attribute.bitmap_for(name), start, stop)
end

annotate(tag) click to toggle source

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

 
               # File rdoc/markup/to_flow.rb, line 68
def annotate(tag)
  tag
end

end_accepting() click to toggle source

 
               # File rdoc/markup/to_flow.rb, line 80
def end_accepting
  @res
end

init_tags() click to toggle source

Set up the standard mapping of attributes to HTML tags

 
               # File rdoc/markup/to_flow.rb, line 47
def init_tags
  @attr_tags = [
    InlineTag.new(RDoc::Markup::Attribute.bitmap_for(:BOLD), "<b>", "</b>"),
    InlineTag.new(RDoc::Markup::Attribute.bitmap_for(:TT),   "<tt>", "</tt>"),
    InlineTag.new(RDoc::Markup::Attribute.bitmap_for(:EM),   "<em>", "</em>"),
  ]
end

start_accepting() click to toggle source

Here’s the client side of the visitor pattern

 
               # File rdoc/markup/to_flow.rb, line 75
def start_accepting
  @res = []
  @list_stack = []
end

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please see Improve the docs, or visit Documenting-ruby.org.

Home Classes Methods

In Files

Parent

Methods

Files

Class/Module Index

RDoc::Markup::ToFlow

Constants

Public Class Methods

Public Instance Methods