X-Git-Url: https://git.ladys.computer/Shushe/blobdiff_plain/7f3046d260fee68969d6cb750fe066ab10982e59..fc985b7f5cf58d16b6d5d81bde7cebbd1747dd27:/README.markdown?ds=sidebyside diff --git a/README.markdown b/README.markdown index 2cefb62..e70361e 100644 --- a/README.markdown +++ b/README.markdown @@ -283,6 +283,8 @@ The following additional variables can be used to control the behaviour 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 @@ -317,6 +319,11 @@ The following additional variables can be used to control the behaviour 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 git tag/branch/commit). @@ -460,8 +467,17 @@ It is **strongly recommended** that auxillary templates in parsers be ⛩️📰 书社 will add a few attributes to the output of the parsing step, namely :⁠— -- A `@书社:cksum` attribute on toplevel result elements, giving the - `cksum` checksum of the corresponding source file. +- For toplevel result elements :⁠— + + - A `@书社:cksum` attribute giving the `cksum` checksum of the + corresponding source file. + + - A `@书社:mtime` attribute giving the last modified time of the + corresponding source file. + + - A `@书社:identifier` attribute giving the ⛩️📰 书社 identifier + (i·e, starting with `about:shushe?`) of the corresponding source + file. - For the elements which result from parsing plaintext `` elements :⁠— @@ -581,9 +597,6 @@ The following params are made available globally in parsers and - **`BUILDTIME`:** The current time. -- **`CKSUM`:** - The checksum of the source file (⅌ `cksum`). - - **`IDENTIFIER`:** The ⛩️📰 书社 identifier of the source file (a u·r·i beginning with `about:shushe`). @@ -591,16 +604,13 @@ The following params are made available globally in parsers and - **`SRCREV`:** The value of the `SRCREV` variable (if present). -- **`SRCTIME`:** - The time at which the source file was last modified. - - **`THISREV`:** The value of the `THISREV` variable (if present). The following params are only available in transforms :⁠— -- **`CATALOG`:** - The path of the catalog file (within `BUILDDIR`). +- **`METADATA`:** + The path of the metadata file (within `BUILDDIR`). - **`PATH`:** The path of the output file (within `DESTDIR`).