@pretextbook/pretext-html 0.1.0

package/assets/xsl/tests/pretext-text-utilities-test.xsl

@@ -0,0 +1,334 @@
+<?xml version='1.0'?>
+
+<!--********************************************************************
+Copyright 2022 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/>.
+*********************************************************************-->
+
+<!-- Standalone testbed for pretext-text-utilities templates        -->
+<!-- Invoke this stylesheet on null.xml in the same folder:         -->
+<!-- xsltproc pretext-text-utilities-test.xsl null.xml              -->
+
+<!-- There are &LOWERCASE; and &UPPERCASE; entities  -->
+<!-- in the "file-extension" template (only?) -->
+<!DOCTYPE xsl:stylesheet [
+    <!ENTITY % entities SYSTEM "../entities.ent">
+    %entities;
+]>
+
+<!-- EXSL needed for token list template (only?) -->
+<xsl:stylesheet
+    xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"
+    xmlns:xml="http://www.w3.org/XML/1998/namespace"
+    xmlns:pi="http://pretextbook.org/2020/pretext/internal"
+    xmlns:str="http://exslt.org/strings"
+    xmlns:exsl="http://exslt.org/common"
+    xmlns:math="http://exslt.org/math"
+    xmlns:set="http://exslt.org/sets"
+    extension-element-prefixes="pi str math"
+>
+
+<!-- Allow serialization of XML in various contexts     -->
+<!-- See the XSL file for more info about Lenz' utility -->
+<xsl:import href="../pretext-text-utilities.xsl"/>
+
+<!-- Output helper -->
+<xsl:variable name="verbose-output" select="false()"/>
+
+<xsl:template name="assert-equal">
+  <xsl:param name="expected"/>
+  <xsl:param name="actual"/>
+  <xsl:param name="test-name"/>
+  <xsl:choose>
+    <xsl:when test="$expected = $actual">
+      <xsl:if test="$verbose-output">
+        <xsl:message>Test <xsl:value-of select="$test-name"/> passed.</xsl:message>
+      </xsl:if>
+    </xsl:when>
+    <xsl:otherwise>
+      <xsl:message>Test <xsl:value-of select="$test-name"/> failed: </xsl:message>
+      <xsl:message>  expected = "<xsl:value-of select="$expected"/>"  (<xsl:value-of select="exsl:object-type($expected)"/>)</xsl:message>
+      <xsl:message>  actual = "<xsl:value-of select="$actual"/>"  (<xsl:value-of select="exsl:object-type($actual)"/>)</xsl:message>
+    </xsl:otherwise>
+  </xsl:choose>
+</xsl:template>
+
+<!--========================================================================-->
+<!-- test count-pad-length-->
+<xsl:variable name="count-pad-length-0">
+  <xsl:variable name="test-val">
+    <xsl:call-template name="count-pad-length">
+      <xsl:with-param name="text" select="'a'"/>
+    </xsl:call-template>
+  </xsl:variable>
+  <xsl:call-template name="assert-equal">
+    <xsl:with-param name="expected" select="0"/>
+    <xsl:with-param name="actual" select="number($test-val)"/>
+    <xsl:with-param name="test-name" select="'count-pad-length-0'"/>
+  </xsl:call-template>
+</xsl:variable>
+
+<xsl:variable name="count-pad-length-2">
+  <xsl:variable name="test-val">
+    <xsl:call-template name="count-pad-length">
+      <xsl:with-param name="text" select="'  a'"/>
+    </xsl:call-template>
+  </xsl:variable>
+  <xsl:call-template name="assert-equal">
+    <xsl:with-param name="expected" select="2"/>
+    <xsl:with-param name="actual" select="number($test-val)"/>
+    <xsl:with-param name="test-name" select="'count-pad-length-2'"/>
+  </xsl:call-template>
+</xsl:variable>
+
+<xsl:variable name="count-pad-length-2-empty">
+  <xsl:variable name="test-val">
+    <xsl:call-template name="count-pad-length">
+      <xsl:with-param name="text" select="'  '"/>
+    </xsl:call-template>
+  </xsl:variable>
+  <xsl:call-template name="assert-equal">
+    <xsl:with-param name="expected" select="2"/>
+    <xsl:with-param name="actual" select="number($test-val)"/>
+    <xsl:with-param name="test-name" select="'count-pad-length-2'"/>
+  </xsl:call-template>
+</xsl:variable>
+
+<!--========================================================================-->
+<!-- test substring-after-last-->
+<xsl:variable name="substring-after-last-b1">
+  <xsl:variable name="test-val">
+    <xsl:call-template name="substring-after-last">
+      <xsl:with-param name="input" select="'aabcc'"/>
+      <xsl:with-param name="substr" select="'b'"/>
+    </xsl:call-template>
+  </xsl:variable>
+  <xsl:call-template name="assert-equal">
+    <xsl:with-param name="expected" select="'cc'"/>
+    <xsl:with-param name="actual" select="$test-val"/>
+    <xsl:with-param name="test-name" select="'substring-after-last-b1'"/>
+  </xsl:call-template>
+</xsl:variable>
+
+<xsl:variable name="substring-after-last-b2">
+  <xsl:variable name="test-val">
+    <xsl:call-template name="substring-after-last">
+      <xsl:with-param name="input" select="'aabccbcc'"/>
+      <xsl:with-param name="substr" select="'b'"/>
+    </xsl:call-template>
+  </xsl:variable>
+  <xsl:call-template name="assert-equal">
+    <xsl:with-param name="expected" select="'cc'"/>
+    <xsl:with-param name="actual" select="$test-val"/>
+    <xsl:with-param name="test-name" select="'substring-after-last-b2'"/>
+  </xsl:call-template>
+</xsl:variable>
+
+<xsl:variable name="substring-after-last-missing">
+  <xsl:variable name="test-val">
+    <xsl:call-template name="substring-after-last">
+      <xsl:with-param name="input" select="'aacc'"/>
+      <xsl:with-param name="substr" select="'b'"/>
+    </xsl:call-template>
+  </xsl:variable>
+  <xsl:call-template name="assert-equal">
+    <xsl:with-param name="expected" select="''"/>
+    <xsl:with-param name="actual" select="$test-val"/>
+    <xsl:with-param name="test-name" select="'substring-after-last-missing'"/>
+  </xsl:call-template>
+</xsl:variable>
+
+<xsl:variable name="substring-after-last-leading">
+  <xsl:variable name="test-val">
+    <xsl:call-template name="substring-after-last">
+      <xsl:with-param name="input" select="'baacc'"/>
+      <xsl:with-param name="substr" select="'b'"/>
+    </xsl:call-template>
+  </xsl:variable>
+  <xsl:call-template name="assert-equal">
+    <xsl:with-param name="expected" select="'aacc'"/>
+    <xsl:with-param name="actual" select="$test-val"/>
+    <xsl:with-param name="test-name" select="'substring-after-last-leading'"/>
+  </xsl:call-template>
+</xsl:variable>
+
+
+<!--========================================================================-->
+<!-- test substring-before-last-->
+<xsl:variable name="substring-before-last-b1">
+  <xsl:variable name="test-val">
+    <xsl:call-template name="substring-before-last">
+      <xsl:with-param name="input" select="'aabcc'"/>
+      <xsl:with-param name="substr" select="'b'"/>
+    </xsl:call-template>
+  </xsl:variable>
+  <xsl:call-template name="assert-equal">
+    <xsl:with-param name="expected" select="'aa'"/>
+    <xsl:with-param name="actual" select="$test-val"/>
+    <xsl:with-param name="test-name" select="'substring-before-last-b1'"/>
+  </xsl:call-template>
+</xsl:variable>
+
+<xsl:variable name="substring-before-last-b2">
+  <xsl:variable name="test-val">
+    <xsl:call-template name="substring-before-last">
+      <xsl:with-param name="input" select="'aabccbcc'"/>
+      <xsl:with-param name="substr" select="'b'"/>
+    </xsl:call-template>
+  </xsl:variable>
+  <xsl:call-template name="assert-equal">
+    <xsl:with-param name="expected" select="'aabcc'"/>
+    <xsl:with-param name="actual" select="$test-val"/>
+    <xsl:with-param name="test-name" select="'substring-before-last-b2'"/>
+  </xsl:call-template>
+</xsl:variable>
+
+<xsl:variable name="substring-before-last-missing">
+  <xsl:variable name="test-val">
+    <xsl:call-template name="substring-before-last">
+      <xsl:with-param name="input" select="'aacc'"/>
+      <xsl:with-param name="substr" select="'b'"/>
+    </xsl:call-template>
+  </xsl:variable>
+  <xsl:call-template name="assert-equal">
+    <xsl:with-param name="expected" select="''"/>
+    <xsl:with-param name="actual" select="$test-val"/>
+    <xsl:with-param name="test-name" select="'substring-before-last-missing'"/>
+  </xsl:call-template>
+</xsl:variable>
+
+<!--========================================================================-->
+<!-- test substring-after-preserve-->
+<xsl:variable name="substring-after-preserve-b1">
+  <xsl:variable name="test-val">
+    <xsl:call-template name="substring-after-preserve">
+      <xsl:with-param name="input" select="'aabcc'"/>
+      <xsl:with-param name="substr" select="'b'"/>
+    </xsl:call-template>
+  </xsl:variable>
+  <xsl:call-template name="assert-equal">
+    <xsl:with-param name="expected" select="'cc'"/>
+    <xsl:with-param name="actual" select="$test-val"/>
+    <xsl:with-param name="test-name" select="'substring-after-preserve-b1'"/>
+  </xsl:call-template>
+</xsl:variable>
+
+<xsl:variable name="substring-after-preserve-miss">
+  <xsl:variable name="test-val">
+    <xsl:call-template name="substring-after-preserve">
+      <xsl:with-param name="input" select="'aacc'"/>
+      <xsl:with-param name="substr" select="'b'"/>
+    </xsl:call-template>
+  </xsl:variable>
+  <xsl:call-template name="assert-equal">
+    <xsl:with-param name="expected" select="'aacc'"/>
+    <xsl:with-param name="actual" select="$test-val"/>
+    <xsl:with-param name="test-name" select="'substring-after-preserve-miss'"/>
+  </xsl:call-template>
+</xsl:variable>
+
+<xsl:variable name="substring-after-preserve-empty">
+  <xsl:variable name="test-val">
+    <xsl:call-template name="substring-after-preserve">
+      <xsl:with-param name="input" select="''"/>
+      <xsl:with-param name="substr" select="'b'"/>
+    </xsl:call-template>
+  </xsl:variable>
+  <xsl:call-template name="assert-equal">
+    <xsl:with-param name="expected" select="''"/>
+    <xsl:with-param name="actual" select="$test-val"/>
+    <xsl:with-param name="test-name" select="'substring-after-preserve-empty'"/>
+  </xsl:call-template>
+</xsl:variable>
+
+
+<!--========================================================================-->
+<!-- test left-align-text -->
+<xsl:variable name="align-left-first-line-shortest">
+  <xsl:variable name="test-val">
+    <xsl:call-template name="left-align-text">
+      <xsl:with-param name="text" select="'  Line one&#10;   Line two&#10;    Line three'"/>
+    </xsl:call-template>
+  </xsl:variable>
+  <xsl:call-template name="assert-equal">
+    <!-- 2/3/4 spaces should become 0/1/2 spaces -->
+    <xsl:with-param name="expected" select="'Line one&#10; Line two&#10;  Line three'"/>
+    <xsl:with-param name="actual" select="$test-val"/>
+    <xsl:with-param name="test-name" select="'align-left-first-line-shortest'"/>
+  </xsl:call-template>
+</xsl:variable>
+
+<xsl:variable name="align-left-other-line-shortest">
+  <xsl:variable name="test-val-rtf">
+    <xsl:call-template name="left-align-text">
+      <xsl:with-param name="text" select="'    Line one&#10; Line two&#10;  Line three'"/>
+    </xsl:call-template>
+  </xsl:variable>
+  <xsl:variable name="test-val">
+    <xsl:value-of select="$test-val-rtf"/>
+  </xsl:variable>
+  <xsl:call-template name="assert-equal">
+    <!-- 4/1/2 spaces should become 3/0/1 spaces -->
+    <xsl:with-param name="expected" select="'   Line one&#10;Line two&#10; Line three'"/>
+    <xsl:with-param name="actual" select="$test-val"/>
+    <xsl:with-param name="test-name" select="'align-left-other-line-shortest'"/>
+  </xsl:call-template>
+</xsl:variable>
+
+<xsl:variable name="align-left-no-indent">
+  <xsl:variable name="test-val-rtf">
+    <xsl:call-template name="left-align-text">
+      <xsl:with-param name="text" select="'  Line one&#10;Line two&#10;  Line three'"/>
+    </xsl:call-template>
+  </xsl:variable>
+  <xsl:variable name="test-val">
+    <xsl:value-of select="$test-val-rtf"/>
+  </xsl:variable>
+  <xsl:call-template name="assert-equal">
+    <!-- 2/0/2 spaces should become 2/0/2 spaces -->
+    <xsl:with-param name="expected" select="'  Line one&#10;Line two&#10;  Line three'"/>
+    <xsl:with-param name="actual" select="$test-val"/>
+    <xsl:with-param name="test-name" select="'align-left-no-indent'"/>
+  </xsl:call-template>
+</xsl:variable>
+
+<xsl:variable name="align-left-trailing-empty-preserved">
+  <xsl:variable name="test-val-rtf">
+    <xsl:call-template name="left-align-text">
+      <xsl:with-param name="text" select="'  Line one&#10;Line two&#10;  Line three&#10;'"/>
+    </xsl:call-template>
+  </xsl:variable>
+  <xsl:variable name="test-val">
+    <xsl:value-of select="$test-val-rtf"/>
+  </xsl:variable>
+  <xsl:call-template name="assert-equal">
+    <!-- 2/0/2 spaces should become 2/0/2 spaces -->
+    <xsl:with-param name="expected" select="'  Line one&#10;Line two&#10;  Line three&#10;'"/>
+    <xsl:with-param name="actual" select="$test-val"/>
+    <xsl:with-param name="test-name" select="'align-left-trailing-empty-preserved'"/>
+  </xsl:call-template>
+</xsl:variable>
+
+
+<!--========================================================================-->
+
+<!-- "main" -->
+<xsl:template match="/">
+  <xsl:message>Tests complete!</xsl:message>
+</xsl:template>
+
+</xsl:stylesheet>

package/assets/xsl/utilities/README.md

@@ -0,0 +1,31 @@
+# Utilities
+
+## Source-to-Source conversions
+
+For utility programs here which rewrite your source, be **sure** to use version control (collect and review changes on a branch, stash and drop undesirable outcomes), or have backups handy. The effects are not reversible. Stylesheets will output to standard output, so you can redirect their output, or you can use something like the `-o` flag on the `xsltproc` command-line invocation. Experiment first.
+
+### `fix-deprecations.xsl`
+
+This will convert any obsolete element names or constructions to their replacements. As deprecations are added, you may run it anew, and only the new changes will be applied. Despite the name, it does make some minor changes. Empty tags will get a single space prior to the closing backslash.
+
+Be sure to read all the details in the Author's Guide before using this on your source. Here is an absolute minimal example.
+
+```
+$ xsltproc /path/to/xsl/utilities/fix-deprecations.xsl -stringparam fix all /path/to/examples/sample-errors-and-warnings.xml > new-sample.xml
+
+$ diff /path/to/examples/sample-errors-and-warnings.xml new-sample.xml
+```
+
+(Updated: 2017-07-04)
+
+## Author Report
+
+`author-report.xsl` is a very simple stylesheet which will produce a text version of items in your source that could benefit from your attention. This is different than validating your PreTeXt source against the schema, but is part of using automated tools to ensure healthy source material.
+
+(Updated: 2018-12-09)
+
+## Intermediate Enhanced Source
+
+`pretext-enhanced-source.xsl` is mainly meant for development use. It outputs an XML file, which is not necessarily valid PreTeXt, at a key stage of the processing. It gives you a look under the hood (or bonnet). So generally not useful (or necessary) for authors.
+
+(Updated: 2020-02-25)

package/assets/xsl/utilities/author-report.xsl

@@ -0,0 +1,107 @@
+<?xml version='1.0'?> <!-- As XML file -->
+
+<!--********************************************************************
+Copyright 2018 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/>.
+*********************************************************************-->
+
+<!-- http://pimpmyxslt.com/articles/entity-tricks-part2/ -->
+<!DOCTYPE xsl:stylesheet [
+    <!ENTITY % entities SYSTEM "../entities.ent">
+    %entities;
+]>
+
+<!-- Identify as a stylesheet -->
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"
+    xmlns:xml="http://www.w3.org/XML/1998/namespace" >
+
+<!-- NB: (2020-06-07) xref/@provisional gets replaced by placeholder -->
+<!-- text in the "assembly" phase, so think carefully about whether  -->
+<!-- or not this stylesheet should run against orginal source or     -->
+<!-- enhanced source, they *are* different.                          -->
+
+<!-- Uses "strip-leading-whitespace" and more -->
+<!-- Standard conversion groundwork           -->
+<xsl:import href="../publisher-variables.xsl"/>
+<xsl:import href="../pretext-assembly.xsl"/>
+<xsl:import href="../pretext-common.xsl"/>
+
+<!-- ASCII output intended, consistent with -common -->
+<xsl:output method="text" />
+
+<!-- Generally, traverse the tree,                       -->
+<!-- looking for things to do                            -->
+<!-- http://stackoverflow.com/questions/3776333/         -->
+<!-- stripping-all-elements-except-one-in-xml-using-xslt -->
+<xsl:template match="@*|node()|comment()">
+    <xsl:apply-templates select="@*|node()|comment()"/>
+</xsl:template>
+
+<!-- ############## -->
+<!-- Entry Template -->
+<!-- ############## -->
+
+<xsl:template match="/">
+    <xsl:call-template name="converter-blurb-text"/>
+    <xsl:apply-templates select="$document-root" />
+</xsl:template>
+
+<!-- Headers, per division or structure -->
+<xsl:template match="&STRUCTURAL;">
+    <xsl:text>&#xa;**************************************&#xa;</xsl:text>
+    <xsl:apply-templates select="." mode="long-name" />
+    <xsl:text>&#xa;**************************************&#xa;</xsl:text>
+    <xsl:apply-templates select="*[not(self::subtitle)]|comment()"/>
+</xsl:template>
+
+<!-- Kill titles as metadata, but restore behavior on nodes to   -->
+<!-- allow the "long-name" template above to perform as intended -->
+<xsl:template match="title"/>
+<xsl:template match="title/node()">
+    <xsl:value-of select="." />
+</xsl:template>
+
+<!-- Looking for todo's and provisional citations, cross-references -->
+<!-- May need to abandon counting if conditions get more complex    -->
+
+<!-- This template comes close to doing the right thing, -->
+<!-- but is off by one (or more) in strange ways, so we  -->
+<!-- are not numbering the reported items                -->
+<xsl:template match="xref|comment()" mode="overall-number">
+    <xsl:number level="any" count="xref[@provisional]|comment()[translate(substring(normalize-space(string(.)), 1, 4), &UPPERCASE;, &LOWERCASE;) = 'todo']"/>
+</xsl:template>
+
+<xsl:template match="comment()[translate(substring(normalize-space(string(.)), 1, 4), &UPPERCASE;, &LOWERCASE;) = 'todo']">
+    <!-- <xsl:apply-templates select="." mode="overall-number"/> -->
+    <!-- <xsl:text>. </xsl:text> -->
+    <xsl:call-template name="strip-leading-whitespace">
+        <xsl:with-param name="text">
+            <xsl:value-of select="."/>
+        </xsl:with-param>
+    </xsl:call-template>
+    <xsl:text>&#xa;</xsl:text>
+</xsl:template>
+
+<xsl:template match="xref[@provisional]">
+    <!-- <xsl:apply-templates select="." mode="overall-number"/> -->
+    <!-- <xsl:text>.</xsl:text> -->
+    <xsl:text>xref: </xsl:text>
+    <xsl:value-of select="@provisional" />
+    <xsl:text>&#xa;</xsl:text>
+</xsl:template>
+
+</xsl:stylesheet>

package/assets/xsl/utilities/deprecate-autoname.sed

@@ -0,0 +1,18 @@
+# PreTeXt deprecations of xref/@autoname attribute
+# Robert Beezer, 2017-07-25
+
+# Sample usage on directory of *.xml files
+# Converts from current directory to "newdir" subdirectory
+#
+# for f in *.xml; do echo $f; sed -f mathbook/xsl/utilities/deprecate-autoname.sed $f > newdir/$f; done
+
+
+s/autoname="no"/text="global"/g
+s/autoname = "no"/text = "global"/g
+
+s/autoname="yes"/text="type-global"/g
+s/autoname = "yes"/text = "type-global"/g
+
+s/autoname="title"/text="title"/g
+s/autoname = "title"/text = "title"/g
+

package/assets/xsl/utilities/deprecate-index.sed

@@ -0,0 +1,33 @@
+# PreTeXt deprecations of index creation elements
+# Robert Beezer, 2017-07-14
+
+# Sample usage on directory of *.xml files
+# Converts from current directory to "newdir" subdirectory
+#
+# for f in *.xml; do echo $f; sed -f mathbook/xsl/utilities/deprecate-index.sed $f > newdir/$f; done
+
+
+# First, protect elements that begin with "index"
+# so "index" match below will not affect them
+s/<index-part/PARTPART/g
+s/<\/index-part>/PARTENDPARTEND/g
+s/<index-list/LISTLIST/g
+
+# index -> idx
+s/<index/<idx/g
+s/<\/index>/<\/idx>/g
+
+# main -> h
+s/<main/<h/g
+s/<\/main>/<\/h>/g
+
+# sub -> h
+# careful not to clobber <subsection>, etc.
+s/<sub /<h /g
+s/<sub>/<h>/g
+s/<\/sub>/<\/h>/g
+
+# Remove protection, convert to new elements
+s/PARTPART/<index/g
+s/PARTENDPARTEND/<\/index>/g
+s/LISTLIST/<index-list/g