@pretextbook/pretext-html 0.1.0 → 0.1.1

package/assets/xsl/extract-identity.xsl

@@ -1,136 +1,136 @@
-<?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 does nothing but traverse the tree         -->
-<!-- Possibly restricting to a subtree based on xml:id          -->
-<!-- An importing stylesheet can concentrate on a specific task -->
-
-<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
-
-<xsl:import href="./publisher-variables.xsl" />
-<xsl:import href="./pretext-assembly.xsl" />
-
-<!-- We do not specify an output method since nothing gets output from here -->
-
-<!-- This template provides several related templates.                    -->
-<!-- See further notes prior to each one.                                 -->
-<!--                                                                      -->
-<!-- 1.  It provides an entry template.                                   -->
-<!--                                                                      -->
-<!-- At the document root (after assembly) or at the root of some subtree -->
-<!-- passed in and indicated by an xml:id for that root.  So a stylesheet -->
-<!-- that uses this stylesheet must import this utility stylesheet *last* -->
-<!-- so that any entry template of some conversion is overridden.         -->
-<!--                                                                      -->
-<!--                                                                      -->
-<!-- 2.  It establishes a tree walker with mode "extraction".             -->
-<!--                                                                      -->
-<!-- The modal template here walks the tree and does *nothing* at each    -->
-<!-- node, but descend into children and attributes.  So a consuming      -->
-<!-- stylesheet can provide its own "extraction" templates to interrupt   -->
-<!-- this giant no-op and do something interesting.  Note that this modal -->
-<!-- template allows plain/generic templates from established conversions -->
-<!-- to be employed, and conceivably overridden, without disturbing the   -->
-<!-- tree walk.                                                           -->
-<!--                                                                      -->
-<!--                                                                      -->
-<!-- 3.  A template provides for one-time lead-in/lead-out material       -->
-<!-- General an "extraction" will make a list of similar items.  But      -->
-<!-- there may need to be header/footer material, or some sort of         -->
-<!-- overall enclosure of the list.  This template can be implemented     -->
-<!-- to accomplish that.                                                  -->
-
-<!-- 2020-05-19: This general-purpose template formerly obtained a      -->
-<!-- "scratch directory" where intermediate results might be processed. -->
-<!-- But if a pathname, in Windows syntax, was passed in, then the      -->
-<!-- slashes all got butchered.  Better to set a working directory      -->
-<!-- and have "extracttion" worksheets write files, sans paths, into    -->
-<!-- that directory.  We leave a warning behind if there is an attempt  -->
-<!-- to set this, which will likely be something overlooked in a        -->
-<!-- calling script. -->
-<xsl:param name="scratch" select="''"/>
-
-<!-- The xml:id of an element to use as the root                -->
-<!-- no "subtree" stringparam denotes starting at document root -->
-<xsl:param name="subtree" select="''" />
-
-<!-- Entry template, allows restriction to a subtree rooted at an element  -->
-<!-- identified by an author-supplied xml:id. This template is not meant   -->
-<!-- to be overridden by an importing stylesheet, though it can be with a  -->
-<!-- use of "xsl:apply-imports".  Instead it is meant to be the entry      -->
-<!-- template for an importing stylesheet, which will usually mean it      -->
-<!-- should be imported last.  It provides for careful handling of the     -->
-<!-- alternate subtree root.                                               -->
-<xsl:template match="/">
-    <!-- Fail if a scratch directory is set -->
-    <xsl:if test="not($scratch = '')">
-        <xsl:message terminate="yes">PTX:FATAL:   scratch directory provided ("<xsl:value-of select="$scratch" />") which is not supported.  Please report the circumstances revealing this mistake.  Quitting...</xsl:message>
-    </xsl:if>
-    <xsl:choose>
-        <xsl:when test="$subtree=''">
-            <xsl:apply-templates select="$root" mode="extraction-wrapper"/>
-        </xsl:when>
-        <xsl:otherwise>
-            <!-- Context is root of *original* source as we are in the entry template. -->
-            <!-- The "for-each" allows a switch to the duplicate (assembled) source,   -->
-            <!-- so the id() function scans the enhanced tree.                         -->
-            <xsl:for-each select="$root">
-                <xsl:variable name="subtree-root" select="id($subtree)"/>
-                <xsl:if test="not($subtree-root)">
-                    <xsl:message terminate="yes">PTX:FATAL:   xml:id provided ("<xsl:value-of select="$subtree"/>") for restriction to a subtree does not exist.  Quitting...</xsl:message>
-                </xsl:if>
-                <xsl:apply-templates select="$subtree-root" mode="extraction-wrapper"/>
-            </xsl:for-each>
-        </xsl:otherwise>
-    </xsl:choose>
-</xsl:template>
-
-<!-- This template will always be applied with the context being the      -->
-<!-- "real" root, or the optional "subtree" root.  See applications in    -->
-<!-- the entry template.  The implementation here does nothing, but to    -->
-<!-- initiate the "extraction" walker.  This can be optionally overridden -->
-<!-- where the model would be:                                            -->
-<!--                                                                      -->
-<!--    <xsl:template match="*" mode="extraction-wrapper">                -->
-<!--        [do some header, lead-in, and/or set-up, here]                -->
-<!--        <xsl:apply-imports/>                                          -->
-<!--        [do some footer, lead-out, and/or wrap-up, here]              -->
-<!--    </xsl:template>                                                   -->
-<!--                                                                      -->
-<!-- See the "extract-interactive.xsl" stylesheet for a simple example.   -->
-<!-- Note that if the extra material needs to come from some other        -->
-<!-- context, the global variables  $root  and  $document-root  should be -->
-<!-- available to initiate a path to some location of interest.           -->
-<xsl:template match="*" mode="extraction-wrapper">
-    <xsl:apply-templates select="." mode="extraction"/>
-</xsl:template>
-
-<!-- This template traverses the tree, from the provided root, looking       -->
-<!-- for something to do.  As defined here, it does nothing.  An importing   -->
-<!-- stylesheet will define this template for items of interest, providing   -->
-<!-- the desired results.  Note that any such definition should (a) continue -->
-<!-- the recursion, or (b) knowingly dead-end and not recurse further.       -->
-<!-- http://stackoverflow.com/questions/3776333/stripping-all-elements-except-one-in-xml-using-xslt -->
-<xsl:template match="@*|node()" mode="extraction">
-    <xsl:apply-templates select="@*|node()" mode="extraction"/>
-</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 does nothing but traverse the tree         -->
+<!-- Possibly restricting to a subtree based on xml:id          -->
+<!-- An importing stylesheet can concentrate on a specific task -->
+
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
+
+<xsl:import href="./publisher-variables.xsl" />
+<xsl:import href="./pretext-assembly.xsl" />
+
+<!-- We do not specify an output method since nothing gets output from here -->
+
+<!-- This template provides several related templates.                    -->
+<!-- See further notes prior to each one.                                 -->
+<!--                                                                      -->
+<!-- 1.  It provides an entry template.                                   -->
+<!--                                                                      -->
+<!-- At the document root (after assembly) or at the root of some subtree -->
+<!-- passed in and indicated by an xml:id for that root.  So a stylesheet -->
+<!-- that uses this stylesheet must import this utility stylesheet *last* -->
+<!-- so that any entry template of some conversion is overridden.         -->
+<!--                                                                      -->
+<!--                                                                      -->
+<!-- 2.  It establishes a tree walker with mode "extraction".             -->
+<!--                                                                      -->
+<!-- The modal template here walks the tree and does *nothing* at each    -->
+<!-- node, but descend into children and attributes.  So a consuming      -->
+<!-- stylesheet can provide its own "extraction" templates to interrupt   -->
+<!-- this giant no-op and do something interesting.  Note that this modal -->
+<!-- template allows plain/generic templates from established conversions -->
+<!-- to be employed, and conceivably overridden, without disturbing the   -->
+<!-- tree walk.                                                           -->
+<!--                                                                      -->
+<!--                                                                      -->
+<!-- 3.  A template provides for one-time lead-in/lead-out material       -->
+<!-- General an "extraction" will make a list of similar items.  But      -->
+<!-- there may need to be header/footer material, or some sort of         -->
+<!-- overall enclosure of the list.  This template can be implemented     -->
+<!-- to accomplish that.                                                  -->
+
+<!-- 2020-05-19: This general-purpose template formerly obtained a      -->
+<!-- "scratch directory" where intermediate results might be processed. -->
+<!-- But if a pathname, in Windows syntax, was passed in, then the      -->
+<!-- slashes all got butchered.  Better to set a working directory      -->
+<!-- and have "extracttion" worksheets write files, sans paths, into    -->
+<!-- that directory.  We leave a warning behind if there is an attempt  -->
+<!-- to set this, which will likely be something overlooked in a        -->
+<!-- calling script. -->
+<xsl:param name="scratch" select="''"/>
+
+<!-- The xml:id of an element to use as the root                -->
+<!-- no "subtree" stringparam denotes starting at document root -->
+<xsl:param name="subtree" select="''" />
+
+<!-- Entry template, allows restriction to a subtree rooted at an element  -->
+<!-- identified by an author-supplied xml:id. This template is not meant   -->
+<!-- to be overridden by an importing stylesheet, though it can be with a  -->
+<!-- use of "xsl:apply-imports".  Instead it is meant to be the entry      -->
+<!-- template for an importing stylesheet, which will usually mean it      -->
+<!-- should be imported last.  It provides for careful handling of the     -->
+<!-- alternate subtree root.                                               -->
+<xsl:template match="/">
+    <!-- Fail if a scratch directory is set -->
+    <xsl:if test="not($scratch = '')">
+        <xsl:message terminate="yes">PTX:FATAL:   scratch directory provided ("<xsl:value-of select="$scratch" />") which is not supported.  Please report the circumstances revealing this mistake.  Quitting...</xsl:message>
+    </xsl:if>
+    <xsl:choose>
+        <xsl:when test="$subtree=''">
+            <xsl:apply-templates select="$root" mode="extraction-wrapper"/>
+        </xsl:when>
+        <xsl:otherwise>
+            <!-- Context is root of *original* source as we are in the entry template. -->
+            <!-- The "for-each" allows a switch to the duplicate (assembled) source,   -->
+            <!-- so the id() function scans the enhanced tree.                         -->
+            <xsl:for-each select="$root">
+                <xsl:variable name="subtree-root" select="id($subtree)"/>
+                <xsl:if test="not($subtree-root)">
+                    <xsl:message terminate="yes">PTX:FATAL:   xml:id provided ("<xsl:value-of select="$subtree"/>") for restriction to a subtree does not exist.  Quitting...</xsl:message>
+                </xsl:if>
+                <xsl:apply-templates select="$subtree-root" mode="extraction-wrapper"/>
+            </xsl:for-each>
+        </xsl:otherwise>
+    </xsl:choose>
+</xsl:template>
+
+<!-- This template will always be applied with the context being the      -->
+<!-- "real" root, or the optional "subtree" root.  See applications in    -->
+<!-- the entry template.  The implementation here does nothing, but to    -->
+<!-- initiate the "extraction" walker.  This can be optionally overridden -->
+<!-- where the model would be:                                            -->
+<!--                                                                      -->
+<!--    <xsl:template match="*" mode="extraction-wrapper">                -->
+<!--        [do some header, lead-in, and/or set-up, here]                -->
+<!--        <xsl:apply-imports/>                                          -->
+<!--        [do some footer, lead-out, and/or wrap-up, here]              -->
+<!--    </xsl:template>                                                   -->
+<!--                                                                      -->
+<!-- See the "extract-interactive.xsl" stylesheet for a simple example.   -->
+<!-- Note that if the extra material needs to come from some other        -->
+<!-- context, the global variables  $root  and  $document-root  should be -->
+<!-- available to initiate a path to some location of interest.           -->
+<xsl:template match="*" mode="extraction-wrapper">
+    <xsl:apply-templates select="." mode="extraction"/>
+</xsl:template>
+
+<!-- This template traverses the tree, from the provided root, looking       -->
+<!-- for something to do.  As defined here, it does nothing.  An importing   -->
+<!-- stylesheet will define this template for items of interest, providing   -->
+<!-- the desired results.  Note that any such definition should (a) continue -->
+<!-- the recursion, or (b) knowingly dead-end and not recurse further.       -->
+<!-- http://stackoverflow.com/questions/3776333/stripping-all-elements-except-one-in-xml-using-xslt -->
+<xsl:template match="@*|node()" mode="extraction">
+    <xsl:apply-templates select="@*|node()" mode="extraction"/>
+</xsl:template>
+
+</xsl:stylesheet>

package/assets/xsl/extract-interactive.xsl

@@ -1,81 +1,81 @@
-<?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 locates video/@youtube elements and -->
-<!-- prepares a Python dictionary necessary to extract a -->
-<!-- thumbnail for each video from the YouTube servers   -->
-
-<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"
-    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"/>
-<xsl:import href="./pretext-html.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 providews output     -->
-<!-- for a conversion to a static format, but that format will *replace* -->
-<!-- "video" by a static version (a "sidebyside") and it will not be     -->
-<!-- available for extraction.                                           -->
-<xsl:variable name="exercise-style" select="'dynamic'"/>
-
-<!-- @preview indicates custom image is present    -->
-<!-- Stylesheet output is text, with "visible-id"  -->
-<!-- of each interactive, one per line, to be      -->
-<!-- captured in a text file to guide snapshotting -->
-<!-- Make the iframe and standalone page for each  -->
-<!-- interactive, these are two of the three steps -->
-<!-- in the non-modal template for "interactive"   -->
-<!-- in pretext-html.xsl.  Results are HTML files  -->
-<!-- (despite this stylesheet having text output). -->
-<xsl:template match="interactive[not(@preview)]" mode="extraction">
-    <xsl:apply-templates select="." mode="visible-id" />
-    <xsl:text>&#xa;</xsl:text>
-    <!-- (2) Identical content, but now isolated on a reader-friendly page -->
-    <!-- The standalone page has its own masthead h1, so headings inside   -->
-    <!-- start fresh at h2.  Mirrors the standalone-page invocation in     -->
-    <!-- the "interactive" template of pretext-html.xsl.                   -->
-    <xsl:apply-templates select="." mode="standalone-page" >
-        <xsl:with-param name="content">
-            <xsl:apply-templates select="." mode="interactive-core">
-                <xsl:with-param name="is-standalone" select="true()"/>
-                <xsl:with-param name="heading-level" select="2"/>
-            </xsl:apply-templates>
-        </xsl:with-param>
-    </xsl:apply-templates>
-    <!-- (3) A simple page that can be used in an iframe construction -->
-    <xsl:apply-templates select="." mode="create-iframe-page" />
-</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 locates video/@youtube elements and -->
+<!-- prepares a Python dictionary necessary to extract a -->
+<!-- thumbnail for each video from the YouTube servers   -->
+
+<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"
+    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"/>
+<xsl:import href="./pretext-html.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 providews output     -->
+<!-- for a conversion to a static format, but that format will *replace* -->
+<!-- "video" by a static version (a "sidebyside") and it will not be     -->
+<!-- available for extraction.                                           -->
+<xsl:variable name="exercise-style" select="'dynamic'"/>
+
+<!-- @preview indicates custom image is present    -->
+<!-- Stylesheet output is text, with "visible-id"  -->
+<!-- of each interactive, one per line, to be      -->
+<!-- captured in a text file to guide snapshotting -->
+<!-- Make the iframe and standalone page for each  -->
+<!-- interactive, these are two of the three steps -->
+<!-- in the non-modal template for "interactive"   -->
+<!-- in pretext-html.xsl.  Results are HTML files  -->
+<!-- (despite this stylesheet having text output). -->
+<xsl:template match="interactive[not(@preview)]" mode="extraction">
+    <xsl:apply-templates select="." mode="visible-id" />
+    <xsl:text>&#xa;</xsl:text>
+    <!-- (2) Identical content, but now isolated on a reader-friendly page -->
+    <!-- The standalone page has its own masthead h1, so headings inside   -->
+    <!-- start fresh at h2.  Mirrors the standalone-page invocation in     -->
+    <!-- the "interactive" template of pretext-html.xsl.                   -->
+    <xsl:apply-templates select="." mode="standalone-page" >
+        <xsl:with-param name="content">
+            <xsl:apply-templates select="." mode="interactive-core">
+                <xsl:with-param name="is-standalone" select="true()"/>
+                <xsl:with-param name="heading-level" select="2"/>
+            </xsl:apply-templates>
+        </xsl:with-param>
+    </xsl:apply-templates>
+    <!-- (3) A simple page that can be used in an iframe construction -->
+    <xsl:apply-templates select="." mode="create-iframe-page" />
+</xsl:template>
+
+</xsl:stylesheet>