xmlops: regenerate README after doc change
[sip-router] / modules / xmlops / README
1 1. XMLOPS Module
2
3 Daniel-Constantin Mierla
4
5    asipto.com
6    <miconda@gmail.com>
7
8    Copyright © 2009 asipto.com
9      __________________________________________________________________
10
11    1.1. Overview
12    1.2. Dependencies
13
14         1.2.1. Kamailio Modules
15         1.2.2. External Libraries or Applications
16
17    1.3. Parameters
18
19         1.3.1. buf_size (integer)
20         1.3.2. xml_ns (str)
21
22    1.4. Pseudo-Variables
23
24         1.4.1. $xml(name=>spec)
25
26 1.1. Overview
27
28    This is a module implementing functions and pseudo-variables for XML
29    operations.
30
31 1.2. Dependencies
32
33 1.2.1. Kamailio Modules
34
35    The following modules must be loaded before this module:
36      * none.
37
38 1.2.2. External Libraries or Applications
39
40    The following libraries or applications must be installed before
41    running kamailio with this module loaded:
42      * libxml - for compilation from source, the development headers from
43        this library are needed as well.
44
45 1.3. Parameters
46
47 1.3.1. buf_size (integer)
48
49    Maximum size of the XML buffer.
50
51    Default value is 4096.
52
53    Example 1. Set buf_size parameter
54 ...
55 modparam("xmlops", "buf_size", 8192)
56 ...
57
58 1.3.2. xml_ns (str)
59
60    Register xml namespace prefix. Parameter value must have the format:
61    'prefix=uri'.
62
63    Example 2. Set xml_ns parameter
64 ...
65 modparam("xmlops", "xml_ns", "rpid=urn:ietf:params:xml:ns:pidf:rpid")
66 ...
67
68 1.4. Pseudo-Variables
69
70 1.4.1.  $xml(name=>spec)
71
72    Pseudo-variable for XML document operations using xpath syntax. For
73    more see the Pseudo-Variables Cookbook.
74
75    Example 3. xml usage
76 ...
77 $xml(x=>doc)
78     = '<?xml version="1.0" encoding="UTF-8"?><a><b>test</b></a>';
79 xlog("content of node b: $xml(x=>xpath:/a/b/text())\n");
80 $xml(x=>xpath:/a/b) = "1234";
81 ...