ulmul 0.1.0 → 0.3.0

data/bin/ulmul2html5

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+# ulmul2html5
+# Time-stamp: <2010-03-30 18:42:10 takeshi>
+# Author: Takeshi Nishimatsu
+##
+=begin
+= ulmul2html
+== Usage
+=== Examples
+ % ulmul2html foo.txt
+ % ulmul2html --style=style.css --name="John Smith" foo.ulmul > foo.html
+ % ulmul2html --style=ulmul-slidy.css --javascript=slidy.js \
+   --name="Takeshi Nishimatsu" presentation.txt > presentation.xhtml
+=== Command options
+==== -s, --style
+Specify stylesheet filename.
+==== -n, --name
+Specify your name for copyright notices.
+==== -j, --javascript
+Specify JavaScript filename.
+==== -l, --language
+Specify natural language. Its default is "en".
+==== -c, --contents-range
+Range of "Contents". Its default is "2..3".
+If you do not need "Contents" at the beginning of the
+output HTML file, set it 3..2.
+==== --help
+Show a help message.
+=end
+require "ulmul"
+require "optparse"
+name = ENV['USER'] || ENV['LOGNAME'] || Etc.getlogin || Etc.getpwuid.name
+language = "en"
+stylesheets = []
+javascripts = []
+contents_range = Ulmul::CONTENTS_RANGE_DEFAULT
+opts = OptionParser.new
+def opts.usage
+  return to_s.sub(/options/,'options] [filename')
+end
+opts.on("-s STYLESHEET_FILENAME","--style STYLESHEET_FILENAME",
+        "Specify stylesheet filename."){|v| stylesheets<<v}
+opts.on("-n YOUR_NAME","--name YOUR_NAME","Specify your name."){|v| name=v}
+opts.on("-j JAVASCRIPT_FILENAME","--javascript JAVASCRIPT_FILENAME",
+        "Specify JavaScript filename."){|v| javascripts<<v}
+opts.on("-l LANGUAGE","--language LANGUAGE",String,
+        "Specify natural language. Its defalt is 'en'."){|v| language=v[0..1].downcase}
+opts.on("-c CONTENTS_RANGE","--contents-range RANGE_OF_CONTENTS_RANGE","Range of Contents."){|v|
+  begin
+    if eval(v).instance_of?(Range)
+      contents_range=eval(v)
+    else
+      raise NameError
+    end
+  rescue NameError
+    raise("Cannot evaluate given \"#{v}\" as a Range")
+  end
+}
+opts.on_tail("-h", "--help", "Show this message."){puts opts.usage; exit}
+
+opts.parse!(ARGV)
+stylesheets=['ulmul2html5.css'] if stylesheets==[]
+
+u=Ulmul.new(contents_range,'ulmul2html5')
+u.parse(ARGF)
+puts u.html(stylesheets,javascripts,name,language)
+
+# Local variables:
+#   compile-command: "ruby -I ../lib ./ulmul2html ulmul2html"
+# End:

data/bin/ulmul2xhtml

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+# ulmul2xhtml
+# Time-stamp: <2010-03-30 18:29:39 takeshi>
+# Author: Takeshi Nishimatsu
+##
+=begin
+= ulmul2html
+== Usage
+=== Examples
+ % ulmul2html foo.txt
+ % ulmul2html --style=style.css --name="John Smith" foo.ulmul > foo.html
+ % ulmul2html --style=ulmul-slidy.css --javascript=slidy.js \
+   --name="Takeshi Nishimatsu" presentation.txt > presentation.xhtml
+=== Command options
+==== -s, --style
+Specify stylesheet filename.
+==== -n, --name
+Specify your name for copyright notices.
+==== -j, --javascript
+Specify JavaScript filename.
+==== -l, --language
+Specify natural language. Its default is "en".
+==== -c, --contents-range
+Range of "Contents". Its default is "2..3".
+If you do not need "Contents" at the beginning of the
+output HTML file, set it 3..2.
+==== --help
+Show a help message.
+=end
+require "ulmul"
+require "optparse"
+name = ENV['USER'] || ENV['LOGNAME'] || Etc.getlogin || Etc.getpwuid.name
+language = "en"
+stylesheets = []
+javascripts = []
+contents_range = Ulmul::CONTENTS_RANGE_DEFAULT
+opts = OptionParser.new
+def opts.usage
+  return to_s.sub(/options/,'options] [filename')
+end
+opts.on("-s STYLESHEET_FILENAME","--style STYLESHEET_FILENAME",
+        "Specify stylesheet filename."){|v| stylesheets<<v}
+opts.on("-n YOUR_NAME","--name YOUR_NAME","Specify your name."){|v| name=v}
+opts.on("-j JAVASCRIPT_FILENAME","--javascript JAVASCRIPT_FILENAME",
+        "Specify JavaScript filename."){|v| javascripts<<v}
+opts.on("-l LANGUAGE","--language LANGUAGE",String,
+        "Specify natural language. Its defalt is 'en'."){|v| language=v[0..1].downcase}
+opts.on("-c CONTENTS_RANGE","--contents-range RANGE_OF_CONTENTS_RANGE","Range of Contents."){|v|
+  begin
+    if eval(v).instance_of?(Range)
+      contents_range=eval(v)
+    else
+      raise NameError
+    end
+  rescue NameError
+    raise("Cannot evaluate given \"#{v}\" as a Range")
+  end
+}
+opts.on_tail("-h", "--help", "Show this message."){puts opts.usage; exit}
+
+opts.parse!(ARGV)
+stylesheets=['ulmul2xhtml.css'] if stylesheets==[]
+
+u=Ulmul.new(contents_range,'ulmul2xhtml')
+u.parse(ARGF)
+puts u.html(stylesheets,javascripts,name,language)
+
+# Local variables:
+#   compile-command: "ruby -I ../lib ./ulmul2html ulmul2html"
+# End:

data/index.en.html

@@ -0,0 +1,330 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN"
+                     "http://www.w3.org/Math/DTD/mathml2/xhtml-math11-f.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">
+<head>
+  <meta http-equiv="content-type" content="application/xhtml+xml; charset=utf-8" />
+  <title>ULMUL (Ultra Lightweight MarkUp Language)</title>
+  <meta name="author" content="Takeshi Nishimatsu" />
+  <meta name="copyright" content="Copyright &#169; 2010 Takeshi Nishimatsu" />
+  <link rel="stylesheet" href="ulmul2xhtml.css" type="text/css" />
+  <link rel="shortcut icon" href="favicon.ico" />
+</head>
+<body>
+<div class="slide cover">
+<h1 id="LABEL-1">ULMUL (Ultra Lightweight MarkUp Language)</h1>
+<p>
+"ULMUL" is an original Ultra Lightweight MarkUp Language.
+ULMUL texts can be converted into HTML5 with "ulmul2html5" command
+and into XHTML with "ulmul2xhtml" command.
+TeX stile equations are converted into MathML.
+ULMUL is written in Ruby.
+You can also use ulmul.rb as a library.
+</p>
+<p>
+Homepage of ULMUL: <a href="http://ulmul.rubyforge.org/">http://ulmul.rubyforge.org/</a>
+</p>
+<p>
+Download ULMUL from: <a href="http://rubyforge.org/projects/ulmul">http://rubyforge.org/projects/ulmul</a> or <a href="http://rubygems.org/gems/ulmul">http://rubygems.org/gems/ulmul</a>
+</p>
+<br />Contents:
+<ul>
+  <li><a href="#LABEL-2">Features</a></li>
+  <li><a href="#LABEL-3">Installation of ULMUL</a>
+    <ul>
+      <li><a href="#LABEL-4">I. Conservative way; use setup.rb</a></li>
+      <li><a href="#LABEL-5">II. RubyGems users can take an easy way</a></li>
+    </ul></li>
+  <li><a href="#LABEL-6">How to write ULMUL texts</a>
+    <ul>
+      <li><a href="#LABEL-7">lines</a></li>
+      <li><a href="#LABEL-15">Other rules</a></li>
+      <li><a href="#LABEL-16">Equations</a></li>
+      <li><a href="#LABEL-17">Figures</a></li>
+    </ul></li>
+  <li><a href="#LABEL-18">Usage</a>
+    <ul>
+      <li><a href="#LABEL-19">Examples</a></li>
+      <li><a href="#LABEL-20">Command options</a></li>
+      <li><a href="#LABEL-27">ULMUL and Slidy examples</a></li>
+    </ul></li>
+  <li><a href="#LABEL-28">TODO</a></li>
+  <li><a href="#LABEL-29">Subversion repository</a></li>
+  <li><a href="#LABEL-30">Copying</a></li>
+  <li><a href="#LABEL-31">Author of ULMUL</a></li>
+</ul>
+
+</div>
+
+
+<div class="slide">
+<h2 id="LABEL-2">Features</h2>
+
+<ul>
+  <li>TeX style equations between two dollar marks ($) and between Eq. and /Eq.
+    will be converted into MathML. You can use Firefox version 3.x, IE+MathPlayer,
+    etc. to read MathML.</li>
+  <li>ulmul2xhtml output is good with the Slidy presentation environment
+    <a href="http://www.w3.org/Talks/Tools/Slidy/">http://www.w3.org/Talks/Tools/Slidy/</a> using Firefox+CSS+XHTML+JavaScript.</li>
+  <li>Lines starting from "#" are comments.</li>
+  <li>You can add your conversion rules to @subs_rules.</li>
+  <li>List of contents will be automatically generated.</li>
+  <li>"= ABC EFGH" will be the document title and the cover page of Slidy.</li>
+  <li>Use utf-8 for ULMUL texts.
+    Specify your natural language with a --language option, e.g. --language=en.</li>
+</ul>
+</div>
+
+
+<div class="slide">
+<h2 id="LABEL-3">Installation of ULMUL</h2>
+<p>
+There are two different ways to install ULMUL.
+</p>
+<h3 id="LABEL-4">I. Conservative way; use setup.rb</h3>
+<p>
+ulmul-X.Y.Z.tgz package can be installed as:
+</p>
+<pre> $ tar zxf ulmul-X.Y.Z.tgz
+ $ cd ulmul-X.Y.Z
+ $ su
+ # ruby setup.rb
+</pre>
+<p>
+Note that the eimxml and mathml libraries are required.
+</p>
+<h3 id="LABEL-5">II. RubyGems users can take an easy way</h3>
+<p>
+There is an easy way, if you are a RubyGems user:
+</p>
+<pre> $ su
+ # gem install ulmul
+</pre>
+<p>
+If you do not have the eimxml and mathml libraries, gem will download and install the
+library automatically.
+</p>
+</div>
+
+
+<div class="slide">
+<h2 id="LABEL-6">How to write ULMUL texts</h2>
+<p>
+The encode of input file must be utf-8.
+</p>
+<h3 id="LABEL-7">lines</h3>
+<h4 id="LABEL-8">empty</h4>
+<p>
+Empty lines divide paragraphs.
+</p>
+<h4 id="LABEL-9">heading</h4>
+<p>
+Starting with "= ", "== ", "=== ", "==== ", "===== ", and "====== ".
+"= " will be used for the title.
+</p>
+<h4 id="LABEL-10">asterisk</h4>
+<p>
+Lines starting with
+</p>
+<pre>" *"
+"   *"
+"     *"
+"       *"
+"         *"
+</pre>
+<p>
+become itemize.
+</p>
+<h4 id="LABEL-11">offset</h4>
+<p>
+Lines starting with some spaces but not asterisks become verbatim lines.
+</p>
+<h4 id="LABEL-12">end</h4>
+<p>
+EOF or "=end" end the process.
+</p>
+<h4 id="LABEL-13">ignore</h4>
+<p>
+Lines starting with"#" and "=begin" are ignored.
+</p>
+<h4 id="LABEL-14">normal</h4>
+<p>
+Other lines.
+</p>
+<h3 id="LABEL-15">Other rules</h3>
+
+<ul>
+  <li>Lines after "=end" are ignored.</li>
+  <li>Add your substitution rules to @subs_rules.</li>
+</ul>
+<h3 id="LABEL-16">Equations</h3>
+<p>
+Input:
+</p>
+<pre>Mass $m$ can be converted into energy $E$ as
+Eq. 1
+           E=mc^2.
+/Eq.
+</pre>
+<p>
+Output:
+</p>
+<p>
+Mass <math xmlns='http://www.w3.org/1998/Math/MathML' display='inline'><mi>m</mi></math> can be converted into energy <math xmlns='http://www.w3.org/1998/Math/MathML' display='inline'><mi>E</mi></math> as
+<math xmlns='http://www.w3.org/1998/Math/MathML' display='block'>
+ <mi>E</mi>
+ <mo>=</mo>
+ <mi>m</mi>
+ <msup>
+  <mi>c</mi>
+  <mn>2</mn>
+ </msup>
+ <mo>.</mo>
+</math>
+</p>
+<p>
+To view the equations in MathML correctly, please use
+</p>
+
+<ul>
+  <li>Firefox <a href="http://mozilla.jp/firefox/">http://mozilla.jp/firefox/</a></li>
+  <li>IE8 + MathPlayer <a href="http://www.dessci.com/en/products/mathplayer/">http://www.dessci.com/en/products/mathplayer/</a></li>
+  <li>etc.</li>
+</ul>
+<h3 id="LABEL-17">Figures</h3>
+<p>
+Input:
+</p>
+<pre>Fig. 1 ruby.jpg
+  The is a dummy figure for an example.
+  Cute red logo of Ruby, isn't it?
+/Fig.
+</pre>
+<p>
+Output:
+</p>
+<div class="figure">
+  <img src="ruby.jpg" alt="ruby.jpg" />
+  <div class="figcaption">
+  The is a dummy figure for an example.
+  Cute red logo of Ruby, isn't it?
+  </div>
+</div>
+</div>
+
+
+<div class="slide">
+<h2 id="LABEL-18">Usage</h2>
+<p>
+There are ulmul2xhtml and ulmul2html5 commands.
+</p>
+<p>
+Use .html extensions even for ulmul2xhtml outputs.
+</p>
+<p>
+To view HTML5 documents,
+change the setting of the "html5.enable" entry to "true" in "about:config".
+See <a href="http://kb.mozillazine.org/About:config">http://kb.mozillazine.org/About:config</a> for details.
+</p>
+<h3 id="LABEL-19">Examples</h3>
+<pre>$ ulmul2xhtml without-equations.txt &gt; without-equations.html   # XHTML1.0 Transitional
+$ ulmul2xhtml with-equations.txt    &gt; with-equations.html      # XHTML1.1 + MathML2.0
+$ ulmul2xhtml -n 'Takeshi Nishimatsu' -s ulmul-slidy.css -j slidy.js presentation.txt &gt; presentation.xhtml
+$ ulmul2html5 with-equations.txt    &gt; with-equations.html      # HTML5
+</pre>
+<h3 id="LABEL-20">Command options</h3>
+<h4 id="LABEL-21">--help</h4>
+<p>
+Show a help message.
+</p>
+<h4 id="LABEL-22">-s, --style</h4>
+<p>
+Specify stylesheet filename.
+</p>
+<h4 id="LABEL-23">-n, --name</h4>
+<p>
+Specify your name for copyright notices.
+</p>
+<h4 id="LABEL-24">-j, --javascript</h4>
+<p>
+Specify JavaScript filename.
+</p>
+<h4 id="LABEL-25">-l, --language</h4>
+<p>
+Specify natural language. Its default is "en".
+</p>
+<h4 id="LABEL-26">-c, --contents-range</h4>
+<p>
+Range of "Contents". Its default is "2..3".
+If you do not need "Contents" at the beginning of the
+output HTML file, set it 3..2.
+</p>
+<h3 id="LABEL-27">ULMUL and Slidy examples</h3>
+
+<ul>
+  <li><a href="http://loto.sourceforge.net/feram/">http://loto.sourceforge.net/feram/</a>
+    <ul>
+      <li>Its source is <a href="http://loto.sourceforge.net/feram/README">http://loto.sourceforge.net/feram/README</a></li>
+    </ul></li>
+  <li><a href="http://loto.sourceforge.net/feram/doc/film.xhtml">http://loto.sourceforge.net/feram/doc/film.xhtml</a>
+    <ul>
+      <li>It is a Slidy presentation made from <a href="http://loto.sourceforge.net/feram/doc/film.txt">http://loto.sourceforge.net/feram/doc/film.txt</a></li>
+    </ul></li>
+</ul>
+</div>
+
+
+<div class="slide">
+<h2 id="LABEL-28">TODO</h2>
+
+<ul>
+  <li>rescue syntax errors (raises) in an input file and report the
+    errors as #{$FILENAME}:#{file.lineno}:...</li>
+  <li>Unit test, tests/ulmul_test.rb</li>
+  <li>@body must be XML object, not a String.</li>
+  <li>Tables.</li>
+  <li>References to figures, tables and code.</li>
+  <li>Citation.</li>
+  <li>Include highlighted code between Code.../Code.</li>
+</ul>
+</div>
+
+
+<div class="slide">
+<h2 id="LABEL-29">Subversion repository</h2>
+<p>
+You can checkout the latest source tree of ULMUL anonymously from RubyForge with svn(1) command:
+</p>
+<pre>$ svn co svn://rubyforge.org/var/svn/ulmul/ulmul/trunk ulmul
+</pre>
+</div>
+
+
+<div class="slide">
+<h2 id="LABEL-30">Copying</h2>
+<p>
+ulmul.rb is distributed in the hope that
+it will be useful, but WITHOUT ANY WARRANTY.
+You can copy, modify and redistribute ulmul.rb,
+but only under the conditions described in
+the GNU General Public License (the "GPL").
+</p>
+<p>
+W3C has copyrights for slidy.js and ulmul-slidy.css (originally
+named slidy.css). Takeshi Nishimatsu modified them.
+You can download the original package, slidy.zip, from
+<a href="http://www.w3.org/Talks/Tools/Slidy/">http://www.w3.org/Talks/Tools/Slidy/</a> . You can find
+their licenses at <a href="http://www.w3.org/Consortium/Legal/copyright-documents">http://www.w3.org/Consortium/Legal/copyright-documents</a>
+and <a href="http://www.w3.org/Consortium/Legal/copyright-software">http://www.w3.org/Consortium/Legal/copyright-software</a> .
+</p>
+</div>
+
+
+<div class="slide">
+<h2 id="LABEL-31">Author of ULMUL</h2>
+<p>
+Takeshi Nishimatsu (t_nissie{at}yahoo.co.jp)
+</p>
+</div>
+</body>
+</html>