]> Lady’s Gitweb - Shushe/blob - README.markdown
Update FINDRULES documentation
[Shushe] / README.markdown
1 # ⛩️📰 书社
2
3 <b>An X·S·L·T‐based static site generator.</b>
4
5 <dfn>⛩️📰 书社</dfn> aims to make it easy to generate websites with
6 X·S·L·T and G·N·U Make.
7 It is consequently only a good choice for people who like X·S·L·T and
8 G·N·U Make and wish it were easier to make websites with them.
9
10 It makes things easier by :⁠—
11
12 - Automatically identifying source files and characterizing them by
13 type (X·M·L, text, or asset).
14
15 - Parsing supported text types into X·M·L trees.
16
17 - Enabling easy inclusion of source files within each other.
18
19 It aims to do this with zero dependencies beyond the programs already
20 installed on your computer.
21
22 ## Nomenclature
23
24 <i lang="cmn-Hans">书社</i> is a Chinese word meaning “publishing
25 house”.
26
27 The first character, <i lang="cmn-Hans">书</i>, is the simplified form
28 of “document”.
29
30 The second character, <i lang="cmn-Hans">社</i>, contemporarily means
31 “association”, but historically referred to the god of the soil and
32 related altars or festivities.
33 In Japanese, it is an alternate spelling for <i lang="ja">やしろ</i>,
34 the word for “Shinto shrine”.
35
36 The name <i lang="cmn-Hans">书社</i> was chosen to play on this pun, as
37 it is intended as a publishing program for webshrines.
38
39 In Ascii environments, ⛩️📰 书社 should be written `Shushe`, following
40 the pinyin transliteration.
41
42 ## Basic Usage
43
44 Place source files in `sources/` and run `make install` to compile
45 the result to `public/`.
46 Compilation involves the following steps :⁠—
47
48 1. ⛩️📰 书社 compiles all of the magic files in `magic/` into a single
49 file, `build/magic.mgc`.
50
51 2. ⛩️📰 书社 processes all of the parsers in `parsers/` and determines
52 the list of supported plaintext types.
53
54 3. ⛩️📰 书社 identifies all of the source files and includes and uses
55 `build/magic.mgc` to classify them by media type.
56
57 4. ⛩️📰 书社 parses all plaintext and X·M·L source files and includes
58 and then builds a dependency tree between them.
59
60 5. ⛩️📰 书社 uses the dependency tree to establish prerequisites for
61 each output file.
62
63 6. ⛩️📰 书社 compiles each output file to `build/public`.
64
65 7. ⛩️📰 书社 copies the output files to `public`.
66
67 You can use `make list` to list each identified source file or include
68 alongside its computed type and dependencies.
69 As this is a Make‐based program, steps will only be run if the
70 corresponding buildfile or output file is older than its
71 prerequisites.
72
73 ## Namespaces
74
75 The ⛩️📰 书社 namespace is `urn:fdc:ladys.computer:20231231:Shu1She4`.
76
77 This document uses a few namespace prefixes, with the following
78 meanings :⁠—
79
80 | Prefix | Expansion |
81 | -------: | :----------------------------------------- |
82 | `html:` | `http://www.w3.org/1999/xhtml` |
83 | `xlink:` | `http://www.w3.org/1999/xlink` |
84 | `xslt:` | `http://www.w3.org/1999/XSL/Transform` |
85 | `书社:` | `urn:fdc:ladys.computer:20231231:Shu1She4` |
86
87 ## Setup and Configuration
88
89 ⛩️📰 书社 depends on the following programs to run.
90 In every case, you may supply your own implementation by overriding the
91 corresponding (allcaps) variable (e·g, set `MKDIR` to supply your own
92 `mkdir` implementation).
93
94 - `awk`
95 - `cat`
96 - `cp`
97 - `date`
98 - `echo`
99 - `file`
100 - `find`
101 - `mkdir` (requires support for `-p`)
102 - `mv`
103 - `od` (requires support for `-t x1`)
104 - `printf`
105 - `rm`
106 - `sed`
107 - `sleep`
108 - `stat`
109 - `test`
110 - `touch`
111 - `tr` (requires support for `-d`)
112 - `uuencode` (requires support for `-m` and `-r`)
113 - `xargs` (requires support for `-0`)
114 - `xmlcatalog` (provided by `libxml2`)
115 - `xmllint` (provided by `libxml2`)
116 - `xsltproc` (provided by `libxslt`)
117
118 The following additional variables can be used to control the behaviour
119 of ⛩️📰 书社 :⁠—
120
121 - **`SRCDIR`:**
122 The location of the source files (default: `sources`).
123 Multiple source directories can be provided, so long as the same
124 file subpath doesn’t exist in more than one of them.
125
126 - **`INCLUDEDIR`:**
127 The location of source includes (default: `sources/includes`).
128 This can be inside of `SRCDIR`, but needn’t be.
129 Multiple include directories can be provided, so long as the same
130 file subpath doesn’t exist in more than one of them.
131
132 - **`BUILDDIR`:**
133 The location of the (temporary) build directory (default: `build`).
134 `make clean` will delete this, and it is recommended that it not be
135 used for programs aside from ⛩️📰 书社.
136
137 - **`DESTDIR`:**
138 The location of directory to output files to (default: `public`).
139 `make install` will overwrite files in this directory which
140 correspond to those in `SRCDIR`.
141 It *will not* touch other files, including those generated from files
142 in `SRCDIR` which have since been deleted.
143
144 Files are first compiled to `$(BUILDDIR)/public` before they are
145 copied to `DESTDIR`, so this folder is relatively quick and
146 inexpensive to re·create.
147 It’s reasonable to simply delete it before every `make install` to
148 ensure stale content is removed.
149
150 - **`THISDIR`:**
151 The location of the ⛩️📰 书社 `GNUmakefile`.
152 This should be set automatically when calling Make and shouldn’t ever
153 need to be set manually.
154 This variable is used to find the ⛩️📰 书社 `lib/` folder, which is
155 expected to be in the same location.
156
157 - **`MAGICDIR`:**
158 The location of the magic files to use (default: `$(THISDIR)/magic`).
159
160 - **`FINDRULES`:**
161 Rules to use with `find` when searching for source files.
162 The default ignores hidden files, those that start with a period or
163 hyphen‐minus, and those which contain a pipe, buck, percent, or
164 colon.
165
166 - **`FINDINCLUDERULES`:**
167 Rules to use with `find` when searching for includes (default:
168 `$(FINDRULES)`).
169
170 - **`PARSERS`:**
171 A white·space‐separated list of parsers to use (default:
172 `$(THISDIR)/parsers/*.xslt`).
173
174 - **`TRANSFORMS`:**
175 A white·space‐separated list of transforms to use (default:
176 `$(THISDIR)/transforms/*.xslt`).
177
178 - **`XMLTYPES`:**
179 A white·space‐separated list of media types to consider X·M·L
180 (default: `application/xml text/xml`).
181
182 - **`VERBOSE`:**
183 If this variable has a value, every recipe instruction will be
184 printed when it runs (default: empty).
185 This is helpful for debugging, but typically too noisy for general
186 usage.
187
188 ## Source Files
189
190 Source files may be placed in `SRCDIR` in any manner; the file
191 structure used there will match the output.
192 The type of source files is *not* determined by file extension, but
193 rather by magic number; this means that files **must** begin with
194 something recognizable.
195 Supported magic numbers include :⁠—
196
197 - `<?xml` for `application/xml` files
198 - `#!js` for `text/javascript` files
199 - `@charset "` for `text/css` files
200 - `#!tsv` for `text/tab-separated-values` files
201 - `%%` for `text/record-jar` files (unregistered; see
202 [[draft-phillips-record-jar-01][]])
203
204 Text formats with associated X·S·L·T parsers are wrapped in a H·T·M·L
205 `<script>` element whose `@type` gives its media type, and then
206 passed to the parser to process.
207 Source files whose media type does not have an associated X·S·L·T
208 parser are considered “assets” and will not be transformed.
209
210 **☡ For compatibility with this program, source filenames must not
211 contain Ascii whitespace, colons (`:`), pipes (`|`), bucks (`$`),
212 percents (`%`) or control characters, and must not begin with a
213 hyphen‐minus (`-`).**
214 The former characters have the potential to conflict with make syntax,
215 and a leading hyphen‐minus is confusable for a command‐line argument.
216
217 ## Parsers
218
219 Parsers are used to convert plaintext files into X·M·L trees, as well
220 as convert plaintext formats which are already included inline in
221 existing source X·M·L documents.
222 ⛩️📰 书社 comes with some parsers; namely :⁠—
223
224 - **`parsers/plain.xslt`:**
225 Wraps `text/plain` contents in a `<html:pre class="plain">` element.
226
227 - **`parsers/record-jar.xslt`:**
228 Converts `text/record-jar` contents into a
229 `<html:div class="record-jar">` of `<html:dl>` elements (one for
230 each record).
231
232 - **`parsers/tsv.xslt`:**
233 Converts `text/tab-separated-values` contents into an
234 `<html:table class="tsv">` element.
235
236 New ⛩️📰 书社 parsers which target plaintext formats should have an
237 `<xslt:template>` element with no `@name` or `@mode` and whose
238 `@match` attribute…
239
240 - Starts with an appropriately‐namespaced qualified name for a
241 `<html:script>` element.
242
243 - Follows this with the string `[@type=`.
244
245 - Follows this with a quoted string giving a media type supported by
246 the parser.
247 Media type parameters are *not* supported.
248
249 - Follows this with the string `]`.
250
251 For example, the trivial `text/plain` parser is defined as follows :⁠—
252
253 ```xml
254 <?xml version="1.0"?>
255 <transform
256 xmlns="http://www.w3.org/1999/XSL/Transform"
257 xmlns:html="http://www.w3.org/1999/xhtml"
258 version="1.0"
259 >
260 <template match="html:script[@type='text/plain']">
261 <html:pre><value-of select="."/></html:pre>
262 </template>
263 </transform>
264 ```
265
266 ⛩️📰 书社 will scan the provided parsers for this pattern to determine
267 the set of allowed plaintext file types.
268 Multiple such `<xslt:template>` elements may be provided in a single
269 parser, for example if the parser supports multiple media types.
270 Alternatively, you can set the `@书社:supported-media-types` attribute
271 on the root element of the parser to override media type support
272 detection.
273
274 Parsers can also target specific dialects of X·M·L, in which case they
275 operate on the same basic principles as transforms (described below).
276 The major distinction between X·M·L parsers and transforms is where in
277 the process the transformation happens:
278 Parsers are applied *prior* to embedding (and can be used to generate
279 embeds); transforms are applied *after*.
280
281 It is **strongly recommended** that auxillary templates in parsers be
282 namespaced (by `@name` or `@mode`) whenever possible, to avoid
283 conflicts between parsers.
284
285 ## Embedding
286
287 Documents can be embedded in other documents using a `<书社:link>`
288 element with `@xlink:show="embed"`.
289 The `@xlink:href`s of these elements should have the format
290 `about:shushe?source=<path>`, where `<path>` provides the path to the
291 file within `SRCDIR`.
292 Includes, which do not generate outputs of their own but may still be
293 freely embedded, instead use the format
294 `about:shushe?include=<path>`, where `<path>` provides the path
295 within `INCLUDEDIR`.
296
297 Embeds are replaced with the parsed contents of a file, unless the file
298 is an asset, in which case an `<html:object>` element is produced
299 instead (with the contents of the asset file provided as a base64
300 `data:` u·r·i).
301
302 Embedding takes place after parsing but before transformation, so
303 parsers are able to generate their own embeds.
304 ⛩️📰 书社 is able to detect the transitive embed dependencies of files
305 and update them accordingly; it will signal an error if the
306 dependencies are recursive.
307
308 ## Output Redirection
309
310 By default, ⛩️📰 书社 installs files to the same location in `DESTDIR`
311 as they were placed in their `SRCDIR`.
312 This behaviour can be customized by setting the `@书社:destination`
313 attribute on the root element, whose value can give a different path.
314 This attribute is read after parsing, but before transformation (where
315 it is silently dropped).
316
317 ## Transforms
318
319 Transforms are used to convert X·M·L files into their final output,
320 after all necessary parsing and embedding has taken place.
321 ⛩️📰 书社 comes with some transforms; namely :⁠—
322
323 - **`transforms/attributes.xslt`:**
324 Applies transforms to the children of any `<书社:apply-attributes>`
325 elements, and then applies the attributes of the
326 `<书社:apply-attributes>` to each result child, replacing the
327 element with the result.
328 This is useful in combination with image embeds to apply alt‐text to
329 the resulting `<html:img>`.
330
331 - **`transforms/asset.xslt`:**
332 Converts `<html:object>` elements which correspond to recognized
333 media types into the appropriate H·T·M·L elements, and deletes
334 `<html:style>` elements from the body of the document and moves
335 them to the head.
336
337 - **`transforms/metadata.xslt`:**
338 Provides basic `<html:head>` metadata.
339 This metadata is generated from `<html:meta>` elements with one of
340 the following `@itemprop` attributes :⁠—
341
342 - **`urn:fdc:ladys.computer:20231231:Shu1She4:title`:**
343 Provides the title of the page.
344
345 ⛩️📰 书社 automatically encapsulates embeds so that their metadata
346 does not propogate up to the embedding document.
347 To undo this behaviour, remove the `@itemscope` and `@itemtype`
348 attributes from the embed during the transformation phase.
349
350 The following are recommendations on effective creation of
351 transforms :⁠—
352
353 - Make template matchers as specific as possible.
354 It is likely an error if two transforms have templates which match
355 the same element (unless the templates have different priority).
356
357 - Namespace templates (with `@name` or `@mode`) whenever possible.
358
359 - Set `@exclude-result-prefixes` on the root `xslt:transform` element
360 to reduce the number of declared namespaces in the final result.
361
362 The params `$buildtime`, `$srctime`, and `$path` are available within
363 transforms and are initialized to the current time, the time that the
364 source file was last modified, and the path of the output file within
365 $(DESTDIR).
366
367 ## Output Wrapping
368
369 ⛩️📰 书社 will wrap the final output of the transforms in appropriate
370 `<html:html>` and `<html:body>` elements, so it is not necessary for
371 transforms to do this explicitly.
372 After performing the initial transform, ⛩️📰 书社 will match the root
373 node of the result in the following modes to fill in areas of the
374 wrapper :⁠—
375
376 - **`书社:header`:**
377 The result of matching in this mode is prepended into the
378 `<html:body>` of the output (before the transformation result).
379
380 - **`书社:footer`:**
381 The result of matching in this mode is appended into the
382 `<html:body>` of the output (after the transformation result).
383
384 - **`书社:metadata`:**
385 The result of matching in this mode is inserted into the
386 `<html:head>` of the output.
387
388 In addition to being called with the transform result, each of these
389 modes will additionally be called with a `<xslt:include>` element
390 corresponding to each transform.
391 If a transform has a `<书社:id>` top‐level element whose value is an
392 i·r·i, its `<xslt:include>` element will have a corresponding
393 `@书社:id` attribute.
394 This mechanism can be used to allow transforms to insert content
395 without matching any elements in the result; for example, the
396 following transform adds a link to a stylesheet to the `<html:head>`
397 of every page :⁠—
398
399 ```xml
400 <?xml version="1.0"?>
401 <transform
402 xmlns="http://www.w3.org/1999/XSL/Transform"
403 xmlns:html="http://www.w3.org/1999/xhtml"
404 xmlns:xslt="http://www.w3.org/1999/XSL/Transform"
405 xmlns:书社="urn:fdc:ladys.computer:20231231:Shu1She4"
406 exclude-result-prefixes="书社"
407 version="1.0"
408 >
409 <书社:id>example:add-stylesheet-links.xslt</书社:id>
410 <template match="xslt:include[@书社:id='example:add-stylesheet-links.xslt']" mode="书社:metadata">
411 <html:link rel="stylesheet" type="text/css" href="/style.css"/>
412 </template>
413 </transform>
414 ```
415
416 Output wrapping can be entirely disabled by adding a
417 `@书社:disable-output-wrapping` attribute to the top‐level element in
418 the result tree.
419
420 ## License
421
422 Source files are licensed under the terms of the <cite>Mozilla Public
423 License, version 2.0</cite>.
424 For more information, see [LICENSE](./LICENSE).
425
426 [draft-phillips-record-jar-01]: <https://datatracker.ietf.org/doc/html/draft-phillips-record-jar-01>
This page took 0.072437 seconds and 5 git commands to generate.