Support GNU stat

[Shushe] / README.markdown

diff --git a/README.markdown b/README.markdown
index 55d6f8f8d7c31ba42d6477c2f2ef8f043696d45a..5457ce763994785c2029d58162d4b68e25ebf1a7 100644 (file)
--- a/README.markdown
+++ b/README.markdown
@@ -75,7 +75,7 @@ Compilation involves the following steps :⁠—
 
 6. ⛩️📰 书社 compiles each output file to `build/result`.
 
 
 6. ⛩️📰 书社 compiles each output file to `build/result`.
 

-7. ⛩️📰 书社 symlinks most output files from `build/result` to
+7. ⛩️📰 书社 copies most output files from `build/result` to

      `build/public`, but it does some additional processing instead on
      those which indicate a non‐X·M·L desired final output form.
 
      `build/public`, but it does some additional processing instead on
      those which indicate a non‐X·M·L desired final output form.
 


@@ -87,19 +87,23 @@ As this is a Make‐based program, steps will only be run if the
   corresponding buildfile or output file is older than its
   prerequisites.
 
   corresponding buildfile or output file is older than its
   prerequisites.
 

-## Namespaces
+## Name·spaces

 
 

-The ⛩️📰 书社 namespace is `urn:fdc:ladys.computer:20231231:Shu1She4`.
+The ⛩️📰 书社 name·space is `urn:fdc:ladys.computer:20231231:Shu1She4`.

 
 

-This document uses a few namespace prefixes, with the following
+This document uses a few name·space prefixes, with the following

   meanings :⁠—
 
   meanings :⁠—
 

-|   Prefix | Expansion                                  |
-| -------: | :----------------------------------------- |
-|  `html:` | `http://www.w3.org/1999/xhtml`             |
-| `xlink:` | `http://www.w3.org/1999/xlink`             |
-|  `xslt:` | `http://www.w3.org/1999/XSL/Transform`     |
-|  `书社:` | `urn:fdc:ladys.computer:20231231:Shu1She4` |
+|     Prefix | Expansion                                     |
+| ---------: | :-------------------------------------------- |
+| `catalog:` | `urn:oasis:names:tc:entity:xmlns:xml:catalog` |
+|    `exsl:` | `http://exslt.org/common`                     |
+| `exslstr:` | `http://exslt.org/strings`                    |
+|    `html:` | `http://www.w3.org/1999/xhtml`                |
+|     `svg:` | `http://www.w3.org/2000/svg`                  |
+|   `xlink:` | `http://www.w3.org/1999/xlink`                |
+|    `xslt:` | `http://www.w3.org/1999/XSL/Transform`        |
+|    `书社:` | `urn:fdc:ladys.computer:20231231:Shu1She4`    |

 
 ## Setup and Configuration
 
 
 ## Setup and Configuration
 


@@ -117,6 +121,7 @@ In every case, you may supply your own implementation by overriding the
 - `file`
 - `find`
 - `git` (optional; set `GIT=` to disable)
 - `file`
 - `find`
 - `git` (optional; set `GIT=` to disable)

+- `grep`

 - `ln`
 - `mkdir` (requires support for `-p`)
 - `mv`
 - `ln`
 - `mkdir` (requires support for `-p`)
 - `mv`


@@ -126,7 +131,7 @@ In every case, you may supply your own implementation by overriding the
 - `rm`
 - `sed`
 - `sleep`
 - `rm`
 - `sed`
 - `sleep`

-- `stat`
+- `stat` (BSD *or* GNU)

 - `test`
 - `touch`
 - `tr` (requires support for `-d`)
 - `test`
 - `touch`
 - `tr` (requires support for `-d`)


@@ -293,7 +298,7 @@ New ⛩️📰 书社 parsers which target plaintext formats should have an
   `<xslt:template>` element with no `@name` or `@mode` and whose
   `@match` attribute…
 
   `<xslt:template>` element with no `@name` or `@mode` and whose
   `@match` attribute…
 

-- Starts with an appropriately‐namespaced qualified name for a
+- Starts with an appropriately‐name·spaced qualified name for a

     `<html:script>` element.
 
 - Follows this with the string `[@type=`.
     `<html:script>` element.
 
 - Follows this with the string `[@type=`.


@@ -350,7 +355,7 @@ Parsers are applied *prior* to embedding (and can be used to generate
   embeds); transforms are applied *after*.
 
 It is **strongly recommended** that auxillary templates in parsers be
   embeds); transforms are applied *after*.
 
 It is **strongly recommended** that auxillary templates in parsers be

-  namespaced (by `@name` or `@mode`) whenever possible, to avoid
+  name·spaced (by `@name` or `@mode`) whenever possible, to avoid

   conflicts between parsers.
 
 ### Attributes added during parsing
   conflicts between parsers.
 
 ### Attributes added during parsing


@@ -432,6 +437,33 @@ Transforms are used to convert X·M·L files into their final output,
   To undo this behaviour, remove the `@itemscope` and `@itemtype`
     attributes from the embed during the transformation phase.
 
   To undo this behaviour, remove the `@itemscope` and `@itemtype`
     attributes from the embed during the transformation phase.
 

+- **`transforms/serialization.xslt`:**
+  Replaces `<书社:serialize-xml>` elements with the (escaped)
+    serialized X·M·L of their contents.
+  This replacement happens during the application phase, after most
+    other transformations have taken place.
+
+  If a `@with-namespaces` attribute is provided, any name·space nodes
+    on the toplevel serialized elements whose U·R·I’s correspond to the
+    definitions of the provided prefixes, as defined for the
+    `<书社:serialize-xml>` element, will be declared using name·space
+    attributes on the serialized elements.
+  Otherwise, only name·space nodes which _differ_ from the definitions
+    on the `<书社:serialize-xml>` element will be declared.
+  The string `#default` may be used to represent the default
+    name·space.
+  Multiple prefixes may be provided, separated by white·space.
+
+  When it comes to name·spaces used internally by ⛩️📰 书社, the
+    prefix used by ⛩️📰 书社 may be declared _in addition to_ the
+    prefix(es) used in the source document(s).
+  It is not possible to selectively only declare one prefix for a
+    name·space to the exclusion of others.
+
+  `<书社:raw-output>` elements may be used inside of
+    `<书社:serialize-xml>` elements to inject raw output into the
+    serialized X·M·L.
+

 The following are recommendations on effective creation of
   transforms :⁠—
 
 The following are recommendations on effective creation of
   transforms :⁠—
 


@@ -439,10 +471,10 @@ The following are recommendations on effective creation of
   It is likely an error if two transforms have templates which match
     the same element (unless the templates have different priority).
 
   It is likely an error if two transforms have templates which match
     the same element (unless the templates have different priority).
 

-- Namespace templates (with `@name` or `@mode`) whenever possible.
+- Name·space templates (with `@name` or `@mode`) whenever possible.

 
 - Set `@exclude-result-prefixes` on the root `xslt:transform` element
 
 - Set `@exclude-result-prefixes` on the root `xslt:transform` element

-    to reduce the number of declared namespaces in the final result.
+    to reduce the number of declared name·spaces in the final result.

 
 ## Global Params
 
 
 ## Global Params
 


@@ -547,7 +579,7 @@ In both cases, attributes from various sources are combined with
 Attribute application takes place after all ordinary transforms have
   completed.
 
 Attribute application takes place after all ordinary transforms have
   completed.
 

-Both elements ignore attributes in the `xml:` namespace, except for
+Both elements ignore attributes in the `xml:` name·space, 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`, 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


@@ -555,7 +587,7 @@ On H·T·M·L and S·V·G elements, `@lang` has the same behaviour as
 
 ## Other Kinds of Output
 
 
 ## Other Kinds of Output
 

-There are a few special elements in the `书社:` namespace which, if
+There are a few special elements in the `书社:` name·space which, if

   they appear as the toplevel element in a transformation result, cause
   ⛩️📰 书社 to produce something other than an X·M·L file.
 They are :⁠—
   they appear as the toplevel element in a transformation result, cause
   ⛩️📰 书社 to produce something other than an X·M·L file.
 They are :⁠—