X-Git-Url: https://git.ladys.computer/Shushe/blobdiff_plain/af8b42c720c6aaa54199b556a656d40e8b8951a6..55fc968f72857e25fcafe6088c873f5032555c79:/README.markdown diff --git a/README.markdown b/README.markdown index 84c3206..5b5b84c 100644 --- a/README.markdown +++ b/README.markdown @@ -228,13 +228,13 @@ For example, the trivial `text/plain` parser is defined as follows :⁠— ```xml - + ``` @@ -277,25 +277,24 @@ Transforms are used to convert X·M·L files into their final output, ⛩️📰 书社 comes with some transforms; namely :⁠— - **`transforms/asset.xslt`:** - Converts `` elements into corresponding - `` elements and - `` elements into corresponding - `` elements. - This transform enables embedding of `text/css` and `text/javascript` - files, which ordinarily are considered assets (as they lack - associated parsers). + Converts `` elements which correspond to recognized + media types into the appropriate H·T·M·L elements, and deletes + `` elements from the body of the document and moves + them to the head. - **`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 :⁠— @@ -317,6 +316,14 @@ After performing the initial transform, ⛩️📰 书社 will match the root node of the result in the following modes to fill in areas of the wrapper :⁠— +- **`书社:header`:** + The result of matching in this mode is prepended into the + `` of the output (before the transformation result). + +- **`书社:footer`:** + The result of matching in this mode is appended into the + `` of the output (after the transformation result). + - **`书社:metadata`:** The result of matching in this mode is inserted into the `` of the output. @@ -335,20 +342,24 @@ This mechanism can be used to allow transforms to insert content ```xml - <书社:id>example:add-stylesheet-links.xslt - + <书社:id>example:add-stylesheet-links.xslt + ``` +Output wrapping can be entirely disabled by adding a + `@书社:disable-output-wrapping` attribute to the top‐level element in + the result tree. + ## License Source files are licensed under the terms of the Mozilla Public