From 4d51dc76d08e80c0a5ac0abf31d8e1ced153d161 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?John=20Ankarstr=C3=B6m?=
-Em is a limited hypertext markup language.
-
-It is similar to Markdown, but it has a few key advantages:
+Em is a limited hypertext markup language that is designed to be
+maximally readable. It is similar to Markdown, but it has a few key advantages:
-Em takes plain-text readability seriously. You should be able to
-write em in a plain-text e-mail message without the recipient noticing.
-On the other hand, that means that it is limited in terms of what HTML
-it can produce. Most noticeably, only a very limited form of inline links
-are supported (see Lists and Inline formatting).
+Em values readability over expressiveness. This means that it is rather limited
+in terms of what HTML it can produce. Most noticeably, only a very limited
+form of inline links are supported (see Lists and Inline formatting).
+
+Em also values consistency and predictability. As such, the syntax is rather
+strict. This makes it a bit harder to learn, but much more predictable.
-For examples, see the source code for this text (link) or the test file (link).
+Em's complete and exact syntax is defined by its implementation (link), but a
+general description follows below. For longer examples, see the source
+code for this text (link) or the test file (link).
Em is implemented in portable awk, with an rc script to bind it together.
-The rc script can (more or less) trivially be translated to POSIX shell,
-but the work has not been done yet.
+It is written on and for Plan 9 primarily, but the rc code can (more or less)
+trivially be translated to POSIX shell; the work just hasn't been done yet.
-Em's complete and exact syntax is defined by its implementation (link),
-but a general description follows below.
+Em also includes the rc script htwrap, which can be used to create a
+standalone HTML document from em output.
-
Inline formatting
@@ -75,9 +76,9 @@ reference refers to a reference containing only a web address,
the inline reference is replaced with a hyperlink to that address.
-It is available for download [a]. +It is available for download [2]. - [a] v1.tgz + [2] v1.tgz
The above example translates to the following HTML: -- cgit v1.2.3