reference/xml/functions/xml-set-notation-decl-handler.xml
5a14f904d231d294e2e5b4fb5d2fc4d2fd9eddee
...
...
@@ -1,8 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook"
4
-
xml:id="function.xml-set-notation-decl-handler"
5
-
xmlns:xlink="http://www.w3.org/1999/xlink">
3
+
<refentry xml:id="function.xml-set-notation-decl-handler" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
6
4
<refnamediv>
7
5
<refname>xml_set_notation_decl_handler</refname>
8
6
<refpurpose>Set up notation declaration handler</refpurpose>
...
...
@@ -11,8 +9,8 @@
11
9
<refsect1 role="description">
12
10
&reftitle.description;
13
11
<methodsynopsis>
14
-
<type>bool</type><methodname>xml_set_notation_decl_handler</methodname>
15
-
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
12
+
<type>true</type><methodname>xml_set_notation_decl_handler</methodname>
13
+
<methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
16
14
<methodparam><type>callable</type><parameter>handler</parameter></methodparam>
17
15
</methodsynopsis>
18
16
<para>
...
...
@@ -37,50 +35,28 @@
37
35
&reftitle.parameters;
38
36
<para>
39
37
<variablelist>
40
-
<varlistentry>
41
-
<term><parameter>parser</parameter></term>
42
-
<listitem>
43
-
<para>
44
-
A reference to the XML parser to set up notation declaration handler function.
45
-
</para>
46
-
</listitem>
47
-
</varlistentry>
38
+
&xml.parser.param;
48
39
<varlistentry>
49
40
<term><parameter>handler</parameter></term>
50
41
<listitem>
42
+
&xml.handler.description;
51
43
<para>
52
-
<parameter>handler</parameter> is a string containing the name of a
53
-
function that must exist when <function>xml_parse</function> is called
54
-
for <parameter>parser</parameter>.
55
-
</para>
56
-
<para>
57
-
The function named by <parameter>handler</parameter> must accept
58
-
five parameters:
44
+
The signature of the handler must be:
59
45
<methodsynopsis>
60
-
<methodname><replaceable>handler</replaceable></methodname>
61
-
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
46
+
<type>void</type><methodname><replaceable>handler</replaceable></methodname>
47
+
<methodparam><type>XMLParser</type><parameter>parser</parameter></methodparam>
62
48
<methodparam><type>string</type><parameter>notation_name</parameter></methodparam>
63
-
<methodparam><type>string</type><parameter>base</parameter></methodparam>
49
+
<methodparam><type class="union"><type>string</type><type>false</type></type><parameter>base</parameter></methodparam>
64
50
<methodparam><type>string</type><parameter>system_id</parameter></methodparam>
65
-
<methodparam><type>string</type><parameter>public_id</parameter></methodparam>
51
+
<methodparam><type class="union"><type>string</type><type>false</type></type><parameter>public_id</parameter></methodparam>
66
52
</methodsynopsis>
67
53
<variablelist>
68
-
<varlistentry>
69
-
<term>
70
-
<parameter>parser</parameter>
71
-
</term>
72
-
<listitem>
73
-
<simpara>
74
-
The first parameter, <replaceable>parser</replaceable>, is a
75
-
reference to the XML parser calling the handler.
76
-
</simpara>
77
-
</listitem>
78
-
</varlistentry>
54
+
&xml.handler.parser.param;
79
55
<varlistentry>
80
56
<term><parameter>notation_name</parameter></term>
81
57
<listitem>
82
58
<simpara>
83
-
This is the notation's <parameter>name</parameter>, as per
59
+
This is the notation's name, as per
84
60
the notation format described above.
85
61
</simpara>
86
62
</listitem>
...
...
@@ -92,8 +68,7 @@
92
68
<listitem>
93
69
<simpara>
94
70
This is the base for resolving the system identifier
95
-
(<parameter>system_id</parameter>) of the notation declaration.
96
-
Currently this parameter will always be set to an empty string.
71
+
(<literal>system_id</literal>) of the notation declaration.
97
72
</simpara>
98
73
</listitem>
99
74
</varlistentry>
...
...
@@ -117,11 +92,6 @@
117
92
</varlistentry>
118
93
</variablelist>
119
94
</para>
120
-
<para>
121
-
If a handler function is set to an empty string, or &false;, the handler
122
-
in question is disabled.
123
-
</para>
124
-
&note.func-callback;
125
95
</listitem>
126
96
</varlistentry>
127
97
</variablelist>
...
...
@@ -131,12 +101,28 @@
131
101
<refsect1 role="returnvalues">
132
102
&reftitle.returnvalues;
133
103
<para>
134
-
&return.success;
104
+
&return.true.always;
135
105
</para>
136
106
</refsect1>
137
107

138
-
</refentry>
108
+
<refsect1 role="changelog">
109
+
&reftitle.changelog;
110
+
<informaltable>
111
+
<tgroup cols="2">
112
+
<thead>
113
+
<row>
114
+
<entry>&Version;</entry>
115
+
<entry>&Description;</entry>
116
+
</row>
117
+
</thead>
118
+
<tbody>
119
+
&xml.changelog.parser-param;
120
+
</tbody>
121
+
</tgroup>
122
+
</informaltable>
123
+
</refsect1>
139
124

125
+
</refentry>
140
126
<!-- Keep this comment at the end of the file
141
127
Local variables:
142
128
mode: sgml
143
129



Tools (Italian Manual)