@pretextbook/pretext-html 0.1.0

package/assets/xsl/pretext-sage-doctest.xsl

@@ -0,0 +1,289 @@
+<?xml version='1.0'?> <!-- As XML file -->
+
+<!-- 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"
+    xmlns:exsl="http://exslt.org/common"
+    xmlns:date="http://exslt.org/dates-and-times"
+    extension-element-prefixes="exsl date"
+>
+
+<!-- For numbers, titles, text utilities, etc -->
+<!-- Standard conversion groundwork           -->
+<xsl:import href="./publisher-variables.xsl"/>
+<xsl:import href="./pretext-assembly.xsl"/>
+<xsl:import href="./pretext-common.xsl"/>
+
+<!-- Intend output for Python docstring -->
+<xsl:output method="text" />
+
+<!-- Doctest files are Python (docstring) -->
+<xsl:variable name="file-extension" select="'.py'" />
+
+<!-- Set the chunking level variable for the routines in pretext-common.xsl. -->
+<!-- Default to zero, else use whatever an author specifies                  -->
+<xsl:variable name="chunk-level">
+    <xsl:choose>
+        <xsl:when test="$chunk-level-entered != ''">
+            <xsl:value-of select="$chunk-level-entered" />
+        </xsl:when>
+        <xsl:otherwise>
+            <xsl:text>0</xsl:text>
+        </xsl:otherwise>
+    </xsl:choose>
+</xsl:variable>
+
+<!-- ############## -->
+<!-- Entry Template -->
+<!-- ############## -->
+
+<xsl:template match="/">
+    <xsl:apply-templates select="$root"/>
+</xsl:template>
+
+<!-- We process structural nodes via chunking        -->
+<!-- routine in   xsl/pretext-common.xsl             -->
+<!-- The default templates there do everything       -->
+<!-- we need once we have "file-wrap" modal template -->
+<xsl:template match="/pretext">
+    <xsl:apply-templates mode="chunking" />
+</xsl:template>
+
+
+<!-- ########################## -->
+<!-- Default Element Processing -->
+<!-- ########################## -->
+
+<!-- Default is to just recurse into descendant elements            -->
+<!-- Ignoring text() nodes in mixed-content and mostly dead-end'ing -->
+<xsl:template match="*">
+    <xsl:apply-templates select="*" />
+</xsl:template>
+
+
+<!-- ####################### -->
+<!-- Sage Element Processing -->
+<!-- ####################### -->
+
+<!-- "Normal" Sage blocks, including "invisible" -->
+<!-- Form doctring/ReST verbatim block           -->
+<!-- for one input/output pair                   -->
+<!-- Filter limits to Sage language only         -->
+<xsl:template match="sage[(not(@type) or @type='full' or @type='invisible') and (not(@language) or @language='sage')]">
+    <xsl:text>~~~~~~~~~~~~~~~~~~~~~~ ::&#xA;&#xA;</xsl:text>
+    <xsl:apply-templates select="input" />
+    <xsl:apply-templates select="output" />
+    <xsl:text>&#xA;</xsl:text>
+</xsl:template>
+
+<!-- Kill anything else that has not matched -->
+<xsl:template match="sage" />
+
+<!-- Options to doctesting -->
+<!-- A property of the Sage element,         -->
+<!-- but employed in processing input        -->
+<!-- Returns: necessary string, no adornment -->
+<!-- TODO: simplify repeated strings -->
+<xsl:template match="sage" mode="doctest-marker">
+    <xsl:if test="@doctest">
+        <xsl:choose>
+            <xsl:when test="@doctest='random'">
+                <xsl:text>random</xsl:text>
+            </xsl:when>
+            <xsl:when test="@doctest='long time'">
+                <xsl:text>long time</xsl:text>
+            </xsl:when>
+            <xsl:when test="@doctest='not implemented'">
+                <xsl:text>not implemented</xsl:text>
+            </xsl:when>
+            <xsl:when test="@doctest='not tested'">
+                <xsl:text>not tested</xsl:text>
+            </xsl:when>
+            <xsl:when test="@doctest='known bug'">
+                <xsl:text>known bug</xsl:text>
+            </xsl:when>
+            <!-- absolute and relative floating point need literal tolerance -->
+            <xsl:when test="@doctest='absolute' or @doctest='relative'">
+                <xsl:choose>
+                    <xsl:when test="@doctest='absolute'">
+                        <xsl:text>absolute</xsl:text>
+                    </xsl:when>
+                    <xsl:when test="@doctest='relative'">
+                        <xsl:text>relative</xsl:text>
+                    </xsl:when>
+                </xsl:choose>
+                <xsl:text> tolerance </xsl:text>
+                <xsl:choose>
+                    <xsl:when test="@tolerance">
+                        <xsl:value-of select="@tolerance" />
+                    </xsl:when>
+                    <xsl:otherwise>
+                        <xsl:message>PTX:WARNING: '<xsl:value-of select="@doctest" /> tolerance' Sage doctest needs 'tolerance=' attribute</xsl:message>
+                    </xsl:otherwise>
+                </xsl:choose>
+            </xsl:when>
+            <!-- 'optional' indicates an optional package is needed for the test -->
+            <xsl:when test="@doctest='optional'">
+                <xsl:text>optional</xsl:text>
+                <xsl:choose>
+                    <xsl:when test="@package">
+                        <xsl:text>: </xsl:text>
+                        <xsl:value-of select="@package" />
+                    </xsl:when>
+                    <xsl:otherwise>
+                        <xsl:message>PTX:WARNING: 'optional' Sage doctest missing package, supply a 'package=' attribute</xsl:message>
+                    </xsl:otherwise>
+                </xsl:choose>
+            </xsl:when>
+        </xsl:choose>
+    </xsl:if>
+</xsl:template>
+
+<!-- NB: input and output can appear in "program", etc -->
+<!-- so templates below must be specific enough        -->
+
+<!-- Sanitize input block       -->
+<!-- Add in 4-space indentation -->
+<!-- and Sage prompts, then     -->
+<!-- add Sage doctest markers   -->
+<xsl:template match="sage/input">
+    <xsl:variable name="input-block">
+        <xsl:call-template name="prepend-prompt">
+            <xsl:with-param name="text">
+                <xsl:call-template name="sanitize-text" >
+                    <xsl:with-param name="text" select="." />
+                </xsl:call-template>
+            </xsl:with-param>
+        </xsl:call-template>
+    </xsl:variable>
+    <!-- Construct an option marker, perhaps empty -->
+    <xsl:variable name="doctest-marker">
+        <xsl:apply-templates select=".." mode="doctest-marker" />
+    </xsl:variable>
+    <xsl:choose>
+        <xsl:when test="$doctest-marker!=''">
+            <!-- Locate pieces relative to: end of first line of last input command -->
+            <xsl:variable name="before-last-sage">
+                <xsl:call-template name="substring-before-last">
+                    <xsl:with-param name="input"  select="$input-block" />
+                    <xsl:with-param name="substr" select="'sage:'" />
+                </xsl:call-template>
+            </xsl:variable>
+            <xsl:variable name="after-last-sage">
+                <xsl:call-template name="substring-after-last">
+                    <xsl:with-param name="input"  select="$input-block" />
+                    <xsl:with-param name="substr" select="'sage:'" />
+                </xsl:call-template>
+            </xsl:variable>
+            <xsl:variable name="before-eol" select="substring-before($after-last-sage, '&#xa;')" />
+            <xsl:variable name="after-eol"  select="substring-after($after-last-sage, '&#xa;')" />
+            <!-- Back in its box, with markers and doctest marker -->
+            <xsl:value-of select="$before-last-sage" />
+            <xsl:text>sage:</xsl:text>
+            <xsl:value-of select="$before-eol" />
+            <xsl:text>   # </xsl:text>
+            <xsl:value-of select="$doctest-marker" />
+            <xsl:text>&#xa;</xsl:text>
+            <xsl:value-of select="$after-eol" />
+        </xsl:when>
+        <xsl:otherwise>
+            <xsl:value-of select="$input-block" />
+        </xsl:otherwise>
+    </xsl:choose>
+</xsl:template>
+
+<!-- Sanitize output block      -->
+<!-- Add in 4-space indentation -->
+<xsl:template match="sage/output">
+    <xsl:call-template name="add-indentation">
+        <xsl:with-param name="text">
+            <xsl:call-template name="sanitize-text" >
+                <xsl:with-param name="text" select="." />
+            </xsl:call-template>
+        </xsl:with-param>
+        <xsl:with-param name="indent" select="'    '" />
+    </xsl:call-template>
+</xsl:template>
+
+<!-- Doctest specific template, others are in common XSL file -->
+<xsl:template name="prepend-prompt">
+    <xsl:param name="text" />
+    <!-- Just quit when string becomes empty -->
+    <xsl:if test="string-length($text)">
+        <xsl:variable name="first-line" select="substring-before($text, '&#xA;')" />
+        <xsl:choose>
+            <!-- blank lines are treated as continuation -->
+            <!-- could be important content of triply-quoted strings? -->
+            <!-- no harm if really just spacing at totally out-dented level? -->
+            <xsl:when test="not(string-length($first-line))">
+                <xsl:text>    ....: </xsl:text>
+            </xsl:when>
+            <!-- leading blank indicates continuation -->
+            <xsl:when test="substring($first-line,1,1)=' '">
+                <xsl:text>    ....: </xsl:text>
+            </xsl:when>
+            <!-- otherwise, totally outdented, needs sage prompt -->
+            <xsl:otherwise>
+                <xsl:text>    sage: </xsl:text>
+            </xsl:otherwise>
+        </xsl:choose>
+        <xsl:value-of select="$first-line"/>
+        <xsl:text>&#xA;</xsl:text>
+        <!-- recursive call on remainder of string -->
+        <xsl:call-template name="prepend-prompt">
+            <xsl:with-param name="text" select="substring-after($text, '&#xA;')"/>
+        </xsl:call-template>
+    </xsl:if>
+</xsl:template>
+
+<!-- ################# -->
+<!-- File Construction -->
+<!-- ################# -->
+
+<xsl:template match="&STRUCTURAL;" mode="file-wrap">
+    <xsl:param name="content" />
+    <xsl:if test="$content!=''">
+        <xsl:variable name="filename">
+            <xsl:apply-templates select="." mode="containing-filename" />
+        </xsl:variable>
+        <exsl:document href="{$filename}" method="text">
+            <xsl:call-template name="doctest-file-header" />
+            <xsl:text>## </xsl:text>
+            <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="." mode="title-full" />
+            <xsl:text>&#xa;</xsl:text>
+            <xsl:text>##&#xa;</xsl:text>
+            <xsl:text>r"""&#xa;</xsl:text>
+            <xsl:value-of select="$content" />
+            <xsl:text>"""&#xa;</xsl:text>
+        </exsl:document>
+    </xsl:if>
+</xsl:template>
+
+<xsl:template name="doctest-file-header">
+    <xsl:text>##          Sage Doctest File         ##&#xa;</xsl:text>
+    <xsl:call-template name="converter-blurb-python" />
+    <xsl:text>##&#xa;</xsl:text>
+    <xsl:text>## To execute doctests in these files, run&#xa;</xsl:text>
+    <xsl:text>##   $ $SAGE_ROOT/sage -t &lt;directory-of-these-files&gt;&#xa;</xsl:text>
+    <xsl:text>## or&#xa;</xsl:text>
+    <xsl:text>##   $ $SAGE_ROOT/sage -t &lt;a-single-file&gt;&#xa;</xsl:text>
+    <xsl:text>##&#xa;</xsl:text>
+    <xsl:text>## Replace -t by "-tp n" for parallel testing,&#xa;</xsl:text>
+    <xsl:text>##   "-tp 0" will use a sensible number of threads&#xa;</xsl:text>
+    <xsl:text>##&#xa;</xsl:text>
+    <xsl:text>## See: http://www.sagemath.org/doc/developer/doctesting.html&#xa;</xsl:text>
+    <xsl:text>##   or run  $ $SAGE_ROOT/sage --advanced  for brief help&#xa;</xsl:text>
+    <xsl:text>##&#xa;</xsl:text>
+</xsl:template>
+
+</xsl:stylesheet>