aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Ankarström <john@ankarstrom.se>2021-01-31 13:23:18 +0000
committerJohn Ankarström <john@ankarstrom.se>2021-01-31 13:23:18 +0000
commitc24ff6b3ff7abdfeff9fde7d19075ea1edec087c (patch)
tree3097d9c960d7f2376df66d7693e8592d70f7f058
parent6fa6614b3a7e87e42fb39217fa20e96e74e9ebf3 (diff)
downloadem-c24ff6b3ff7abdfeff9fde7d19075ea1edec087c.tar.gz
Update README
-rw-r--r--README3
-rw-r--r--README.html3
-rw-r--r--README.old114
3 files changed, 118 insertions, 2 deletions
diff --git a/README b/README
index a434797..a2e8c62 100644
--- a/README
+++ b/README
@@ -67,7 +67,7 @@ reference item later in the document:
</li>
</ol>
-For more information about references, see *Reference lists* below.
+For more information about references, see *Reference lists* [5].
---
@@ -222,3 +222,4 @@ _Paragraphs start with no space:_
[2] <../tree/emparse>
[3] <../tree/README>
[4] <../tree/test.em>
+ [5] <#reference-lists>
diff --git a/README.html b/README.html
index 05dd7b8..3b19f94 100644
--- a/README.html
+++ b/README.html
@@ -81,7 +81,7 @@ reference item later in the document:
&lt;/ol&gt;
</pre>
<p>
-For more information about references, see <i>Reference lists</i> below.
+For more information about references, see <i>Reference lists</i> [<a href="#reference-lists">5</a>].
</p>
<hr/>
<h3 id="hyperlinks">Hyperlinks</h3>
@@ -256,5 +256,6 @@ This is another paragraph.
</li><li value="2" id="ref2"><a href="../tree/emparse">../tree/emparse</a>
</li><li value="3" id="ref3"><a href="../tree/README">../tree/README</a>
</li><li value="4" id="ref4"><a href="../tree/test.em">../tree/test.em</a>
+</li><li value="5" id="ref5"><a href="#reference-lists">#reference-lists</a>
</li>
</ol>
diff --git a/README.old b/README.old
new file mode 100644
index 0000000..804b513
--- /dev/null
+++ b/README.old
@@ -0,0 +1,114 @@
+== Introducing Em ==
+
+Em is a *limited* markup language that compiles to HTML.
+It is similar to Markdown, but it has a few key advantages:
+
+ 1. It is more readable.
+ 2. It is simpler to parse.
+ 3. There is *not* more than one way to do it (sorry Larry).
+For any given HTML output, there is only a single possible Em input.
+
+As was said above, Em is also more limited than Markdown,
+because it values plain-text readability more than power.
+Most clearly, hyperlinks cannot have arbitrary link text;
+they have to be formatted in a fashion similar to how they
+are included in e-mails:
+
+ It can be downloaded here [1].
+
+ [1] v1.zip
+
+This is translated to the following HTML:
+
+ <p>It can be downloaded here (<a href="v1.zip">link</a>).
+
+This limitation is intentional, because there is no other readable way
+of specifying what text is part of the link text. But it should be remembered
+that the purpose of Em -- and of Markdown -- is not to be a general-purpose
+HTML preprocessor, but rather to be a simple, readable markup language.
+In many ways, Markdown has come short of this original goal.
+
+The name Em is an abbreviation of e-mail, because the format
+could be used in a plain-text e-mail without anyone noticing.
+It is also an allusion to the unit called em.
+
+== Syntax ==
+
+=== Block-level elements ===
+
+Block-level elements are separated using one empty line.
+This empty line is removed in the final HTML output.
+
+Lists begin with a single space:
+
+ - Test
+ - Test
+ - Test
+
+ 1. Test
+ 2. Test
+ 3. Test
+
+ term: definition
+ term: definition
+
+Lists within lists begin with another space. Tables, which normally start
+with two spaces, cannot be put inside a list.
+
+Tables begin with two spaces; cells are separated with tabs.
+Empty cells have a single empty space.
+
+ Column 1 Column 2 Column 3
+ Test Test Test
+
+Code blocks begin with a tab (or four spaces?):
+
+ #include <stdio.h>
+ main(){
+ puts("Hello world!");
+ }
+
+If "paragraph lists" are wanted, then normal paragraphs should be used:
+
+ 1. This is the first point.
+ Bla bla bla.
+
+ 2. This is the second point.
+ Bla bla bla.
+
+Headings are formatted with equal signs:
+
+ = First-level heading =
+
+ == Second-level heading ==
+
+ === Third-level heading ===
+
+The equal signs on the right side are not optional.
+
+A paragraph containing three hyphens signifies a horizontal rule:
+
+ ---
+
+== Inline formatting ==
+
+Three types of inline formatting are supported:
+
+ b: underline (_)
+ i: asterisk (*)
+ tt: backquote (`)
+
+They are valid only at word borders.
+One type of inline formatting cannot contain another one.
+
+Only visual formatting (b, i, tt) is supported, not semantic (strong, em, code),
+as the HTML translator cannot possibly know the semantics of the text.
+
+Links are available only as in plain-text e-mail [1].
+
+ [1] http://like.this.example.com/
+
+When converting to HTML, references containing only a URL are converted
+to (link), optionally localized. References containing text are shown as footnotes.
+
+Reference lists are a special case of lists, which is why they begin with a space. \ No newline at end of file