class RDoc::Markup::ToBs
Outputs RDoc
markup with hot backspace action! You will probably need a pager to use this output format.
This formatter won’t work on 1.8.6 because it lacks String#chars.
Public Class Methods
Source
# File lib/rdoc/markup/to_bs.rb, line 13 def initialize markup = nil super @in_b = false @in_em = false end
Returns a new ToBs
that is ready for hot backspace action!
Calls superclass method
RDoc::Markup::ToRdoc::new
Public Instance Methods
Source
# File lib/rdoc/markup/to_bs.rb, line 33 def accept_heading heading use_prefix or @res << ' ' * @indent @res << @headings[heading.level][0] @in_b = true @res << attributes(heading.text) @in_b = false @res << @headings[heading.level][1] @res << "\n" end
Makes heading text bold.
Source
# File lib/rdoc/markup/to_bs.rb, line 46 def accept_list_item_start list_item type = @list_type.last case type when :NOTE, :LABEL then bullets = Array(list_item.label).map do |label| attributes(label).strip end.join "\n" bullets << ":\n" unless bullets.empty? @prefix = ' ' * @indent @indent += 2 @prefix << bullets + (' ' * @indent) else bullet = type == :BULLET ? '*' : @list_index.last.to_s + '.' @prefix = (' ' * @indent) + bullet.ljust(bullet.length + 1) width = bullet.length + 1 @indent += width end end
Prepares the visitor for consuming list_item
Source
# File lib/rdoc/markup/to_bs.rb, line 71 def annotate tag case tag when '+b' then @in_b = true when '-b' then @in_b = false when '+_' then @in_em = true when '-_' then @in_em = false end '' end
Turns on or off regexp handling for convert_string
Source
# File lib/rdoc/markup/to_bs.rb, line 84 def convert_regexp_handling target convert_string super end
Calls convert_string
on the result of convert_regexp_handling
Calls superclass method
RDoc::Markup::Formatter#convert_regexp_handling
Source
# File lib/rdoc/markup/to_bs.rb, line 91 def convert_string string return string unless @in_b or @in_em chars = if @in_b then string.chars.map do |char| "#{char}\b#{char}" end elsif @in_em then string.chars.map do |char| "_\b#{char}" end end chars.join end
Adds bold or underline mixed with backspaces