aboutsummaryrefslogtreecommitdiff
path: root/_markdown.qmd
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2025-05-24 12:48:58 +0200
committerJonas Smedegaard <dr@jones.dk>2025-05-24 12:48:58 +0200
commit642c7c79b20028631cda30ef7562b22455a21231 (patch)
treea3a2f56d5bba8d208bb3b044d612f1a2f05671f3 /_markdown.qmd
parent77739f570ef39d9047232b6bb23cb59082480fa8 (diff)
tightne british english grammar
Diffstat (limited to '_markdown.qmd')
-rw-r--r--_markdown.qmd29
1 files changed, 15 insertions, 14 deletions
diff --git a/_markdown.qmd b/_markdown.qmd
index ac75d96..928adac 100644
--- a/_markdown.qmd
+++ b/_markdown.qmd
@@ -5,11 +5,11 @@ that is relevant for annotation,
and then an analysis of a not yet used subset
proposed specifically for the intent of marking up annotations.
-Ahead of these analyses,
-it helps to define terminology of "dialect" and "extension":
-Markdown is not a single strictly defined language,
-but a range of slightly varying languages
-all derived from the same slightly ambiguous original specification.
+Before these analyses,
+it is helpful to define terminology of "dialect" and "extension":
+Markdown is not a single, strictly defined language
+but rather a range of slightly varying languages,
+all derived from the same somewhat ambiguous original specification.
One way to approach this variability,
used among other places in the documentation of the Markdown processor Pandoc
and reused here,
@@ -95,14 +95,13 @@ to be able to cover Markdown
The PEG grammar covering all syntax diagrams shown here
is included as [Appendix @sec-def-peg].
-Words are sets of printable characters
-(including punctuation and other printable characters).
+Words are sets of printable characters, including punctuation.
They can be styled,
have a hyperlink annotated
and have CSS structure and styling annotated.
Each set can contain each other,
or a set of plain words.
-Se @fig-def-words for their syntax diagrams.
+See @fig-def-words for their syntax diagrams.
::: {#fig-def-words}
@@ -186,28 +185,30 @@ Syntax of `SemWords`, `Curie`, `SEMPREFIX` and `NAME`.
*FIXME: write this!*
+<!--
* hvad skal med
* hvad skal ikke med
* hvis PDF..., hvad så?
Dette afsnit udgør "requirements"
+-->
### Readability
In the source format of Markdown with annotations...
-* the syntax for annotation **should** be relatively human comprehensible
- (in the same spirit as Markdown -- e.g. \*\*strong emphasis\*\*)
+* the syntax for annotation **should** be relatively comprehensible to humans
+ (in the same spirit as Markdown -- for example, \*\*strong emphasis\*\*)
* annotation syntax **must not** conflict with core Markdown
- (i.e. must not cause disambiguations)
-* annotation syntaxt **should not** conflict with other Markdown extensions
+ (i.e. must not cause ambiguities)
+* annotation syntax **should not** conflict with other Markdown extensions
For syntactically correct and structurally supported annotations...
-* visual output **must** be identical to source without the annotation
+* visual output **must** be identical to the source without the annotation
* metadata of output **must** contain the annotation
For syntactically incorrect or structurally unsupported annotations...
* the annotation **must not** disappear from visual output
-* visual output **should** include the annotation in source form
+* visual output **should** include the annotation in its source form