aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJohn Ankarström <john@ankarstrom.se>2021-01-31 13:18:23 +0000
committerJohn Ankarström <john@ankarstrom.se>2021-01-31 13:18:23 +0000
commit6fa6614b3a7e87e42fb39217fa20e96e74e9ebf3 (patch)
tree3fc944338d3082255886d3cb63bac6a34dc714ce /README
parent75303cb47fead302ad02982a0fe6d09dcc78372d (diff)
downloadem-6fa6614b3a7e87e42fb39217fa20e96e74e9ebf3.tar.gz
Add information about literal hyperlinks to README
Diffstat (limited to 'README')
-rw-r--r--README37
1 files changed, 28 insertions, 9 deletions
diff --git a/README b/README
index 471ebce..a434797 100644
--- a/README
+++ b/README
@@ -8,14 +8,14 @@ never more than a single possible em representation.
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 *Hyperlinks* below).
+form of inline links are supported (see *Hyperlinks* [1]).
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.
-Em's complete and exact syntax is defined by its implementation [1], but a
+Em's complete and exact syntax is defined by its implementation [2], but a
general description follows below. For longer examples, see the source
-code for this text [2] or the test file [3].
+code for this text [3] or the test file [4].
Em is implemented in portable awk, with an rc script to bind it together.
It is written on and for Plan 9 primarily, but the rc code can (more or less)
@@ -73,9 +73,27 @@ For more information about references, see *Reference lists* below.
=== Hyperlinks ===
-Hyperlinks are a special case of inline references. When an inline
-reference refers to a reference containing a single link, the inline
-reference points directly to that link, rather than at the reference.
+Em provides two types of hyperlinks: literal hyperlinks and hyperlink
+references.
+
+_Literal hyperlinks_ are wrapped in less-than and greater-than signs:
+
+ <http://example.com>
+
+Most links are recognized, as long as they are free of spaces and
+contain a slash or start with a hash:
+
+ </page>
+ <./page>
+ <#section>
+
+The less-than and greater-than signs are valid in the same places
+as the font style formatting marks.
+
+_Hyperlink references_ are a special case of inline references.
+When an inline reference refers to a reference containing a literal
+hyperlink and nothing else, the inline reference points directly to
+that link, rather than at the reference.
It is available for download [1].
@@ -200,6 +218,7 @@ _Paragraphs start with no space:_
== References ==
- [1] <../tree/emparse>
- [2] <../tree/README>
- [3] <../tree/test.em>
+ [1] <#hyperlinks>
+ [2] <../tree/emparse>
+ [3] <../tree/README>
+ [4] <../tree/test.em>