@pretextbook/pretext-html 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (106) hide show
  1. package/README.md +104 -4
  2. package/assets/preview-html.xsl +230 -230
  3. package/assets/upstream.json +7 -7
  4. package/assets/xsl/entities.ent +154 -154
  5. package/assets/xsl/extract-asymptote.xsl +68 -68
  6. package/assets/xsl/extract-biblio-csl.xsl +327 -327
  7. package/assets/xsl/extract-datafile.xsl +71 -71
  8. package/assets/xsl/extract-dynamic.xsl +139 -139
  9. package/assets/xsl/extract-identity.xsl +136 -136
  10. package/assets/xsl/extract-interactive.xsl +81 -81
  11. package/assets/xsl/extract-latex-image.xsl +118 -118
  12. package/assets/xsl/extract-mermaid.xsl +58 -58
  13. package/assets/xsl/extract-mom.xsl +63 -63
  14. package/assets/xsl/extract-pg.xsl +2897 -2897
  15. package/assets/xsl/extract-prefigure.xsl +157 -157
  16. package/assets/xsl/extract-qrcode.xsl +100 -100
  17. package/assets/xsl/extract-runestone-page-template.xsl +139 -139
  18. package/assets/xsl/extract-sageplot.xsl +166 -166
  19. package/assets/xsl/extract-stack.xsl +56 -56
  20. package/assets/xsl/extract-trace.xsl +134 -134
  21. package/assets/xsl/extract-youtube.xsl +63 -63
  22. package/assets/xsl/html-symbols.xsl +3344 -3344
  23. package/assets/xsl/latex/pretext-latex-AIM.xsl +56 -56
  24. package/assets/xsl/latex/pretext-latex-CLP.xsl +148 -148
  25. package/assets/xsl/latex/pretext-latex-chaos.xsl +317 -317
  26. package/assets/xsl/latex/pretext-latex-dyslexic-font.xsl +76 -76
  27. package/assets/xsl/latex/pretext-latex-guide.xsl +104 -104
  28. package/assets/xsl/latex/pretext-latex-texstyle.xsl +862 -862
  29. package/assets/xsl/localizations/af-ZA.xml +276 -276
  30. package/assets/xsl/localizations/bg-BG.xml +276 -276
  31. package/assets/xsl/localizations/ca-ES.xml +285 -285
  32. package/assets/xsl/localizations/cs-CZ.xml +280 -280
  33. package/assets/xsl/localizations/de-DE.xml +281 -281
  34. package/assets/xsl/localizations/en-US.xml +427 -427
  35. package/assets/xsl/localizations/es-ES.xml +287 -287
  36. package/assets/xsl/localizations/fi-FI.xml +275 -275
  37. package/assets/xsl/localizations/fr-CA.xml +276 -276
  38. package/assets/xsl/localizations/fr-FR.xml +280 -280
  39. package/assets/xsl/localizations/hu-HU.xml +280 -280
  40. package/assets/xsl/localizations/it-IT.xml +276 -276
  41. package/assets/xsl/localizations/ku-CKB.xml +275 -275
  42. package/assets/xsl/localizations/localizations.xml +48 -48
  43. package/assets/xsl/localizations/nl-NL.xml +275 -275
  44. package/assets/xsl/localizations/pt-BR.xml +288 -288
  45. package/assets/xsl/localizations/pt-PT.xml +292 -292
  46. package/assets/xsl/localizations/zh-HANS.xml +269 -269
  47. package/assets/xsl/pretext-assembly.xsl +4795 -4795
  48. package/assets/xsl/pretext-basic-html.xsl +86 -86
  49. package/assets/xsl/pretext-beamer.xsl +662 -662
  50. package/assets/xsl/pretext-braille-preprint.xsl +2249 -2249
  51. package/assets/xsl/pretext-common.xsl +12018 -12018
  52. package/assets/xsl/pretext-dynamic.xsl +65 -65
  53. package/assets/xsl/pretext-epub.xsl +1483 -1483
  54. package/assets/xsl/pretext-fo.xsl +4593 -4593
  55. package/assets/xsl/pretext-html.xsl +14791 -14791
  56. package/assets/xsl/pretext-json-manifest.xsl +150 -150
  57. package/assets/xsl/pretext-jupyter.xsl +868 -868
  58. package/assets/xsl/pretext-latex-classic.xsl +952 -952
  59. package/assets/xsl/pretext-latex-common.xsl +11563 -11563
  60. package/assets/xsl/pretext-latex.xsl +47 -47
  61. package/assets/xsl/pretext-litprog.xsl +105 -105
  62. package/assets/xsl/pretext-merge.xsl +41 -41
  63. package/assets/xsl/pretext-numbers.xsl +875 -875
  64. package/assets/xsl/pretext-revealjs.xsl +522 -522
  65. package/assets/xsl/pretext-runestone-fitb.xsl +1233 -1233
  66. package/assets/xsl/pretext-runestone-static.xsl +1438 -1438
  67. package/assets/xsl/pretext-runestone.xsl +3083 -3083
  68. package/assets/xsl/pretext-sage-doctest.xsl +289 -289
  69. package/assets/xsl/pretext-smc.xsl +492 -492
  70. package/assets/xsl/pretext-solution-manual-latex.xsl +323 -323
  71. package/assets/xsl/pretext-text-utilities.xsl +1217 -1217
  72. package/assets/xsl/pretext-text.xsl +392 -392
  73. package/assets/xsl/pretext-units.xsl +195 -195
  74. package/assets/xsl/pretext-view-source.xsl +157 -157
  75. package/assets/xsl/pretext-ww-problem-sets.xsl +391 -391
  76. package/assets/xsl/publisher-variables.xsl +4756 -4756
  77. package/assets/xsl/support/extract-math.xsl +256 -256
  78. package/assets/xsl/support/package-math.xsl +141 -141
  79. package/assets/xsl/support/play-button/play-button.svg +3 -3
  80. package/assets/xsl/support/pretext-pg-macros.xsl +110 -110
  81. package/assets/xsl/support/webpack_static_imports.xml +14 -14
  82. package/assets/xsl/tests/null.xml +3 -3
  83. package/assets/xsl/tests/pretext-text-utilities-test.xsl +333 -333
  84. package/assets/xsl/utilities/author-report.xsl +107 -107
  85. package/assets/xsl/utilities/deprecate-autoname.sed +18 -18
  86. package/assets/xsl/utilities/deprecate-index.sed +33 -33
  87. package/assets/xsl/utilities/fix-deprecations.xsl +663 -663
  88. package/assets/xsl/utilities/pretext-enhanced-source.xsl +112 -112
  89. package/assets/xsl/utilities/report-publisher-variables.xsl +162 -162
  90. package/assets/xsl/xml-to-json.xsl +326 -326
  91. package/assets/xsl/xml-to-string.xsl +328 -328
  92. package/assets/xsl-bundle.json +1 -0
  93. package/dist/{cli-C6tfAVvi.js → cli-B2LiKunq.js} +268 -233
  94. package/dist/cli.js +1 -1
  95. package/dist/host.browser.d.ts +29 -0
  96. package/dist/host.d.ts +41 -0
  97. package/dist/index.browser.d.ts +29 -0
  98. package/dist/index.browser.js +650 -0
  99. package/dist/index.d.ts +5 -0
  100. package/dist/index.js +16 -8
  101. package/dist/internal/posix-path.d.ts +59 -0
  102. package/dist/mounts.d.ts +18 -0
  103. package/dist/renderer.d.ts +14 -1
  104. package/dist/theme.d.ts +68 -0
  105. package/dist/theme.js +93 -0
  106. package/package.json +22 -4
@@ -1,289 +1,289 @@
1
- <?xml version='1.0'?> <!-- As XML file -->
2
-
3
- <!-- http://pimpmyxslt.com/articles/entity-tricks-part2/ -->
4
- <!DOCTYPE xsl:stylesheet [
5
- <!ENTITY % entities SYSTEM "entities.ent">
6
- %entities;
7
- ]>
8
-
9
- <!-- Identify as a stylesheet -->
10
- <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"
11
- xmlns:xml="http://www.w3.org/XML/1998/namespace"
12
- xmlns:exsl="http://exslt.org/common"
13
- xmlns:date="http://exslt.org/dates-and-times"
14
- extension-element-prefixes="exsl date"
15
- >
16
-
17
- <!-- For numbers, titles, text utilities, etc -->
18
- <!-- Standard conversion groundwork -->
19
- <xsl:import href="./publisher-variables.xsl"/>
20
- <xsl:import href="./pretext-assembly.xsl"/>
21
- <xsl:import href="./pretext-common.xsl"/>
22
-
23
- <!-- Intend output for Python docstring -->
24
- <xsl:output method="text" />
25
-
26
- <!-- Doctest files are Python (docstring) -->
27
- <xsl:variable name="file-extension" select="'.py'" />
28
-
29
- <!-- Set the chunking level variable for the routines in pretext-common.xsl. -->
30
- <!-- Default to zero, else use whatever an author specifies -->
31
- <xsl:variable name="chunk-level">
32
- <xsl:choose>
33
- <xsl:when test="$chunk-level-entered != ''">
34
- <xsl:value-of select="$chunk-level-entered" />
35
- </xsl:when>
36
- <xsl:otherwise>
37
- <xsl:text>0</xsl:text>
38
- </xsl:otherwise>
39
- </xsl:choose>
40
- </xsl:variable>
41
-
42
- <!-- ############## -->
43
- <!-- Entry Template -->
44
- <!-- ############## -->
45
-
46
- <xsl:template match="/">
47
- <xsl:apply-templates select="$root"/>
48
- </xsl:template>
49
-
50
- <!-- We process structural nodes via chunking -->
51
- <!-- routine in xsl/pretext-common.xsl -->
52
- <!-- The default templates there do everything -->
53
- <!-- we need once we have "file-wrap" modal template -->
54
- <xsl:template match="/pretext">
55
- <xsl:apply-templates mode="chunking" />
56
- </xsl:template>
57
-
58
-
59
- <!-- ########################## -->
60
- <!-- Default Element Processing -->
61
- <!-- ########################## -->
62
-
63
- <!-- Default is to just recurse into descendant elements -->
64
- <!-- Ignoring text() nodes in mixed-content and mostly dead-end'ing -->
65
- <xsl:template match="*">
66
- <xsl:apply-templates select="*" />
67
- </xsl:template>
68
-
69
-
70
- <!-- ####################### -->
71
- <!-- Sage Element Processing -->
72
- <!-- ####################### -->
73
-
74
- <!-- "Normal" Sage blocks, including "invisible" -->
75
- <!-- Form doctring/ReST verbatim block -->
76
- <!-- for one input/output pair -->
77
- <!-- Filter limits to Sage language only -->
78
- <xsl:template match="sage[(not(@type) or @type='full' or @type='invisible') and (not(@language) or @language='sage')]">
79
- <xsl:text>~~~~~~~~~~~~~~~~~~~~~~ ::&#xA;&#xA;</xsl:text>
80
- <xsl:apply-templates select="input" />
81
- <xsl:apply-templates select="output" />
82
- <xsl:text>&#xA;</xsl:text>
83
- </xsl:template>
84
-
85
- <!-- Kill anything else that has not matched -->
86
- <xsl:template match="sage" />
87
-
88
- <!-- Options to doctesting -->
89
- <!-- A property of the Sage element, -->
90
- <!-- but employed in processing input -->
91
- <!-- Returns: necessary string, no adornment -->
92
- <!-- TODO: simplify repeated strings -->
93
- <xsl:template match="sage" mode="doctest-marker">
94
- <xsl:if test="@doctest">
95
- <xsl:choose>
96
- <xsl:when test="@doctest='random'">
97
- <xsl:text>random</xsl:text>
98
- </xsl:when>
99
- <xsl:when test="@doctest='long time'">
100
- <xsl:text>long time</xsl:text>
101
- </xsl:when>
102
- <xsl:when test="@doctest='not implemented'">
103
- <xsl:text>not implemented</xsl:text>
104
- </xsl:when>
105
- <xsl:when test="@doctest='not tested'">
106
- <xsl:text>not tested</xsl:text>
107
- </xsl:when>
108
- <xsl:when test="@doctest='known bug'">
109
- <xsl:text>known bug</xsl:text>
110
- </xsl:when>
111
- <!-- absolute and relative floating point need literal tolerance -->
112
- <xsl:when test="@doctest='absolute' or @doctest='relative'">
113
- <xsl:choose>
114
- <xsl:when test="@doctest='absolute'">
115
- <xsl:text>absolute</xsl:text>
116
- </xsl:when>
117
- <xsl:when test="@doctest='relative'">
118
- <xsl:text>relative</xsl:text>
119
- </xsl:when>
120
- </xsl:choose>
121
- <xsl:text> tolerance </xsl:text>
122
- <xsl:choose>
123
- <xsl:when test="@tolerance">
124
- <xsl:value-of select="@tolerance" />
125
- </xsl:when>
126
- <xsl:otherwise>
127
- <xsl:message>PTX:WARNING: '<xsl:value-of select="@doctest" /> tolerance' Sage doctest needs 'tolerance=' attribute</xsl:message>
128
- </xsl:otherwise>
129
- </xsl:choose>
130
- </xsl:when>
131
- <!-- 'optional' indicates an optional package is needed for the test -->
132
- <xsl:when test="@doctest='optional'">
133
- <xsl:text>optional</xsl:text>
134
- <xsl:choose>
135
- <xsl:when test="@package">
136
- <xsl:text>: </xsl:text>
137
- <xsl:value-of select="@package" />
138
- </xsl:when>
139
- <xsl:otherwise>
140
- <xsl:message>PTX:WARNING: 'optional' Sage doctest missing package, supply a 'package=' attribute</xsl:message>
141
- </xsl:otherwise>
142
- </xsl:choose>
143
- </xsl:when>
144
- </xsl:choose>
145
- </xsl:if>
146
- </xsl:template>
147
-
148
- <!-- NB: input and output can appear in "program", etc -->
149
- <!-- so templates below must be specific enough -->
150
-
151
- <!-- Sanitize input block -->
152
- <!-- Add in 4-space indentation -->
153
- <!-- and Sage prompts, then -->
154
- <!-- add Sage doctest markers -->
155
- <xsl:template match="sage/input">
156
- <xsl:variable name="input-block">
157
- <xsl:call-template name="prepend-prompt">
158
- <xsl:with-param name="text">
159
- <xsl:call-template name="sanitize-text" >
160
- <xsl:with-param name="text" select="." />
161
- </xsl:call-template>
162
- </xsl:with-param>
163
- </xsl:call-template>
164
- </xsl:variable>
165
- <!-- Construct an option marker, perhaps empty -->
166
- <xsl:variable name="doctest-marker">
167
- <xsl:apply-templates select=".." mode="doctest-marker" />
168
- </xsl:variable>
169
- <xsl:choose>
170
- <xsl:when test="$doctest-marker!=''">
171
- <!-- Locate pieces relative to: end of first line of last input command -->
172
- <xsl:variable name="before-last-sage">
173
- <xsl:call-template name="substring-before-last">
174
- <xsl:with-param name="input" select="$input-block" />
175
- <xsl:with-param name="substr" select="'sage:'" />
176
- </xsl:call-template>
177
- </xsl:variable>
178
- <xsl:variable name="after-last-sage">
179
- <xsl:call-template name="substring-after-last">
180
- <xsl:with-param name="input" select="$input-block" />
181
- <xsl:with-param name="substr" select="'sage:'" />
182
- </xsl:call-template>
183
- </xsl:variable>
184
- <xsl:variable name="before-eol" select="substring-before($after-last-sage, '&#xa;')" />
185
- <xsl:variable name="after-eol" select="substring-after($after-last-sage, '&#xa;')" />
186
- <!-- Back in its box, with markers and doctest marker -->
187
- <xsl:value-of select="$before-last-sage" />
188
- <xsl:text>sage:</xsl:text>
189
- <xsl:value-of select="$before-eol" />
190
- <xsl:text> # </xsl:text>
191
- <xsl:value-of select="$doctest-marker" />
192
- <xsl:text>&#xa;</xsl:text>
193
- <xsl:value-of select="$after-eol" />
194
- </xsl:when>
195
- <xsl:otherwise>
196
- <xsl:value-of select="$input-block" />
197
- </xsl:otherwise>
198
- </xsl:choose>
199
- </xsl:template>
200
-
201
- <!-- Sanitize output block -->
202
- <!-- Add in 4-space indentation -->
203
- <xsl:template match="sage/output">
204
- <xsl:call-template name="add-indentation">
205
- <xsl:with-param name="text">
206
- <xsl:call-template name="sanitize-text" >
207
- <xsl:with-param name="text" select="." />
208
- </xsl:call-template>
209
- </xsl:with-param>
210
- <xsl:with-param name="indent" select="' '" />
211
- </xsl:call-template>
212
- </xsl:template>
213
-
214
- <!-- Doctest specific template, others are in common XSL file -->
215
- <xsl:template name="prepend-prompt">
216
- <xsl:param name="text" />
217
- <!-- Just quit when string becomes empty -->
218
- <xsl:if test="string-length($text)">
219
- <xsl:variable name="first-line" select="substring-before($text, '&#xA;')" />
220
- <xsl:choose>
221
- <!-- blank lines are treated as continuation -->
222
- <!-- could be important content of triply-quoted strings? -->
223
- <!-- no harm if really just spacing at totally out-dented level? -->
224
- <xsl:when test="not(string-length($first-line))">
225
- <xsl:text> ....: </xsl:text>
226
- </xsl:when>
227
- <!-- leading blank indicates continuation -->
228
- <xsl:when test="substring($first-line,1,1)=' '">
229
- <xsl:text> ....: </xsl:text>
230
- </xsl:when>
231
- <!-- otherwise, totally outdented, needs sage prompt -->
232
- <xsl:otherwise>
233
- <xsl:text> sage: </xsl:text>
234
- </xsl:otherwise>
235
- </xsl:choose>
236
- <xsl:value-of select="$first-line"/>
237
- <xsl:text>&#xA;</xsl:text>
238
- <!-- recursive call on remainder of string -->
239
- <xsl:call-template name="prepend-prompt">
240
- <xsl:with-param name="text" select="substring-after($text, '&#xA;')"/>
241
- </xsl:call-template>
242
- </xsl:if>
243
- </xsl:template>
244
-
245
- <!-- ################# -->
246
- <!-- File Construction -->
247
- <!-- ################# -->
248
-
249
- <xsl:template match="&STRUCTURAL;" mode="file-wrap">
250
- <xsl:param name="content" />
251
- <xsl:if test="$content!=''">
252
- <xsl:variable name="filename">
253
- <xsl:apply-templates select="." mode="containing-filename" />
254
- </xsl:variable>
255
- <exsl:document href="{$filename}" method="text">
256
- <xsl:call-template name="doctest-file-header" />
257
- <xsl:text>## </xsl:text>
258
- <xsl:apply-templates select="." mode="type-name" />
259
- <xsl:text> </xsl:text>
260
- <xsl:apply-templates select="." mode="number" />
261
- <xsl:text> </xsl:text>
262
- <xsl:apply-templates select="." mode="title-full" />
263
- <xsl:text>&#xa;</xsl:text>
264
- <xsl:text>##&#xa;</xsl:text>
265
- <xsl:text>r"""&#xa;</xsl:text>
266
- <xsl:value-of select="$content" />
267
- <xsl:text>"""&#xa;</xsl:text>
268
- </exsl:document>
269
- </xsl:if>
270
- </xsl:template>
271
-
272
- <xsl:template name="doctest-file-header">
273
- <xsl:text>## Sage Doctest File ##&#xa;</xsl:text>
274
- <xsl:call-template name="converter-blurb-python" />
275
- <xsl:text>##&#xa;</xsl:text>
276
- <xsl:text>## To execute doctests in these files, run&#xa;</xsl:text>
277
- <xsl:text>## $ $SAGE_ROOT/sage -t &lt;directory-of-these-files&gt;&#xa;</xsl:text>
278
- <xsl:text>## or&#xa;</xsl:text>
279
- <xsl:text>## $ $SAGE_ROOT/sage -t &lt;a-single-file&gt;&#xa;</xsl:text>
280
- <xsl:text>##&#xa;</xsl:text>
281
- <xsl:text>## Replace -t by "-tp n" for parallel testing,&#xa;</xsl:text>
282
- <xsl:text>## "-tp 0" will use a sensible number of threads&#xa;</xsl:text>
283
- <xsl:text>##&#xa;</xsl:text>
284
- <xsl:text>## See: http://www.sagemath.org/doc/developer/doctesting.html&#xa;</xsl:text>
285
- <xsl:text>## or run $ $SAGE_ROOT/sage --advanced for brief help&#xa;</xsl:text>
286
- <xsl:text>##&#xa;</xsl:text>
287
- </xsl:template>
288
-
289
- </xsl:stylesheet>
1
+ <?xml version='1.0'?> <!-- As XML file -->
2
+
3
+ <!-- http://pimpmyxslt.com/articles/entity-tricks-part2/ -->
4
+ <!DOCTYPE xsl:stylesheet [
5
+ <!ENTITY % entities SYSTEM "entities.ent">
6
+ %entities;
7
+ ]>
8
+
9
+ <!-- Identify as a stylesheet -->
10
+ <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"
11
+ xmlns:xml="http://www.w3.org/XML/1998/namespace"
12
+ xmlns:exsl="http://exslt.org/common"
13
+ xmlns:date="http://exslt.org/dates-and-times"
14
+ extension-element-prefixes="exsl date"
15
+ >
16
+
17
+ <!-- For numbers, titles, text utilities, etc -->
18
+ <!-- Standard conversion groundwork -->
19
+ <xsl:import href="./publisher-variables.xsl"/>
20
+ <xsl:import href="./pretext-assembly.xsl"/>
21
+ <xsl:import href="./pretext-common.xsl"/>
22
+
23
+ <!-- Intend output for Python docstring -->
24
+ <xsl:output method="text" />
25
+
26
+ <!-- Doctest files are Python (docstring) -->
27
+ <xsl:variable name="file-extension" select="'.py'" />
28
+
29
+ <!-- Set the chunking level variable for the routines in pretext-common.xsl. -->
30
+ <!-- Default to zero, else use whatever an author specifies -->
31
+ <xsl:variable name="chunk-level">
32
+ <xsl:choose>
33
+ <xsl:when test="$chunk-level-entered != ''">
34
+ <xsl:value-of select="$chunk-level-entered" />
35
+ </xsl:when>
36
+ <xsl:otherwise>
37
+ <xsl:text>0</xsl:text>
38
+ </xsl:otherwise>
39
+ </xsl:choose>
40
+ </xsl:variable>
41
+
42
+ <!-- ############## -->
43
+ <!-- Entry Template -->
44
+ <!-- ############## -->
45
+
46
+ <xsl:template match="/">
47
+ <xsl:apply-templates select="$root"/>
48
+ </xsl:template>
49
+
50
+ <!-- We process structural nodes via chunking -->
51
+ <!-- routine in xsl/pretext-common.xsl -->
52
+ <!-- The default templates there do everything -->
53
+ <!-- we need once we have "file-wrap" modal template -->
54
+ <xsl:template match="/pretext">
55
+ <xsl:apply-templates mode="chunking" />
56
+ </xsl:template>
57
+
58
+
59
+ <!-- ########################## -->
60
+ <!-- Default Element Processing -->
61
+ <!-- ########################## -->
62
+
63
+ <!-- Default is to just recurse into descendant elements -->
64
+ <!-- Ignoring text() nodes in mixed-content and mostly dead-end'ing -->
65
+ <xsl:template match="*">
66
+ <xsl:apply-templates select="*" />
67
+ </xsl:template>
68
+
69
+
70
+ <!-- ####################### -->
71
+ <!-- Sage Element Processing -->
72
+ <!-- ####################### -->
73
+
74
+ <!-- "Normal" Sage blocks, including "invisible" -->
75
+ <!-- Form doctring/ReST verbatim block -->
76
+ <!-- for one input/output pair -->
77
+ <!-- Filter limits to Sage language only -->
78
+ <xsl:template match="sage[(not(@type) or @type='full' or @type='invisible') and (not(@language) or @language='sage')]">
79
+ <xsl:text>~~~~~~~~~~~~~~~~~~~~~~ ::&#xA;&#xA;</xsl:text>
80
+ <xsl:apply-templates select="input" />
81
+ <xsl:apply-templates select="output" />
82
+ <xsl:text>&#xA;</xsl:text>
83
+ </xsl:template>
84
+
85
+ <!-- Kill anything else that has not matched -->
86
+ <xsl:template match="sage" />
87
+
88
+ <!-- Options to doctesting -->
89
+ <!-- A property of the Sage element, -->
90
+ <!-- but employed in processing input -->
91
+ <!-- Returns: necessary string, no adornment -->
92
+ <!-- TODO: simplify repeated strings -->
93
+ <xsl:template match="sage" mode="doctest-marker">
94
+ <xsl:if test="@doctest">
95
+ <xsl:choose>
96
+ <xsl:when test="@doctest='random'">
97
+ <xsl:text>random</xsl:text>
98
+ </xsl:when>
99
+ <xsl:when test="@doctest='long time'">
100
+ <xsl:text>long time</xsl:text>
101
+ </xsl:when>
102
+ <xsl:when test="@doctest='not implemented'">
103
+ <xsl:text>not implemented</xsl:text>
104
+ </xsl:when>
105
+ <xsl:when test="@doctest='not tested'">
106
+ <xsl:text>not tested</xsl:text>
107
+ </xsl:when>
108
+ <xsl:when test="@doctest='known bug'">
109
+ <xsl:text>known bug</xsl:text>
110
+ </xsl:when>
111
+ <!-- absolute and relative floating point need literal tolerance -->
112
+ <xsl:when test="@doctest='absolute' or @doctest='relative'">
113
+ <xsl:choose>
114
+ <xsl:when test="@doctest='absolute'">
115
+ <xsl:text>absolute</xsl:text>
116
+ </xsl:when>
117
+ <xsl:when test="@doctest='relative'">
118
+ <xsl:text>relative</xsl:text>
119
+ </xsl:when>
120
+ </xsl:choose>
121
+ <xsl:text> tolerance </xsl:text>
122
+ <xsl:choose>
123
+ <xsl:when test="@tolerance">
124
+ <xsl:value-of select="@tolerance" />
125
+ </xsl:when>
126
+ <xsl:otherwise>
127
+ <xsl:message>PTX:WARNING: '<xsl:value-of select="@doctest" /> tolerance' Sage doctest needs 'tolerance=' attribute</xsl:message>
128
+ </xsl:otherwise>
129
+ </xsl:choose>
130
+ </xsl:when>
131
+ <!-- 'optional' indicates an optional package is needed for the test -->
132
+ <xsl:when test="@doctest='optional'">
133
+ <xsl:text>optional</xsl:text>
134
+ <xsl:choose>
135
+ <xsl:when test="@package">
136
+ <xsl:text>: </xsl:text>
137
+ <xsl:value-of select="@package" />
138
+ </xsl:when>
139
+ <xsl:otherwise>
140
+ <xsl:message>PTX:WARNING: 'optional' Sage doctest missing package, supply a 'package=' attribute</xsl:message>
141
+ </xsl:otherwise>
142
+ </xsl:choose>
143
+ </xsl:when>
144
+ </xsl:choose>
145
+ </xsl:if>
146
+ </xsl:template>
147
+
148
+ <!-- NB: input and output can appear in "program", etc -->
149
+ <!-- so templates below must be specific enough -->
150
+
151
+ <!-- Sanitize input block -->
152
+ <!-- Add in 4-space indentation -->
153
+ <!-- and Sage prompts, then -->
154
+ <!-- add Sage doctest markers -->
155
+ <xsl:template match="sage/input">
156
+ <xsl:variable name="input-block">
157
+ <xsl:call-template name="prepend-prompt">
158
+ <xsl:with-param name="text">
159
+ <xsl:call-template name="sanitize-text" >
160
+ <xsl:with-param name="text" select="." />
161
+ </xsl:call-template>
162
+ </xsl:with-param>
163
+ </xsl:call-template>
164
+ </xsl:variable>
165
+ <!-- Construct an option marker, perhaps empty -->
166
+ <xsl:variable name="doctest-marker">
167
+ <xsl:apply-templates select=".." mode="doctest-marker" />
168
+ </xsl:variable>
169
+ <xsl:choose>
170
+ <xsl:when test="$doctest-marker!=''">
171
+ <!-- Locate pieces relative to: end of first line of last input command -->
172
+ <xsl:variable name="before-last-sage">
173
+ <xsl:call-template name="substring-before-last">
174
+ <xsl:with-param name="input" select="$input-block" />
175
+ <xsl:with-param name="substr" select="'sage:'" />
176
+ </xsl:call-template>
177
+ </xsl:variable>
178
+ <xsl:variable name="after-last-sage">
179
+ <xsl:call-template name="substring-after-last">
180
+ <xsl:with-param name="input" select="$input-block" />
181
+ <xsl:with-param name="substr" select="'sage:'" />
182
+ </xsl:call-template>
183
+ </xsl:variable>
184
+ <xsl:variable name="before-eol" select="substring-before($after-last-sage, '&#xa;')" />
185
+ <xsl:variable name="after-eol" select="substring-after($after-last-sage, '&#xa;')" />
186
+ <!-- Back in its box, with markers and doctest marker -->
187
+ <xsl:value-of select="$before-last-sage" />
188
+ <xsl:text>sage:</xsl:text>
189
+ <xsl:value-of select="$before-eol" />
190
+ <xsl:text> # </xsl:text>
191
+ <xsl:value-of select="$doctest-marker" />
192
+ <xsl:text>&#xa;</xsl:text>
193
+ <xsl:value-of select="$after-eol" />
194
+ </xsl:when>
195
+ <xsl:otherwise>
196
+ <xsl:value-of select="$input-block" />
197
+ </xsl:otherwise>
198
+ </xsl:choose>
199
+ </xsl:template>
200
+
201
+ <!-- Sanitize output block -->
202
+ <!-- Add in 4-space indentation -->
203
+ <xsl:template match="sage/output">
204
+ <xsl:call-template name="add-indentation">
205
+ <xsl:with-param name="text">
206
+ <xsl:call-template name="sanitize-text" >
207
+ <xsl:with-param name="text" select="." />
208
+ </xsl:call-template>
209
+ </xsl:with-param>
210
+ <xsl:with-param name="indent" select="' '" />
211
+ </xsl:call-template>
212
+ </xsl:template>
213
+
214
+ <!-- Doctest specific template, others are in common XSL file -->
215
+ <xsl:template name="prepend-prompt">
216
+ <xsl:param name="text" />
217
+ <!-- Just quit when string becomes empty -->
218
+ <xsl:if test="string-length($text)">
219
+ <xsl:variable name="first-line" select="substring-before($text, '&#xA;')" />
220
+ <xsl:choose>
221
+ <!-- blank lines are treated as continuation -->
222
+ <!-- could be important content of triply-quoted strings? -->
223
+ <!-- no harm if really just spacing at totally out-dented level? -->
224
+ <xsl:when test="not(string-length($first-line))">
225
+ <xsl:text> ....: </xsl:text>
226
+ </xsl:when>
227
+ <!-- leading blank indicates continuation -->
228
+ <xsl:when test="substring($first-line,1,1)=' '">
229
+ <xsl:text> ....: </xsl:text>
230
+ </xsl:when>
231
+ <!-- otherwise, totally outdented, needs sage prompt -->
232
+ <xsl:otherwise>
233
+ <xsl:text> sage: </xsl:text>
234
+ </xsl:otherwise>
235
+ </xsl:choose>
236
+ <xsl:value-of select="$first-line"/>
237
+ <xsl:text>&#xA;</xsl:text>
238
+ <!-- recursive call on remainder of string -->
239
+ <xsl:call-template name="prepend-prompt">
240
+ <xsl:with-param name="text" select="substring-after($text, '&#xA;')"/>
241
+ </xsl:call-template>
242
+ </xsl:if>
243
+ </xsl:template>
244
+
245
+ <!-- ################# -->
246
+ <!-- File Construction -->
247
+ <!-- ################# -->
248
+
249
+ <xsl:template match="&STRUCTURAL;" mode="file-wrap">
250
+ <xsl:param name="content" />
251
+ <xsl:if test="$content!=''">
252
+ <xsl:variable name="filename">
253
+ <xsl:apply-templates select="." mode="containing-filename" />
254
+ </xsl:variable>
255
+ <exsl:document href="{$filename}" method="text">
256
+ <xsl:call-template name="doctest-file-header" />
257
+ <xsl:text>## </xsl:text>
258
+ <xsl:apply-templates select="." mode="type-name" />
259
+ <xsl:text> </xsl:text>
260
+ <xsl:apply-templates select="." mode="number" />
261
+ <xsl:text> </xsl:text>
262
+ <xsl:apply-templates select="." mode="title-full" />
263
+ <xsl:text>&#xa;</xsl:text>
264
+ <xsl:text>##&#xa;</xsl:text>
265
+ <xsl:text>r"""&#xa;</xsl:text>
266
+ <xsl:value-of select="$content" />
267
+ <xsl:text>"""&#xa;</xsl:text>
268
+ </exsl:document>
269
+ </xsl:if>
270
+ </xsl:template>
271
+
272
+ <xsl:template name="doctest-file-header">
273
+ <xsl:text>## Sage Doctest File ##&#xa;</xsl:text>
274
+ <xsl:call-template name="converter-blurb-python" />
275
+ <xsl:text>##&#xa;</xsl:text>
276
+ <xsl:text>## To execute doctests in these files, run&#xa;</xsl:text>
277
+ <xsl:text>## $ $SAGE_ROOT/sage -t &lt;directory-of-these-files&gt;&#xa;</xsl:text>
278
+ <xsl:text>## or&#xa;</xsl:text>
279
+ <xsl:text>## $ $SAGE_ROOT/sage -t &lt;a-single-file&gt;&#xa;</xsl:text>
280
+ <xsl:text>##&#xa;</xsl:text>
281
+ <xsl:text>## Replace -t by "-tp n" for parallel testing,&#xa;</xsl:text>
282
+ <xsl:text>## "-tp 0" will use a sensible number of threads&#xa;</xsl:text>
283
+ <xsl:text>##&#xa;</xsl:text>
284
+ <xsl:text>## See: http://www.sagemath.org/doc/developer/doctesting.html&#xa;</xsl:text>
285
+ <xsl:text>## or run $ $SAGE_ROOT/sage --advanced for brief help&#xa;</xsl:text>
286
+ <xsl:text>##&#xa;</xsl:text>
287
+ </xsl:template>
288
+
289
+ </xsl:stylesheet>