How to write ULMUL texts
The encode of input file must be utf-8.
lines
Inside ulmul.rb, input lines are processed as "events" with aasm library https://rubygems.org/gems/aasm .
empty
Empty lines divide paragraphs.
heading
Starting with "= ", "== ", "=== ", "==== ", "===== ", and "====== ". "= " will be used for the title.
asterisk
Lines starting with asterisks become itemizing list. For example,
# Nesting is allowed up to 4th--5th level.
* First
* Second
* Third
* Fourth
* more for Fourth
second continue
* More for third
* More for first
become
- First
- Second
- Third
- Fourth
- more for Fourth
- More for third
- Third
- Second
- More for first
offset
Lines starting with some spaces but not asterisks become verbatim lines.
end
EOF or "=end" end the process.
ignore
Lines starting with "#" and "=begin" are ignored.
normal
Other lines.
Other rules
- Lines after "=end" are ignored.
- Add your substitution rules to @subs_rules.
Equations
Input:
Mass $m$ can be converted into energy $E$ as
\Eq:Emc2
E=mc^2.
/Eq:Emc2
Output:
Mass can be converted into energy as
You can refer the equation in a way like "Eq:Einstein", as Eq. (1).
To view the equations in MathML correctly, please use
- Firefox 4 http://mozilla.jp/firefox/
- IE9 http://windows.microsoft.com/en-US/internet-explorer/products/ie/home
- etc.
Figures
Start a Figure environment with "\Fig:foo FILENAME.jpg" and terminate it with "/Fig:foo", where "foo" is a tag for the figure. You can write a figure caption between them. You can refer the figure with "Fig:foo" as Fig. 1.
Input:
\Fig:ruby ruby.jpg The is a dummy figure for an example. Cute red logo of Ruby, isn't it? You can write equations even in a caption as $ax^2+bx+c=0$. /Fig:ruby
Output:
Tables
Table environment is NOT IMPLEMENTED yet. Start a Table environment with "\Table:bar" and terminate it with "/Table:bar", where "bar" is a tag for the table. You can write a table caption between them. You can refer the table with "Table:bar" as Table 1.
Input:
\Table:diamond The is a dummy caption for the table. /Table:diamond
Output:
| TABLE |
|---|
| Not yet implemented |
Code
Start a Code environment with "\Code:baz FILENAME" and terminate it with "/Code:baz", where "baz" is a tag for the code. You can write a caption between them. You can refer the code with "Code:baz" as Code 1. Code will be highlighted with google-code-prettify when -j https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js is given.
Input:
\Code:hello hello.c Ordinary hello.c. Can you see stdio.h? /Code:hello
Output:
Code 1: Ordinary hello.c. Can you see stdio.h? (download: hello.c)
/* hello.c */
#include <stdio.h>
int main()
{
printf("hello, world\n");
return 0;
}