aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2025-05-26 22:13:23 +0200
committerJonas Smedegaard <dr@jones.dk>2025-05-26 22:14:15 +0200
commit3c6f9af85324b73acdba97c1867a2592e0ad4884 (patch)
tree069d817cfe155a613cf885ca6869f4af3417c300
parent786988b552e7e4ea44a08c421c850d06893dd883 (diff)
tighten requirements
-rw-r--r--_intro.qmd23
1 files changed, 11 insertions, 12 deletions
diff --git a/_intro.qmd b/_intro.qmd
index c511c35..2acea79 100644
--- a/_intro.qmd
+++ b/_intro.qmd
@@ -125,25 +125,24 @@ Partly it is due to a deliberate design choice,
as reflected in the quote introducing this paper:
The format should be easy to both write and read in source form.
-*FIXME: rewrite as more fluent prose*
+The annotation syntax in a Markdown text...
-In the source format of Markdown with annotations...
-
-* the syntax for annotation **should** be relatively comprehensible to humans
+* **should** be relatively comprehensible to humans
(in the same spirit as Markdown -- for example, \*\*strong emphasis\*\*)
-* annotation syntax **must not** conflict with core Markdown
+* **should not** conflict with other Markdown extensions
+* **must not** conflict with core Markdown
(i.e. must not cause ambiguities)
-* annotation syntax **should not** conflict with other Markdown extensions
-For syntactically correct and structurally supported annotations...
+A rendering of syntactically correct annotations...
-* visual output **must** be identical to the source without the annotation
-* metadata of output **must** contain the annotation
+* **must** be functionally equal to the text authored without annotations
+ (similar to how a text with a hyperlink is still rendered as text)
+* **may** include the annotation in some multimodal form
+ (again similar to how some renderings of a hyperlink offer interacive navigation)
-For syntactically incorrect or structurally unsupported annotations...
+A rendering of syntactically incorrect or structurally unsupported annotations...
-* the annotation **must not** disappear from visual output
-* visual output **should** include the annotation in its source form
+* **should** include the annotation as regular text
### Improve accepted formats and tools {#sec-improve}