aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Ankarström <john@ankarstrom.se>2021-01-30 12:21:56 +0000
committerJohn Ankarström <john@ankarstrom.se>2021-01-30 12:21:56 +0000
commitf9535fc7d640f6a908a22032087976e654911da3 (patch)
tree6d83f6ec9d5004fbdfba042caebd2c67e03fd577
parent4d00aca757265010cae5626c33d186c1cb2c23b8 (diff)
downloadem-f9535fc7d640f6a908a22032087976e654911da3.tar.gz
Update README
-rw-r--r--README13
-rw-r--r--README.html14
-rw-r--r--mkfile2
3 files changed, 20 insertions, 9 deletions
diff --git a/README b/README
index 110e084..542ab4f 100644
--- a/README
+++ b/README
@@ -25,6 +25,11 @@ but the work has not been done yet.
== Syntax ==
+Em's complete and exact syntax is defined by its implementation [c],
+but this section contains a general description.
+
+ [c] ../tree/aux/emparse
+
=== Block-level formatting ===
_A single empty line_ always marks a block break. There is
@@ -112,14 +117,14 @@ Paragraphs start with no space:
_Italic, bold and teletype text_ is marked with the asterisk,
the underscore and the backtick, respectively:
- Example of *italic* text.
+ Example of *italic text*.
The marks are only valid in certain positions:
1. At word borders
- 2. After an opening parenthesis
- 3. Before any of `.,:;?!)`
- 4. Before a closing parenthesis any of `.,:;?!`
+ 2. At the beginning of a word after an opening parenthesis
+ 3. At the end of a word before any of `.,:;?!)`
+ 4. At the end of a word before a closing parenthesis followed by any of `.,:;?!`
_Inline references_ are created with square brackets:
diff --git a/README.html b/README.html
index 4b5b3c0..9395bf4 100644
--- a/README.html
+++ b/README.html
@@ -29,6 +29,12 @@ The rc script can (more or less) trivially be translated to POSIX shell,
but the work has not been done yet.
</p>
<h2>Syntax</h2>
+<p>
+Em's complete and exact syntax is defined by its implementation (<a href="../tree/aux/emparse">link</a>),
+but this section contains a general description.
+</p>
+<ol class="reflist" style="font-size: small;">
+</ol>
<h3>Block-level formatting</h3>
<p>
<b>A single empty line</b> always marks a block break. There is
@@ -135,16 +141,16 @@ This is another paragraph.
the underscore and the backtick, respectively:
</p>
<pre>
-Example of *italic* text.
+Example of *italic text*.
</pre>
<p>
The marks are only valid in certain positions:
</p>
<ol>
<li value="1">At word borders
-</li><li value="2">After an opening parenthesis
-</li><li value="3">Before any of <tt>.,:;?!)</tt>
-</li><li value="4">Before a closing parenthesis any of <tt>.,:;?!</tt>
+</li><li value="2">At the beginning of a word after an opening parenthesis
+</li><li value="3">At the end of a word before any of <tt>.,:;?!)</tt>
+</li><li value="4">At the end of a word before a closing parenthesis followed by any of <tt>.,:;?!</tt>
</li>
</ol>
<p>
diff --git a/mkfile b/mkfile
index 74bd7b8..63a45ce 100644
--- a/mkfile
+++ b/mkfile
@@ -1,4 +1,4 @@
-test:
+test.html:
em test.em > test.html
README.html: README