@pretextbook/pretext-html 0.1.0

package/assets/xsl/pretext-text.xsl

@@ -0,0 +1,392 @@
+<?xml version='1.0'?>
+
+<!--********************************************************************
+Copyright 2018 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/>.
+*********************************************************************-->
+
+<!-- http://pimpmyxslt.com/articles/entity-tricks-part2/ -->
+<!DOCTYPE xsl:stylesheet [
+    <!ENTITY % entities SYSTEM "entities.ent">
+    %entities;
+]>
+
+<!-- Identify as a stylesheet -->
+<!-- We choose to not include a default namespace       -->
+<!-- (in particular  http://www.w3.org/1999/xhtml),     -->
+<!-- even if this complicates adding namespaces onto    -->
+<!-- derivatives, such as HTML destined for EPUB output -->
+<!-- xmlns="http://www.w3.org/1999/xhtml"               -->
+<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:date="http://exslt.org/dates-and-times"
+    xmlns:str="http://exslt.org/strings"
+    extension-element-prefixes="exsl date str"
+>
+
+<!-- Standard conversion groundwork -->
+<xsl:import href="./publisher-variables.xsl"/>
+<xsl:import href="./pretext-assembly.xsl"/>
+<xsl:import href="./pretext-common.xsl"/>
+
+<!-- This is a conversion to "plain" text.  Upon initiation it is mainly -->
+<!-- meant as a foundation for various simple conversions to things like -->
+<!-- doctests or JSON table-of-contents.  But it is designed as a "real" -->
+<!-- conversion.  But obviously, there are many PreTeXt constructions    -->
+<!-- which cannot be realized in text.                                   -->
+<!--                                                                     -->
+<!-- Goal is to make it so *no* conversion imports "pretext-common.xsl" -->
+<!-- since some foundational conversion (such as this one) can be the    -->
+<!-- basis of the conversion and will import the foundationa one instead.-->
+<!--                                                                     -->
+<!-- Initial work might be to implement certain characters as 7-bit      -->
+<!-- ASCII and as Unicode, under the control of a switch.  For example,  -->
+<!-- the "q" element could have dumb generic quotes or smart left and    -->
+<!-- right quotes.                                                       -->
+
+<xsl:output method="text"/>
+
+<!-- if chunking, this is the extension of the files produced -->
+<xsl:variable name="file-extension" select="'.txt'"/>
+
+
+<!-- Entry Template -->
+<!-- Kickstart the process, ignore "docinfo"  -->
+<xsl:template match="/">
+    <xsl:call-template name="banner-warning">
+        <xsl:with-param name="warning">Conversion to simple text is incomplete&#xa;But importing this stylesheet could be helpful for certain purposes&#xa;Override the entry template to make this warning go away</xsl:with-param>
+    </xsl:call-template>
+    <xsl:apply-templates select="$document-root"/>
+</xsl:template>
+
+<!-- TEMPORARY: defined to stop errors, need stubs in -common -->
+<xsl:template name="inline-warning"/>
+<xsl:template name="margin-warning"/>
+<xsl:template match="sage" mode="sage-active-markup"/>
+<xsl:template name="sage-display-markup"/>
+
+<!-- ######### -->
+<!-- Divisions -->
+<!-- ######### -->
+
+<xsl:template match="part|chapter|section|subsection|subsubsection|exercises|reading-questions|worksheet|handout|glossary|references|solutions">
+    <!-- empty line prior -->
+    <xsl:text>&#xa;</xsl:text>
+    <xsl:apply-templates select="." mode="type-name"/>
+    <xsl:text> </xsl:text>
+    <xsl:apply-templates select="." mode="number"/>
+    <!-- Title is required (or default is supplied) -->
+    <xsl:text> </xsl:text>
+    <xsl:apply-templates select="." mode="title-full"/>
+    <xsl:text>&#xa;</xsl:text>
+    <!-- metadata-ish, eg "title", should be killed by default -->
+    <xsl:apply-templates select="*"/>
+</xsl:template>
+
+<!-- ################ -->
+<!-- Cross-References -->
+<!-- ################ -->
+
+<!-- Nothing fancy (like in LaTeX conversion) for  -->
+<!-- the number of the target of a cross-reference -->
+<xsl:template match="*" mode="xref-number">
+    <xsl:apply-templates select="." mode="number"/>
+</xsl:template>
+
+<!-- No good way to link/direct to target, so we just   -->
+<!-- parrot the text produced typically for a clickable -->
+<xsl:template match="xref" mode="xref-link">
+    <xsl:param name="target"/>
+    <xsl:param name="content"/>
+
+    <xsl:value-of select="$content"/>
+</xsl:template>
+
+<!-- Characters -->
+
+<!-- Idea: variables from "choose" on $text.encoding variable      -->
+<!-- to use cheap ASCII versions (or stand-ins, like [PER-MILLE]), -->
+<!-- versus more realistic Unicode versions                        -->
+
+<!-- N.B. Quotation marks are localized by language in other       -->
+<!-- conversions (HTML, LaTeX) and skipped in other conversions    -->
+<!-- (braille).  They would likely need to use Unicode characters  -->
+<!-- like  «, »  rather than cheap 7-bit ASCII versions, like      -->
+<!-- <<, >>.  So this would force the issue of a Unicode (8-bit    -->
+<!-- and more-than) switch and supporting that.  So as of          -->
+<!-- 2026-02-18 we are punting.                                    -->
+
+<!-- ASCII we just use a regular space -->
+<xsl:template name="nbsp-character">
+    <xsl:text> </xsl:text>
+</xsl:template>
+
+<xsl:template name="ndash-character">
+    <xsl:text>-</xsl:text>
+</xsl:template>
+
+<xsl:template name="mdash-character">
+    <xsl:text>-</xsl:text>
+</xsl:template>
+
+<!-- The abstract template for "mdash" consults a publisher option -->
+<!-- for thin space, or no space, surrounding an em-dash.  So the  -->
+<!-- "thin-space-character" is needed for that purpose, and does   -->
+<!-- not have an associated empty PTX element.                     -->
+
+<!-- ASCII we just use a full space -->
+<xsl:template name="thin-space-character">
+    <xsl:text> </xsl:text>
+</xsl:template>
+
+<xsl:template match="*" mode="lsq-character">
+    <xsl:text>'</xsl:text>
+</xsl:template>
+
+<xsl:template match="*" mode="rsq-character">
+    <xsl:text>'</xsl:text>
+</xsl:template>
+
+<xsl:template match="*" mode="lq-character">
+    <xsl:text>"</xsl:text>
+</xsl:template>
+
+<xsl:template match="*" mode="rq-character">
+    <xsl:text>"</xsl:text>
+</xsl:template>
+
+<xsl:template name="ellipsis-character">
+    <xsl:text>...</xsl:text>
+</xsl:template>
+
+<!-- Math -->
+<!-- Until we think of something better, we just -->
+<!-- bracket raw LaTeX that appears inline       -->
+<!-- This can be overridden, if necessary        -->
+<xsl:template name="inline-math-wrapper">
+    <xsl:param name="math"/>
+    <xsl:text>[</xsl:text>
+    <xsl:value-of select="$math"/>
+    <xsl:text>]</xsl:text>
+</xsl:template>
+
+<xsl:template match="p">
+    <!-- space with a blank line if not -->
+    <!-- first in a structured element  -->
+    <!-- barring metadata-ish           -->
+    <xsl:if test="preceding-sibling::*[not(self::title)]">
+        <xsl:text>&#xa;</xsl:text>
+    </xsl:if>
+    <!-- mixed-content -->
+    <xsl:apply-templates/>
+    <!-- end onto a newline -->
+    <xsl:text>&#xa;</xsl:text>
+</xsl:template>
+
+<!-- ############ -->
+<!-- Environments -->
+<!-- ############ -->
+
+<xsl:template match="&REMARK-LIKE;">
+    <!-- space with a blank line if not -->
+    <!-- first in a structured element  -->
+    <!-- barring metadata-ish           -->
+    <xsl:if test="preceding-sibling::*[not(self::title)]">
+        <xsl:text>&#xa;</xsl:text>
+    </xsl:if>
+    <xsl:apply-templates select="." mode="type-name"/>
+    <xsl:text> </xsl:text>
+    <xsl:apply-templates select="." mode="number"/>
+    <xsl:if test="title">
+        <xsl:text> </xsl:text>
+        <xsl:apply-templates select="." mode="title-full"/>
+    </xsl:if>
+    <xsl:text>&#xa;</xsl:text>
+    <!-- structured -->
+    <xsl:apply-templates select="*"/>
+</xsl:template>
+
+<xsl:template match="&EXAMPLE-LIKE;">
+    <!-- space with a blank line if not -->
+    <!-- first in a structured element  -->
+    <!-- barring metadata-ish           -->
+    <xsl:if test="preceding-sibling::*[not(self::title)]">
+        <xsl:text>&#xa;</xsl:text>
+    </xsl:if>
+    <xsl:apply-templates select="." mode="type-name"/>
+    <xsl:text> </xsl:text>
+    <xsl:apply-templates select="." mode="number"/>
+    <xsl:if test="title">
+        <xsl:text> </xsl:text>
+        <xsl:apply-templates select="." mode="title-full"/>
+    </xsl:if>
+    <xsl:text>&#xa;</xsl:text>
+    <xsl:choose>
+        <xsl:when test="statement">
+            <xsl:apply-templates select="statement"/>
+            <xsl:apply-templates select="&SOLUTION-LIKE;"/>
+        </xsl:when>
+        <xsl:otherwise>
+            <xsl:apply-templates select="*[self::hint|self::answer|self::solution]"/>
+        </xsl:otherwise>
+    </xsl:choose>
+</xsl:template>
+
+<xsl:template match="&THEOREM-LIKE;">
+    <!-- space with a blank line if not -->
+    <!-- first in a structured element  -->
+    <!-- barring metadata-ish           -->
+    <xsl:if test="preceding-sibling::*[not(self::title)]">
+        <xsl:text>&#xa;</xsl:text>
+    </xsl:if>
+    <xsl:apply-templates select="." mode="type-name"/>
+    <xsl:text> </xsl:text>
+    <xsl:apply-templates select="." mode="number"/>
+    <xsl:if test="title">
+        <xsl:text> </xsl:text>
+        <xsl:apply-templates select="." mode="title-full"/>
+    </xsl:if>
+    <xsl:text>&#xa;</xsl:text>
+    <xsl:choose>
+        <xsl:when test="statement">
+            <xsl:apply-templates select="statement"/>
+            <xsl:apply-templates select="&PROOF-LIKE;"/>
+        </xsl:when>
+        <xsl:otherwise>
+            <xsl:apply-templates select="*"/>
+        </xsl:otherwise>
+    </xsl:choose>
+</xsl:template>
+
+<!-- General-purpose container, we  -->
+<!-- do not enforce possibilities -->
+<xsl:template match="statement">
+    <!-- structured -->
+    <xsl:apply-templates select="*"/>
+</xsl:template>
+
+<!-- THEOREM-LIKE only -->
+<xsl:template match="&PROOF-LIKE;">
+    <xsl:apply-templates select="." mode="type-name"/>
+    <xsl:text>.&#xa;</xsl:text>
+    <!-- structured -->
+    <xsl:apply-templates select="*"/>
+</xsl:template>
+
+<!-- ######### -->
+<!-- Exercises -->
+<!-- ######### -->
+
+<xsl:template match="exercise">
+    <!-- space with a blank line if not -->
+    <!-- first in a structured element  -->
+    <!-- barring metadata-ish           -->
+    <xsl:if test="preceding-sibling::*[not(self::title)]">
+        <xsl:text>&#xa;</xsl:text>
+    </xsl:if>
+    <xsl:apply-templates select="." mode="serial-number"/>
+    <xsl:text>.</xsl:text>
+    <xsl:if test="title">
+        <xsl:text> (</xsl:text>
+        <xsl:apply-templates select="." mode="title-full"/>
+        <xsl:text>)</xsl:text>
+    </xsl:if>
+    <xsl:text> </xsl:text>
+    <xsl:choose>
+        <xsl:when test="statement">
+            <xsl:apply-templates select="statement"/>
+            <xsl:apply-templates select="&SOLUTION-LIKE;"/>
+        </xsl:when>
+        <xsl:otherwise>
+            <xsl:apply-templates select="*[self::hint|self::answer|self::solution]"/>
+        </xsl:otherwise>
+    </xsl:choose>
+</xsl:template>
+
+<xsl:template match="&SOLUTION-LIKE;">
+    <xsl:apply-templates select="." mode="type-name"/>
+    <xsl:variable name="the-number">
+        <xsl:apply-templates select="." mode="non-singleton-number" />
+    </xsl:variable>
+    <!-- An empty value means element is a singleton -->
+    <!-- else the serial number comes through        -->
+    <xsl:if test="not($the-number = '')">
+        <xsl:text> </xsl:text>
+        <xsl:apply-templates select="." mode="serial-number" />
+    </xsl:if>
+    <xsl:text>. </xsl:text>
+    <xsl:apply-templates select="*"/>
+    <!-- not needed if structured -->
+    <xsl:text>&#xa;</xsl:text>
+</xsl:template>
+
+<!-- ############### -->
+<!-- Captioned Items -->
+<!-- ############### -->
+
+<xsl:template match="figure">
+    <!-- space with a blank line if not -->
+    <!-- first in a structured element  -->
+    <!-- barring metadata-ish           -->
+    <xsl:if test="preceding-sibling::*[not(self::title)]">
+        <xsl:text>&#xa;</xsl:text>
+    </xsl:if>
+    <xsl:apply-templates select="." mode="type-name"/>
+    <xsl:text> </xsl:text>
+    <xsl:apply-templates select="." mode="number"/>
+    <xsl:text>: </xsl:text>
+    <xsl:apply-templates select="caption"/>
+    <xsl:text>&#xa;</xsl:text>
+</xsl:template>
+
+<xsl:template match="caption">
+    <!-- mixed-content -->
+    <xsl:apply-templates/>
+</xsl:template>
+
+<!-- ##### -->
+<!-- Lists -->
+<!-- ##### -->
+
+<xsl:template match="ul|ol|dl">
+    <xsl:text>&#xa;</xsl:text>
+    <xsl:apply-templates select="li"/>
+</xsl:template>
+
+<xsl:template match="ol/li">
+    <xsl:apply-templates select="." mode="serial-number"/>
+    <xsl:text>. </xsl:text>
+    <xsl:apply-templates/>
+    <xsl:text>&#xa;</xsl:text>
+</xsl:template>
+
+<xsl:template match="ul/li">
+    <xsl:text>* </xsl:text>
+    <xsl:apply-templates/>
+    <xsl:text>&#xa;</xsl:text>
+</xsl:template>
+
+<xsl:template match="dl/li">
+    <xsl:apply-templates select="." mode="title-full"/>
+    <xsl:text> </xsl:text>
+    <xsl:apply-templates/>
+    <xsl:text>&#xa;</xsl:text>
+</xsl:template>
+
+</xsl:stylesheet>

package/assets/xsl/pretext-units.xsl

@@ -0,0 +1,195 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<xsl:stylesheet version="1.0"
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+
+<!--********************************************************************
+Copyright 2013 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 file contains unit-related abbreviations, such as 'kilo' => 'k'           -->
+<!-- and 'meter' => 'm'. These are used by the quantity/unit and quantity/per       -->
+<!-- elements for HMTL output, and possibly other places in the future.             -->
+<!-- For tex, the siunitx package knows \kilo, \meter, etc. If there is a unit      -->
+<!-- that siunitx does not know, the abbreviations here are used to add it to       -->
+<!-- the preamble.                                                                  -->
+<!-- Future enhancements (which maybe happen in other stylesheets, not here):       -->
+<!-- 1. If MathJax siunitx extension is functional, start using it for HTML.        -->
+<!-- 2. Make use of siunitx's \of{}.                                                -->
+<!-- 3. Create a docinfo element that adds custom units.                            -->
+
+<!-- Unit prefixes (the prefix attribute in a unit or per tag)                      -->
+<!-- SI prefixes                                                                    -->
+<xsl:variable name="prefixes">
+    <prefix full='yocto'                short='y'/>
+    <prefix full='zepto'                short='z'/>
+    <prefix full='atto'                 short='a'/>
+    <prefix full='femto'                short='f'/>
+    <prefix full='pico'                 short='p'/>
+    <prefix full='nano'                 short='n'/>
+    <prefix full='micro'                short='&#xb5;'/>
+    <prefix full='milli'                short='m'/>
+    <prefix full='centi'                short='c'/>
+    <prefix full='deci'                 short='d'/>
+    <prefix full='deca'                 short='da'/>
+    <prefix full='deka'                 short='da'/>
+    <prefix full='hecto'                short='h'/>
+    <prefix full='kilo'                 short='k'/>
+    <prefix full='mega'                 short='M'/>
+    <prefix full='giga'                 short='G'/>
+    <prefix full='tera'                 short='T'/>
+    <prefix full='peta'                 short='P'/>
+    <prefix full='exa'                  short='E'/>
+    <prefix full='zetta'                short='Z'/>
+    <prefix full='yotta'                short='Y'/>
+</xsl:variable>
+
+
+<!-- Unit bases  (the base attribute in a unit or per tag)                          -->
+<xsl:variable name="bases">
+<!-- SI fundamental units                                                           -->
+    <base full='ampere'                 short='A'/>
+    <base full='candela'                short='cd'/>
+    <base full='kelvin'                 short='K'/>
+    <base full='gram'                   short='g'/>
+    <base full='meter'                  short='m'/>
+    <base full='metre'                  short='m'/>
+    <base full='mole'                   short='mol'/>
+    <base full='second'                 short='s'/>
+
+<!-- SI derived units and non-SI units with a simple relationship to SI units       -->
+    <!-- Radioactivity                                                              -->
+    <base full='becquerel'              short='Bq'/>
+    <base full='gray'                   short='Gy'/>
+    <base full='sievert'                short='Sv'/>
+
+    <!-- Temperature                                                                -->
+    <base full='degreeCelsius'          short='&#176;C'/>
+    <base full='celsius'                short='&#176;C'/>
+
+    <!-- Elecro-magnetic                                                            -->
+    <base full='coulomb'                short='C'/>
+    <base full='henry'                  short='H'/>
+    <base full='ohm'                    short='&#8486;'/>
+    <base full='siemens'                short='S'/>
+    <base full='tesla'                  short='T'/>
+    <base full='volt'                   short='V'/>
+    <base full='electronvolt'           short='eV'/>
+    <base full='weber'                  short='Wb'/>
+
+    <!-- Frequency and Catalytic Activity                                           -->
+    <base full='hertz'                  short='Hz'/>
+    <base full='katal'                  short='kat'/>
+
+    <!-- Energy, Work, Power, Force                                                 -->
+    <base full='joule'                  short='J'/>
+    <base full='newton'                 short='N'/>
+    <base full='pascal'                 short='Pa'/>
+    <base full='watt'                   short='W'/>
+
+    <!-- Candela-related                                                            -->
+    <base full='lumen'                  short='lm'/>
+    <base full='lux'                    short='lx'/>
+
+    <!-- Angle (2D and 3D)                                                          -->
+    <base full='radian'                 short='rad'/>
+    <base full='steradian'              short='sr'/>
+    <base full='degree'                 short='&#176;'/>
+    <base full='arcminute'              short='&#8242;'/>
+    <base full='arcsecond'              short='&#8243;'/>
+
+    <!-- Time                                                                       -->
+    <base full='day'                    short='d'/>
+    <base full='hour'                   short='h'/>
+    <base full='minute'                 short='min'/>
+
+    <!-- Area                                                                       -->
+    <base full='hectare'                short='ha'/>
+
+    <!-- Volume                                                                     -->
+    <base full='liter'                  short='L'/>
+    <base full='litre'                  short='l'/>
+
+    <!-- Mass                                                                       -->
+    <base full='tonne'                  short='t'/>
+
+    <!-- Percent                                                                    -->
+    <base full='percent'                short='&#37;'/>
+
+<!-- completely non-SI units; these are not part of the siunitx package, so they    -->
+<!-- need siunitx='none'. The value of 'short' will be used as the macro output,    -->
+<!-- unless something else is specified. This is necessary if the value of 'short'  -->
+<!-- has unusual characters, as with Fahrenheit below.                              -->
+    <!-- Temperature                                                                -->
+    <base full='degreeFahrenheit'       short='&#176;F'     siunitx='\SIUnitSymbolDegree{F}' />
+    <base full='fahrenheit'             short='&#176;F'     siunitx='\degreeFahrenheit'      />
+
+    <!-- Weight, Force                                                              -->
+    <base full='pound'                  short='lb'          siunitx='none' />
+    <base full='ounce'                  short='oz'          siunitx='none' />
+    <base full='ton'                    short='T'           siunitx='none' />
+
+    <!-- Length                                                                     -->
+    <base full='foot'                   short='ft'          siunitx='none' />
+    <base full='inch'                   short='in'          siunitx='none' />
+    <base full='yard'                   short='yd'          siunitx='none' />
+    <base full='mile'                   short='mi'          siunitx='none' />
+
+    <!-- Time                                                                       -->
+    <base full='millennium'             short='millennium'  siunitx='none' />
+    <base full='century'                short='century'     siunitx='none' />
+    <base full='decade'                 short='decade'      siunitx='none' />
+    <base full='year'                   short='yr'          siunitx='none' />
+    <base full='month'                  short='mo'          siunitx='none' />
+    <base full='week'                   short='wk'          siunitx='none' />
+
+    <!-- Speed                                                                      -->
+    <base full='kilometerperhour'       short='kph'         siunitx='none' />
+    <base full='kilometreperhour'       short='kph'         siunitx='none' />
+    <base full='mileperhour'            short='mph'         siunitx='none' />
+
+    <!-- Volume                                                                     -->
+    <base full='gallon'                 short='gal'         siunitx='none' />
+    <base full='cubiccentimeter'        short='cc'          siunitx='none' />
+    <base full='tablespoon'             short='tbsp'        siunitx='none' />
+    <base full='teaspoon'               short='tsp'         siunitx='none' />
+    <base full='cup'                    short='c'           siunitx='none' />
+    <base full='pint'                   short='pt'          siunitx='none' />
+    <base full='quart'                  short='qt'          siunitx='none' />
+    <base full='fluidounce'             short='fl&#8239;oz'  siunitx='none' />
+
+    <!-- Distance per Volume                                                        -->
+    <base full='milepergallon'          short='mpg'         siunitx='none' />
+    <base full='kilometerpergallon'     short='kpg'         siunitx='none' />
+
+    <!-- Frequency and Catalytic Activity                                           -->
+    <base full='revolution'             short='rev'         siunitx='none' />
+    <base full='revolutionperminute'    short='rpm'         siunitx='none' />
+    <base full='cycle'                  short='cycle'       siunitx='none' />
+
+    <!-- Storage, Memory, and Transfer Rate                                         -->
+    <base full='bit'                    short='b'           siunitx='none' />
+    <base full='byte'                   short='B'           siunitx='none' />
+    <base full='bitpersecond'           short='bps'         siunitx='none' />
+    <base full='bytepersecond'          short='Bps'         siunitx='none' />
+
+</xsl:variable>
+
+
+
+</xsl:stylesheet>