X-Git-Url: https://git.ladys.computer/Shushe/blobdiff_plain/023ca463e9644ebe5ceac3c15d73607583da00e5..0a274f491afeda433fa075f7477eb4b200655b24:/README.markdown?ds=inline diff --git a/README.markdown b/README.markdown index cafda3a..95f6954 100644 --- a/README.markdown +++ b/README.markdown @@ -91,14 +91,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 +111,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,16 +121,32 @@ 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`). + `make clean` will delete this, and it is recommended that it not be + used for programs aside from ⛩️📰 书社. - **`DESTDIR`:** The location of directory to output files to (default: `public`). + `make install` will overwrite files in this directory which + correspond to those in `SRCDIR`. + It *will not* touch other files, including those generated from files + in `SRCDIR` which have since been deleted. + + Files are first compiled to `$(BUILDDIR)/public` before they are + copied to `DESTDIR`, so this folder is relatively quick and + inexpensive to re·create. + It’s reasonable to simply delete it before every `make install` to + ensure stale content is removed. - **`THISDIR`:** The location of the ⛩️📰 书社 `GNUmakefile`. @@ -138,13 +158,15 @@ 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: - `-LE`). - - **`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 hidden files, those that start with a period or + hyphen‐minus, and those which contain a pipe, buck, percent, + bracket, hash, asterisk, eroteme, semi, or colon. + +- **`FINDINCLUDERULES`:** + Rules to use with `find` when searching for includes (default: + `$(FINDRULES)`). - **`PARSERS`:** A white·space‐separated list of parsers to use (default: @@ -186,18 +208,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 conform to - the following rules :⁠— - -- They should not start with a hyphen‐minus. - This is to prevent confusion between filenames and options on the - commandline. - -- They should not contain spaces, colons, percent signs, backticks, - question marks, hashes, or backslashes. - -In general, filenames should be such that they do not require - percent‐encoding in the path component of an i·r·i. +**☡ For compatibility with this program, source file·names must not + contain Ascii white·space, colons (`:`), semis (`;`), pipes (`|`), + bucks (`$`), percents (`%`), hashes (`#`), asterisks (`*`), brackets + (`[` or `]`), erotemes (`?`), 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 @@ -207,14 +224,20 @@ Parsers are used to convert plaintext files into X·M·L trees, as well ⛩️📰 书社 comes with some parsers; namely :⁠— - **`parsers/plain.xslt`:** - Wraps `text/plain` contents in a `` element. + Wraps `text/plain` contents in a `` element. + +- **`parsers/record-jar.xslt`:** + Converts `text/record-jar` contents into a + `` of `` elements (one for + each record). - **`parsers/tsv.xslt`:** - Converts `text/tab-separated-values` contents into an `` - element. + Converts `text/tab-separated-values` contents into an + `` element. -New ⛩️📰 书社 parsers should have a `` element with no - `@name` or `@mode` and whose `@match` attribute… +New ⛩️📰 书社 parsers which target plaintext formats should have an + `` element with no `@name` or `@mode` and whose + `@match` attribute… - Starts with an appropriately‐namespaced qualified name for a `` element. @@ -234,8 +257,10 @@ For example, the trivial `text/plain` parser is defined as follows :⁠— + <书社:id>example:text/plain @@ -250,9 +275,29 @@ Alternatively, you can set the `@书社:supported-media-types` attribute on the root element of the parser to override media type support detection. -It is **strongly recommended** that all templates in parsers other than - those described above be namespaced (by `@name` or `@mode`), to avoid - conflicts between templates in multiple parsers. +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 + embeds); transforms are applied *after*. + +It is **strongly recommended** that auxillary templates in parsers be + namespaced (by `@name` or `@mode`) whenever possible, to avoid + conflicts between parsers. ## Embedding @@ -277,6 +322,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, @@ -299,7 +353,7 @@ Transforms are used to convert X·M·L files into their final output, - **`transforms/metadata.xslt`:** Provides basic `` metadata. - This metadata is generated from `` elements with one o. + This metadata is generated from `` elements with one of the following `@itemprop` attributes :⁠— - **`urn:fdc:ladys.computer:20231231:Shu1She4:title`:** @@ -322,10 +376,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 @@ -352,7 +428,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