RDoc::Markup::ToLabel

Creates HTML-safe labels suitable for use in id attributes. Tidylinks are converted to their link part and cross-reference links have the suppression marks removed (\SomeClass is converted to SomeClass).

Methods

C

convert

H

handle_special_CROSSREF,
handle_special_TIDYLINK

N

Class Public methods

new(markup = nil) Link

Creates a new formatter that will output HTML-safe labels

Source: show

# File lib/rdoc/markup/to_label.rb, line 15
def initialize markup = nil
  super nil, markup

  @markup.add_special RDoc::CrossReference::CROSSREF_REGEXP, :CROSSREF
  @markup.add_special(/(((\{.*?\})|\b\S+?)\[\S+?\])/, :TIDYLINK)

  add_tag :BOLD, '', ''
  add_tag :TT,   '', ''
  add_tag :EM,   '', ''

  @res = []
end

Instance Public methods

convert(text) Link

Converts text to an HTML-safe label

Source: show

# File lib/rdoc/markup/to_label.rb, line 31
def convert text
  label = convert_flow @am.flow text

  CGI.escape label
end

handle_special_CROSSREF(special) Link

Converts the CROSSREF special to plain text, removing the suppression marker, if any

Source: show

# File lib/rdoc/markup/to_label.rb, line 41
def handle_special_CROSSREF special
  text = special.text

  text.sub(/^\/, '')
end

handle_special_TIDYLINK(special) Link

Converts the TIDYLINK special to just the text part

Source: show

# File lib/rdoc/markup/to_label.rb, line 50
def handle_special_TIDYLINK special
  text = special.text

  return text unless text =~ /\{(.*?)\}\[(.*?)\]/ or text =~ /(\S+)\[(.*?)\]/

  $1
end

Class RDoc::Markup::ToLabel < RDoc::Markup::Formatter