From c24ff6b3ff7abdfeff9fde7d19075ea1edec087c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?John=20Ankarstr=C3=B6m?= Date: Sun, 31 Jan 2021 13:23:18 +0000 Subject: Update README --- README | 3 +- README.html | 3 +- README.old | 114 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 118 insertions(+), 2 deletions(-) create mode 100644 README.old diff --git a/README b/README index a434797..a2e8c62 100644 --- a/README +++ b/README @@ -67,7 +67,7 @@ reference item later in the document: -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: </ol>

-For more information about references, see Reference lists below. +For more information about references, see Reference lists [5].

@@ -256,5 +256,6 @@ This is another paragraph.
  • ../tree/emparse
  • ../tree/README
  • ../tree/test.em +
  • #reference-lists
    • 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: + +

    It can be downloaded here (link). + +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 + 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 -- cgit v1.2.3