]> Lady’s Gitweb - Shushe/blobdiff - README.markdown
Prepend X·M·L declaration on parsed assets
[Shushe] / README.markdown
index b83d49ecd24272d33ece6f19ec210683e4133492..8a6efb8afdd623b1f62fd39f1eb543b483dc4985 100644 (file)
@@ -57,13 +57,6 @@ Details on particular programs are given below; if a program is not
   listed, it is assumed that any Posix‐compliant implementation will
   work.
 
-### `date`
-
-This is a Posix utility, but ⛩️📰 书社 currently depends on
-  unspecified behaviour.
-When the G·N·U version of `stat` is being used, then the G·N·U version
-  of `date` is also expected.
-
 ### `file`
 
 This is a Posix utility, but ⛩️📰 书社 currently depends on
@@ -108,13 +101,6 @@ This is a Posix utility, but not included in the Linux Standard Base or
   installed by default in many distributions.
 Only `ustar` format support is required.
 
-### `stat`
-
-This is not a Posix utility, and nor is it particularly portable.
-To get around incompatibilities, ⛩️📰 书社 attempts to recognize G·N·U
-  `stat` by searching for the string `GNU` when invoked with the
-  `--version` option, and falls back to B·S·D behaviour otherwise.
-
 ### `uudecode` and `uuencode`
 
 These are Posix utilities, but not included in the Linux Standard Base
@@ -198,13 +184,12 @@ In every case, you may supply your own implementation by overriding the
 - `cksum`
 - `cp`
 - `date`
-- `echo`
+- `diff`
 - `file`
 - `find`
 - `git` (optional; set `GIT=` to disable)
 - `grep`
 - `ln`
-- `ls`
 - `mkdir`
 - `mv`
 - `od`
@@ -213,7 +198,6 @@ In every case, you may supply your own implementation by overriding the
 - `rm`
 - `sed`
 - `sleep`
-- `stat` (BSD *or* GNU)
 - `test`
 - `touch`
 - `tr`
@@ -308,8 +292,8 @@ The following additional variables can be used to control the behaviour
     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`).
 
 - **`THISREV`:**
   The current version of ⛩️📰 书社 (default: derived from the current
@@ -319,6 +303,15 @@ The following additional variables can be used to control the behaviour
   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).
@@ -351,14 +344,12 @@ Source files whose media type does not have an associated X·S·L·T
   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 (`-`), must not end
-  with a cloparen (`)`), and must not contain quoted braces (`"{` or
-  `}"`).**
+  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, a
+  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),
-  and quoted braces are used internally by the program.
+  3.81](https://stackoverflow.com/questions/17148468/capturing-filenames-including-parentheses-with-gnu-makes-wildcard-function#comment24825307_17148894).
 
 ## Parsers
 
@@ -685,6 +676,13 @@ They are :⁠—
     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
@@ -694,29 +692,6 @@ They are :⁠—
   A plaintext (U·T·F‐8) file will be produced from the text nodes in
     the transformation result.
 
-## Pagination
-
-It is possible to have a single source file produce multiple output
-  files via `<书社:page>` elements, whose `@name` gives the name of the
-  page.
-If a parsed document has a `@书社:destination` which contains `%s`,
-  the `%s` will be replaced with the `@name` for each `<书社:page>` (and
-  removed for the main output).
-Otherwise, the `@name` is inserted before the first period of the
-  filename (or at the end of the filename for those with no period).
-If `<书社:page>`s do not have a `@name`, they are numbered
-  sequentially.
-The destination of pages must be in the same directory as their parent.
-
-Pagination essentially forms a limited convenience for the more
-  sophisticated technique of creating an archive with ⛩️📰 书社 and
-  then unarchiving it.
-Pages are, from Make’s point of view, untracked side·effects of
-  installing the main output, meaning they cannot be targeted directly
-  and will not appear in `make list` or `make listout`.
-They are intended solely for the like of indices and feeds, for which
-  convenience and necessity outweigh their flaws.
-
 ## License
 
 This repository conforms to [REUSE][].
This page took 0.056206 seconds and 4 git commands to generate.