summaryrefslogtreecommitdiff
path: root/jni/ruby/sample/rdoc
diff options
context:
space:
mode:
Diffstat (limited to 'jni/ruby/sample/rdoc')
-rw-r--r--jni/ruby/sample/rdoc/markup/rdoc2latex.rb15
-rw-r--r--jni/ruby/sample/rdoc/markup/sample.rb40
2 files changed, 55 insertions, 0 deletions
diff --git a/jni/ruby/sample/rdoc/markup/rdoc2latex.rb b/jni/ruby/sample/rdoc/markup/rdoc2latex.rb
new file mode 100644
index 0000000..aa8079e
--- /dev/null
+++ b/jni/ruby/sample/rdoc/markup/rdoc2latex.rb
@@ -0,0 +1,15 @@
+#!/usr/local/bin/ruby
+# Illustration of a script to convert an RDoc-style file to a LaTeX document
+
+require 'rdoc/markup'
+require 'rdoc/markup/to_latex'
+
+p = RDoc::Markup.new
+h = RDoc::Markup::ToLaTeX.new
+
+#puts "\\documentclass{report}"
+#puts "\\usepackage{tabularx}"
+#puts "\\usepackage{parskip}"
+#puts "\\begin{document}"
+puts p.convert(ARGF.read, h)
+#puts "\\end{document}"
diff --git a/jni/ruby/sample/rdoc/markup/sample.rb b/jni/ruby/sample/rdoc/markup/sample.rb
new file mode 100644
index 0000000..db5d88d
--- /dev/null
+++ b/jni/ruby/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>"