# ⛩️📰 书社
-<b>An X·S·L·T‐based static site generator.</b>
+<b>A make·file for X·M·L.</b>
<dfn>⛩️📰 书社</dfn> aims to make it easy to generate websites with
X·S·L·T and G·N·U Make.
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`.)
+
+**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.
## Nomenclature
- `echo`
- `file`
- `find`
+- `git` (optional; set `GIT=` to disable)
+- `ln`
- `mkdir` (requires support for `-p`)
- `mv`
- `od` (requires support for `-t x1`)
This variable is used to find the ⛩️📰 书社 `lib/` folder, which is
expected to be in the same location.
-- **`MAGICDIR`:**
- The location of the magic files to use (default: `$(THISDIR)/magic`).
+- **`MAGIC`:**
+ A white·space‐separated list of magic files to use (default:
+ `$(THISDIR)/magic/*`).
+
+- **`EXTRAMAGIC`:**
+ The value of this variable is appended to `MAGIC` by default, to
+ enable additional magic files without overriding the existing ones.
- **`FINDRULES`:**
Rules to use with `find` when searching for source files.
- The default ignores hidden files, those that start with a period or
- hyphen‐minus, and those which contain a pipe, buck, percent, or
- colon.
+ The default ignores files that start with a period or hyphen‐minus,
+ those which end with a cloparen, and those which contain a hash,
+ buck, percent, asterisk, colon, semi, eroteme, bracket, backslash,
+ or pipe.
+
+- **`EXTRAFINDRULES`:**
+ The value of this variable is appended to `FINDRULES` by default, to
+ enable additional rules without overriding the existing ones.
- **`FINDINCLUDERULES`:**
Rules to use with `find` when searching for includes (default:
`$(FINDRULES)`).
+- **`EXTRAFINDINCLUDERULES`:**
+ The value of this variable is appended to `FINDINCLUDERULES` by
+ default, to enable additional rules without overriding the existing
+ ones.
+
- **`PARSERS`:**
A white·space‐separated list of parsers to use (default:
`$(THISDIR)/parsers/*.xslt`).
+- **`EXTRAPARSERS`:**
+ The value of this variable is appended to `PARSERS` by default, to
+ enable additional parsers without overriding the existing ones.
+
- **`TRANSFORMS`:**
A white·space‐separated list of transforms to use (default:
`$(THISDIR)/transforms/*.xslt`).
+- **`EXTRATRANSFORMS`:**
+ The value of this variable is appended to `TRANSFORMS` 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`).
+- **`GENERATOR`:**
+ The name of the generator program (default: `⛩️📰 书社`).
+
+- **`VERSION`:**
+ The current version of `GENERATOR` (default: derived from the current
+ git tag/branch/commit).
+
+- **`SRCREV`:**
+ The current version of the source files (default: derived from the
+ current git tag/branch/commit).
+
- **`VERBOSE`:**
If this variable has a value, every recipe instruction will be
printed when it runs (default: empty).
Source files whose media type does not have an associated X·S·L·T
parser are considered “assets” and will not be transformed.
-**☡ For compatibility with this program, source filenames must not
- contain Ascii whitespace, colons (`:`), pipes (`|`), bucks (`$`),
- percents (`%`) or control characters, and must not begin with a
- hyphen‐minus (`-`).**
+**☡ For compatibility with this program, source file·names must not
+ 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 (`)`).**
The former characters have the potential to conflict with make syntax,
- and a leading hyphen‐minus is confusable for a command‐line argument.
+ a leading hyphen‐minus is confusable for a command‐line 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
- Set `@exclude-result-prefixes` on the root `xslt:transform` element
to reduce the number of declared namespaces in the final result.
-The params `$buildtime`, `$srctime`, and `$path` are available within
- transforms and are initialized to the current time, the time that the
- source file was last modified, and the path of the output file within
- $(DESTDIR).
+## Global Params
+
+The following params are made available globally in parsers and
+ transforms :—
+
+- **`BUILDTIME`:**
+ The current time.
+
+- **`GENERATOR`:**
+ The value of the `GENERATOR` variable (if present).
+
+- **`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).
+
+The following params are only available in transforms :—
+
+- **`CATALOG`:**
+ The path of the catalog file (within `BUILDDIR`).
+
+- **`PATH`:**
+ The path of the output file (within `DESTDIR`).
## Output Wrapping
License, version 2.0</cite>.
For more information, see [LICENSE](./LICENSE).
-[draft-phillips-record-jar-01]: <https://datatracker.ietf.org/doc/html/draft-phillips-record-jar-01>
\ No newline at end of file
+[draft-phillips-record-jar-01]: <https://datatracker.ietf.org/doc/html/draft-phillips-record-jar-01>
Lady’s Gitweb / Shushe / blobdiff