File: xmerl_xs_examples.md

package info (click to toggle)
erlang 1%3A28.1.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 235,640 kB
  • sloc: erlang: 1,685,753; ansic: 436,891; cpp: 178,143; xml: 82,195; makefile: 15,086; sh: 14,588; lisp: 9,856; java: 8,603; asm: 6,829; perl: 5,874; python: 5,482; sed: 72
file content (264 lines) | stat: -rw-r--r-- 6,678 bytes parent folder | download
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
<!--
%% %CopyrightBegin%
%%
%% SPDX-License-Identifier: Apache-2.0
%%
%% Copyright Ericsson AB 2024-2025. All Rights Reserved.
%%
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%%     http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%
%% %CopyrightEnd%
-->
# XSLT-like transformations

### Examples

---

#### Example 1 Using xslapply

original XSLT:

    <xsl:template match="doc/title">
        <h1>
          <xsl:apply-templates/>
        </h1>
    </xsl:template>

becomes in Erlang:

    template(E = #xmlElement{ parents=[{'doc',_}|_], name='title'}) ->
        ["<h1>",
             xslapply(fun template/1, E),
         "</h1>"];

---

---

#### Example 2 Using value_of and select

    <xsl:template match="title">
      <div align="center"><h1><xsl:value-of select="." /></h1></div>
    </xsl:template>

becomes:

    template(E = #xmlElement{name='title'}) ->
        ["<div align=\"center\"><h1>", value_of(select(".", E)), "</h1></div>"];

---

---

#### Example 3 Simple xsl stylesheet

A complete example with the XSLT sheet in the xmerl distribution.

    <xsl:stylesheet version="1.0"
    		xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
    		xmlns="http://www.w3.org/TR/xhtml1/strict">

      <xsl:strip-space elements="doc chapter section"/>
      <xsl:output
    	method="xml"
    	indent="yes"
    	encoding="iso-8859-1"
      />

      <xsl:template match="doc">
        <html>
          <head>
            <title>
              <xsl:value-of select="title"/>
            </title>
          </head>
          <body>
            <xsl:apply-templates/>
          </body>
        </html>
      </xsl:template>

      <xsl:template match="doc/title">
        <h1>
          <xsl:apply-templates/>
        </h1>
      </xsl:template>

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

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

      <xsl:template match="para">
        <p>
          <xsl:apply-templates/>
        </p>
      </xsl:template>

      <xsl:template match="note">
        <p class="note">
          <b>NOTE: </b>
          <xsl:apply-templates/>
        </p>
      </xsl:template>

      <xsl:template match="emph">
        <em>
          <xsl:apply-templates/>
        </em>
      </xsl:template>

    </xsl:stylesheet>

---

---

#### Example 4 Erlang version

Erlang transformation of previous example:

    -include("xmerl.hrl").

    -import(xmerl_xs,
    	[ xslapply/2, value_of/1, select/2, built_in_rules/2 ]).

    doctype()->
        "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"\
     \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd \">".

    process_xml(Doc)->
    	template(Doc).

    template(E = #xmlElement{name='doc'})->
        [ "<\?xml version=\"1.0\" encoding=\"iso-8859-1\"\?>",
          doctype(),
          "<html xmlns=\"http://www.w3.org/1999/xhtml\" >"
          "<head>"
          "<title>", value_of(select("title",E)), "</title>"
          "</head>"
          "<body>",
          xslapply( fun template/1, E),
          "</body>"
          "</html>" ];


    template(E = #xmlElement{ parents=[{'doc',_}|_], name='title'}) ->
        ["<h1>",
         xslapply( fun template/1, E),
         "</h1>"];

    template(E = #xmlElement{ parents=[{'chapter',_}|_], name='title'}) ->
        ["<h2>",
         xslapply( fun template/1, E),
         "</h2>"];

    template(E = #xmlElement{ parents=[{'section',_}|_], name='title'}) ->
        ["<h3>",
         xslapply( fun template/1, E),
         "</h3>"];

    template(E = #xmlElement{ name='para'}) ->
        ["<p>", xslapply( fun template/1, E), "</p>"];

    template(E = #xmlElement{ name='note'}) ->
        ["<p class=\"note\">"
         "<b>NOTE: </b>",
         xslapply( fun template/1, E),
         "</p>"];

    template(E = #xmlElement{ name='emph'}) ->
        ["<em>", xslapply( fun template/1, E), "</em>"];

    template(E)->
        built_in_rules( fun template/1, E).

It is important to end with a call to `xmerl_xs:built_in_rules/2` if you want any
text to be written in "push" transforms. That are the ones using a lot `xslapply(
fun template/1, E )` instead of `value_of(select("xpath",E))`, which is pull...

---

The largest example is the stylesheet to transform this document from the
Simplified Docbook XML format to xhtml. The source file is sdocbook2xhtml.erl.

### Tips and tricks

#### for-each

The function for-each is quite common in XSLT stylesheets. It can often be
rewritten and replaced by select/1. Since select/1 returns a list of
#xmlElements and xslapply/2 traverses them it is more or less the same as to
loop over all the elements.

#### position()

The XSLT position() and #xmlElement.pos are not the same. One has to make an own
position in Erlang.

---

#### Example 5 Counting positions

    <xsl:template match="stanza">
      <p><xsl:apply-templates select="line" /></p>
    </xsl:template>

    <xsl:template match="line">
      <xsl:if test="position() mod 2 = 0">&#160;&#160;</xsl:if>
      <xsl:value-of select="." /><br />
    </xsl:template>

Can be written as

    template(E = #xmlElement{name='stanza'}) ->
        {Lines,LineNo} = lists:mapfoldl(fun template_pos/2, 1, select("line", E)),
        ["<p>", Lines, "</p>"].

    template_pos(E = #xmlElement{name='line'}, P) ->
        {[indent_line(P rem 2), value_of(E#xmlElement.content), "<br />"], P + 1 }.

    indent_line(0)->"&#160;&#160;";
    indent_line(_)->"".

---

#### Global tree awareness

In XSLT you have "root" access to the top of the tree with XPath, even though
you are somewhere deep in your tree.

The xslapply/2 function only carries back the child part of the tree to the
template fun. But it is quite easy to write template funs that handles both the
child and top tree.

---

#### Example 6 Passing the root tree

The following example piece will prepend the article title to any section title

    template(E = #xmlElement{name='title'}, ETop ) ->
        ["<h3>", value_of(select("title", ETop))," - ",
         xslapply( fun(A) -> template(A, ETop) end, E),
         "</h3>"];

---