From: Huck Boles <huck@huck.website>
Date: Tue, 23 May 2023 22:17:58 +0000 (-0500)
Subject: refactor: readme site fixes
X-Git-Url: https://git.huck.website/?a=commitdiff_plain;h=1306cdbe4ca66012f36ae36b17f1dd46f4b97041;p=metaforge.git

refactor: readme site fixes
---

diff --git a/files/README/source/docs/definitions.meta b/files/README/source/docs/definitions.meta
index ff507c2..2d790ec 100644
--- a/files/README/source/docs/definitions.meta
+++ b/files/README/source/docs/definitions.meta
@@ -7,23 +7,24 @@ ${
 ## rules
 
 definition blocks are allowed in all files, but have to be before any source
-text, and after any header settings (which are a special type of definition block)
+text, and after any header settings (which are a special type of definition block).
 
-a block is a sigil for the definition type, followed by braces that
-surround assignment statements
+a block consists of a sigil for the definition type, followed by braces that
+surround assignment statements.
 
 assignments are identifiers, followed by an equals sign (=), then a value
 
 definition blocks can have spaces and new lines arbitrarily inserted
-between each component, and support multiple assignments per block
+between each component, and support multiple assignments per block.
 
 ## identifiers
 
-identifiers can contain alphanumeric ascii values and _ as well as separating dots (.)
+identifiers can contain alphanumeric ascii values and underscores [a-zA-Z0-9_],
+as well as separating dots (.)
 
-variable identifiers without dots are available to any pattern called by the file
+variable identifiers without dots are available to any pattern called by the file.
 
-array identifiers without dots are available only to the pattern they are defined in
+array identifiers without dots are available only to the pattern they are defined in.
 
 variable and array identifiers with separating dots use the final item
 as the identifier, and the preceding items are expanded like a pattern identifier to make
@@ -41,9 +42,9 @@ assignment in a local block can be made global again by prefixing it with an exc
 ## values
 
 values can be a double or single quoted string, if defining an array,
-a value is a bracket surrounded, comma separated list of strings
+a value is a bracket surrounded, comma separated list of strings.
 
-all values can optionally be assigned as ***BLANK***, which expands to nothing
+all values can optionally be assigned as ***BLANK***, which expands to nothing.
 
 patterns can also be assigned as ***DEFAULT***, for overriding globally defined patterns.
 
diff --git a/files/README/source/docs/expansions.meta b/files/README/source/docs/expansions.meta
index 6060114..f3d9212 100644
--- a/files/README/source/docs/expansions.meta
+++ b/files/README/source/docs/expansions.meta
@@ -41,11 +41,11 @@ don't need any extra expansion.
            quux = BLANK
         }
 
-    pattern [foo]: <p>${var}baz} ${var}quux}</p>
+    pattern [foo]: <p>${var_sub}baz} ${var}quux}</p>
 
     expanded [foo]: <p>foo </p>
 
-    pattern [bar]: <p>${var}baz} ${var}quux}</p>
+    pattern [bar]: <p>${var_sub}baz} ${var}quux}</p>
 
     expanded [bar]: <p>quux </p>
 
diff --git a/files/README/source/docs/syntax.meta b/files/README/source/docs/syntax.meta
index f8ae0b7..72deca7 100644
--- a/files/README/source/docs/syntax.meta
+++ b/files/README/source/docs/syntax.meta
@@ -49,7 +49,7 @@ whitespace and newlines between list values are accepted
     ]
 
 ## comments
-a comment sigil \- followed by a comment in braces.
+a comment sigil (\-) followed by a comment in braces.
 the only characters not allowed are braces.
 
 comments get removed during the first pass through of parsing, and can occur