X-Git-Url: https://git.ladys.computer/Shushe/blobdiff_plain/d94cfdc987aba3983f4945d59b02cbb062573432..b03ac9094ce56f3591816f976cd5a4c97be492ac:/README.markdown
diff --git a/README.markdown b/README.markdown
index cae7ac1..654904a 100644
--- a/README.markdown
+++ b/README.markdown
@@ -1,6 +1,6 @@
# ⛩️📰 书社
-An X·S·L·T‐based static site generator.
+A make·file for X·M·L.
⛩️📰 书社 aims to make it easy to generate websites with
X·S·L·T and G·N·U Make.
@@ -18,6 +18,15 @@ It makes things easier by :—
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
@@ -91,14 +100,17 @@ 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).
+- `awk`
- `cat`
- `cp`
- `date`
- `echo`
- `file`
- `find`
+- `git` (optional; set `GIT=` to disable)
- `mkdir` (requires support for `-p`)
- `mv`
+- `od` (requires support for `-t x1`)
- `printf`
- `rm`
- `sed`
@@ -108,6 +120,7 @@ In every case, you may supply your own implementation by overriding the
- `touch`
- `tr` (requires support for `-d`)
- `uuencode` (requires support for `-m` and `-r`)
+- `xargs` (requires support for `-0`)
- `xmlcatalog` (provided by `libxml2`)
- `xmllint` (provided by `libxml2`)
- `xsltproc` (provided by `libxslt`)
@@ -117,10 +130,14 @@ The following additional variables can be used to control the behaviour
- **`SRCDIR`:**
The location of the source files (default: `sources`).
+ Multiple source directories can be provided, so long as the same
+ file subpath doesn’t exist in more than one of them.
- **`INCLUDEDIR`:**
- The location of the source files (default: `sources/includes`).
+ The location of source includes (default: `sources/includes`).
This can be inside of `SRCDIR`, but needn’t be.
+ Multiple include directories can be provided, so long as the same
+ file subpath doesn’t exist in more than one of them.
- **`BUILDDIR`:**
The location of the (temporary) build directory (default: `build`).
@@ -150,30 +167,41 @@ The following additional variables can be used to control the behaviour
- **`MAGICDIR`:**
The location of the magic files to use (default: `$(THISDIR)/magic`).
-- **`FINDOPTS`:**
- Options to pass to `find` when searching for source files (default:
- `-PE`).
-
- **`FINDRULES`:**
- Rules to use with `find` when searching for source files (default:
- `-flags -nohidden -and -not -name '.*'`).
+ Rules to use with `find` when searching for source files.
+ The default ignores files that start with a period or hyphen‐minus
+ and those which contain a hash, buck, percent, asterisk, colon,
+ semi, eroteme, bracket, backslash, or pipe.
-- **`FINDINCLUDEOPTS`:**
- Options to pass to `find` when searching for includes (default:
- `$(FINDOPTS)`).
+- **`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`).
@@ -206,11 +234,13 @@ Text formats with associated X·S·L·T parsers are wrapped in a H·T·M·L
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 should not
- contain Ascii whitespace or any of the following Ascii characters:
- ``!"#$%&()-:<>?\^`{|}``.
-These characters are either invalid in u·r·i’s or conflict with aspects
- of the Make or commandline syntax.
+**☡ 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, and must not begin with a hyphen‐minus (`-`).**
+The former characters have the potential to conflict with make syntax,
+ and a leading hyphen‐minus is confusable for a command‐line argument.
## Parsers
@@ -253,8 +283,10 @@ For example, the trivial `text/plain` parser is defined as follows :—
+ <书社:id>example:text/plain书社:id>
@@ -269,8 +301,21 @@ Alternatively, you can set the `@书社:supported-media-types` attribute
on the root element of the parser to override media type support
detection.
-Parsers can also target specific dialects of X·M·L, in which case they
- operate on the same basic principles as transforms (described below).
+Even when `@书社:supported-media-types` is set, it is a requirement
+ that each parser transform any `` elements with a
+ `@type` which matches their registered types into something else.
+Otherwise the parser will be stuck in an endless loop.
+The result tree of applying the transform to the ``
+ element will be reparsed (in case any new `` elements
+ were added in its subtree), and a `@书社:parsed-by` attribute will be
+ added to each toplevel element in the result.
+The value of this attribute will be the value of the `<书社:id>`
+ toplevel element in the parser.
+
+It is possible for parsers to support zero plaintext types.
+This is useful when targeting specific dialects of X·M·L; parsers in
+ this sense operate on the same basic principles as transforms
+ (described below).
The major distinction between X·M·L parsers and transforms is where in
the process the transformation happens:
Parsers are applied *prior* to embedding (and can be used to generate
@@ -303,6 +348,15 @@ Embedding takes place after parsing but before transformation, so
and update them accordingly; it will signal an error if the
dependencies are recursive.
+## Output Redirection
+
+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.
+This attribute is read after parsing, but before transformation (where
+ it is silently dropped).
+
## Transforms
Transforms are used to convert X·M·L files into their final output,
@@ -348,10 +402,32 @@ The following are recommendations on effective creation of
- 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.
+
+- **`SRCREV`:**
+ The tag or hash of the current commit in the working directory (if
+ `GIT` is defined and `./.git` exists).
+
+- **`SRCTIME`:**
+ The time at which the source file was last modified.
+
+- **`VERSION`:**
+ The tag or hash of the current commit in `THISDIR` (if `GIT` is
+ defined and `$(THISDIR)/.git` exists).
+
+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
@@ -378,7 +454,7 @@ In addition to being called with the transform result, each of these
modes will additionally be called with a `` element
corresponding to each transform.
If a transform has a `<书社:id>` top‐level element whose value is an
- i·r·i, its `` element will have a corresponding
+ i·r·i, its `` 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
@@ -412,4 +488,4 @@ Source files are licensed under the terms of the Mozilla Public
License, version 2.0.
For more information, see [LICENSE](./LICENSE).
-[draft-phillips-record-jar-01]:
\ No newline at end of file
+[draft-phillips-record-jar-01]: