- 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†.
-**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.
+† Assuming an operating system with a fairly featureful, and
+ Posix‐compliant, development setup (e·g, Macintosh ≥ version 10.8).
+In fact, on Linux you will probably need to install a few programs:
+ `libxml2-utils`, `xsltproc`, `sharutils`, and `pax`.
## Nomenclature
In Ascii environments, ⛩️📰 书社 should be written `Shushe`, following
the pinyin transliteration.
+## Prerequisites
+
+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
+ listed, it is assumed that any Posix‐compliant implementation will
+ work.
+
+### `diff`
+
+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
+ correctly in legacy mode (`COMMAND_MODE=legacy`) but incorrectly by
+ default (despite claiming `POSIX.1-2008` conformance for this
+ utility).
+[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
+ fractional component when a Posix⹀compliant (e·g, Macintosh legacy or
+ G·N·U) implementation is used.
+
+### `file`
+
+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.
+It requires support for the following additional options :—
+
+- **`-C`**, when supplied with `-m`, must be useable to compile a
+ `.mgc` magicfile for use with future invocations of `file`.
+
+- **`--files-from`** must be useable to provide a file that `file`
+ should read file·names from, and `-` must be useable in this
+ context to specify the standard input.
+
+- **`--mime-type`** must cause `file` to print the internet media type
+ of the file with no charset parameter.
+
+- **`--separator`** must be useable to set the separator that `file`
+ uses to separate file names from types.
+
+These options are implemented by the
+ [Fine Free File Command](https://darwinsys.com/file/), which is used
+ by most operating systems.
+
+### `git`
+
+This is not a Posix utility.
+Usage of `git` is optional, but recommended (and activated by default).
+To disable it, set `GIT=`.
+
+### `make`
+
+This is a Posix utility, but it is considered an optional Software
+ Development utility and ⛩️📰 书社 currently depends on unspecified
+ behaviour.
+⛩️📰 书社 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.
+
+### `pax`
+
+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.
+
+### `uudecode` and `uuencode`
+
+These are Posix utilities, but they were considered optional in
+ `POSIX.1-2001` (altho they are made mandatory in `POSIX.1-2008`) and
+ they are not included in the Linux Standard Base or installed by
+ default in many distributions.
+The G·N·U [Sharutils](https://www.gnu.org/software/sharutils/) package
+ provides one implementation.
+
+### `xmlcatalog` and `xmllint`
+
+These are not a Posix utilities.
+They are a part of `libxml2`, but may need to be installed separately
+ on some platforms (e·g by the name `libxml2-utils`).
+
+### `xsltproc`
+
+This is not a Posix utility.
+It is a part of `libxslt`, but may need to be installed separately on
+ some platforms.
+
## Basic Usage
Place source files in `sources/` and run `make install` to compile
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.
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
- `awk`
- `cat`
+- `cd`
- `cksum`
- `cp`
- `date`
-- `echo`
+- `diff`
- `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`
- `test`
- `touch`
-- `tr` (requires support for `-d`)
-- `uuencode` (requires support for `-m` and `-r`)
-- `uudecode` (requires support for `-m` and `-r`)
-- `xargs` (requires support for `-0`)
+- `tr`
+- `uuencode`
+- `uudecode`
+- `xargs`
- `xmlcatalog` (provided by `libxml2`)
- `xmllint` (provided by `libxml2`)
- `xsltproc` (provided by `libxslt`)
those which end with a cloparen, and those which contain a hash,
buck, percent, asterisk, colon, semi, eroteme, bracket, backslash,
or pipe.
+ It is important that these rules not produce any output, as anything
+ printed to `stdout` will be considered a result of the find.
- **`EXTRAFINDRULES`:**
The value of this variable is appended to `FINDRULES` by default, to
enable additional transforms without overriding the existing ones.
- **`XMLTYPES`:**
- A white·space‐separated list of media types to consider X·M·L
- (default: `application/xml text/xml`).
+ A white·space‐separated list of media types or media type suffixes to
+ consider X·M·L (default: `application/xml text/xml +xml`).
+
+- **`FINALIZE`:**
+ A program to run on (unspecial) X·M·L files after they are
+ transformed (default: `xmllint --nonet --nsclean`).
+ This variable can be used for postprocessing.
- **`THISREV`:**
The current version of ⛩️📰 书社 (default: derived from the current
The current version of the source files (default: derived from the
current git tag/branch/commit).
+- **`QUIET`:**
+ If this variable has a value, informative messages will not be
+ printed (default: empty).
+ Informative messages print to stderr, not stdout, so disabling them
+ usually shouldn’t be necessary.
+ This does not (cannot) disable messages from Make itself, for which
+ the `-s`, `--silent` ∕ `--quiet` Make option is more likely to be
+ useful.
+
- **`VERBOSE`:**
If this variable has a value, every recipe instruction will be
printed when it runs (default: empty).
contain Ascii white·space, colons (`:`), semis (`;`), pipes (`|`),
bucks (`$`), percents (`%`), hashes (`#`), asterisks (`*`), brackets
(`[` or `]`), erotemes (`?`), backslashes (`\`), or control
- characters, must not begin with a hyphen‐minus (`-`), and must not
- end with a cloparen (`)`).**
+ characters, must not begin with a hyphen‐minus (`-`), and must not end
+ with a cloparen (`)`).**
The former characters have the potential to conflict with make syntax,
- a leading hyphen‐minus is confusable for a command‐line argument, and
- a trailing cloparen [activates a bug in G·N·U Make
+ a leading hyphen‐minus is confusable for a commandline argument, and a
+ trailing cloparen [activates a bug in G·N·U Make
3.81](https://stackoverflow.com/questions/17148468/capturing-filenames-including-parentheses-with-gnu-makes-wildcard-function#comment24825307_17148894).
## Parsers
`<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
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
`@书社:disable-output-wrapping` attribute to the top‐level element in
the result tree.
It will not be performed on outputs whose root elements are
- `<书社:raw-text>` or `<书社:base64-binary>` (described below).
+ `<书社:archive>`, `<书社:base64-binary>`, or `<书社:raw-text>`
+ (described below).
## Applying Attributes
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
## 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 :—
-- **`<书社:raw-text>`:**
- A plaintext (U·T·F‐8) file will be produced from the text nodes in
- the transformation result.
+- **`<书社: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.
+
+ If the `<书社:archive>` element is given an `@书社:expanded`
+ 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
+ directory.
- **`<书社: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
This repository conforms to [REUSE][].
[REUSE]: <https://reuse.software/spec/>
[draft-phillips-record-jar-01]: <https://datatracker.ietf.org/doc/html/draft-phillips-record-jar-01>
+[rdar-92753335]: <https://github.com/apple-oss-distributions/patch_cmds/blob/5084833f90df1b0e0924ea56f94c0199b3b8bbc6/diff/diffreg.c#L1800-L1808>
Lady’s Gitweb / Shushe / blobdiff