/tools/Ruby/lib/ruby/1.8/rdoc/markup/sample/sample.rb

http://github.com/agross/netopenspace · Ruby · 42 lines · 13 code · 9 blank · 20 comment · 0 complexity · adcdb544a65f22a9cfaea0f20ec4aad3 MD5 · raw file 

    

  1. # This program illustrates the basic use of the SimpleMarkup
    2. 

  2. # class. It extracts the first comment block from the 
    3. 

  3. # simple_markup.rb file and converts it into HTML on
    4. 

  4. # standard output. Run it using
    5. 

  5. #
    6. 

  6. #  % ruby sample.rb
    7. 

  7. #
    8. 

  8. # You should be in the sample/ directory when you do this,
    9. 

  9. # as it hardwires the path to the files it needs to require.
    10. 

  10. # This isn't necessary in the code you write once you've 
    11. 

  11. # installed the package.
    12. 

  12. #
    13. 

  13. # For a better way of formatting code comment blocks (and more)
    14. 

  14. # see the rdoc package.
    15. 

  15. #
    16. 

  16. 

  17. $:.unshift "../../.."
    18. 

  18. 

  19. require 'rdoc/markup/simple_markup'
    20. 

  20. require 'rdoc/markup/simple_markup/to_html'
    21. 

  21. 

  22. # Extract the comment block from the source file
    23. 

  23. 

  24. input_string = ""
    25. 

  25. 

  26. File.foreach("../simple_markup.rb") do |line|
    27. 

  27.   break unless line.gsub!(/^\# ?/, '')
    28. 

  28.   input_string << line
    29. 

  29. end
    30. 

  30. 

  31. # Create a markup object
    32. 

  32. markup = SM::SimpleMarkup.new
    33. 

  33. 

  34. # Attach it to an HTML formatter
    35. 

  35. h = SM::ToHtml.new
    36. 

  36. 

  37. # And convert out comment block to html. Wrap it a body
    38. 

  38. # tag pair to let browsers view it
    39. 

  39. 

  40. puts "<html><body>"
    41. 

  41. puts markup.convert(input_string, h)
    42. 

  42. puts "</body></html>"
    43.