Module: RDoc::Generator::MarkUp

Included in:
Context, HTML, Method, Texinfo
Defined in:
lib/rdoc/generator.rb

Overview

Handle common markup tasks for the various Context subclasses

Instance Method Summary collapse

Instance Method Details

#cvs_url(url, full_path) ⇒ Object

Build a webcvs URL with the given ‘url’ argument. URLs with a ‘%s’ in them get the file’s path sprintfed into them; otherwise they’re just catenated together.



121
122
123
124
125
126
127
 
# File 'lib/rdoc/generator.rb', line 121

def cvs_url(url, full_path)
  if /%s/ =~ url
    return sprintf( url, full_path )
  else
    return url + full_path
  end
end

#markup(str, remove_para = false) ⇒ Object

Convert a string in markup format into HTML.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/rdoc/generator.rb', line 80

def markup(str, remove_para = false)
  return '' unless str

  # Convert leading comment markers to spaces, but only if all non-blank
  # lines have them
  if str =~ /^(?>\s*)[^\#]/ then
    content = str
  else
    content = str.gsub(/^\s*(#+)/) { $1.tr '#', ' ' }
  end

  res = @formatter.convert content

  if remove_para then
    res.sub!(/^<p>/, '')
    res.sub!(/<\/p>$/, '')
  end

  res
end

#style_url(path, css_name = nil) ⇒ Object

Qualify a stylesheet URL; if if css_name does not begin with ‘/’ or ‘http://’, prepend a prefix relative to path. Otherwise, return it unmodified.



106
107
108
109
110
111
112
113
114
 
# File 'lib/rdoc/generator.rb', line 106

def style_url(path, css_name=nil)
#      $stderr.puts "style_url( #{path.inspect}, #{css_name.inspect} )"
  css_name ||= CSS_NAME
  if %r{^(https?:/)?/} =~ css_name
    css_name
  else
    RDoc::Generator.gen_url path, css_name
  end
end