Sha256: 8bd4682923969554bbb7d90a7423f171fcae24e2952d7da7619c2fc3d67974dc

Contents?: true

Size: 1.15 KB

Versions: 102

Compression:

Stored size: 1.15 KB

Contents

require 'cgi'

##
# 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).

class RDoc::Markup::ToLabel < RDoc::Markup::Formatter

  ##
  # Creates a new formatter that will output HTML-safe labels

  def initialize markup = nil
    super

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

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

  ##
  # Converts +text+ to an HTML-safe label

  def convert text
    label = convert_flow @am.flow text

    CGI.escape label
  end

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

  def handle_special_CROSSREF special
    text = special.text

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

  ##
  # Converts the TIDYLINK +special+ to just the text part

  def handle_special_TIDYLINK special
    text = special.text

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

    $1
  end

end

Version data entries

102 entries across 80 versions & 20 rubygems

Version Path
challah-0.5.0 vendor/bundle/gems/rdoc-3.12/lib/rdoc/markup/to_label.rb
challah-0.4.1 vendor/bundle/gems/rdoc-3.12/lib/rdoc/markup/to_label.rb
challah-0.4.0 vendor/bundle/gems/rdoc-3.12/lib/rdoc/markup/to_label.rb
challah-0.3.5 vendor/bundle/gems/rdoc-3.12/lib/rdoc/markup/to_label.rb
challah-0.3.4 vendor/bundle/gems/rdoc-3.12/lib/rdoc/markup/to_label.rb
challah-0.3.3 vendor/bundle/gems/rdoc-3.12/lib/rdoc/markup/to_label.rb
challah-0.3.2 vendor/bundle/gems/rdoc-3.12/lib/rdoc/markup/to_label.rb
challah-0.3.1 vendor/bundle/gems/rdoc-3.12/lib/rdoc/markup/to_label.rb
challah-0.3.0 vendor/bundle/gems/rdoc-3.12/lib/rdoc/markup/to_label.rb
challah-0.2.1 vendor/bundle/gems/rdoc-3.12/lib/rdoc/markup/to_label.rb
challah-0.2.0 vendor/bundle/gems/rdoc-3.12/lib/rdoc/markup/to_label.rb
horseman-0.0.4 vendor/ruby/1.9.1/gems/rdoc-3.12/lib/rdoc/markup/to_label.rb
horseman-0.0.4 vendor/ruby/1.9.1/gems/rdoc-3.11/lib/rdoc/markup/to_label.rb
horseman-0.0.3 vendor/ruby/1.9.1/gems/rdoc-3.11/lib/rdoc/markup/to_label.rb
horseman-0.0.3 vendor/ruby/1.9.1/gems/rdoc-3.12/lib/rdoc/markup/to_label.rb
horseman-0.0.2 vendor/ruby/1.9.1/gems/rdoc-3.11/lib/rdoc/markup/to_label.rb
rdoc-3.12 lib/rdoc/markup/to_label.rb
rdoc-3.11 lib/rdoc/markup/to_label.rb
rdoc-3.10 lib/rdoc/markup/to_label.rb
rdoc-3.10.pre.3 lib/rdoc/markup/to_label.rb