summaryrefslogtreecommitdiff
path: root/tools/xml2md.xsl
blob: 2fc7ce16170f5d0bfe8aa4fe6bb9d3e13caa01c3 (plain)
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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
<?xml version="1.0" encoding="UTF-8"?>

<!--

xml2md.xsl
==========

This XSLT stylesheet transforms the cmark XML format back to Commonmark.
Since the XML output is lossy, a lossless MD->XML->MD roundtrip isn't
possible. The XML->MD->XML roundtrip should produce the original XML,
though.

HTML blocks and inlines aren't supported.

Example usage with xsltproc:

    cmark -t xml doc.md | xsltproc -novalid xml2md.xsl -

-->

<xsl:stylesheet
    version="1.0"
    xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
    xmlns:md="http://commonmark.org/xml/1.0">

<xsl:output method="text" encoding="utf-8"/>

<!-- Generic templates -->

<xsl:template match="/ | md:document | md:list">
    <xsl:apply-templates select="md:*"/>
</xsl:template>

<xsl:template match="md:*">
    <xsl:message>Unsupported element '<xsl:value-of select="local-name()"/>'</xsl:message>
</xsl:template>

<xsl:template match="md:*" mode="indent"/>

<!-- Indent blocks -->

<xsl:template match="md:*" mode="indent-block">
    <xsl:if test="preceding-sibling::md:*">
        <xsl:if test="not(ancestor::md:list[1][@tight='true'])">
            <xsl:apply-templates select="ancestor::md:*" mode="indent"/>
            <xsl:text>&#10;</xsl:text>
        </xsl:if>
        <xsl:apply-templates select="ancestor::md:*" mode="indent"/>
    </xsl:if>
</xsl:template>

<!-- Heading -->

<xsl:template match="md:heading">
    <xsl:apply-templates select="." mode="indent-block"/>
    <xsl:value-of select="substring('###### ', 7 - @level)"/>
    <xsl:apply-templates select="md:*"/>
    <xsl:text>&#10;</xsl:text>
</xsl:template>

<!-- Paragraph -->

<xsl:template match="md:paragraph">
    <xsl:apply-templates select="." mode="indent-block"/>
    <xsl:apply-templates select="md:*"/>
    <xsl:text>&#10;</xsl:text>
</xsl:template>

<!-- Thematic break -->

<xsl:template match="md:thematic_break">
    <xsl:apply-templates select="." mode="indent-block"/>
    <xsl:text>***&#10;</xsl:text>
</xsl:template>

<!-- List -->

<xsl:template match="md:list">
    <xsl:apply-templates select="." mode="indent-block"/>
    <xsl:apply-templates select="md:*"/>
</xsl:template>

<xsl:template match="md:item">
    <xsl:apply-templates select="." mode="indent-block"/>
    <xsl:choose>
        <xsl:when test="../@type = 'bullet'">-</xsl:when>
        <xsl:when test="../@type = 'ordered'">
            <xsl:value-of select="../@start + position() - 1"/>
            <xsl:choose>
                <xsl:when test="../@delim = 'period'">.</xsl:when>
                <xsl:when test="../@delim = 'paren'">)</xsl:when>
            </xsl:choose>
        </xsl:when>
    </xsl:choose>
    <xsl:text> </xsl:text>
    <xsl:apply-templates select="md:*"/>
</xsl:template>

<xsl:template match="md:item" mode="indent">
    <xsl:choose>
        <xsl:when test="../@type = 'bullet'">
            <xsl:text>  </xsl:text>
        </xsl:when>
        <xsl:when test="../@type = 'ordered'">
            <xsl:text>   </xsl:text>
        </xsl:when>
    </xsl:choose>
</xsl:template>

<!-- Block quote -->

<xsl:template match="md:block_quote">
    <xsl:apply-templates select="." mode="indent-block"/>
    <xsl:text>&gt; </xsl:text>
    <xsl:apply-templates select="md:*"/>
</xsl:template>

<xsl:template match="md:block_quote" mode="indent">
    <xsl:text>&gt; </xsl:text>
</xsl:template>

<!-- Code block -->

<xsl:template match="md:code_block">
    <xsl:apply-templates select="." mode="indent-block"/>
    <!-- TODO: Longer delimiter if text contains ``` -->
    <xsl:text>```</xsl:text>
    <xsl:value-of select="@info"/>
    <xsl:text>&#10;</xsl:text>
    <xsl:call-template name="indent-lines">
        <xsl:with-param name="code" select="."/>
    </xsl:call-template>
    <xsl:apply-templates select="ancestor::md:*" mode="indent"/>
    <xsl:text>```</xsl:text>
    <xsl:text>&#10;</xsl:text>
</xsl:template>

<!-- Inline HTML -->

<xsl:template match="md:html_block">
    <xsl:apply-templates select="." mode="indent-block"/>
    <xsl:value-of select="substring-before(., '&#10;')"/>
    <xsl:text>&#10;</xsl:text>
    <xsl:call-template name="indent-lines">
        <xsl:with-param name="code" select="substring-after(., '&#10;')"/>
    </xsl:call-template>
</xsl:template>

<!-- Indent multiple lines -->

<xsl:template name="indent-lines">
    <xsl:param name="code"/>
    <xsl:if test="contains($code, '&#10;')">
        <xsl:apply-templates select="ancestor::md:*" mode="indent"/>
        <xsl:value-of select="substring-before($code, '&#10;')"/>
        <xsl:text>&#10;</xsl:text>
        <xsl:call-template name="indent-lines">
            <xsl:with-param name="code" select="substring-after($code, '&#10;')"/>
        </xsl:call-template>
    </xsl:if>
</xsl:template>

<!-- Text -->

<xsl:template match="md:text">
    <xsl:variable name="t" select="string(.)"/>
    <xsl:variable name="first" select="substring($t, 1, 1)"/>
    <xsl:variable name="marker-check" select="translate(substring($t, 1, 10), '0123456789', '')"/>
    <xsl:choose>
        <!-- Escape ordered list markers -->
        <xsl:when test="starts-with($marker-check, '.') and $first != '.'">
            <xsl:value-of select="substring-before($t, '.')"/>
            <xsl:text>\.</xsl:text>
            <xsl:call-template name="escape-text">
                <xsl:with-param name="text" select="substring-after($t, '.')"/>
            </xsl:call-template>
        </xsl:when>
        <xsl:when test="starts-with($marker-check, ')') and $first != ')'">
            <xsl:value-of select="substring-before($t, ')')"/>
            <xsl:text>\)</xsl:text>
            <xsl:call-template name="escape-text">
                <xsl:with-param name="text" select="substring-after($t, ')')"/>
            </xsl:call-template>
        </xsl:when>
        <!-- Escape leading block characters -->
        <xsl:when test="contains('-+>#=~', $first)">
            <xsl:text>\</xsl:text>
            <xsl:value-of select="$first"/>
            <xsl:call-template name="escape-text">
                <xsl:with-param name="text" select="substring($t, 2)"/>
            </xsl:call-template>
        </xsl:when>
        <!-- Otherwise -->
        <xsl:otherwise>
            <xsl:call-template name="escape-text">
                <xsl:with-param name="text" select="$t"/>
            </xsl:call-template>
        </xsl:otherwise>
    </xsl:choose>
</xsl:template>

<!-- Breaks -->

<xsl:template match="md:softbreak">
    <xsl:text>&#10;</xsl:text>
    <xsl:apply-templates select="ancestor::md:*" mode="indent"/>
</xsl:template>

<xsl:template match="md:linebreak">
    <xsl:text>  &#10;</xsl:text>
    <xsl:apply-templates select="ancestor::md:*" mode="indent"/>
</xsl:template>

<!-- Emphasis -->

<xsl:template match="md:emph">
    <xsl:text>*</xsl:text>
    <xsl:apply-templates select="md:*"/>
    <xsl:text>*</xsl:text>
</xsl:template>

<xsl:template match="md:strong">
    <xsl:text>**</xsl:text>
    <xsl:apply-templates select="md:*"/>
    <xsl:text>**</xsl:text>
</xsl:template>

<!-- Inline code -->

<xsl:template match="md:code">
    <xsl:call-template name="escape-code">
        <xsl:with-param name="text" select="string(.)"/>
    </xsl:call-template>
</xsl:template>

<xsl:template name="escape-code">
    <xsl:param name="text"/>
    <xsl:param name="delim" select="'`'"/>

    <xsl:choose>
        <xsl:when test="contains($text, $delim)">
            <xsl:call-template name="escape-code">
                <xsl:with-param name="text" select="$text"/>
                <xsl:with-param name="delim" select="concat($delim, '`')"/>
            </xsl:call-template>
        </xsl:when>
        <xsl:otherwise>
            <xsl:value-of select="$delim"/>
            <xsl:value-of select="$text"/>
            <xsl:value-of select="$delim"/>
        </xsl:otherwise>
    </xsl:choose>
</xsl:template>

<!-- Links and images -->

<xsl:template match="md:link | md:image">
    <xsl:if test="self::md:image">!</xsl:if>
    <xsl:text>[</xsl:text>
    <xsl:apply-templates select="md:*"/>
    <xsl:text>](</xsl:text>
    <xsl:call-template name="escape-text">
        <xsl:with-param name="text" select="string(@destination)"/>
        <xsl:with-param name="escape" select="'()'"/>
    </xsl:call-template>
    <xsl:if test="string(@title)">
        <xsl:text> "</xsl:text>
        <xsl:call-template name="escape-text">
            <xsl:with-param name="text" select="string(@title)"/>
            <xsl:with-param name="escape" select="'&quot;'"/>
        </xsl:call-template>
        <xsl:text>"</xsl:text>
    </xsl:if>
    <xsl:text>)</xsl:text>
</xsl:template>

<!-- Inline HTML -->

<xsl:template match="md:html_inline">
    <xsl:value-of select="."/>
</xsl:template>

<!-- Escape text -->

<xsl:template name="escape-text">
    <xsl:param name="text"/>
    <xsl:param name="escape" select="'*_`&lt;[]&amp;'"/>

    <xsl:variable name="trans" select="translate($text, $escape, '\\\\\\\')"/>
    <xsl:choose>
        <xsl:when test="contains($trans, '\')">
            <xsl:variable name="safe" select="substring-before($trans, '\')"/>
            <xsl:variable name="l" select="string-length($safe)"/>
            <xsl:value-of select="$safe"/>
            <xsl:text>\</xsl:text>
            <xsl:value-of select="substring($text, $l + 1, 1)"/>
            <xsl:call-template name="escape-text">
                <xsl:with-param name="text" select="substring($text, $l + 2)"/>
                <xsl:with-param name="escape" select="$escape"/>
            </xsl:call-template>
        </xsl:when>
        <xsl:otherwise>
            <xsl:value-of select="$text"/>
        </xsl:otherwise>
    </xsl:choose>
</xsl:template>

</xsl:stylesheet>