Sven Utcke's MM-RST-Page

• Skip Menu
• Main Page
• Software
• • Quizcard
  • mm-rst

What is it?

MM-RST is a post-, aehm, pre-, aehm, infix-processor for mm/lx files. It allows you to write files in a syntax similar to ReStructured Text and have mm-rst translate this into html-markup, which then results in nicer pages when finally output to HTML by mm/lx.

Currently supported are:

Unordered lists

These start with "[-*+] ", allowing you to achive the following effect:

You write:	You get
* item one - next item + last item	item one next item last item

RST-compatibility

• RST allows a few more (non ASCII) symbols.
• Changing the symbol within a list in RST results in a new list being started.
• RST requires an empty line before and after the list.

Ordered Lists

These start with one of: "(\(#|[a-z]|[A-Z]|[0-9]+\)) " or "\(#|[a-z]|[A-Z]|[0-9]+\)[).] ", allowing you to achive the following effect:

You write:	You get
#. First item 1) Second item a. Third item 12345) A highly numbered item	First item Second item Third item A highly numbered item

RST-compatibility

• RST allows roman numerals too.
• Changing the symbol within a list in RST results in a new list being started.
• RST might use the actual symbol provided.
• RST requires an empty line before and after the list.

Definition Lists

These start with ":tag text: ", allowing you to achive the following effect:

You write:	You get
:tag 1: First definition :tag 2: Second definition :tagtag: Third definition	tag 1 First definition tag 2 Second definition tagtag Third definition

RST-compatibility

• These are called "Field Lists" in RST and are normally rendered using a table; however, syntactically these really are definition lists.
• RST requires an empty line before and after the list.

Accentuations

You can surround a phrase with a pair of either "*" or "**", allowing you to achive the following effect:

You write:	You get
*This* text shows **several *different* accentuations**	This text shows several different accentuations

RST-compatibility

• These are 100% RST compatible.

Links

You can write one of "<url>" or "<<url>tag text>" to create inline links, allowing you to achive the following effect:

You write:	You get
My homepage can be found <<http://www.desy.de/~utcke>here>, or you can have a look at <http://kogs-www.informatik.uni-hamburg.de>.	My homepage can be found here, or you can have a look at http://kogs-www.informatik.uni-hamburg.de.

RST-compatibility

• These are completely different from the RST syntax, however, since the RST-syntax for links in particular is very hard to parse I'm afraid we just have to live with it...

| A | B | A&B |
| 0 | 0 |  0  |
| 0 | 1 |  0  |
| 1 | 0 |  0  |
| 1 | 1 |  1  |
          

Usage

Currently, mm-rst simply reads from stdin and writes to stdout, so you would usually call is as

License

You are very much welcome to use this code any way you see fit. I use it, and so far haven't lost any data (or at least haven't noticed the loss) - but this IS alpha-quality code, and you could lose information. You have been warned!

That said, I would be delighted if this would turn out to be any use to someone, and even mored delighted to receive any Bug-reports or feature-requests.

Download