]> Lady’s Gitweb - Shushe/blob - README.markdown
Drop CKSUM and SRCTIME params; add as attributes
[Shushe] / README.markdown
1 <!--
2 SPDX-FileCopyrightText: 2024 Lady <https://www.ladys.computer/about/#lady>
3 SPDX-License-Identifier: CC0-1.0
4 -->
5 # ⛩️📰 书社
6
7 <b>A make·file for X·M·L.</b>
8
9 <dfn>⛩️📰 书社</dfn> aims to make it easy to generate websites with
10 X·S·L·T and G·N·U Make.
11 It is consequently only a good choice for people who like X·S·L·T and
12 G·N·U Make and wish it were easier to make websites with them.
13
14 It makes things easier by :⁠—
15
16 - Automatically identifying source files and characterizing them by
17 type (X·M·L, text, or asset).
18
19 - Parsing supported text types into X·M·L trees.
20
21 - Enabling easy inclusion of source files within each other.
22
23 It aims to do this with zero dependencies beyond the programs already
24 installed on your computer†.
25
26 † Assuming an operating system with a fairly featureful, and
27 Posix‐compliant, development setup (e·g, Macintosh ≥ version 10.8).
28 In fact, on Linux you will probably need to install a few programs:
29 `libxml2-utils`, `xsltproc`, `sharutils`, and `pax`.
30
31 ## Nomenclature
32
33 <i lang="cmn-Hans">书社</i> is a Chinese word meaning “publishing
34 house”.
35
36 The first character, <i lang="cmn-Hans">书</i>, is the simplified form
37 of “document”.
38
39 The second character, <i lang="cmn-Hans">社</i>, contemporarily means
40 “association”, but historically referred to the god of the soil and
41 related altars or festivities.
42 In Japanese, it is an alternate spelling for <i lang="ja">やしろ</i>,
43 the word for “Shinto shrine”.
44
45 The name <i lang="cmn-Hans">书社</i> was chosen to play on this pun, as
46 it is intended as a publishing program for webshrines.
47
48 In Ascii environments, ⛩️📰 书社 should be written `Shushe`, following
49 the pinyin transliteration.
50
51 ## Prerequisites
52
53 In most cases, ⛩️📰 书社 aims to require only functionality which is
54 present in all Posix‐compliant (`POSIX.1-2001`) operating systems.
55 There are a few exceptions.
56 Details on particular programs are given below; if a program is not
57 listed, it is assumed that any Posix‐compliant implementation will
58 work.
59
60 ### `diff`
61
62 This is a Posix utility, but ⛩️📰 书社 depends on functionality
63 introduced after `POSIX.1-2001` (the `-u` option, introduced in
64 `POSIX.1-2008`).
65 Macintosh systems somewhat interestingly implement this option
66 correctly in legacy mode (`COMMAND_MODE=legacy`) but incorrectly by
67 default (despite claiming `POSIX.1-2008` conformance for this
68 utility).
69 [Note this erroneous comment claiming nanosecond & timezone are
70 extensions rather than standardized.][rdar-92753335]
71 Despite this, the default Macintosh implementation will still work with
72 ⛩️📰 书社, with the caveat that the timestamp will only include a
73 fractional component when a Posix⹀compliant (e·g, Macintosh legacy or
74 G·N·U) implementation is used.
75
76 ### `file`
77
78 This is a Posix utility, but it was considered optional in
79 `POSIX.1-2001` (altho it was made mandatory in `POSIX.1-2008`) and
80 ⛩️📰 书社 currently depends on unspecified behaviour.
81 It requires support for the following additional options :⁠—
82
83 - **`-C`**, when supplied with `-m`, must be useable to compile a
84 `.mgc` magicfile for use with future invocations of `file`.
85
86 - **`--files-from`** must be useable to provide a file that `file`
87 should read file·names from, and `-` must be useable in this
88 context to specify the standard input.
89
90 - **`--mime-type`** must cause `file` to print the internet media type
91 of the file with no charset parameter.
92
93 - **`--separator`** must be useable to set the separator that `file`
94 uses to separate file names from types.
95
96 These options are implemented by the
97 [Fine Free File Command](https://darwinsys.com/file/), which is used
98 by most operating systems.
99
100 ### `git`
101
102 This is not a Posix utility.
103 Usage of `git` is optional, but recommended (and activated by default).
104 To disable it, set `GIT=`.
105
106 ### `make`
107
108 This is a Posix utility, but it is considered an optional Software
109 Development utility and ⛩️📰 书社 currently depends on unspecified
110 behaviour.
111 ⛩️📰 书社 requires specifically the G·N·U version of `make`, and
112 depends on functionality present in version 3.81 or later.
113 It is not expected to work in previous versions, or with other
114 implementations of Make.
115
116 ### `pax`
117
118 This is a Posix utility, but it is not included in the Linux Standard
119 Base or installed by default in many distributions.
120 ⛩️📰 书社 only requires support for the `ustar` format.
121
122 ### `uudecode` and `uuencode`
123
124 These are Posix utilities, but they were considered optional in
125 `POSIX.1-2001` (altho they are made mandatory in `POSIX.1-2008`) and
126 they are not included in the Linux Standard Base or installed by
127 default in many distributions.
128 The G·N·U [Sharutils](https://www.gnu.org/software/sharutils/) package
129 provides one implementation.
130
131 ### `xmlcatalog` and `xmllint`
132
133 These are not a Posix utilities.
134 They are a part of `libxml2`, but may need to be installed separately
135 on some platforms (e·g by the name `libxml2-utils`).
136
137 ### `xsltproc`
138
139 This is not a Posix utility.
140 It is a part of `libxslt`, but may need to be installed separately on
141 some platforms.
142
143 ## Basic Usage
144
145 Place source files in `sources/` and run `make install` to compile
146 the result to `public/`.
147 Compilation involves the following steps :⁠—
148
149 1. ⛩️📰 书社 compiles all of the magic files in `magic/` into a single
150 file, `build/magic.mgc`.
151
152 2. ⛩️📰 书社 processes all of the parsers in `parsers/` and determines
153 the list of supported plaintext types.
154
155 3. ⛩️📰 书社 identifies all of the source files and includes and uses
156 `build/magic.mgc` to classify them by media type.
157
158 4. ⛩️📰 书社 parses all plaintext and X·M·L source files and includes
159 and then builds a dependency tree between them.
160
161 5. ⛩️📰 书社 uses the dependency tree to establish prerequisites for
162 each output file.
163
164 6. ⛩️📰 书社 compiles each output file to `build/result`.
165
166 7. ⛩️📰 书社 copies most output files from `build/result` to
167 `build/public`, but it does some additional processing instead on
168 those which indicate a non‐X·M·L desired final output form.
169
170 8. ⛩️📰 书社 copies the final resulting files to `public`.
171
172 You can use `make list` to list each identified source file or include
173 alongside its computed type and dependencies.
174 As this is a Make‐based program, steps will only be run if the
175 corresponding buildfile or output file is older than its
176 prerequisites.
177
178 ## Name·spaces
179
180 The ⛩️📰 书社 name·space is `urn:fdc:ladys.computer:20231231:Shu1She4`.
181
182 This document uses a few name·space prefixes, with the following
183 meanings :⁠—
184
185 | Prefix | Expansion |
186 | ---------: | :-------------------------------------------- |
187 | `catalog:` | `urn:oasis:names:tc:entity:xmlns:xml:catalog` |
188 | `exsl:` | `http://exslt.org/common` |
189 | `exslstr:` | `http://exslt.org/strings` |
190 | `html:` | `http://www.w3.org/1999/xhtml` |
191 | `svg:` | `http://www.w3.org/2000/svg` |
192 | `xlink:` | `http://www.w3.org/1999/xlink` |
193 | `xslt:` | `http://www.w3.org/1999/XSL/Transform` |
194 | `书社:` | `urn:fdc:ladys.computer:20231231:Shu1She4` |
195
196 ## Setup and Configuration
197
198 ⛩️📰 书社 depends on the following programs to run.
199 In every case, you may supply your own implementation by overriding the
200 corresponding (allcaps) variable (e·g, set `MKDIR` to supply your own
201 `mkdir` implementation).
202
203 - `awk`
204 - `cat`
205 - `cd`
206 - `cksum`
207 - `cp`
208 - `date`
209 - `diff`
210 - `file`
211 - `find`
212 - `git` (optional; set `GIT=` to disable)
213 - `grep`
214 - `ln`
215 - `mkdir`
216 - `mv`
217 - `od`
218 - `pax` (only when generating archives)
219 - `printf`
220 - `rm`
221 - `sed`
222 - `sleep`
223 - `test`
224 - `touch`
225 - `tr`
226 - `uuencode`
227 - `uudecode`
228 - `xargs`
229 - `xmlcatalog` (provided by `libxml2`)
230 - `xmllint` (provided by `libxml2`)
231 - `xsltproc` (provided by `libxslt`)
232
233 The following additional variables can be used to control the behaviour
234 of ⛩️📰 书社 :⁠—
235
236 - **`SRCDIR`:**
237 The location of the source files (default: `sources`).
238 Multiple source directories can be provided, so long as the same
239 file subpath doesn’t exist in more than one of them.
240
241 - **`INCLUDEDIR`:**
242 The location of source includes (default: `sources/includes`).
243 This can be inside of `SRCDIR`, but needn’t be.
244 Multiple include directories can be provided, so long as the same
245 file subpath doesn’t exist in more than one of them.
246
247 - **`BUILDDIR`:**
248 The location of the (temporary) build directory (default: `build`).
249 `make clean` will delete this, and it is recommended that it not be
250 used for programs aside from ⛩️📰 书社.
251
252 - **`DESTDIR`:**
253 The location of directory to output files to (default: `public`).
254 `make install` will overwrite files in this directory which
255 correspond to those in `SRCDIR`.
256 It *will not* touch other files, including those generated from files
257 in `SRCDIR` which have since been deleted.
258
259 Files are first compiled to `$(BUILDDIR)/public` before they are
260 copied to `DESTDIR`, so this folder is relatively quick and
261 inexpensive to re·create.
262 It’s reasonable to simply delete it before every `make install` to
263 ensure stale content is removed.
264
265 - **`THISDIR`:**
266 The location of the ⛩️📰 书社 `GNUmakefile`.
267 This should be set automatically when calling Make and shouldn’t ever
268 need to be set manually.
269 This variable is used to find the ⛩️📰 书社 `lib/` folder, which is
270 expected to be in the same location.
271
272 - **`MAGIC`:**
273 A white·space‐separated list of magic files to use (default:
274 `$(THISDIR)/magic/*`).
275
276 - **`EXTRAMAGIC`:**
277 The value of this variable is appended to `MAGIC` by default, to
278 enable additional magic files without overriding the existing ones.
279
280 - **`FINDRULES`:**
281 Rules to use with `find` when searching for source files.
282 The default ignores files that start with a period or hyphen‐minus,
283 those which end with a cloparen, and those which contain a hash,
284 buck, percent, asterisk, colon, semi, eroteme, bracket, backslash,
285 or pipe.
286 It is important that these rules not produce any output, as anything
287 printed to `stdout` will be considered a result of the find.
288
289 - **`EXTRAFINDRULES`:**
290 The value of this variable is appended to `FINDRULES` by default, to
291 enable additional rules without overriding the existing ones.
292
293 - **`FINDINCLUDERULES`:**
294 Rules to use with `find` when searching for includes (default:
295 `$(FINDRULES)`).
296
297 - **`EXTRAFINDINCLUDERULES`:**
298 The value of this variable is appended to `FINDINCLUDERULES` by
299 default, to enable additional rules without overriding the existing
300 ones.
301
302 - **`PARSERS`:**
303 A white·space‐separated list of parsers to use (default:
304 `$(THISDIR)/parsers/*.xslt`).
305
306 - **`EXTRAPARSERS`:**
307 The value of this variable is appended to `PARSERS` by default, to
308 enable additional parsers without overriding the existing ones.
309
310 - **`TRANSFORMS`:**
311 A white·space‐separated list of transforms to use (default:
312 `$(THISDIR)/transforms/*.xslt`).
313
314 - **`EXTRATRANSFORMS`:**
315 The value of this variable is appended to `TRANSFORMS` by default, to
316 enable additional transforms without overriding the existing ones.
317
318 - **`XMLTYPES`:**
319 A white·space‐separated list of media types or media type suffixes to
320 consider X·M·L (default: `application/xml text/xml +xml`).
321
322 - **`FINALIZE`:**
323 A program to run on (unspecial) X·M·L files after they are
324 transformed (default: `xmllint --nonet --nsclean`).
325 This variable can be used for postprocessing.
326
327 - **`THISREV`:**
328 The current version of ⛩️📰 书社 (default: derived from the current
329 git tag/branch/commit).
330
331 - **`SRCREV`:**
332 The current version of the source files (default: derived from the
333 current git tag/branch/commit).
334
335 - **`QUIET`:**
336 If this variable has a value, informative messages will not be
337 printed (default: empty).
338 Informative messages print to stderr, not stdout, so disabling them
339 usually shouldn’t be necessary.
340 This does not (cannot) disable messages from Make itself, for which
341 the `-s`, `--silent` ∕ `--quiet` Make option is more likely to be
342 useful.
343
344 - **`VERBOSE`:**
345 If this variable has a value, every recipe instruction will be
346 printed when it runs (default: empty).
347 This is helpful for debugging, but typically too noisy for general
348 usage.
349
350 ## Source Files
351
352 Source files may be placed in `SRCDIR` in any manner; the file
353 structure used there will match the output.
354 The type of source files is *not* determined by file extension, but
355 rather by magic number; this means that files **must** begin with
356 something recognizable.
357 Supported magic numbers include :⁠—
358
359 - `<?xml` for `application/xml` files
360 - `#!js` for `text/javascript` files
361 - `@charset "` for `text/css` files
362 - `#!tsv` for `text/tab-separated-values` files
363 - `%%` for `text/record-jar` files (unregistered; see
364 [[draft-phillips-record-jar-01][]])
365
366 Text formats with associated X·S·L·T parsers are wrapped in a H·T·M·L
367 `<script>` element whose `@type` gives its media type, and then
368 passed to the parser to process.
369 Source files whose media type does not have an associated X·S·L·T
370 parser are considered “assets” and will not be transformed.
371
372 **☡ For compatibility with this program, source file·names must not
373 contain Ascii white·space, colons (`:`), semis (`;`), pipes (`|`),
374 bucks (`$`), percents (`%`), hashes (`#`), asterisks (`*`), brackets
375 (`[` or `]`), erotemes (`?`), backslashes (`\`), or control
376 characters, must not begin with a hyphen‐minus (`-`), and must not end
377 with a cloparen (`)`).**
378 The former characters have the potential to conflict with make syntax,
379 a leading hyphen‐minus is confusable for a commandline argument, and a
380 trailing cloparen [activates a bug in G·N·U Make
381 3.81](https://stackoverflow.com/questions/17148468/capturing-filenames-including-parentheses-with-gnu-makes-wildcard-function#comment24825307_17148894).
382
383 ## Parsers
384
385 Parsers are used to convert plaintext files into X·M·L trees, as well
386 as convert plaintext formats which are already included inline in
387 existing source X·M·L documents.
388 ⛩️📰 书社 comes with some parsers; namely :⁠—
389
390 - **`parsers/plain.xslt`:**
391 Wraps `text/plain` contents in a `<html:pre>` element.
392
393 - **`parsers/record-jar.xslt`:**
394 Converts `text/record-jar` contents into a `<html:div>` of
395 `<html:dl>` elements (one for each record).
396
397 - **`parsers/tsv.xslt`:**
398 Converts `text/tab-separated-values` contents into an `<html:table>`
399 element.
400
401 New ⛩️📰 书社 parsers which target plaintext formats should have an
402 `<xslt:template>` element with no `@name` or `@mode` and whose
403 `@match` attribute…
404
405 - Starts with an appropriately‐name·spaced qualified name for a
406 `<html:script>` element.
407
408 - Follows this with the string `[@type=`.
409
410 - Follows this with a quoted string giving a media type supported by
411 the parser.
412 Media type parameters are *not* supported.
413
414 - Follows this with the string `]`.
415
416 For example, the trivial `text/plain` parser is defined as follows :⁠—
417
418 ```xml
419 <?xml version="1.0"?>
420 <transform
421 xmlns="http://www.w3.org/1999/XSL/Transform"
422 xmlns:html="http://www.w3.org/1999/xhtml"
423 xmlns:书社="urn:fdc:ladys.computer:20231231:Shu1She4"
424 version="1.0"
425 >
426 <书社:id>example:text/plain</书社:id>
427 <template match="html:script[@type='text/plain']">
428 <html:pre><value-of select="."/></html:pre>
429 </template>
430 </transform>
431 ```
432
433 ⛩️📰 书社 will scan the provided parsers for this pattern to determine
434 the set of allowed plaintext file types.
435 Multiple such `<xslt:template>` elements may be provided in a single
436 parser, for example if the parser supports multiple media types.
437 Alternatively, you can set the `@书社:supported-media-types` attribute
438 on the root element of the parser to override media type support
439 detection.
440
441 Even when `@书社:supported-media-types` is set, it is a requirement
442 that each parser transform any `<html:script>` elements with a
443 `@type` which matches their registered types into something else.
444 Otherwise the parser will be stuck in an endless loop.
445 The result tree of applying the transform to the `<html:script>`
446 element will be reparsed (in case any new `<html:script>` elements
447 were added in its subtree), and a `@书社:parsed-by` attribute will be
448 added to each toplevel element in the result.
449 The value of this attribute will be the value of the `<书社:id>`
450 toplevel element in the parser.
451
452 It is possible for parsers to support zero plaintext types.
453 This is useful when targeting specific dialects of X·M·L; parsers in
454 this sense operate on the same basic principles as transforms
455 (described below).
456 The major distinction between X·M·L parsers and transforms is where in
457 the process the transformation happens:
458 Parsers are applied *prior* to embedding (and can be used to generate
459 embeds); transforms are applied *after*.
460
461 It is **strongly recommended** that auxillary templates in parsers be
462 name·spaced (by `@name` or `@mode`) whenever possible, to avoid
463 conflicts between parsers.
464
465 ### Attributes added during parsing
466
467 ⛩️📰 书社 will add a few attributes to the output of the parsing step,
468 namely :⁠—
469
470 - For toplevel result elements :⁠—
471
472 - A `@书社:cksum` attribute giving the `cksum` checksum of the
473 corresponding source file.
474
475 - A `@书社:mtime` attribute giving the last modified time of the
476 corresponding source file.
477
478 - A `@书社:identifier` attribute giving the ⛩️📰 书社 identifier
479 (i·e, starting with `about:shushe?`) of the corresponding source
480 file.
481
482 - For the elements which result from parsing plaintext `<html:script>`
483 elements :⁠—
484
485 - A `@书社:parsed-by` attribute, giving a space‐separated list of
486 parsers which parsed the node.
487 (Generally, this will be a list of one, but it is possible for the
488 result of a parse to be another plaintext node, which may be
489 parsed by a different parser.)
490
491 - A `@书社:media-type` attribute, giving the identified media type of
492 the plaintext node.
493
494 ## Embedding
495
496 Documents can be embedded in other documents using a `<书社:link>`
497 element with `@xlink:show="embed"`.
498 The `@xlink:href`s of these elements should have the format
499 `about:shushe?source=<path>`, where `<path>` provides the path to the
500 file within `SRCDIR`.
501 Includes, which do not generate outputs of their own but may still be
502 freely embedded, instead use the format
503 `about:shushe?include=<path>`, where `<path>` provides the path
504 within `INCLUDEDIR`.
505
506 Embeds are replaced with the parsed contents of a file, unless the file
507 is an asset, in which case an `<html:object>` element is produced
508 instead (with the contents of the asset file provided as a base64
509 `data:` u·r·i).
510 Embed replacements will be given a `@书社:identifier` attribute whose
511 value will match the `@xlink:href` of the embed.
512
513 Embedding takes place after parsing but before transformation, so
514 parsers are able to generate their own embeds.
515 ⛩️📰 书社 is able to detect the transitive embed dependencies of files
516 and update them accordingly; it will signal an error if the
517 dependencies are recursive.
518
519 ## Output Redirection
520
521 By default, ⛩️📰 书社 installs files to the same location in `DESTDIR`
522 as they were placed in their `SRCDIR`.
523 This behaviour can be customized by setting the `@书社:destination`
524 attribute on the root element, whose value can give a different path.
525 This attribute is read after parsing, but before transformation (where
526 it is silently dropped).
527
528 ## Transforms
529
530 Transforms are used to convert X·M·L files into their final output,
531 after all necessary parsing and embedding has taken place.
532 ⛩️📰 书社 comes with some transforms; namely :⁠—
533
534 - **`transforms/asset.xslt`:**
535 Converts `<html:object>` elements which correspond to recognized
536 media types into the appropriate H·T·M·L elements, and deletes
537 `<html:style>` elements from the body of the document and moves
538 them to the head.
539
540 - **`transforms/metadata.xslt`:**
541 Provides basic `<html:head>` metadata.
542 This metadata is generated from `<html:meta>` elements with one of
543 the following `@itemprop` attributes :⁠—
544
545 - **`urn:fdc:ladys.computer:20231231:Shu1She4:title`:**
546 Provides the title of the page.
547
548 ⛩️📰 书社 automatically encapsulates H·T·M·L embeds so that their
549 metadata does not propogate up to the embedding document.
550 To undo this behaviour, remove the `@itemscope` and `@itemtype`
551 attributes from the embed during the transformation phase.
552
553 - **`transforms/serialization.xslt`:**
554 Replaces `<书社:serialize-xml>` elements with the (escaped)
555 serialized X·M·L of their contents.
556 This replacement happens during the application phase, after most
557 other transformations have taken place.
558
559 If a `@with-namespaces` attribute is provided, any name·space nodes
560 on the toplevel serialized elements whose U·R·I’s correspond to the
561 definitions of the provided prefixes, as defined for the
562 `<书社:serialize-xml>` element, will be declared using name·space
563 attributes on the serialized elements.
564 Otherwise, only name·space nodes which _differ_ from the definitions
565 on the `<书社:serialize-xml>` element will be declared.
566 The string `#default` may be used to represent the default
567 name·space.
568 Multiple prefixes may be provided, separated by white·space.
569
570 When it comes to name·spaces used internally by ⛩️📰 书社, the
571 prefix used by ⛩️📰 书社 may be declared _in addition to_ the
572 prefix(es) used in the source document(s).
573 It is not possible to selectively only declare one prefix for a
574 name·space to the exclusion of others.
575
576 `<书社:raw-output>` elements may be used inside of
577 `<书社:serialize-xml>` elements to inject raw output into the
578 serialized X·M·L.
579
580 The following are recommendations on effective creation of
581 transforms :⁠—
582
583 - Make template matchers as specific as possible.
584 It is likely an error if two transforms have templates which match
585 the same element (unless the templates have different priority).
586
587 - Name·space templates (with `@name` or `@mode`) whenever possible.
588
589 - Set `@exclude-result-prefixes` on the root `xslt:transform` element
590 to reduce the number of declared name·spaces in the final result.
591
592 ## Global Params
593
594 The following params are made available globally in parsers and
595 transforms :⁠—
596
597 - **`BUILDTIME`:**
598 The current time.
599
600 - **`IDENTIFIER`:**
601 The ⛩️📰 书社 identifier of the source file (a u·r·i beginning with
602 `about:shushe`).
603
604 - **`SRCREV`:**
605 The value of the `SRCREV` variable (if present).
606
607 - **`THISREV`:**
608 The value of the `THISREV` variable (if present).
609
610 The following params are only available in transforms :⁠—
611
612 - **`METADATA`:**
613 The path of the metadata file (within `BUILDDIR`).
614
615 - **`PATH`:**
616 The path of the output file (within `DESTDIR`).
617
618 ## Output Wrapping
619
620 ⛩️📰 书社 will wrap the final output of the transforms in appropriate
621 `<html:html>` and `<html:body>` elements, so it is not necessary for
622 transforms to do this explicitly.
623 After performing the initial transform, ⛩️📰 书社 will match the root
624 node of the result in the following modes to fill in areas of the
625 wrapper :⁠—
626
627 - **`书社:header`:**
628 The result of matching in this mode is prepended into the
629 `<html:body>` of the output (before the transformation result).
630
631 - **`书社:footer`:**
632 The result of matching in this mode is appended into the
633 `<html:body>` of the output (after the transformation result).
634
635 - **`书社:metadata`:**
636 The result of matching in this mode is inserted into the
637 `<html:head>` of the output.
638
639 In addition to being called with the transform result, each of these
640 modes will additionally be called with a `<xslt:include>` element
641 corresponding to each transform.
642 If a transform has a `<书社:id>` top‐level element whose value is an
643 i·r·i, its `<xslt:include>` element will have a corresponding
644 `@书社:id` attribute.
645 This mechanism can be used to allow transforms to insert content
646 without matching any elements in the result; for example, the
647 following transform adds a link to a stylesheet to the `<html:head>`
648 of every page :⁠—
649
650 ```xml
651 <?xml version="1.0"?>
652 <transform
653 xmlns="http://www.w3.org/1999/XSL/Transform"
654 xmlns:html="http://www.w3.org/1999/xhtml"
655 xmlns:xslt="http://www.w3.org/1999/XSL/Transform"
656 xmlns:书社="urn:fdc:ladys.computer:20231231:Shu1She4"
657 exclude-result-prefixes="书社"
658 version="1.0"
659 >
660 <书社:id>example:add-stylesheet-links.xslt</书社:id>
661 <template match="xslt:include[@书社:id='example:add-stylesheet-links.xslt']" mode="书社:metadata">
662 <html:link rel="stylesheet" type="text/css" href="/style.css"/>
663 </template>
664 </transform>
665 ```
666
667 Output wrapping can be entirely disabled by adding a
668 `@书社:disable-output-wrapping` attribute to the top‐level element in
669 the result tree.
670 It will not be performed on outputs whose root elements are
671 `<书社:archive>`, `<书社:base64-binary>`, or `<书社:raw-text>`
672 (described below).
673
674 ## Applying Attributes
675
676 The `<书社:apply-attributes>` element will apply any attributes on the
677 element to the element(s) it wraps.
678 It is especially useful in combination with embeds.
679
680 The `<书社:apply-attributes-to-root>` element will apply any attributes
681 on the element to the root node of the final transformation result.
682 It is especially useful in combination with output wrapping.
683
684 In both cases, attributes from various sources are combined with
685 white·space between them.
686 Attribute application takes place after all ordinary transforms have
687 completed.
688
689 Both elements ignore attributes in the `xml:` name·space, except for
690 `@xml:lang`, which ignores all but the first definition (including
691 any already present on the root element).
692 On H·T·M·L and S·V·G elements, `@lang` has the same behaviour as
693 `@xml:lang`.
694
695 ## Other Kinds of Output
696
697 There are a few special elements in the `书社:` name·space which, if
698 they appear as the toplevel element in a transformation result, cause
699 ⛩️📰 书社 to produce something other than an X·M·L file.
700 They are :⁠—
701
702 - **`<书社:archive>`:**
703 Each child element with a `@书社:archived-as` attribute will be
704 archived as a separate file in a resulting tarball (this attribute
705 gives the file name).
706 These elements will be processed the same as the root elements of any
707 other file (e·g, they will be wrapped; they can themselves specify
708 non X·M·L output types, ⁊·c).
709 Other child elements will be ignored.
710
711 If the `<书社:archive>` element is given an `@书社:expanded`
712 attribute, rather than producing a tarball ⛩️📰 书社 will output
713 the directory which expanding the tarball would produce.
714 This mechanism can be used to generate multiple files from a single
715 source, provided all of the files are contained with·in the same
716 directory.
717
718 - **`<书社:base64-binary>`:**
719 The text nodes in the transformation result will, after removing all
720 Ascii whitespace, be treated as a Base·64 string, which is then
721 decoded.
722
723 - **`<书社:raw-text>`:**
724 A plaintext (U·T·F‐8) file will be produced from the text nodes in
725 the transformation result.
726
727 ## License
728
729 This repository conforms to [REUSE][].
730
731 Most source files are licensed under the terms of the <cite>Mozilla
732 Public License, version 2.0</cite>.
733
734 [REUSE]: <https://reuse.software/spec/>
735 [draft-phillips-record-jar-01]: <https://datatracker.ietf.org/doc/html/draft-phillips-record-jar-01>
736 [rdar-92753335]: <https://github.com/apple-oss-distributions/patch_cmds/blob/5084833f90df1b0e0924ea56f94c0199b3b8bbc6/diff/diffreg.c#L1800-L1808>
This page took 0.148082 seconds and 5 git commands to generate.