X-Git-Url: https://git.ladys.computer/Shushe/blobdiff_plain/e7c797ffb120c0dac9be13b28d533d49d164b6d0..0dbf03dfcc1a94ba1a07a0b1d7dd8c0f53824db3:/README.markdown
diff --git a/README.markdown b/README.markdown
index 2dd0eff..2bb1bce 100644
--- a/README.markdown
+++ b/README.markdown
@@ -228,13 +228,13 @@ For example, the trivial `text/plain` parser is defined as follows :—
```xml
-
-
-
+
+
+
```
@@ -287,15 +287,17 @@ Transforms are used to convert X·M·L files into their final output,
- **`transforms/metadata.xslt`:**
Provides basic `` metadata.
- This metadata is generated from `` descendants of the
- first element with an `@itemscope` attribute (recommended to just
- be the root element).
- Such elements can provide metadata using the following `@itemprop`
- attributes :—
+ This metadata is generated from `` elements with one o.
+ the following `@itemprop` attributes :—
- **`urn:fdc:ladys.computer:20231231:Shu1She4:title`:**
Provides the title of the page.
+ ⛩️📰 书社 automatically encapsulates embeds so that their metadata
+ does not propogate up to the embedding document.
+ To undo this behaviour, remove the `@itemscope` and `@itemtype`
+ attributes from the embed during the transformation phase.
+
The following are recommendations on effective creation of
transforms :—
@@ -313,10 +315,41 @@ The following are recommendations on effective creation of
⛩️📰 书社 will wrap the final output of the transforms in appropriate
`` and `` elements, so it is not necessary for
transforms to do this explicitly.
-The `` of the output will contain the result tree generated
- by matching the root node in the `书社:metadata` mode; the provided
- `transforms/metadata.xslt` transform uses this mode to generate basic
- metadata, but it is possible for other transforms to add their own.
+After performing the initial transform, ⛩️📰 书社 will match the root
+ node of the result in the following modes to fill in areas of the
+ wrapper :—
+
+- **`书社:metadata`:**
+ The result of matching in this mode is inserted into the
+ `` of the output.
+
+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
+ `@书社:id` attribute.
+This mechanism can be used to allow transforms to insert content
+ without matching any elements in the result; for example, the
+ following transform adds a link to a stylesheet to the ``
+ of every page :—
+
+```xml
+
+
+ <书社:id>example:add-stylesheet-links.xslt书社:id>
+
+
+
+
+```
## License