]> Lady’s Gitweb - Shushe/blob - README.markdown
Improve SRCDIR/INCLUDEDIR handling; allow dot
[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
287 - **`EXTRAFINDRULES`:**
288 The value of this variable is appended to `FINDRULES` by default, to
289 enable additional rules without overriding the existing ones.
290
291 - **`FINDINCLUDERULES`:**
292 Rules to use with `find` when searching for includes (default:
293 `$(FINDRULES)`).
294
295 - **`EXTRAFINDINCLUDERULES`:**
296 The value of this variable is appended to `FINDINCLUDERULES` by
297 default, to enable additional rules without overriding the existing
298 ones.
299
300 - **`PARSERS`:**
301 A white·space‐separated list of parsers to use (default:
302 `$(THISDIR)/parsers/*.xslt`).
303
304 - **`EXTRAPARSERS`:**
305 The value of this variable is appended to `PARSERS` by default, to
306 enable additional parsers without overriding the existing ones.
307
308 - **`TRANSFORMS`:**
309 A white·space‐separated list of transforms to use (default:
310 `$(THISDIR)/transforms/*.xslt`).
311
312 - **`EXTRATRANSFORMS`:**
313 The value of this variable is appended to `TRANSFORMS` by default, to
314 enable additional transforms without overriding the existing ones.
315
316 - **`XMLTYPES`:**
317 A white·space‐separated list of media types or media type suffixes to
318 consider X·M·L (default: `application/xml text/xml +xml`).
319
320 - **`THISREV`:**
321 The current version of ⛩️📰 书社 (default: derived from the current
322 git tag/branch/commit).
323
324 - **`SRCREV`:**
325 The current version of the source files (default: derived from the
326 current git tag/branch/commit).
327
328 - **`QUIET`:**
329 If this variable has a value, informative messages will not be
330 printed (default: empty).
331 Informative messages print to stderr, not stdout, so disabling them
332 usually shouldn’t be necessary.
333 This does not (cannot) disable messages from Make itself, for which
334 the `-s`, `--silent` ∕ `--quiet` Make option is more likely to be
335 useful.
336
337 - **`VERBOSE`:**
338 If this variable has a value, every recipe instruction will be
339 printed when it runs (default: empty).
340 This is helpful for debugging, but typically too noisy for general
341 usage.
342
343 ## Source Files
344
345 Source files may be placed in `SRCDIR` in any manner; the file
346 structure used there will match the output.
347 The type of source files is *not* determined by file extension, but
348 rather by magic number; this means that files **must** begin with
349 something recognizable.
350 Supported magic numbers include :⁠—
351
352 - `<?xml` for `application/xml` files
353 - `#!js` for `text/javascript` files
354 - `@charset "` for `text/css` files
355 - `#!tsv` for `text/tab-separated-values` files
356 - `%%` for `text/record-jar` files (unregistered; see
357 [[draft-phillips-record-jar-01][]])
358
359 Text formats with associated X·S·L·T parsers are wrapped in a H·T·M·L
360 `<script>` element whose `@type` gives its media type, and then
361 passed to the parser to process.
362 Source files whose media type does not have an associated X·S·L·T
363 parser are considered “assets” and will not be transformed.
364
365 **☡ For compatibility with this program, source file·names must not
366 contain Ascii white·space, colons (`:`), semis (`;`), pipes (`|`),
367 bucks (`$`), percents (`%`), hashes (`#`), asterisks (`*`), brackets
368 (`[` or `]`), erotemes (`?`), backslashes (`\`), or control
369 characters, must not begin with a hyphen‐minus (`-`), and must not end
370 with a cloparen (`)`).**
371 The former characters have the potential to conflict with make syntax,
372 a leading hyphen‐minus is confusable for a commandline argument, and a
373 trailing cloparen [activates a bug in G·N·U Make
374 3.81](https://stackoverflow.com/questions/17148468/capturing-filenames-including-parentheses-with-gnu-makes-wildcard-function#comment24825307_17148894).
375
376 ## Parsers
377
378 Parsers are used to convert plaintext files into X·M·L trees, as well
379 as convert plaintext formats which are already included inline in
380 existing source X·M·L documents.
381 ⛩️📰 书社 comes with some parsers; namely :⁠—
382
383 - **`parsers/plain.xslt`:**
384 Wraps `text/plain` contents in a `<html:pre>` element.
385
386 - **`parsers/record-jar.xslt`:**
387 Converts `text/record-jar` contents into a `<html:div>` of
388 `<html:dl>` elements (one for each record).
389
390 - **`parsers/tsv.xslt`:**
391 Converts `text/tab-separated-values` contents into an `<html:table>`
392 element.
393
394 New ⛩️📰 书社 parsers which target plaintext formats should have an
395 `<xslt:template>` element with no `@name` or `@mode` and whose
396 `@match` attribute…
397
398 - Starts with an appropriately‐name·spaced qualified name for a
399 `<html:script>` element.
400
401 - Follows this with the string `[@type=`.
402
403 - Follows this with a quoted string giving a media type supported by
404 the parser.
405 Media type parameters are *not* supported.
406
407 - Follows this with the string `]`.
408
409 For example, the trivial `text/plain` parser is defined as follows :⁠—
410
411 ```xml
412 <?xml version="1.0"?>
413 <transform
414 xmlns="http://www.w3.org/1999/XSL/Transform"
415 xmlns:html="http://www.w3.org/1999/xhtml"
416 xmlns:书社="urn:fdc:ladys.computer:20231231:Shu1She4"
417 version="1.0"
418 >
419 <书社:id>example:text/plain</书社:id>
420 <template match="html:script[@type='text/plain']">
421 <html:pre><value-of select="."/></html:pre>
422 </template>
423 </transform>
424 ```
425
426 ⛩️📰 书社 will scan the provided parsers for this pattern to determine
427 the set of allowed plaintext file types.
428 Multiple such `<xslt:template>` elements may be provided in a single
429 parser, for example if the parser supports multiple media types.
430 Alternatively, you can set the `@书社:supported-media-types` attribute
431 on the root element of the parser to override media type support
432 detection.
433
434 Even when `@书社:supported-media-types` is set, it is a requirement
435 that each parser transform any `<html:script>` elements with a
436 `@type` which matches their registered types into something else.
437 Otherwise the parser will be stuck in an endless loop.
438 The result tree of applying the transform to the `<html:script>`
439 element will be reparsed (in case any new `<html:script>` elements
440 were added in its subtree), and a `@书社:parsed-by` attribute will be
441 added to each toplevel element in the result.
442 The value of this attribute will be the value of the `<书社:id>`
443 toplevel element in the parser.
444
445 It is possible for parsers to support zero plaintext types.
446 This is useful when targeting specific dialects of X·M·L; parsers in
447 this sense operate on the same basic principles as transforms
448 (described below).
449 The major distinction between X·M·L parsers and transforms is where in
450 the process the transformation happens:
451 Parsers are applied *prior* to embedding (and can be used to generate
452 embeds); transforms are applied *after*.
453
454 It is **strongly recommended** that auxillary templates in parsers be
455 name·spaced (by `@name` or `@mode`) whenever possible, to avoid
456 conflicts between parsers.
457
458 ### Attributes added during parsing
459
460 ⛩️📰 书社 will add a few attributes to the output of the parsing step,
461 namely :⁠—
462
463 - A `@书社:cksum` attribute on toplevel result elements, giving the
464 `cksum` checksum of the corresponding source file.
465
466 - For the elements which result from parsing plaintext `<html:script>`
467 elements :⁠—
468
469 - A `@书社:parsed-by` attribute, giving a space‐separated list of
470 parsers which parsed the node.
471 (Generally, this will be a list of one, but it is possible for the
472 result of a parse to be another plaintext node, which may be
473 parsed by a different parser.)
474
475 - A `@书社:media-type` attribute, giving the identified media type of
476 the plaintext node.
477
478 ## Embedding
479
480 Documents can be embedded in other documents using a `<书社:link>`
481 element with `@xlink:show="embed"`.
482 The `@xlink:href`s of these elements should have the format
483 `about:shushe?source=<path>`, where `<path>` provides the path to the
484 file within `SRCDIR`.
485 Includes, which do not generate outputs of their own but may still be
486 freely embedded, instead use the format
487 `about:shushe?include=<path>`, where `<path>` provides the path
488 within `INCLUDEDIR`.
489
490 Embeds are replaced with the parsed contents of a file, unless the file
491 is an asset, in which case an `<html:object>` element is produced
492 instead (with the contents of the asset file provided as a base64
493 `data:` u·r·i).
494 Embed replacements will be given a `@书社:identifier` attribute whose
495 value will match the `@xlink:href` of the embed.
496
497 Embedding takes place after parsing but before transformation, so
498 parsers are able to generate their own embeds.
499 ⛩️📰 书社 is able to detect the transitive embed dependencies of files
500 and update them accordingly; it will signal an error if the
501 dependencies are recursive.
502
503 ## Output Redirection
504
505 By default, ⛩️📰 书社 installs files to the same location in `DESTDIR`
506 as they were placed in their `SRCDIR`.
507 This behaviour can be customized by setting the `@书社:destination`
508 attribute on the root element, whose value can give a different path.
509 This attribute is read after parsing, but before transformation (where
510 it is silently dropped).
511
512 ## Transforms
513
514 Transforms are used to convert X·M·L files into their final output,
515 after all necessary parsing and embedding has taken place.
516 ⛩️📰 书社 comes with some transforms; namely :⁠—
517
518 - **`transforms/asset.xslt`:**
519 Converts `<html:object>` elements which correspond to recognized
520 media types into the appropriate H·T·M·L elements, and deletes
521 `<html:style>` elements from the body of the document and moves
522 them to the head.
523
524 - **`transforms/metadata.xslt`:**
525 Provides basic `<html:head>` metadata.
526 This metadata is generated from `<html:meta>` elements with one of
527 the following `@itemprop` attributes :⁠—
528
529 - **`urn:fdc:ladys.computer:20231231:Shu1She4:title`:**
530 Provides the title of the page.
531
532 ⛩️📰 书社 automatically encapsulates H·T·M·L embeds so that their
533 metadata does not propogate up to the embedding document.
534 To undo this behaviour, remove the `@itemscope` and `@itemtype`
535 attributes from the embed during the transformation phase.
536
537 - **`transforms/serialization.xslt`:**
538 Replaces `<书社:serialize-xml>` elements with the (escaped)
539 serialized X·M·L of their contents.
540 This replacement happens during the application phase, after most
541 other transformations have taken place.
542
543 If a `@with-namespaces` attribute is provided, any name·space nodes
544 on the toplevel serialized elements whose U·R·I’s correspond to the
545 definitions of the provided prefixes, as defined for the
546 `<书社:serialize-xml>` element, will be declared using name·space
547 attributes on the serialized elements.
548 Otherwise, only name·space nodes which _differ_ from the definitions
549 on the `<书社:serialize-xml>` element will be declared.
550 The string `#default` may be used to represent the default
551 name·space.
552 Multiple prefixes may be provided, separated by white·space.
553
554 When it comes to name·spaces used internally by ⛩️📰 书社, the
555 prefix used by ⛩️📰 书社 may be declared _in addition to_ the
556 prefix(es) used in the source document(s).
557 It is not possible to selectively only declare one prefix for a
558 name·space to the exclusion of others.
559
560 `<书社:raw-output>` elements may be used inside of
561 `<书社:serialize-xml>` elements to inject raw output into the
562 serialized X·M·L.
563
564 The following are recommendations on effective creation of
565 transforms :⁠—
566
567 - Make template matchers as specific as possible.
568 It is likely an error if two transforms have templates which match
569 the same element (unless the templates have different priority).
570
571 - Name·space templates (with `@name` or `@mode`) whenever possible.
572
573 - Set `@exclude-result-prefixes` on the root `xslt:transform` element
574 to reduce the number of declared name·spaces in the final result.
575
576 ## Global Params
577
578 The following params are made available globally in parsers and
579 transforms :⁠—
580
581 - **`BUILDTIME`:**
582 The current time.
583
584 - **`CKSUM`:**
585 The checksum of the source file (⅌ `cksum`).
586
587 - **`IDENTIFIER`:**
588 The ⛩️📰 书社 identifier of the source file (a u·r·i beginning with
589 `about:shushe`).
590
591 - **`SRCREV`:**
592 The value of the `SRCREV` variable (if present).
593
594 - **`SRCTIME`:**
595 The time at which the source file was last modified.
596
597 - **`THISREV`:**
598 The value of the `THISREV` variable (if present).
599
600 The following params are only available in transforms :⁠—
601
602 - **`CATALOG`:**
603 The path of the catalog file (within `BUILDDIR`).
604
605 - **`PATH`:**
606 The path of the output file (within `DESTDIR`).
607
608 ## Output Wrapping
609
610 ⛩️📰 书社 will wrap the final output of the transforms in appropriate
611 `<html:html>` and `<html:body>` elements, so it is not necessary for
612 transforms to do this explicitly.
613 After performing the initial transform, ⛩️📰 书社 will match the root
614 node of the result in the following modes to fill in areas of the
615 wrapper :⁠—
616
617 - **`书社:header`:**
618 The result of matching in this mode is prepended into the
619 `<html:body>` of the output (before the transformation result).
620
621 - **`书社:footer`:**
622 The result of matching in this mode is appended into the
623 `<html:body>` of the output (after the transformation result).
624
625 - **`书社:metadata`:**
626 The result of matching in this mode is inserted into the
627 `<html:head>` of the output.
628
629 In addition to being called with the transform result, each of these
630 modes will additionally be called with a `<xslt:include>` element
631 corresponding to each transform.
632 If a transform has a `<书社:id>` top‐level element whose value is an
633 i·r·i, its `<xslt:include>` element will have a corresponding
634 `@书社:id` attribute.
635 This mechanism can be used to allow transforms to insert content
636 without matching any elements in the result; for example, the
637 following transform adds a link to a stylesheet to the `<html:head>`
638 of every page :⁠—
639
640 ```xml
641 <?xml version="1.0"?>
642 <transform
643 xmlns="http://www.w3.org/1999/XSL/Transform"
644 xmlns:html="http://www.w3.org/1999/xhtml"
645 xmlns:xslt="http://www.w3.org/1999/XSL/Transform"
646 xmlns:书社="urn:fdc:ladys.computer:20231231:Shu1She4"
647 exclude-result-prefixes="书社"
648 version="1.0"
649 >
650 <书社:id>example:add-stylesheet-links.xslt</书社:id>
651 <template match="xslt:include[@书社:id='example:add-stylesheet-links.xslt']" mode="书社:metadata">
652 <html:link rel="stylesheet" type="text/css" href="/style.css"/>
653 </template>
654 </transform>
655 ```
656
657 Output wrapping can be entirely disabled by adding a
658 `@书社:disable-output-wrapping` attribute to the top‐level element in
659 the result tree.
660 It will not be performed on outputs whose root elements are
661 `<书社:archive>`, `<书社:base64-binary>`, or `<书社:raw-text>`
662 (described below).
663
664 ## Applying Attributes
665
666 The `<书社:apply-attributes>` element will apply any attributes on the
667 element to the element(s) it wraps.
668 It is especially useful in combination with embeds.
669
670 The `<书社:apply-attributes-to-root>` element will apply any attributes
671 on the element to the root node of the final transformation result.
672 It is especially useful in combination with output wrapping.
673
674 In both cases, attributes from various sources are combined with
675 white·space between them.
676 Attribute application takes place after all ordinary transforms have
677 completed.
678
679 Both elements ignore attributes in the `xml:` name·space, except for
680 `@xml:lang`, which ignores all but the first definition (including
681 any already present on the root element).
682 On H·T·M·L and S·V·G elements, `@lang` has the same behaviour as
683 `@xml:lang`.
684
685 ## Other Kinds of Output
686
687 There are a few special elements in the `书社:` name·space which, if
688 they appear as the toplevel element in a transformation result, cause
689 ⛩️📰 书社 to produce something other than an X·M·L file.
690 They are :⁠—
691
692 - **`<书社:archive>`:**
693 Each child element with a `@书社:archived-as` attribute will be
694 archived as a separate file in a resulting tarball (this attribute
695 gives the file name).
696 These elements will be processed the same as the root elements of any
697 other file (e·g, they will be wrapped; they can themselves specify
698 non X·M·L output types, ⁊·c).
699 Other child elements will be ignored.
700
701 If the `<书社:archive>` element is given an `@书社:expanded`
702 attribute, rather than producing a tarball ⛩️📰 书社 will output
703 the directory which expanding the tarball would produce.
704 This mechanism can be used to generate multiple files from a single
705 source, provided all of the files are contained with·in the same
706 directory.
707
708 - **`<书社:base64-binary>`:**
709 The text nodes in the transformation result will, after removing all
710 Ascii whitespace, be treated as a Base·64 string, which is then
711 decoded.
712
713 - **`<书社:raw-text>`:**
714 A plaintext (U·T·F‐8) file will be produced from the text nodes in
715 the transformation result.
716
717 ## License
718
719 This repository conforms to [REUSE][].
720
721 Most source files are licensed under the terms of the <cite>Mozilla
722 Public License, version 2.0</cite>.
723
724 [REUSE]: <https://reuse.software/spec/>
725 [draft-phillips-record-jar-01]: <https://datatracker.ietf.org/doc/html/draft-phillips-record-jar-01>
726 [rdar-92753335]: <https://github.com/apple-oss-distributions/patch_cmds/blob/5084833f90df1b0e0924ea56f94c0199b3b8bbc6/diff/diffreg.c#L1800-L1808>
This page took 0.137777 seconds and 5 git commands to generate.