Don’t allow xsltproc to output files

[Shushe] / README.markdown

diff --git a/README.markdown b/README.markdown
index e5a24eddc675297b11551834d15673f74dea3568..4ce99945acbd4c0fb4fd0ba1689ad0ae4b983b90 100644 (file)
--- a/README.markdown
+++ b/README.markdown
@@ -2,11 +2,11 @@
 SPDX-FileCopyrightText: 2024 Lady <https://www.ladys.computer/about/#lady>
 SPDX-License-Identifier: CC0-1.0
 -->
 SPDX-FileCopyrightText: 2024 Lady <https://www.ladys.computer/about/#lady>
 SPDX-License-Identifier: CC0-1.0
 -->

-# ⛩️📰 书社
+# ⛩📰 书社

 
 <b>A make·file for X·M·L.</b>
 
 
 <b>A make·file for X·M·L.</b>
 

-<dfn>⛩️📰 书社</dfn> aims to make it easy to generate websites with
+<dfn>⛩📰 书社</dfn> aims to make it easy to generate websites with

   X·S·L·T and G·N·U Make.
 It is consequently only a good choice for people who like X·S·L·T and
   G·N·U Make and wish it were easier to make websites with them.
   X·S·L·T and G·N·U Make.
 It is consequently only a good choice for people who like X·S·L·T and
   G·N·U Make and wish it were easier to make websites with them.


@@ -45,12 +45,12 @@ In Japanese, it is an alternate spelling for <i lang="ja">やしろ</i>,
 The name <i lang="cmn-Hans">书社</i> was chosen to play on this pun, as
   it is intended as a publishing program for webshrines.
 
 The name <i lang="cmn-Hans">书社</i> was chosen to play on this pun, as
   it is intended as a publishing program for webshrines.
 

-In Ascii environments, ⛩️📰 书社 should be written `Shushe`, following
+In Ascii environments, ⛩📰 书社 should be written `Shushe`, following

   the pinyin transliteration.
 
 ## Prerequisites
 
   the pinyin transliteration.
 
 ## Prerequisites
 

-In most cases, ⛩️📰 书社 aims to require only functionality which is
+In most cases, ⛩📰 书社 aims to require only functionality which is

   present in all Posix‐compliant (`POSIX.1-2001`) operating systems.
 There are a few exceptions.
 Details on particular programs are given below; if a program is not
   present in all Posix‐compliant (`POSIX.1-2001`) operating systems.
 There are a few exceptions.
 Details on particular programs are given below; if a program is not


@@ -59,7 +59,7 @@ Details on particular programs are given below; if a program is not
 
 ### `diff`
 
 
 ### `diff`
 

-This is a Posix utility, but ⛩️📰 书社 depends on functionality
+This is a Posix utility, but ⛩📰 书社 depends on functionality

   introduced after `POSIX.1-2001` (the `-u` option, introduced in
   `POSIX.1-2008`).
 Macintosh systems somewhat interestingly implement this option
   introduced after `POSIX.1-2001` (the `-u` option, introduced in
   `POSIX.1-2008`).
 Macintosh systems somewhat interestingly implement this option


@@ -69,7 +69,7 @@ Macintosh systems somewhat interestingly implement this option
 [Note this erroneous comment claiming nanosecond & timezone are
   extensions rather than standardized.][rdar-92753335]
 Despite this, the default Macintosh implementation will still work with
 [Note this erroneous comment claiming nanosecond & timezone are
   extensions rather than standardized.][rdar-92753335]
 Despite this, the default Macintosh implementation will still work with

-  ⛩️📰 书社, with the caveat that the timestamp will only include a
+  ⛩📰 书社, with the caveat that the timestamp will only include a

   fractional component when a Posix⹀compliant (e·g, Macintosh legacy or
   G·N·U) implementation is used.
 
   fractional component when a Posix⹀compliant (e·g, Macintosh legacy or
   G·N·U) implementation is used.
 


@@ -77,7 +77,7 @@ Despite this, the default Macintosh implementation will still work with
 
 This is a Posix utility, but it was considered optional in
   `POSIX.1-2001` (altho it was made mandatory in `POSIX.1-2008`) and
 
 This is a Posix utility, but it was considered optional in
   `POSIX.1-2001` (altho it was made mandatory in `POSIX.1-2008`) and

-  ⛩️📰 书社 currently depends on unspecified behaviour.
+  ⛩📰 书社 currently depends on unspecified behaviour.

 It requires support for the following additional options :⁠—
 
 - **`-C`**, when supplied with `-m`, must be useable to compile a
 It requires support for the following additional options :⁠—
 
 - **`-C`**, when supplied with `-m`, must be useable to compile a


@@ -106,9 +106,9 @@ To disable it, set `GIT=`.
 ### `make`
 
 This is a Posix utility, but it is considered an optional Software
 ### `make`
 
 This is a Posix utility, but it is considered an optional Software

-  Development utility and ⛩️📰 书社 currently depends on unspecified
+  Development utility and ⛩📰 书社 currently depends on unspecified

   behaviour.
   behaviour.

-⛩️📰 书社 requires specifically the G·N·U version of `make`, and
+⛩📰 书社 requires specifically the G·N·U version of `make`, and

   depends on functionality present in version 3.81 or later.
 It is not expected to work in previous versions, or with other
   implementations of Make.
   depends on functionality present in version 3.81 or later.
 It is not expected to work in previous versions, or with other
   implementations of Make.


@@ -117,7 +117,7 @@ It is not expected to work in previous versions, or with other
 
 This is a Posix utility, but it is not included in the Linux Standard
   Base or installed by default in many distributions.
 
 This is a Posix utility, but it is not included in the Linux Standard
   Base or installed by default in many distributions.

-⛩️📰 书社 only requires support for the `ustar` format.
+⛩📰 书社 only requires support for the `ustar` format.

 
 ### `uudecode` and `uuencode`
 
 
 ### `uudecode` and `uuencode`
 


@@ -146,28 +146,28 @@ Place source files in `sources/` and run `make install` to compile
   the result to `public/`.
 Compilation involves the following steps :⁠—
 
   the result to `public/`.
 Compilation involves the following steps :⁠—
 

-1. ⛩️📰 书社 compiles all of the magic files in `magic/` into a single
+1. ⛩📰 书社 compiles all of the magic files in `magic/` into a single

     file, `build/magic.mgc`.
 
     file, `build/magic.mgc`.
 

-2. ⛩️📰 书社 processes all of the parsers in `parsers/` and determines
+2. ⛩📰 书社 processes all of the parsers in `parsers/` and determines

     the list of supported plaintext types.
 
     the list of supported plaintext types.
 

-3. ⛩️📰 书社 identifies all of the source files and includes and uses
+3. ⛩📰 书社 identifies all of the source files and includes and uses

     `build/magic.mgc` to classify them by media type.
 
     `build/magic.mgc` to classify them by media type.
 

-4. ⛩️📰 书社 parses all plaintext and X·M·L source files and includes
+4. ⛩📰 书社 parses all plaintext and X·M·L source files and includes

     and then builds a dependency tree between them.
 
     and then builds a dependency tree between them.
 

-5. ⛩️📰 书社 uses the dependency tree to establish prerequisites for
+5. ⛩📰 书社 uses the dependency tree to establish prerequisites for

     each output file.
 
     each output file.
 

-6. ⛩️📰 书社 compiles each output file to `build/result`.
+6. ⛩📰 书社 compiles each output file to `build/result`.

 
 

-7. ⛩️📰 书社 copies 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.
 

-8. ⛩️📰 书社 copies the final resulting files to `public`.
+8. ⛩📰 书社 copies the final resulting files to `public`.

 
 You can use `make list` to list each identified source file or include
   alongside its computed type and dependencies.
 
 You can use `make list` to list each identified source file or include
   alongside its computed type and dependencies.


@@ -177,7 +177,7 @@ As this is a Make‐based program, steps will only be run if the
 
 ## Name·spaces
 
 
 ## Name·spaces
 

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

 
 This document uses a few name·space prefixes, with the following
   meanings :⁠—
 
 This document uses a few name·space prefixes, with the following
   meanings :⁠—


@@ -195,7 +195,7 @@ This document uses a few name·space prefixes, with the following
 
 ## Setup and Configuration
 
 
 ## Setup and Configuration
 

-⛩️📰 书社 depends on the following programs to run.
+⛩📰 书社 depends on the following programs to run.

 In every case, you may supply your own implementation by overriding the
   corresponding (allcaps) variable (e·g, set `MKDIR` to supply your own
   `mkdir` implementation).
 In every case, you may supply your own implementation by overriding the
   corresponding (allcaps) variable (e·g, set `MKDIR` to supply your own
   `mkdir` implementation).


@@ -231,7 +231,7 @@ In every case, you may supply your own implementation by overriding the
 - `xsltproc` (provided by `libxslt`)
 
 The following additional variables can be used to control the behaviour
 - `xsltproc` (provided by `libxslt`)
 
 The following additional variables can be used to control the behaviour

-  of ⛩️📰 书社 :⁠—
+  of ⛩📰 书社 :⁠—

 
 - **`SRCDIR`:**
   The location of the source files (default: `sources`).
 
 - **`SRCDIR`:**
   The location of the source files (default: `sources`).


@@ -247,7 +247,7 @@ The following additional variables can be used to control the behaviour
 - **`BUILDDIR`:**
   The location of the (temporary) build directory (default: `build`).
   `make clean` will delete this, and it is recommended that it not be
 - **`BUILDDIR`:**
   The location of the (temporary) build directory (default: `build`).
   `make clean` will delete this, and it is recommended that it not be

-    used for programs aside from ⛩️📰 书社.
+    used for programs aside from ⛩📰 书社.

 
 - **`DESTDIR`:**
   The location of directory to output files to (default: `public`).
 
 - **`DESTDIR`:**
   The location of directory to output files to (default: `public`).


@@ -263,10 +263,10 @@ The following additional variables can be used to control the behaviour
     ensure stale content is removed.
 
 - **`THISDIR`:**
     ensure stale content is removed.
 
 - **`THISDIR`:**

-  The location of the ⛩️📰 书社 `GNUmakefile`.
+  The location of the ⛩📰 书社 `GNUmakefile`.

   This should be set automatically when calling Make and shouldn’t ever
     need to be set manually.
   This should be set automatically when calling Make and shouldn’t ever
     need to be set manually.

-  This variable is used to find the ⛩️📰 书社 `lib/` folder, which is
+  This variable is used to find the ⛩📰 书社 `lib/` folder, which is

     expected to be in the same location.
 
 - **`MAGIC`:**
     expected to be in the same location.
 
 - **`MAGIC`:**


@@ -325,7 +325,7 @@ The following additional variables can be used to control the behaviour
   This variable can be used for postprocessing.
 
 - **`THISREV`:**
   This variable can be used for postprocessing.
 
 - **`THISREV`:**

-  The current version of ⛩️📰 书社 (default: derived from the current
+  The current version of ⛩📰 书社 (default: derived from the current

     git tag/branch/commit).
 
 - **`SRCREV`:**
     git tag/branch/commit).
 
 - **`SRCREV`:**


@@ -385,7 +385,7 @@ The former characters have the potential to conflict with make syntax,
 Parsers are used to convert plaintext files into X·M·L trees, as well
   as convert plaintext formats which are already included inline in
   existing source X·M·L documents.
 Parsers are used to convert plaintext files into X·M·L trees, as well
   as convert plaintext formats which are already included inline in
   existing source X·M·L documents.

-⛩️📰 书社 comes with some parsers; namely :⁠—
+⛩📰 书社 comes with some parsers; namely :⁠—

 
 - **`parsers/plain.xslt`:**
   Wraps `text/plain` contents in a `<html:pre>` element.
 
 - **`parsers/plain.xslt`:**
   Wraps `text/plain` contents in a `<html:pre>` element.


@@ -398,7 +398,7 @@ Parsers are used to convert plaintext files into X·M·L trees, as well
   Converts `text/tab-separated-values` contents into an `<html:table>`
     element.
 
   Converts `text/tab-separated-values` contents into an `<html:table>`
     element.
 

-New ⛩️📰 书社 parsers which target plaintext formats should have an
+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…
 


@@ -430,7 +430,7 @@ For example, the trivial `text/plain` parser is defined as follows :⁠—
 </transform>
 ```
 
 </transform>
 ```
 

-⛩️📰 书社 will scan the provided parsers for this pattern to determine
+⛩📰 书社 will scan the provided parsers for this pattern to determine

   the set of allowed plaintext file types.
 Multiple such `<xslt:template>` elements may be provided in a single
   parser, for example if the parser supports multiple media types.
   the set of allowed plaintext file types.
 Multiple such `<xslt:template>` elements may be provided in a single
   parser, for example if the parser supports multiple media types.


@@ -464,7 +464,7 @@ It is **strongly recommended** that auxillary templates in parsers be
 
 ### Attributes added during parsing
 
 
 ### Attributes added during parsing
 

-⛩️📰 书社 will add a few attributes to elements which result from
+⛩📰 书社 will add a few attributes to elements which result from

   parsing plaintext `<html:script>` elements.
 These include :⁠—
 
   parsing plaintext `<html:script>` elements.
 These include :⁠—
 


@@ -479,7 +479,7 @@ These include :⁠—
 
 ## Output Redirection
 
 
 ## Output Redirection
 

-By default, ⛩️📰 书社 installs files to the same location in `DESTDIR`
+By default, ⛩📰 书社 installs files to the same location in `DESTDIR`

   as they were placed in their `SRCDIR`.
 This behaviour can be customized by setting the `@书社:destination`
   attribute on the root element, whose value can give a different path.
   as they were placed in their `SRCDIR`.
 This behaviour can be customized by setting the `@书社:destination`
   attribute on the root element, whose value can give a different path.


@@ -507,13 +507,13 @@ Embed replacements will be given a `@书社:identifier` attribute whose
 
 Embedding takes place after parsing but before transformation, so
   parsers are able to generate their own embeds.
 
 Embedding takes place after parsing but before transformation, so
   parsers are able to generate their own embeds.

-⛩️📰 书社 is able to detect the transitive embed dependencies of files
+⛩📰 书社 is able to detect the transitive embed dependencies of files

   and update them accordingly; it will signal an error if the
   dependencies are recursive.
 
 ### Attributes added during expansion
 
   and update them accordingly; it will signal an error if the
   dependencies are recursive.
 
 ### Attributes added during expansion
 

-⛩️📰 书社 will add a few attributes to toplevel result elements, both
+⛩📰 书社 will add a few attributes to toplevel result elements, both

   in the main document and any embedded documents, during the expansion
   phase prior to the main transformation.
 These include :⁠—
   in the main document and any embedded documents, during the expansion
   phase prior to the main transformation.
 These include :⁠—


@@ -524,7 +524,7 @@ These include :⁠—
 - A `@书社:mtime` attribute giving the last modified time of the
     corresponding source file.
 
 - A `@书社:mtime` attribute giving the last modified time of the
     corresponding source file.
 

-- A `@书社:identifier` attribute giving the ⛩️📰 书社 identifier
+- A `@书社:identifier` attribute giving the ⛩📰 书社 identifier

     (i·e, starting with `about:shushe?`) of the corresponding source
     file.
 
     (i·e, starting with `about:shushe?`) of the corresponding source
     file.
 


@@ -540,7 +540,7 @@ These include :⁠—
 
 Transforms are used to convert X·M·L files into their final output,
   after all necessary parsing and embedding has taken place.
 
 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 :⁠—
+⛩📰 书社 comes with some transforms; namely :⁠—

 
 - **`transforms/asset.xslt`:**
   Converts `<html:object>` elements which correspond to recognized
 
 - **`transforms/asset.xslt`:**
   Converts `<html:object>` elements which correspond to recognized


@@ -556,7 +556,7 @@ 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.
 
   - **`urn:fdc:ladys.computer:20231231:Shu1She4:title`:**
     Provides the title of the page.
 

-  ⛩️📰 书社 automatically encapsulates H·T·M·L embeds so that their
+  ⛩📰 书社 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.
     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.


@@ -578,8 +578,8 @@ Transforms are used to convert X·M·L files into their final output,
     name·space.
   Multiple prefixes may be provided, separated by white·space.
 
     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
+  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.
     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.


@@ -609,7 +609,7 @@ The following params are made available globally in parsers and
   The current time.
 
 - **`IDENTIFIER`:**
   The current time.
 
 - **`IDENTIFIER`:**

-  The ⛩️📰 书社 identifier of the source file (a u·r·i beginning with
+  The ⛩📰 书社 identifier of the source file (a u·r·i beginning with

     `about:shushe`).
 
 - **`SRCREV`:**
     `about:shushe`).
 
 - **`SRCREV`:**


@@ -625,11 +625,17 @@ The following params are only available in transforms :⁠—
 
 ## Output Wrapping
 
 
 ## Output Wrapping
 

-⛩️📰 书社 will wrap the final output of the transforms in appropriate
-  `<html:html>` and `<html:body>` elements, so it is not necessary for
-  transforms to do this explicitly.
-After performing the initial transform, ⛩️📰 书社 will match the root
-  node of the result in the following modes to fill in areas of the
+Provided at least one toplevel result element belongs to the H·T·M·L
+  namespace, ⛩📰 书社 will wrap the final output of the transforms in
+  appropriate `<html:html>` and `<html:body>` elements, so it is not
+  necessary for transforms to do this explicitly.
+If a toplevel result element _is_ a `<html:html>` and `<html:body>`
+  element, it will be merged with the one that ⛩📰 书社 creates.
+Consequently, wrapping the result in a `<html:body>` element can be
+  used to enable wrapping for non‐H·T·M·L content, when desired.
+
+As a part of this process, after performing the initial transform
+  ⛩📰 书社 will match in the following modes to fill in areas of the

   wrapper :⁠—
 
 - **`书社:header`:**
   wrapper :⁠—
 
 - **`书社:header`:**


@@ -644,16 +650,13 @@ After performing the initial transform, ⛩️📰 书社 will match the root
   The result of matching in this mode is inserted into the
     `<html:head>` of the output.
 
   The result of matching in this mode is inserted into the
     `<html:head>` of the output.
 

-In addition to being called with the transform result, each of these
-  modes will additionally be called with a `<xslt:include>` element
-  corresponding to each transform.
-If a transform has a `<书社:id>` top‐level element whose value is an
-  i·r·i, its `<xslt:include>` element will have a corresponding
-  `@书社:id` attribute.
-This mechanism can be used to allow transforms to insert content
-  without matching any elements in the result; for example, the
-  following transform adds a link to a stylesheet to the `<html:head>`
-  of every page :⁠—
+The document being matched will contain the full transform result
+  prior to wrapping as well as an `<书社:id>` element for each
+  transform.
+The latter elements can be matched to enable transforms to provide
+  content _without_ matching any elements in the result; for example,
+  the following transform adds a link to a stylesheet to the
+  `<html:head>` of every page :⁠—

 
 ```xml
 <?xml version="1.0"?>
 
 ```xml
 <?xml version="1.0"?>


@@ -666,7 +669,7 @@ This mechanism can be used to allow transforms to insert content
   version="1.0"
 >
   <书社:id>example:add-stylesheet-links.xslt</书社:id>
   version="1.0"
 >
   <书社:id>example:add-stylesheet-links.xslt</书社:id>

-  <template match="xslt:include[@书社:id='example:add-stylesheet-links.xslt']" mode="书社:metadata">
+  <template match="书社:id[string(.)='example:add-stylesheet-links.xslt']" mode="书社:metadata">

     <html:link rel="stylesheet" type="text/css" href="/style.css"/>
   </template>
 </transform>
     <html:link rel="stylesheet" type="text/css" href="/style.css"/>
   </template>
 </transform>


@@ -677,7 +680,8 @@ Output wrapping can be entirely disabled by adding a
   the result tree.
 It will not be performed on outputs whose root elements are
   `<书社:archive>`, `<书社:base64-binary>`, or `<书社:raw-text>`
   the result tree.
 It will not be performed on outputs whose root elements are
   `<书社:archive>`, `<书社:base64-binary>`, or `<书社:raw-text>`

-  (described below).
+  (described below), or on result trees which do not contain a toplevel
+  element in the H·T·M·L namespace.

 
 ## Applying Attributes
 
 
 ## Applying Attributes
 


@@ -704,7 +708,7 @@ On H·T·M·L and S·V·G elements, `@lang` has the same behaviour as
 
 There are a few special elements in the `书社:` name·space which, if
   they appear as the toplevel element in a transformation result, cause
 
 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.
+  ⛩📰 书社 to produce something other than an X·M·L file.

 They are :⁠—
 
 - **`<书社:archive>`:**
 They are :⁠—
 
 - **`<书社:archive>`:**


@@ -717,7 +721,7 @@ They are :⁠—
   Other child elements will be ignored.
 
   If the `<书社:archive>` element is given an `@书社:expanded`
   Other child elements will be ignored.
 
   If the `<书社:archive>` element is given an `@书社:expanded`

-    attribute, rather than producing a tarball ⛩️📰 书社 will output
+    attribute, rather than producing a tarball ⛩📰 书社 will output

     the directory which expanding the tarball would produce.
   This mechanism can be used to generate multiple files from a single
     source, provided all of the files are contained with·in the same
     the directory which expanding the tarball would produce.
   This mechanism can be used to generate multiple files from a single
     source, provided all of the files are contained with·in the same