+<!--
+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>
- Enabling easy inclusion of source files within each other.
It aims to do this with zero dependencies beyond the programs already
- installed on your computer.
-(On Linux machines, you may need to install `libxml2-utils` to get the
- commandline programs from `libxml2`.)
+ installed on your computer†.
+
+† The only non‐Posix programs‡ required (other than G·N·U Make itself,
+ and optionally Git) are those provided by `libxml2` and `libxslt`.
+On most operating systems, these libraries come pre·installed, but on
+ Linux machines the commandline utilities are often packaged
+ separately (as **`libxml2-utils`** and **`xsltproc`**), which may
+ still need to be installed.
+Additionally, not all Linux distributions bundle all necessary Posix
+ programs; on Debian (for example) you may need to separately install
+ **`sharutils`** for `uudecode` and `uuencode` and **`pax`** for
+ archiving.
+
+‡ This make·file also currently depends on non‐Posix `stat` but
+ attempts to handle both the G·N·U and B·S·D variants.
+It expects `xargs` to accept a `-0` option, which, while widely
+ supported, is not a part of the Posix standard.
**Note:**
-⛩️📰 书社 requires functionality present in G·N·U Make 3.81 (or later)
- and will not work in previous versions, or other implementations of
- Make.
-Compatibility with later versions of G·N·U Make is assumed, but not
- tested.
+⛩️📰 书社 requires functionality present in G·N·U Make 3.81 or later,
+ and will not work in previous versions, or with other implementations
+ of Make.
## Nomenclature
5. ⛩️📰 书社 uses the dependency tree to establish prerequisites for
each output file.
-6. ⛩️📰 书社 compiles each output file to `build/public`.
+6. ⛩️📰 书社 compiles each output file to `build/result`.
-7. ⛩️📰 书社 copies the output files to `public`.
+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.
+
+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.
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 :—
-| 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
- `file`
- `find`
- `git` (optional; set `GIT=` to disable)
+- `grep`
- `ln`
-- `mkdir` (requires support for `-p`)
+- `mkdir`
- `mv`
-- `od` (requires support for `-t x1`)
+- `od`
+- `pax` (only when generating archives)
- `printf`
- `rm`
- `sed`
- `sleep`
-- `stat`
+- `stat` (BSD *or* GNU)
- `test`
- `touch`
-- `tr` (requires support for `-d`)
-- `uuencode` (requires support for `-m` and `-r`)
+- `tr`
+- `uuencode`
+- `uudecode`
- `xargs` (requires support for `-0`)
- `xmlcatalog` (provided by `libxml2`)
- `xmllint` (provided by `libxml2`)
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`:**
`<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=`.
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
is an asset, in which case an `<html:object>` 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.
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 `<html:img>`.
-
- **`transforms/asset.xslt`:**
Converts `<html:object>` elements which correspond to recognized
media types into the appropriate H·T·M·L elements, and deletes
- **`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.
+- **`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 :—
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
- 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
- **`CKSUM`:**
The checksum of the source file (⅌ `cksum`).
-- **`GENERATOR`:**
- The value of the `GENERATOR` variable (if present).
+- **`IDENTIFIER`:**
+ The ⛩️📰 书社 identifier of the source file (a u·r·i beginning with
+ `about:shushe`).
- **`SRCREV`:**
The value of the `SRCREV` variable (if present).
- **`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 :—
Output wrapping can be entirely disabled by adding a
`@书社:disable-output-wrapping` attribute to the top‐level element in
the result tree.
+It will not be performed on outputs whose root elements are
+ `<书社:archive>`, `<书社:base64-binary>`, or `<书社:raw-text>`
+ (described below).
+
+## 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:` 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`.
+
+## Other Kinds of Output
+
+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 :—
+
+- **`<书社:archive>`:**
+ Each child element with a `@书社:archived-as` attribute will be
+ archived as a separate file in a resulting tarball (this attribute
+ gives the file name).
+ These elements will be processed the same as the root elements of any
+ other file (e·g, they will be wrapped; they can themselves specify
+ non X·M·L output types, ⁊·c).
+ Other child elements will be ignored.
+
+- **`<书社:base64-binary>`:**
+ The text nodes in the transformation result will, after removing all
+ Ascii whitespace, be treated as a Base·64 string, which is then
+ decoded.
+
+- **`<书社:raw-text>`:**
+ A plaintext (U·T·F‐8) file will be produced from the text nodes in
+ the transformation result.
## License
-Source files are licensed under the terms of the <cite>Mozilla Public
- License, version 2.0</cite>.
-For more information, see [LICENSE](./LICENSE).
+This repository conforms to [REUSE][].
+
+Most source files are licensed under the terms of the <cite>Mozilla
+ Public License, version 2.0</cite>.
+[REUSE]: <https://reuse.software/spec/>
[draft-phillips-record-jar-01]: <https://datatracker.ietf.org/doc/html/draft-phillips-record-jar-01>
Lady’s Gitweb / Shushe / blobdiff