2003-12-01 02:12:49 -05:00
|
|
|
# This program illustrates the basic use of the SimpleMarkup
|
2007-12-28 01:39:15 -05:00
|
|
|
# class. It extracts the first comment block from the
|
2003-12-01 02:12:49 -05:00
|
|
|
# simple_markup.rb file and converts it into HTML on
|
|
|
|
|
# standard output. Run it using
|
|
|
|
|
#
|
|
|
|
|
# % ruby sample.rb
|
|
|
|
|
#
|
2007-12-28 01:39:15 -05:00
|
|
|
# You should be in the sample/rdoc/markup/ directory when you do this,
|
2003-12-01 02:12:49 -05:00
|
|
|
# as it hardwires the path to the files it needs to require.
|
2007-12-28 01:39:15 -05:00
|
|
|
# This isn't necessary in the code you write once you've
|
2003-12-01 02:12:49 -05:00
|
|
|
# installed the package.
|
|
|
|
|
#
|
|
|
|
|
# For a better way of formatting code comment blocks (and more)
|
|
|
|
|
# see the rdoc package.
|
|
|
|
|
#
|
|
|
|
|
|
|
|
|
|
require 'rdoc/markup/simple_markup'
|
|
|
|
|
require 'rdoc/markup/simple_markup/to_html'
|
|
|
|
|
|
|
|
|
|
# Extract the comment block from the source file
|
|
|
|
|
|
|
|
|
|
input_string = ""
|
|
|
|
|
|
2007-12-28 01:39:15 -05:00
|
|
|
File.foreach("../../../lib/rdoc/markup/simple_markup.rb") do |line|
|
2003-12-01 02:12:49 -05:00
|
|
|
break unless line.gsub!(/^\# ?/, '')
|
|
|
|
|
input_string << line
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Create a markup object
|
|
|
|
|
markup = SM::SimpleMarkup.new
|
|
|
|
|
|
|
|
|
|
# Attach it to an HTML formatter
|
|
|
|
|
h = SM::ToHtml.new
|
|
|
|
|
|
|
|
|
|
# And convert out comment block to html. Wrap it a body
|
|
|
|
|
# tag pair to let browsers view it
|
|
|
|
|
|
|
|
|
|
puts "<html><body>"
|
|
|
|
|
puts markup.convert(input_string, h)
|
|
|
|
|
puts "</body></html>"
|
