1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
<?xml version="1.0" encoding="UTF-8"?>
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<!--
; XDOC Documentation System for ACL2
; Copyright (C) 2009-2011 Centaur Technology
;
; Contact:
; Centaur Technology Formal Verification Group
; 7600-C N. Capital of Texas Highway, Suite 300, Austin, TX 78731, USA.
; http://www.centtech.com/
;
; License: (An MIT/X11-style license)
;
; Permission is hereby granted, free of charge, to any person obtaining a
; copy of this software and associated documentation files (the "Software"),
; to deal in the Software without restriction, including without limitation
; the rights to use, copy, modify, merge, publish, distribute, sublicense,
; and/or sell copies of the Software, and to permit persons to whom the
; Software is furnished to do so, subject to the following conditions:
;
; The above copyright notice and this permission notice shall be included in
; all copies or substantial portions of the Software.
;
; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
; IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
; FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
; AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
; LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
; FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
; DEALINGS IN THE SOFTWARE.
;
; Original author: Jared Davis <jared@centtech.com>
text.xsl - converts xdoc markup to plain text
[Jared 1/03/11]: Note that the :xdoc command does NOT use this file; this is
only used to generate the files in the text/ directory of a manual, and I
think its output is inferior to the acl2-based :xdoc command.
[Jared 10/21/09]: I haven't put too much work into this. Doing fancy
things with XSLT seems rather difficult and I am not an expert.
The main deficiency right now is that I do not know how to make links
stand out. My word-wrapping code is copied from some web site, and to use it
I seem to have to treat the contents of elements such as <p> and <li> as
ordinary text. This means that templates for <a> and <see> are never
processed. Maybe someone who knows XSLT will be able to provide a fix.
-->
<xsl:output method="text"/>
<xsl:strip-space elements="box ul ol dl p topic"/>
<xsl:template match="topic">
<xsl:text>------------------------------------------------------------------------

</xsl:text>
<xsl:text> </xsl:text>
<xsl:value-of select="@name"/>
<xsl:text>

</xsl:text>
<xsl:text>------------------------------------------------------------------------

</xsl:text>
<xsl:apply-templates/>
<xsl:text>
------------------------------------------------------------------------
</xsl:text>
</xsl:template>
<xsl:template match="parent">
<xsl:text>Parent Topic: </xsl:text>
<xsl:value-of select="."/>
<xsl:text> (</xsl:text>
<xsl:value-of select="@topic"/>
<xsl:text>)

</xsl:text>
</xsl:template>
<xsl:template match="p">
<!-- Word wrap paragraphs. -->
<xsl:call-template name="wrap-string">
<xsl:with-param name="str" select="normalize-space(.)"/>
<xsl:with-param name="wrap-col" select="65"/>
<xsl:with-param name="break-mark" select="'
'"/>
</xsl:call-template>
<xsl:text>

</xsl:text>
</xsl:template>
<xsl:template match="blockquote">
<!-- just treat blockquotes like regular paragraphs -->
<xsl:call-template name="wrap-string">
<xsl:with-param name="str" select="normalize-space(.)"/>
<xsl:with-param name="wrap-col" select="65"/>
<xsl:with-param name="break-mark" select="'
'"/>
</xsl:call-template>
<xsl:text>

</xsl:text>
</xsl:template>
<xsl:template match="ul">
<xsl:apply-templates/>
<xsl:text>
</xsl:text>
</xsl:template>
<xsl:template match="ol">
<xsl:apply-templates/>
<xsl:text>
</xsl:text>
</xsl:template>
<xsl:template match="dl">
<xsl:apply-templates/>
<xsl:text>
</xsl:text>
</xsl:template>
<xsl:template match="box">
<!-- This isn't great. -->
<xsl:apply-templates/>
</xsl:template>
<xsl:template match="li">
<!-- Word wrap li elements and star them. -->
<xsl:text> * </xsl:text>
<xsl:call-template name="wrap-string">
<xsl:with-param name="str" select="normalize-space(.)"/>
<xsl:with-param name="wrap-col" select="65"/>
<xsl:with-param name="break-mark" select="'
'"/>
<xsl:with-param name="pos" select="4"/>
</xsl:call-template>
<xsl:text>
</xsl:text>
</xsl:template>
<xsl:template match="dd">
<!-- Word wrap dd elements and indent them. -->
<xsl:text> </xsl:text>
<xsl:call-template name="wrap-string">
<xsl:with-param name="str" select="normalize-space(.)"/>
<xsl:with-param name="wrap-col" select="65"/>
<xsl:with-param name="break-mark" select="'
'"/>
<xsl:with-param name="pos" select="6"/>
</xsl:call-template>
<xsl:text>
</xsl:text>
</xsl:template>
<xsl:template match="dt">
<!-- Word wrap dt elements and indent them. -->
<xsl:text> </xsl:text>
<xsl:call-template name="wrap-string">
<xsl:with-param name="str" select="normalize-space(.)"/>
<xsl:with-param name="wrap-col" select="65"/>
<xsl:with-param name="break-mark" select="'
'"/>
<xsl:with-param name="pos" select="2"/>
</xsl:call-template>
<xsl:text>
</xsl:text>
</xsl:template>
<xsl:template match="short">
<xsl:apply-templates/>
<xsl:text>
</xsl:text>
</xsl:template>
<xsl:template match="h1">
<xsl:text>
--- </xsl:text>
<xsl:apply-templates/>
<xsl:text> ---

</xsl:text>
</xsl:template>
<xsl:template match="h2">
<xsl:text>
--- </xsl:text>
<xsl:apply-templates/>
<xsl:text> ---

</xsl:text>
</xsl:template>
<xsl:template match="h3">
<xsl:text>
--- </xsl:text>
<xsl:apply-templates/>
<xsl:text> ---

</xsl:text>
</xsl:template>
<xsl:template match="h4">
<xsl:text>
</xsl:text>
<xsl:apply-templates/>
<xsl:text>

</xsl:text>
</xsl:template>
<xsl:template match="h5">
<xsl:text>
</xsl:text>
<xsl:apply-templates/>
<xsl:text>

</xsl:text>
</xsl:template>
<xsl:template match="code">
<xsl:value-of select="."/>
<xsl:text>

</xsl:text>
</xsl:template>
<xsl:template match="see">
<!-- This doesn't work with word-wrapping tags like <p> and <li>. -->
<xsl:value-of select="."/>
<xsl:text> (Link: </xsl:text>
<xsl:value-of select="@topic"/>
<xsl:text>)</xsl:text>
</xsl:template>
<!-- I got this this word-wrapping code from http://plasmasturm.org/log/204/ -->
<xsl:template name="wrap-string">
<xsl:param name="str" />
<xsl:param name="wrap-col" />
<xsl:param name="break-mark" />
<xsl:param name="pos" select="0" />
<xsl:choose>
<xsl:when test="contains( $str, ' ' )">
<xsl:variable name="before" select="substring-before( $str, ' ' )" />
<xsl:variable name="pos-now" select="$pos + string-length( $before )" />
<xsl:choose>
<xsl:when test="$pos = 0" />
<xsl:when test="floor( $pos div $wrap-col ) != floor( $pos-now div $wrap-col )">
<xsl:copy-of select="$break-mark" />
</xsl:when>
<xsl:otherwise>
<xsl:text> </xsl:text>
</xsl:otherwise>
</xsl:choose>
<xsl:value-of select="$before" />
<xsl:call-template name="wrap-string">
<xsl:with-param name="str" select="substring-after( $str, ' ' )" />
<xsl:with-param name="wrap-col" select="$wrap-col" />
<xsl:with-param name="break-mark" select="$break-mark" />
<xsl:with-param name="pos" select="$pos-now" />
</xsl:call-template>
</xsl:when>
<xsl:otherwise>
<xsl:if test="$pos > 0"><xsl:text> </xsl:text></xsl:if>
<xsl:value-of select="$str" />
</xsl:otherwise>
</xsl:choose>
</xsl:template>
</xsl:stylesheet>
|
