]> Lady’s Gitweb - Shushe/commitdiff
Update parser documentation
authorLady <redacted>
Sun, 4 Feb 2024 22:36:46 +0000 (17:36 -0500)
committerLady <redacted>
Sun, 4 Feb 2024 22:36:46 +0000 (17:36 -0500)
- Remove class names which are no longer provided from description.

- Document attributes added during parsing.

README.markdown

index e0a143e5f5ea0fa823630038a616edf6496ec97f..885fe751dcd580ec353e52d2c1162f2eab7df1bd 100644 (file)
@@ -272,16 +272,15 @@ Parsers are used to convert plaintext files into X·M·L trees, as well
 ⛩️📰 书社 comes with some parsers; namely :⁠—
 
 - **`parsers/plain.xslt`:**
-  Wraps `text/plain` contents in a `<html:pre class="plain">` element.
+  Wraps `text/plain` contents in a `<html:pre>` element.
 
 - **`parsers/record-jar.xslt`:**
-  Converts `text/record-jar` contents into a
-    `<html:div class="record-jar">` of `<html:dl>` elements (one for
-    each record).
+  Converts `text/record-jar` contents into a `<html:div>` of
+    `<html:dl>` elements (one for each record).
 
 - **`parsers/tsv.xslt`:**
-  Converts `text/tab-separated-values` contents into an
-    `<html:table class="tsv">` element.
+  Converts `text/tab-separated-values` contents into an `<html:table>`
+    element.
 
 New ⛩️📰 书社 parsers which target plaintext formats should have an
   `<xslt:template>` element with no `@name` or `@mode` and whose
@@ -347,6 +346,26 @@ It is **strongly recommended** that auxillary templates in parsers be
   namespaced (by `@name` or `@mode`) whenever possible, to avoid
   conflicts between parsers.
 
+### Attributes added during parsing
+
+⛩️📰 书社 will add a few attributes to the output of the parsing step,
+  namely :⁠—
+
+- A `@书社:cksum` attribute on toplevel result elements, giving the
+    `cksum` checksum of the corresponding source file.
+
+- For the elements which result from parsing plaintext `<html:script>`
+    elements :⁠—
+
+  - A `@书社:parsed-by` attribute, giving a space‐separated list of
+      parsers which parsed the node.
+    (Generally, this will be a list of one, but it is possible for the
+      result of a parse to be another plaintext node, which may be
+      parsed by a different parser.)
+
+  - A `@书社:media-type` attribute, giving the identified media type of
+      the plaintext node.
+
 ## Embedding
 
 Documents can be embedded in other documents using a `<书社:link>`
This page took 0.025897 seconds and 4 git commands to generate.