X-Git-Url: https://git.ladys.computer/Shushe/blobdiff_plain/03f9773767ae7811289561abe5162e8b04578991..2024d501192c7399c0791dec5ba0d3004613aefc:/README.markdown?ds=sidebyside
diff --git a/README.markdown b/README.markdown
index 573fb86..1973e02 100644
--- a/README.markdown
+++ b/README.markdown
@@ -1,3 +1,7 @@
+
# ⛩️📰 书社
A make·file for X·M·L.
@@ -102,6 +106,7 @@ In every case, you may supply your own implementation by overriding the
- `awk`
- `cat`
+- `cksum`
- `cp`
- `date`
- `echo`
@@ -213,11 +218,8 @@ The following additional variables can be used to control the behaviour
A white·space‐separated list of media types to consider X·M·L
(default: `application/xml text/xml`).
-- **`GENERATOR`:**
- The name of the generator program (default: `⛩️📰 书社`).
-
-- **`VERSION`:**
- The current version of `GENERATOR` (default: derived from the current
+- **`THISREV`:**
+ The current version of ⛩️📰 书社 (default: derived from the current
git tag/branch/commit).
- **`SRCREV`:**
@@ -271,16 +273,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 `` element.
+ Wraps `text/plain` contents in a `` element.
- **`parsers/record-jar.xslt`:**
- Converts `text/record-jar` contents into a
- `` of `` elements (one for
- each record).
+ Converts `text/record-jar` contents into a `` of
+ `` elements (one for each record).
- **`parsers/tsv.xslt`:**
- Converts `text/tab-separated-values` contents into an
- `` element.
+ Converts `text/tab-separated-values` contents into an ``
+ element.
New ⛩️📰 书社 parsers which target plaintext formats should have an
`` element with no `@name` or `@mode` and whose
@@ -346,6 +347,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 ``
+ 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>`
@@ -362,6 +383,8 @@ Embeds are replaced with the parsed contents of a file, unless the file
is an asset, in which case an `` element is produced
instead (with the contents of the asset file provided as a base64
`data:` u·r·i).
+Embed replacements will be given a `@书社:identifier` attribute whose
+ value will match the `@xlink:href` of the embed.
Embedding takes place after parsing but before transformation, so
parsers are able to generate their own embeds.
@@ -384,14 +407,6 @@ Transforms are used to convert X·M·L files into their final output,
after all necessary parsing and embedding has taken place.
⛩️📰 书社 comes with some transforms; namely :—
-- **`transforms/attributes.xslt`:**
- Applies transforms to the children of any `<书社:apply-attributes>`
- elements, and then applies the attributes of the
- `<书社:apply-attributes>` to each result child, replacing the
- element with the result.
- This is useful in combination with image embeds to apply alt‐text to
- the resulting ``.
-
- **`transforms/asset.xslt`:**
Converts `` elements which correspond to recognized
media types into the appropriate H·T·M·L elements, and deletes
@@ -406,8 +421,8 @@ Transforms are used to convert X·M·L files into their final output,
- **`urn:fdc:ladys.computer:20231231:Shu1She4:title`:**
Provides the title of the page.
- ⛩️📰 书社 automatically encapsulates embeds so that their metadata
- does not propogate up to the embedding document.
+ ⛩️📰 书社 automatically encapsulates H·T·M·L embeds so that their
+ metadata does not propogate up to the embedding document.
To undo this behaviour, remove the `@itemscope` and `@itemtype`
attributes from the embed during the transformation phase.
@@ -431,8 +446,12 @@ The following params are made available globally in parsers and
- **`BUILDTIME`:**
The current time.
-- **`GENERATOR`:**
- The value of the `GENERATOR` variable (if present).
+- **`CKSUM`:**
+ The checksum of the source file (⅌ `cksum`).
+
+- **`IDENTIFIER`:**
+ The ⛩️📰 书社 identifier of the source file (a u·r·i beginning with
+ `about:shushe`).
- **`SRCREV`:**
The value of the `SRCREV` variable (if present).
@@ -440,8 +459,8 @@ The following params are made available globally in parsers and
- **`SRCTIME`:**
The time at which the source file was last modified.
-- **`VERSION`:**
- The value of the `VERSION` variable (if present).
+- **`THISREV`:**
+ The value of the `THISREV` variable (if present).
The following params are only available in transforms :—
@@ -503,11 +522,36 @@ This mechanism can be used to allow transforms to insert content
Output wrapping can be entirely disabled by adding a
`@书社:disable-output-wrapping` attribute to the top‐level element in
the result tree.
+This attribute will also prevent wrapping non‐H·T·M·L embeds with an
+ ``.
+
+## Applying Attributes
+
+The `<书社:apply-attributes>` element will apply any attributes on the
+ element to the element(s) it wraps.
+It is especially useful in combination with embeds.
+
+The `<书社:apply-attributes-to-root>` element will apply any attributes
+ on the element to the root node of the final transformation result.
+It is especially useful in combination with output wrapping.
+
+In both cases, attributes from various sources are combined with
+ white·space between them.
+Attribute application takes place after all ordinary transforms have
+ completed.
+
+Both elements ignore attributes in the `xml:` namespace, except for
+ `@xml:lang`, which ignores all but the first definition (including
+ any already present on the root element).
+On H·T·M·L and S·V·G elements, `@lang` has the same behaviour as
+ `@xml:lang`.
## License
-Source files are licensed under the terms of the Mozilla Public
- License, version 2.0.
-For more information, see [LICENSE](./LICENSE).
+This repository conforms to [REUSE][].
+
+Most source files are licensed under the terms of the Mozilla
+ Public License, version 2.0.
+[REUSE]:
[draft-phillips-record-jar-01]: