diff options
| author | drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2007-12-28 06:39:15 +0000 |
|---|---|---|
| committer | drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2007-12-28 06:39:15 +0000 |
| commit | ecb7eb6ba4a6f10ac9ff2e7531c9b12ac81646c5 (patch) | |
| tree | 798ee6dd17a811a2819ca4be117e899245f5e094 /sample/rdoc/markup/sample.rb | |
| parent | cc54d01f8bcbffb2a66db767bbe3f367b86a78c5 (diff) | |
Move RDoc markup samples to sample/rdoc/markup directory
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@14761 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'sample/rdoc/markup/sample.rb')
| -rw-r--r-- | sample/rdoc/markup/sample.rb | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/sample/rdoc/markup/sample.rb b/sample/rdoc/markup/sample.rb new file mode 100644 index 0000000000..db5d88d150 --- /dev/null +++ b/sample/rdoc/markup/sample.rb @@ -0,0 +1,40 @@ +# This program illustrates the basic use of the SimpleMarkup +# class. It extracts the first comment block from the +# simple_markup.rb file and converts it into HTML on +# standard output. Run it using +# +# % ruby sample.rb +# +# You should be in the sample/rdoc/markup/ directory when you do this, +# as it hardwires the path to the files it needs to require. +# This isn't necessary in the code you write once you've +# 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 = "" + +File.foreach("../../../lib/rdoc/markup/simple_markup.rb") do |line| + 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>" |