@pretextbook/pretext-html 0.1.0 → 0.2.0

package/assets/xsl/extract-prefigure.xsl

@@ -1,157 +1,157 @@
-<?xml version='1.0'?>
-
-<!--********************************************************************
-Copyright 2014-2016 Robert A. Beezer
-
-This file is part of MathBook XML.
-
-MathBook XML is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 2 or version 3 of the
-License (at your option).
-
-MathBook XML is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with MathBook XML.  If not, see <http://www.gnu.org/licenses/>.
-*********************************************************************-->
-
-<!-- This stylesheet locates <prefigure> elements and copies them for processing -->
-
-<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"
-    xmlns:xml="http://www.w3.org/XML/1998/namespace"
-    xmlns:exsl="http://exslt.org/common"
-    xmlns:pf="https://prefigure.org"
-    extension-element-prefixes="exsl"
->
-
-<!-- Get internal ID's for filenames, etc -->
-<!-- Standard conversion groundwork       -->
-<xsl:import href="./publisher-variables.xsl"/>
-<xsl:import href="./pretext-assembly.xsl"/>
-<xsl:import href="./pretext-common.xsl"/>
-
-<!-- Get a "subtree" xml:id value   -->
-<!-- Then walk the XML source tree  -->
-<!-- applying specializations below -->
-<xsl:import href="./extract-identity.xsl" />
-
-<!-- Output PreFigure XML -->
-<xsl:output method="xml" encoding="UTF-8"/>
-
-<!-- PreFigure graphics to standalone file            -->
-<!-- NB: don't match the empty element that is a text -->
-<!-- generator.  Once PreFigure has a namespace, then -->
-<!-- it should be used here instead.                  -->
-<xsl:template match="pf:prefigure[node()]" mode="extraction">
-    <xsl:variable name="filebase">
-        <xsl:apply-templates select="." mode="image-source-basename"/>
-    </xsl:variable>
-    <!-- Do not use directories here, as Windows paths will get mangled -->
-    <!-- Instead, set working directory before applying stylesheet      -->
-    <exsl:document href="{$filebase}.xml" method="xml">
-        <!-- xerox the "prefigure" element, but with modifications -->
-        <xsl:apply-templates select="." mode="prefigure-edit"/>
-    </exsl:document>
- </xsl:template>
-
-<!-- Identity template, with a mode, so we can edit a diagram -->
-<!-- NB: it does not seem the "pf:" is necessary here         -->
-<xsl:template match="node()|@*" mode="prefigure-edit">
-    <xsl:copy>
-        <xsl:apply-templates select="node()|@*" mode="prefigure-edit"/>
-    </xsl:copy>
-</xsl:template>
-
-<!-- Raison d'etre for "prefigure-edit": insert a PF "caption" with -->
-<!-- a type-name/number pair and a document-wide serial number      -->
-<xsl:template match="pf:diagram" mode="prefigure-edit">
-    <xsl:copy>
-        <xsl:apply-templates select="@*" mode="prefigure-edit"/>
-        <!-- insert a PF "caption", hopefully with helpful content -->
-        <!-- duplicate indentation of first child of "diagram" to  -->
-        <!-- make insertion of the first new children look good    -->
-        <xsl:value-of select="text()[1]"/>
-        <xsl:comment> Reference to containing ancestor comes from PreTeXt context     </xsl:comment>
-        <xsl:value-of select="text()[1]"/>
-        <xsl:comment> Serial number is from document-wide count of PreFigure diagrams </xsl:comment>
-        <xsl:value-of select="text()[1]"/>
-        <xsl:element name="caption" namespace="https://prefigure.org">
-            <!-- pf:diagram, pf:prefigure, and "image" all lack meaningful  -->
-            <!-- numbers, so start searching for a [location with a number] -->
-            <!-- from the parent of the "image"                             -->
-            <xsl:apply-templates select="parent::pf:prefigure/parent::image/parent::*" mode="prefigure-container"/>
-            <!-- previous template supplies a space, if it provides a type/number pair -->
-            <!-- Serial number, just document-wide for pf:prefigure -->
-            <!-- NB: implement this as part of the overall numbering -->
-            <!-- scheme, so it comes through as an attribute.        -->
-            <xsl:text>(</xsl:text>
-            <!-- pf:diagram is current context, no danger that an empty "pretext" -->
-            <!-- generator will be mistakenly used for the @from pattern          -->
-            <xsl:number count="pf:prefigure" from="pretext" level="any"/>
-            <xsl:text>)</xsl:text>
-        </xsl:element>
-        <!-- xerox remaining elements -->
-        <xsl:apply-templates select="node()" mode="prefigure-edit"/>
-    </xsl:copy>
-</xsl:template>
-
-<!-- Recurse up the tree, looking for the first element with a -->
-<!-- non-empty number.  Produce type-name and a serial number. -->
-<xsl:template match="*" mode="prefigure-container">
-    <!-- Will test on non-empty number strings.  This can be -->
-    <!-- fooled by elements with un-implemented numbers such -->
-    <!-- as a pure container like a "sidebyside".            -->
-    <xsl:variable name="the-number">
-        <xsl:apply-templates select="." mode="number"/>
-    </xsl:variable>
-
-    <xsl:choose>
-        <!-- this is the safety-valve halting condition -->
-        <xsl:when test="self::pretext"/>
-        <!-- Test here for useless containers that have better parents. -->
-        <!-- Examples might be a "case" in a "proof" or a "task" in an  -->
-        <!-- "exercise" or an "li" in an "ol".                          -->
-        <!-- Then recurse with the parent, as below.                    -->
-        <xsl:when test="not($the-number = '')">
-            <xsl:apply-templates select="." mode="type-name" />
-            <xsl:text> </xsl:text>
-            <xsl:value-of select="$the-number"/>
-            <!-- will always follow with a serial number, -->
-            <!-- so add a space here, since conditional   -->
-            <xsl:text> </xsl:text>
-            <!-- mission accomplished, no more recursion -->
-        </xsl:when>
-        <xsl:otherwise>
-            <!-- step-up (recurse) to the parent -->
-            <xsl:apply-templates select="parent::*" mode="prefigure-container"/>
-        </xsl:otherwise>
-    </xsl:choose>
-</xsl:template>
-
-<!-- PreFigure publication file -->
-<!-- We need a one-off generation of a PreFigure publication    -->
-<!-- file, dumped in the same directory as the extracted source -->
-<!-- diagrams.  So we match the *only* guaranteed node and let  -->
-<!-- it do its thing, and then create the necessary file.       -->
- <xsl:template match="/">
-    <xsl:apply-imports/>
-    <exsl:document href="pf_publication.xml" method="xml">
-        <xsl:element name="prefigure" namespace="https://prefigure.org">
-            <!-- No "prefigure-preamble" => nothing produced       -->
-            <xsl:copy-of select="$docinfo/pf:prefigure-preamble/*"/>
-            <!-- $latex-macros is never empty (<, >, &) so always a "macros" -->
-            <xsl:element name="macros" namespace="https://prefigure.org">
-                <!-- move to a new line for minimal readability -->
-                <xsl:text>&#xa;</xsl:text>
-                <!-- global variable in -common, includes \lt, \gt, \amp -->
-                <xsl:value-of select="$latex-macros"/>
-            </xsl:element>
-        </xsl:element>
-    </exsl:document>
-</xsl:template>
-
-</xsl:stylesheet>
+<?xml version='1.0'?>
+
+<!--********************************************************************
+Copyright 2014-2016 Robert A. Beezer
+
+This file is part of MathBook XML.
+
+MathBook XML is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 or version 3 of the
+License (at your option).
+
+MathBook XML is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with MathBook XML.  If not, see <http://www.gnu.org/licenses/>.
+*********************************************************************-->
+
+<!-- This stylesheet locates <prefigure> elements and copies them for processing -->
+
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"
+    xmlns:xml="http://www.w3.org/XML/1998/namespace"
+    xmlns:exsl="http://exslt.org/common"
+    xmlns:pf="https://prefigure.org"
+    extension-element-prefixes="exsl"
+>
+
+<!-- Get internal ID's for filenames, etc -->
+<!-- Standard conversion groundwork       -->
+<xsl:import href="./publisher-variables.xsl"/>
+<xsl:import href="./pretext-assembly.xsl"/>
+<xsl:import href="./pretext-common.xsl"/>
+
+<!-- Get a "subtree" xml:id value   -->
+<!-- Then walk the XML source tree  -->
+<!-- applying specializations below -->
+<xsl:import href="./extract-identity.xsl" />
+
+<!-- Output PreFigure XML -->
+<xsl:output method="xml" encoding="UTF-8"/>
+
+<!-- PreFigure graphics to standalone file            -->
+<!-- NB: don't match the empty element that is a text -->
+<!-- generator.  Once PreFigure has a namespace, then -->
+<!-- it should be used here instead.                  -->
+<xsl:template match="pf:prefigure[node()]" mode="extraction">
+    <xsl:variable name="filebase">
+        <xsl:apply-templates select="." mode="image-source-basename"/>
+    </xsl:variable>
+    <!-- Do not use directories here, as Windows paths will get mangled -->
+    <!-- Instead, set working directory before applying stylesheet      -->
+    <exsl:document href="{$filebase}.xml" method="xml">
+        <!-- xerox the "prefigure" element, but with modifications -->
+        <xsl:apply-templates select="." mode="prefigure-edit"/>
+    </exsl:document>
+ </xsl:template>
+
+<!-- Identity template, with a mode, so we can edit a diagram -->
+<!-- NB: it does not seem the "pf:" is necessary here         -->
+<xsl:template match="node()|@*" mode="prefigure-edit">
+    <xsl:copy>
+        <xsl:apply-templates select="node()|@*" mode="prefigure-edit"/>
+    </xsl:copy>
+</xsl:template>
+
+<!-- Raison d'etre for "prefigure-edit": insert a PF "caption" with -->
+<!-- a type-name/number pair and a document-wide serial number      -->
+<xsl:template match="pf:diagram" mode="prefigure-edit">
+    <xsl:copy>
+        <xsl:apply-templates select="@*" mode="prefigure-edit"/>
+        <!-- insert a PF "caption", hopefully with helpful content -->
+        <!-- duplicate indentation of first child of "diagram" to  -->
+        <!-- make insertion of the first new children look good    -->
+        <xsl:value-of select="text()[1]"/>
+        <xsl:comment> Reference to containing ancestor comes from PreTeXt context     </xsl:comment>
+        <xsl:value-of select="text()[1]"/>
+        <xsl:comment> Serial number is from document-wide count of PreFigure diagrams </xsl:comment>
+        <xsl:value-of select="text()[1]"/>
+        <xsl:element name="caption" namespace="https://prefigure.org">
+            <!-- pf:diagram, pf:prefigure, and "image" all lack meaningful  -->
+            <!-- numbers, so start searching for a [location with a number] -->
+            <!-- from the parent of the "image"                             -->
+            <xsl:apply-templates select="parent::pf:prefigure/parent::image/parent::*" mode="prefigure-container"/>
+            <!-- previous template supplies a space, if it provides a type/number pair -->
+            <!-- Serial number, just document-wide for pf:prefigure -->
+            <!-- NB: implement this as part of the overall numbering -->
+            <!-- scheme, so it comes through as an attribute.        -->
+            <xsl:text>(</xsl:text>
+            <!-- pf:diagram is current context, no danger that an empty "pretext" -->
+            <!-- generator will be mistakenly used for the @from pattern          -->
+            <xsl:number count="pf:prefigure" from="pretext" level="any"/>
+            <xsl:text>)</xsl:text>
+        </xsl:element>
+        <!-- xerox remaining elements -->
+        <xsl:apply-templates select="node()" mode="prefigure-edit"/>
+    </xsl:copy>
+</xsl:template>
+
+<!-- Recurse up the tree, looking for the first element with a -->
+<!-- non-empty number.  Produce type-name and a serial number. -->
+<xsl:template match="*" mode="prefigure-container">
+    <!-- Will test on non-empty number strings.  This can be -->
+    <!-- fooled by elements with un-implemented numbers such -->
+    <!-- as a pure container like a "sidebyside".            -->
+    <xsl:variable name="the-number">
+        <xsl:apply-templates select="." mode="number"/>
+    </xsl:variable>
+
+    <xsl:choose>
+        <!-- this is the safety-valve halting condition -->
+        <xsl:when test="self::pretext"/>
+        <!-- Test here for useless containers that have better parents. -->
+        <!-- Examples might be a "case" in a "proof" or a "task" in an  -->
+        <!-- "exercise" or an "li" in an "ol".                          -->
+        <!-- Then recurse with the parent, as below.                    -->
+        <xsl:when test="not($the-number = '')">
+            <xsl:apply-templates select="." mode="type-name" />
+            <xsl:text> </xsl:text>
+            <xsl:value-of select="$the-number"/>
+            <!-- will always follow with a serial number, -->
+            <!-- so add a space here, since conditional   -->
+            <xsl:text> </xsl:text>
+            <!-- mission accomplished, no more recursion -->
+        </xsl:when>
+        <xsl:otherwise>
+            <!-- step-up (recurse) to the parent -->
+            <xsl:apply-templates select="parent::*" mode="prefigure-container"/>
+        </xsl:otherwise>
+    </xsl:choose>
+</xsl:template>
+
+<!-- PreFigure publication file -->
+<!-- We need a one-off generation of a PreFigure publication    -->
+<!-- file, dumped in the same directory as the extracted source -->
+<!-- diagrams.  So we match the *only* guaranteed node and let  -->
+<!-- it do its thing, and then create the necessary file.       -->
+ <xsl:template match="/">
+    <xsl:apply-imports/>
+    <exsl:document href="pf_publication.xml" method="xml">
+        <xsl:element name="prefigure" namespace="https://prefigure.org">
+            <!-- No "prefigure-preamble" => nothing produced       -->
+            <xsl:copy-of select="$docinfo/pf:prefigure-preamble/*"/>
+            <!-- $latex-macros is never empty (<, >, &) so always a "macros" -->
+            <xsl:element name="macros" namespace="https://prefigure.org">
+                <!-- move to a new line for minimal readability -->
+                <xsl:text>&#xa;</xsl:text>
+                <!-- global variable in -common, includes \lt, \gt, \amp -->
+                <xsl:value-of select="$latex-macros"/>
+            </xsl:element>
+        </xsl:element>
+    </exsl:document>
+</xsl:template>
+
+</xsl:stylesheet>

package/assets/xsl/extract-qrcode.xsl

@@ -1,100 +1,100 @@
-<?xml version='1.0'?>
-
-<!--********************************************************************
-Copyright 2014-2016 Robert A. Beezer
-
-This file is part of PreTeXt.
-
-PreTeXt is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 2 or version 3 of the
-License (at your option).
-
-PreTeXt is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with PreTeXt.  If not, see <http://www.gnu.org/licenses/>.
-*********************************************************************-->
-
-<!-- This stylesheet extracts URL information for audio, video,  -->
-<!-- and interactive elements.  For each, it writes a sidecar    -->
-<!-- XML file (via exsl:document) containing a standalone URL    -->
-<!-- and an in-context URL, used later for QR code generation    -->
-<!-- (Python) and for links in static representations            -->
-<!-- (pretext-assembly.xsl).                                     -->
-<!--                                                             -->
-<!-- It is hard to get a link into chunked HTML while actually   -->
-<!-- building generic PreTeXt for a static representation.  The  -->
-<!-- chunking level and file extension are format-specific, but  -->
-<!-- assembly must remain format-neutral.  So we set HTML-        -->
-<!-- specific variables ($chunk-level, $file-extension) here in  -->
-<!-- the extraction stylesheet, which has the highest import     -->
-<!-- precedence.  Assembly then reads the pre-computed URLs from  -->
-<!-- the sidecar files rather than computing them itself.         -->
-
-<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"
-    xmlns:xml="http://www.w3.org/XML/1998/namespace"
-    xmlns:exsl="http://exslt.org/common"
-    xmlns:str="http://exslt.org/strings"
-    xmlns:pi="http://pretextbook.org/2020/pretext/internal"
-    extension-element-prefixes="exsl"
->
-
-<!-- Get internal ID's for filenames, etc -->
-<!-- Standard conversion groundwork       -->
-<xsl:import href="./publisher-variables.xsl"/>
-<xsl:import href="./pretext-assembly.xsl"/>
-<xsl:import href="./pretext-common.xsl"/>
-
-<!-- Get a "subtree" xml:id value   -->
-<!-- Then walk the XML source tree  -->
-<!-- applying specializations below -->
-<xsl:import href="./extract-identity.xsl" />
-
-<xsl:output method="text" encoding="UTF-8"/>
-
-<!-- Avoid Catch-22: default assembly/pre-processor provides output  -->
-<!-- for a conversion to a static format, but that format will       -->
-<!-- *replace* "audio", "video", "interactive" by a static version   -->
-<!-- (a "sidebyside") and it will not be available for extraction.    -->
-<xsl:variable name="exercise-style" select="'dynamic'"/>
-
-<!-- In "normal" circumstances, this variable is   -->
-<!-- set to "false()", but when employing this     -->
-<!-- specialized stylesheet, we override to "true" -->
-<xsl:variable name="b-extracting-qrcode" select="true()"/>
-
-<!-- Set HTML-specific variables so that "containing-filename" -->
-<!-- (used by "context-url") produces correct HTML filenames.  -->
-<!-- These override the abstract defaults in pretext-common.xsl -->
-<!-- by virtue of this stylesheet's higher import precedence.   -->
-<xsl:variable name="chunk-level" select="$html-chunk-level"/>
-<xsl:variable name="file-extension" select="'.html'"/>
-
-<xsl:template match="audio[@source|@href]|video[@source|@href|@youtube|@youtubeplaylist|@vimeo]|interactive" mode="extraction">
-    <!-- Sidecar XML file with pre-computed URLs for use      -->
-    <!-- by pretext-assembly.xsl when building static         -->
-    <!-- representations, and by the Python script when       -->
-    <!-- generating QR code images.                           -->
-    <xsl:variable name="the-id">
-        <xsl:apply-templates select="." mode="visible-id"/>
-    </xsl:variable>
-    <exsl:document href="{$the-id}-url.xml" method="xml">
-        <pi:qrcode-urls>
-            <pi:standalone-url>
-                <xsl:apply-templates select="." mode="static-url"/>
-            </pi:standalone-url>
-            <pi:context-url>
-                <xsl:apply-templates select="." mode="context-url"/>
-            </pi:context-url>
-            <pi:embed-iframe-url>
-                <xsl:apply-templates select="." mode="embed-iframe-url"/>
-            </pi:embed-iframe-url>
-        </pi:qrcode-urls>
-    </exsl:document>
-</xsl:template>
-
-</xsl:stylesheet>
+<?xml version='1.0'?>
+
+<!--********************************************************************
+Copyright 2014-2016 Robert A. Beezer
+
+This file is part of PreTeXt.
+
+PreTeXt is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 or version 3 of the
+License (at your option).
+
+PreTeXt is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with PreTeXt.  If not, see <http://www.gnu.org/licenses/>.
+*********************************************************************-->
+
+<!-- This stylesheet extracts URL information for audio, video,  -->
+<!-- and interactive elements.  For each, it writes a sidecar    -->
+<!-- XML file (via exsl:document) containing a standalone URL    -->
+<!-- and an in-context URL, used later for QR code generation    -->
+<!-- (Python) and for links in static representations            -->
+<!-- (pretext-assembly.xsl).                                     -->
+<!--                                                             -->
+<!-- It is hard to get a link into chunked HTML while actually   -->
+<!-- building generic PreTeXt for a static representation.  The  -->
+<!-- chunking level and file extension are format-specific, but  -->
+<!-- assembly must remain format-neutral.  So we set HTML-        -->
+<!-- specific variables ($chunk-level, $file-extension) here in  -->
+<!-- the extraction stylesheet, which has the highest import     -->
+<!-- precedence.  Assembly then reads the pre-computed URLs from  -->
+<!-- the sidecar files rather than computing them itself.         -->
+
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"
+    xmlns:xml="http://www.w3.org/XML/1998/namespace"
+    xmlns:exsl="http://exslt.org/common"
+    xmlns:str="http://exslt.org/strings"
+    xmlns:pi="http://pretextbook.org/2020/pretext/internal"
+    extension-element-prefixes="exsl"
+>
+
+<!-- Get internal ID's for filenames, etc -->
+<!-- Standard conversion groundwork       -->
+<xsl:import href="./publisher-variables.xsl"/>
+<xsl:import href="./pretext-assembly.xsl"/>
+<xsl:import href="./pretext-common.xsl"/>
+
+<!-- Get a "subtree" xml:id value   -->
+<!-- Then walk the XML source tree  -->
+<!-- applying specializations below -->
+<xsl:import href="./extract-identity.xsl" />
+
+<xsl:output method="text" encoding="UTF-8"/>
+
+<!-- Avoid Catch-22: default assembly/pre-processor provides output  -->
+<!-- for a conversion to a static format, but that format will       -->
+<!-- *replace* "audio", "video", "interactive" by a static version   -->
+<!-- (a "sidebyside") and it will not be available for extraction.    -->
+<xsl:variable name="exercise-style" select="'dynamic'"/>
+
+<!-- In "normal" circumstances, this variable is   -->
+<!-- set to "false()", but when employing this     -->
+<!-- specialized stylesheet, we override to "true" -->
+<xsl:variable name="b-extracting-qrcode" select="true()"/>
+
+<!-- Set HTML-specific variables so that "containing-filename" -->
+<!-- (used by "context-url") produces correct HTML filenames.  -->
+<!-- These override the abstract defaults in pretext-common.xsl -->
+<!-- by virtue of this stylesheet's higher import precedence.   -->
+<xsl:variable name="chunk-level" select="$html-chunk-level"/>
+<xsl:variable name="file-extension" select="'.html'"/>
+
+<xsl:template match="audio[@source|@href]|video[@source|@href|@youtube|@youtubeplaylist|@vimeo]|interactive" mode="extraction">
+    <!-- Sidecar XML file with pre-computed URLs for use      -->
+    <!-- by pretext-assembly.xsl when building static         -->
+    <!-- representations, and by the Python script when       -->
+    <!-- generating QR code images.                           -->
+    <xsl:variable name="the-id">
+        <xsl:apply-templates select="." mode="visible-id"/>
+    </xsl:variable>
+    <exsl:document href="{$the-id}-url.xml" method="xml">
+        <pi:qrcode-urls>
+            <pi:standalone-url>
+                <xsl:apply-templates select="." mode="static-url"/>
+            </pi:standalone-url>
+            <pi:context-url>
+                <xsl:apply-templates select="." mode="context-url"/>
+            </pi:context-url>
+            <pi:embed-iframe-url>
+                <xsl:apply-templates select="." mode="embed-iframe-url"/>
+            </pi:embed-iframe-url>
+        </pi:qrcode-urls>
+    </exsl:document>
+</xsl:template>
+
+</xsl:stylesheet>