summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTaylan Kammer <taylan.kammer@gmail.com>2026-01-12 08:03:38 +0100
committerTaylan Kammer <taylan.kammer@gmail.com>2026-01-12 08:03:38 +0100
commit2f77b3ceaa2989d944296c572a07b2caee39d9d4 (patch)
tree93b5838d5d49e7f7f23796c1accc089a5b78eacd /docs
parentb7a386f1da020cb4dde8d37e96170ea4299def30 (diff)
Update HTML stuff.
Diffstat (limited to 'docs')
-rw-r--r--docs/c1/1-parse.md2
-rw-r--r--docs/c1/grammar/abnf.txt (renamed from docs/c1/grammar.abnf.txt)4
-rw-r--r--docs/c1/grammar/index.md (renamed from docs/c1/grammar.md)6
-rw-r--r--docs/c1/grammar/peg.txt (renamed from docs/c1/grammar.peg.txt)7
-rw-r--r--docs/c1/grammar/zbnf.txt (renamed from docs/c1/grammar.zbnf.txt)2
5 files changed, 13 insertions, 8 deletions
diff --git a/docs/c1/1-parse.md b/docs/c1/1-parse.md
index b01d759..73b8d8a 100644
--- a/docs/c1/1-parse.md
+++ b/docs/c1/1-parse.md
@@ -1,6 +1,6 @@
# Parser for Code & Data
-*For an exact specification of the grammar, see [grammar](grammar.html).*
+*For an exact specification of the grammar, see [grammar](grammar/).*
Zisp S-Expressions represent an extremely minimal set of data types; only that
which is necessary to strategically construct more complex code and data:
diff --git a/docs/c1/grammar.abnf.txt b/docs/c1/grammar/abnf.txt
index 9279210..6daaceb 100644
--- a/docs/c1/grammar.abnf.txt
+++ b/docs/c1/grammar/abnf.txt
@@ -1,4 +1,6 @@
-; Compatible with https://www.quut.com/abnfgen/
+; Standards-compliant ABNF (RFC 5234, RFC 7405)
+
+; Compatible with: https://www.quut.com/abnfgen/
; It's unclear whether this grammar is truly complete. It has been
; verified not to produce text that is rejected by the Zisp parser
diff --git a/docs/c1/grammar.md b/docs/c1/grammar/index.md
index 3364150..5bedbfc 100644
--- a/docs/c1/grammar.md
+++ b/docs/c1/grammar/index.md
@@ -2,9 +2,9 @@
The grammar is available in several different formats:
-* [ZBNF](grammar.zbnf.txt): See below for the rules of this notation
-* [ABNF](grammar.abnf.txt): Compatible with the `abnfgen` tool
-* [PEG](grammar.peg.txt): Compatible with `peg/leg` tool
+* [ZBNF](zbnf.txt): See below for the rules of this notation
+* [ABNF](abnf.txt): Compatible with the `abnfgen` tool
+* [PEG](peg.txt): Compatible with `peg/leg` tool
## ZBNF notation
diff --git a/docs/c1/grammar.peg.txt b/docs/c1/grammar/peg.txt
index d194652..1e060ec 100644
--- a/docs/c1/grammar.peg.txt
+++ b/docs/c1/grammar/peg.txt
@@ -1,4 +1,4 @@
-# Compatible with https://piumarta.com/software/peg
+# Standard PEG notation
Stream <- Unit ( Blank Unit )* !.
@@ -67,9 +67,12 @@ ALPHA <- [a-zA-Z]
HEXDIG <- [0-9a-fA-F]
-# This file should be kept in perfect sync with zbnf.txt for easy
+# Keep this in sync line-for-line with the ZBNF grammar for easy
# comparison between the two.
+# This file is meant to be compatible with:
+# https://piumarta.com/software/peg
+
# Due to a quirk in the peg tool this file is used with, the grammar
# must not allow an empty stream. Therefore, the Unit rule has its
# Datum declared as mandatory rather than optional.
diff --git a/docs/c1/grammar.zbnf.txt b/docs/c1/grammar/zbnf.txt
index a8792f0..551c319 100644
--- a/docs/c1/grammar.zbnf.txt
+++ b/docs/c1/grammar/zbnf.txt
@@ -1,4 +1,4 @@
-# Custom notation with PEG semantics; see grammar.html
+# Custom notation with PEG semantics
Stream : Unit ( Blank Unit )*