← Back to branch summary

~ubuntu-branches/ubuntu/natty/raptor/natty-security

« back to all changes in this revision

Viewing changes to docs/xml/section-feature.xml

  • Committer: Bazaar Package Importer
  • Author(s): Dave Beckett
  • Date: 2009-08-19 14:22:53 UTC
  • mfrom: (1.1.10 upstream) (2.1.7 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090819142253-wumhfgi7k5seq8e6
Tags: 1.4.19-1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/xml/section-feature.xml
13
13
<refnamediv>
14
14
<refname>Features</refname>
15
15
<refpurpose>Parser and Serializer features</refpurpose>
16
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
17
16
</refnamediv>
18
17
 
19
18
<refsynopsisdiv id="raptor-section-feature.synopsis" role="synopsis">
53
52
<title role="details.title">Details</title>
54
53
<refsect2 id="raptor-feature" role="enum">
55
54
<title>enum raptor_feature</title>
56
 
<indexterm zone="raptor-feature"><primary>raptor_feature</primary></indexterm><programlisting>typedef enum {
 
55
<indexterm zone="raptor-feature"><primary sortas="raptor_feature">raptor_feature</primary></indexterm><programlisting>typedef enum {
57
56
  RAPTOR_FEATURE_SCANNING,
58
57
  RAPTOR_FEATURE_ASSUME_IS_RDF,
59
58
  RAPTOR_FEATURE_ALLOW_NON_NS_ATTRIBUTES,
89
88
  RAPTOR_FEATURE_JSON_EXTRA_DATA,
90
89
  RAPTOR_FEATURE_RSS_TRIPLES,
91
90
  RAPTOR_FEATURE_ATOM_ENTRY_URI,
92
 
  RAPTOR_FEATURE_LAST=RAPTOR_FEATURE_ATOM_ENTRY_URI
 
91
  RAPTOR_FEATURE_PREFIX_ELEMENTS,
 
92
  RAPTOR_FEATURE_LAST = RAPTOR_FEATURE_PREFIX_ELEMENTS
93
93
} raptor_feature;
94
94
</programlisting>
95
95
<para>
96
96
Raptor parser, serializer or XML writer features.</para>
97
97
<para>
98
 
 
99
98
</para><variablelist role="enum">
100
 
<varlistentry id="RAPTOR-FEATURE-SCANNING:CAPS" role="constant">
 
99
<varlistentry id="RAPTOR-FEATURE-SCANNING--CAPS" role="constant">
101
100
<term><literal>RAPTOR_FEATURE_SCANNING</literal></term>
102
101
<listitem><simpara> If true (default false), the RDF/XML
103
102
  parser will look for embedded rdf:RDF elements inside the XML
105
104
  element.
106
105
</simpara></listitem>
107
106
</varlistentry>
108
 
<varlistentry id="RAPTOR-FEATURE-ASSUME-IS-RDF:CAPS" role="constant">
 
107
<varlistentry id="RAPTOR-FEATURE-ASSUME-IS-RDF--CAPS" role="constant">
109
108
<term><literal>RAPTOR_FEATURE_ASSUME_IS_RDF</literal></term>
110
109
<listitem><simpara> If true (default false) then the
111
110
  RDF/XML parser will assume the content is RDF/XML, not require
113
112
  as RDF/XML.
114
113
</simpara></listitem>
115
114
</varlistentry>
116
 
<varlistentry id="RAPTOR-FEATURE-ALLOW-NON-NS-ATTRIBUTES:CAPS" role="constant">
 
115
<varlistentry id="RAPTOR-FEATURE-ALLOW-NON-NS-ATTRIBUTES--CAPS" role="constant">
117
116
<term><literal>RAPTOR_FEATURE_ALLOW_NON_NS_ATTRIBUTES</literal></term>
118
117
<listitem><simpara> If true (default true)
119
118
  then the RDF/XML parser will allow non-XML namespaced attributes
122
121
  and rdf:ID respectively.
123
122
</simpara></listitem>
124
123
</varlistentry>
125
 
<varlistentry id="RAPTOR-FEATURE-ALLOW-OTHER-PARSETYPES:CAPS" role="constant">
 
124
<varlistentry id="RAPTOR-FEATURE-ALLOW-OTHER-PARSETYPES--CAPS" role="constant">
126
125
<term><literal>RAPTOR_FEATURE_ALLOW_OTHER_PARSETYPES</literal></term>
127
126
<listitem><simpara> If true (default true)
128
127
  then the RDF/XML parser will allow unknown parsetypes to be
130
129
  present.
131
130
</simpara></listitem>
132
131
</varlistentry>
133
 
<varlistentry id="RAPTOR-FEATURE-ALLOW-BAGID:CAPS" role="constant">
 
132
<varlistentry id="RAPTOR-FEATURE-ALLOW-BAGID--CAPS" role="constant">
134
133
<term><literal>RAPTOR_FEATURE_ALLOW_BAGID</literal></term>
135
134
<listitem><simpara> If true (default true) then the
136
135
  RDF/XML parser will support the rdf:bagID attribute that was
138
137
  support may be removed in future.
139
138
</simpara></listitem>
140
139
</varlistentry>
141
 
<varlistentry id="RAPTOR-FEATURE-ALLOW-RDF-TYPE-RDF-LIST:CAPS" role="constant">
 
140
<varlistentry id="RAPTOR-FEATURE-ALLOW-RDF-TYPE-RDF-LIST--CAPS" role="constant">
142
141
<term><literal>RAPTOR_FEATURE_ALLOW_RDF_TYPE_RDF_LIST</literal></term>
143
142
<listitem><simpara> If true (default false)
144
143
  then the RDF/XML parser will generate the idList rdf:type
147
146
  collections were initially added.
148
147
</simpara></listitem>
149
148
</varlistentry>
150
 
<varlistentry id="RAPTOR-FEATURE-NORMALIZE-LANGUAGE:CAPS" role="constant">
 
149
<varlistentry id="RAPTOR-FEATURE-NORMALIZE-LANGUAGE--CAPS" role="constant">
151
150
<term><literal>RAPTOR_FEATURE_NORMALIZE_LANGUAGE</literal></term>
152
151
<listitem><simpara> If true (default true) then
153
152
  XML language values such as from xml:lang will be normalized to
154
153
  lowercase.
155
154
</simpara></listitem>
156
155
</varlistentry>
157
 
<varlistentry id="RAPTOR-FEATURE-NON-NFC-FATAL:CAPS" role="constant">
 
156
<varlistentry id="RAPTOR-FEATURE-NON-NFC-FATAL--CAPS" role="constant">
158
157
<term><literal>RAPTOR_FEATURE_NON_NFC_FATAL</literal></term>
159
158
<listitem><simpara> If true (default false) then
160
159
 illegal Unicode Normal Form C in literals will give a fatal
161
160
 error, otherwise just a warning.
162
161
</simpara></listitem>
163
162
</varlistentry>
164
 
<varlistentry id="RAPTOR-FEATURE-WARN-OTHER-PARSETYPES:CAPS" role="constant">
 
163
<varlistentry id="RAPTOR-FEATURE-WARN-OTHER-PARSETYPES--CAPS" role="constant">
165
164
<term><literal>RAPTOR_FEATURE_WARN_OTHER_PARSETYPES</literal></term>
166
165
<listitem><simpara> If true (default true) then 
167
166
  the RDF/XML parser will warn about unknown rdf:parseType values.
168
167
</simpara></listitem>
169
168
</varlistentry>
170
 
<varlistentry id="RAPTOR-FEATURE-CHECK-RDF-ID:CAPS" role="constant">
 
169
<varlistentry id="RAPTOR-FEATURE-CHECK-RDF-ID--CAPS" role="constant">
171
170
<term><literal>RAPTOR_FEATURE_CHECK_RDF_ID</literal></term>
172
171
<listitem><simpara> If true (default true) then the
173
172
  RDF/XML will check rdf:ID attribute values for duplicates and
174
173
  cause an error if any are found.
175
174
</simpara></listitem>
176
175
</varlistentry>
177
 
<varlistentry id="RAPTOR-FEATURE-RELATIVE-URIS:CAPS" role="constant">
 
176
<varlistentry id="RAPTOR-FEATURE-RELATIVE-URIS--CAPS" role="constant">
178
177
<term><literal>RAPTOR_FEATURE_RELATIVE_URIS</literal></term>
179
178
<listitem><simpara> If true (default true) then
180
179
  relative URIs will be used wherever possible when serializing.
181
180
</simpara></listitem>
182
181
</varlistentry>
183
 
<varlistentry id="RAPTOR-FEATURE-START-URI:CAPS" role="constant">
 
182
<varlistentry id="RAPTOR-FEATURE-START-URI--CAPS" role="constant">
184
183
<term><literal>RAPTOR_FEATURE_START_URI</literal></term>
185
184
<listitem><simpara> Set the start URI for serlalizing to use.
186
185
</simpara></listitem>
187
186
</varlistentry>
188
 
<varlistentry id="RAPTOR-FEATURE-WRITER-AUTO-INDENT:CAPS" role="constant">
 
187
<varlistentry id="RAPTOR-FEATURE-WRITER-AUTO-INDENT--CAPS" role="constant">
189
188
<term><literal>RAPTOR_FEATURE_WRITER_AUTO_INDENT</literal></term>
190
189
<listitem><simpara> Automatically indent elements when
191
190
  seriailizing.
192
191
</simpara></listitem>
193
192
</varlistentry>
194
 
<varlistentry id="RAPTOR-FEATURE-WRITER-AUTO-EMPTY:CAPS" role="constant">
 
193
<varlistentry id="RAPTOR-FEATURE-WRITER-AUTO-EMPTY--CAPS" role="constant">
195
194
<term><literal>RAPTOR_FEATURE_WRITER_AUTO_EMPTY</literal></term>
196
195
<listitem><simpara> Automatically detect and
197
196
  abbreviate empty elements when serializing.
198
197
</simpara></listitem>
199
198
</varlistentry>
200
 
<varlistentry id="RAPTOR-FEATURE-WRITER-INDENT-WIDTH:CAPS" role="constant">
 
199
<varlistentry id="RAPTOR-FEATURE-WRITER-INDENT-WIDTH--CAPS" role="constant">
201
200
<term><literal>RAPTOR_FEATURE_WRITER_INDENT_WIDTH</literal></term>
202
201
<listitem><simpara> Integer number of spaces to use
203
202
  for each indent level when serializing with auto indent.
204
203
</simpara></listitem>
205
204
</varlistentry>
206
 
<varlistentry id="RAPTOR-FEATURE-WRITER-XML-VERSION:CAPS" role="constant">
 
205
<varlistentry id="RAPTOR-FEATURE-WRITER-XML-VERSION--CAPS" role="constant">
207
206
<term><literal>RAPTOR_FEATURE_WRITER_XML_VERSION</literal></term>
208
207
<listitem><simpara> Integer XML version XML 1.0 (10) or XML 1.1 (11)
209
208
</simpara></listitem>
210
209
</varlistentry>
211
 
<varlistentry id="RAPTOR-FEATURE-WRITER-XML-DECLARATION:CAPS" role="constant">
 
210
<varlistentry id="RAPTOR-FEATURE-WRITER-XML-DECLARATION--CAPS" role="constant">
212
211
<term><literal>RAPTOR_FEATURE_WRITER_XML_DECLARATION</literal></term>
213
212
<listitem><simpara> Write XML 1.0 or 1.1 declaration.
214
213
</simpara></listitem>
215
214
</varlistentry>
216
 
<varlistentry id="RAPTOR-FEATURE-NO-NET:CAPS" role="constant">
 
215
<varlistentry id="RAPTOR-FEATURE-NO-NET--CAPS" role="constant">
217
216
<term><literal>RAPTOR_FEATURE_NO_NET</literal></term>
218
217
<listitem><simpara> Deny network requests.
219
218
</simpara></listitem>
220
219
</varlistentry>
221
 
<varlistentry id="RAPTOR-FEATURE-RESOURCE-BORDER:CAPS" role="constant">
 
220
<varlistentry id="RAPTOR-FEATURE-RESOURCE-BORDER--CAPS" role="constant">
222
221
<term><literal>RAPTOR_FEATURE_RESOURCE_BORDER</literal></term>
223
222
<listitem><simpara> Border color of resource
224
223
  nodes for GraphViz DOT serializer.
225
224
</simpara></listitem>
226
225
</varlistentry>
227
 
<varlistentry id="RAPTOR-FEATURE-LITERAL-BORDER:CAPS" role="constant">
 
226
<varlistentry id="RAPTOR-FEATURE-LITERAL-BORDER--CAPS" role="constant">
228
227
<term><literal>RAPTOR_FEATURE_LITERAL_BORDER</literal></term>
229
228
<listitem><simpara> Border color of literal nodes
230
229
  for GraphViz DOT serializer.
231
230
</simpara></listitem>
232
231
</varlistentry>
233
 
<varlistentry id="RAPTOR-FEATURE-BNODE-BORDER:CAPS" role="constant">
 
232
<varlistentry id="RAPTOR-FEATURE-BNODE-BORDER--CAPS" role="constant">
234
233
<term><literal>RAPTOR_FEATURE_BNODE_BORDER</literal></term>
235
234
<listitem><simpara> Border color of blank nodes for
236
235
  GraphViz DOT serializer.
237
236
</simpara></listitem>
238
237
</varlistentry>
239
 
<varlistentry id="RAPTOR-FEATURE-RESOURCE-FILL:CAPS" role="constant">
 
238
<varlistentry id="RAPTOR-FEATURE-RESOURCE-FILL--CAPS" role="constant">
240
239
<term><literal>RAPTOR_FEATURE_RESOURCE_FILL</literal></term>
241
240
<listitem><simpara> Fill color of resource nodes
242
241
  for GraphViz DOT serializer.
243
242
</simpara></listitem>
244
243
</varlistentry>
245
 
<varlistentry id="RAPTOR-FEATURE-LITERAL-FILL:CAPS" role="constant">
 
244
<varlistentry id="RAPTOR-FEATURE-LITERAL-FILL--CAPS" role="constant">
246
245
<term><literal>RAPTOR_FEATURE_LITERAL_FILL</literal></term>
247
246
<listitem><simpara> Fill color of literal nodes for
248
247
  GraphViz DOT serializer.
249
248
</simpara></listitem>
250
249
</varlistentry>
251
 
<varlistentry id="RAPTOR-FEATURE-BNODE-FILL:CAPS" role="constant">
 
250
<varlistentry id="RAPTOR-FEATURE-BNODE-FILL--CAPS" role="constant">
252
251
<term><literal>RAPTOR_FEATURE_BNODE_FILL</literal></term>
253
252
<listitem><simpara> Fill color of blank nodes for
254
253
  GraphViz DOT serializer.
255
254
</simpara></listitem>
256
255
</varlistentry>
257
 
<varlistentry id="RAPTOR-FEATURE-HTML-TAG-SOUP:CAPS" role="constant">
 
256
<varlistentry id="RAPTOR-FEATURE-HTML-TAG-SOUP--CAPS" role="constant">
258
257
<term><literal>RAPTOR_FEATURE_HTML_TAG_SOUP</literal></term>
259
258
<listitem><simpara> Use a lax HTML parser if an XML parser
260
259
  fails when read HTML for GRDDL parser.
261
260
</simpara></listitem>
262
261
</varlistentry>
263
 
<varlistentry id="RAPTOR-FEATURE-MICROFORMATS:CAPS" role="constant">
 
262
<varlistentry id="RAPTOR-FEATURE-MICROFORMATS--CAPS" role="constant">
264
263
<term><literal>RAPTOR_FEATURE_MICROFORMATS</literal></term>
265
264
<listitem><simpara> Look for microformats for GRDDL parser.
266
265
</simpara></listitem>
267
266
</varlistentry>
268
 
<varlistentry id="RAPTOR-FEATURE-HTML-LINK:CAPS" role="constant">
 
267
<varlistentry id="RAPTOR-FEATURE-HTML-LINK--CAPS" role="constant">
269
268
<term><literal>RAPTOR_FEATURE_HTML_LINK</literal></term>
270
269
<listitem><simpara> Look for head &lt;link&gt; to type rdf/xml
271
270
  for GRDDL parser.
272
271
</simpara></listitem>
273
272
</varlistentry>
274
 
<varlistentry id="RAPTOR-FEATURE-WWW-TIMEOUT:CAPS" role="constant">
 
273
<varlistentry id="RAPTOR-FEATURE-WWW-TIMEOUT--CAPS" role="constant">
275
274
<term><literal>RAPTOR_FEATURE_WWW_TIMEOUT</literal></term>
276
275
<listitem><simpara> Set timeout for internal WWW URI requests
277
276
  for GRDDL parser.
278
277
</simpara></listitem>
279
278
</varlistentry>
280
 
<varlistentry id="RAPTOR-FEATURE-WRITE-BASE-URI:CAPS" role="constant">
 
279
<varlistentry id="RAPTOR-FEATURE-WRITE-BASE-URI--CAPS" role="constant">
281
280
<term><literal>RAPTOR_FEATURE_WRITE_BASE_URI</literal></term>
282
281
<listitem><simpara> Write <parameter>base</parameter> directive for Turtle/N3.
283
282
</simpara></listitem>
284
283
</varlistentry>
285
 
<varlistentry id="RAPTOR-FEATURE-WWW-HTTP-CACHE-CONTROL:CAPS" role="constant">
 
284
<varlistentry id="RAPTOR-FEATURE-WWW-HTTP-CACHE-CONTROL--CAPS" role="constant">
286
285
<term><literal>RAPTOR_FEATURE_WWW_HTTP_CACHE_CONTROL</literal></term>
287
286
<listitem><simpara> HTTP Cache-Control: header
288
287
</simpara></listitem>
289
288
</varlistentry>
290
 
<varlistentry id="RAPTOR-FEATURE-WWW-HTTP-USER-AGENT:CAPS" role="constant">
 
289
<varlistentry id="RAPTOR-FEATURE-WWW-HTTP-USER-AGENT--CAPS" role="constant">
291
290
<term><literal>RAPTOR_FEATURE_WWW_HTTP_USER_AGENT</literal></term>
292
291
<listitem><simpara> HTTP User-Agent: header
293
292
</simpara></listitem>
294
293
</varlistentry>
295
 
<varlistentry id="RAPTOR-FEATURE-JSON-CALLBACK:CAPS" role="constant">
 
294
<varlistentry id="RAPTOR-FEATURE-JSON-CALLBACK--CAPS" role="constant">
296
295
<term><literal>RAPTOR_FEATURE_JSON_CALLBACK</literal></term>
297
296
<listitem><simpara> JSON serializer callback function.
298
297
</simpara></listitem>
299
298
</varlistentry>
300
 
<varlistentry id="RAPTOR-FEATURE-JSON-EXTRA-DATA:CAPS" role="constant">
 
299
<varlistentry id="RAPTOR-FEATURE-JSON-EXTRA-DATA--CAPS" role="constant">
301
300
<term><literal>RAPTOR_FEATURE_JSON_EXTRA_DATA</literal></term>
302
301
<listitem><simpara> JSON serializer extra top-level data
303
302
</simpara></listitem>
304
303
</varlistentry>
305
 
<varlistentry id="RAPTOR-FEATURE-RSS-TRIPLES:CAPS" role="constant">
 
304
<varlistentry id="RAPTOR-FEATURE-RSS-TRIPLES--CAPS" role="constant">
306
305
<term><literal>RAPTOR_FEATURE_RSS_TRIPLES</literal></term>
307
306
<listitem><simpara> Atom/RSS serializer writes extra RDF triples it finds (none, rdf-xml, atom-triples)
308
307
</simpara></listitem>
309
308
</varlistentry>
310
 
<varlistentry id="RAPTOR-FEATURE-ATOM-ENTRY-URI:CAPS" role="constant">
 
309
<varlistentry id="RAPTOR-FEATURE-ATOM-ENTRY-URI--CAPS" role="constant">
311
310
<term><literal>RAPTOR_FEATURE_ATOM_ENTRY_URI</literal></term>
312
311
<listitem><simpara> Atom entry URI.  If given, generate an Atom Entry Document with the item having the given URI, otherwise generate an Atom Feed Document with any items found.
313
312
</simpara></listitem>
314
313
</varlistentry>
315
 
<varlistentry id="RAPTOR-FEATURE-LAST:CAPS" role="constant">
 
314
<varlistentry id="RAPTOR-FEATURE-PREFIX-ELEMENTS--CAPS" role="constant">
 
315
<term><literal>RAPTOR_FEATURE_PREFIX_ELEMENTS</literal></term>
 
316
<listitem><simpara> Integer. If set, generate Atom/RSS1.0 documents with prefixed elements, otherwise unprefixed.
 
317
</simpara></listitem>
 
318
</varlistentry>
 
319
<varlistentry id="RAPTOR-FEATURE-LAST--CAPS" role="constant">
316
320
<term><literal>RAPTOR_FEATURE_LAST</literal></term>
317
321
<listitem><simpara> Internal
318
322
</simpara></listitem>
320
324
</variablelist></refsect2>
321
325
<refsect2 id="raptor-get-feature-count" role="function">
322
326
<title>raptor_get_feature_count ()</title>
323
 
<indexterm zone="raptor-get-feature-count"><primary>raptor_get_feature_count</primary></indexterm><programlisting>unsigned <link linkend="int">int</link>        raptor_get_feature_count            (void);</programlisting>
 
327
<indexterm zone="raptor-get-feature-count"><primary sortas="raptor_get_feature_count">raptor_get_feature_count</primary></indexterm><programlisting>unsigned <link linkend="int">int</link>        raptor_get_feature_count            (void);</programlisting>
324
328
<para>
325
329
Get the count of features defined.
326
330
</para>
327
331
<para>
328
 
This is prefered to the compile time-only symbol <link linkend="RAPTOR-FEATURE-LAST:CAPS"><type>RAPTOR_FEATURE_LAST</type></link>
 
332
This is prefered to the compile time-only symbol <link linkend="RAPTOR-FEATURE-LAST--CAPS"><type>RAPTOR_FEATURE_LAST</type></link>
329
333
and returns a count of the number of features which is
330
 
<link linkend="RAPTOR-FEATURE-LAST:CAPS"><type>RAPTOR_FEATURE_LAST</type></link>+1.</para>
 
334
<link linkend="RAPTOR-FEATURE-LAST--CAPS"><type>RAPTOR_FEATURE_LAST</type></link>+1.</para>
331
335
<para>
332
 
 
333
336
</para><variablelist role="params">
334
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> count of features in the <link linkend="raptor-feature"><type>raptor_feature</type></link> enumeration
 
337
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> count of features in the <link linkend="raptor-feature"><type>raptor_feature</type></link> enumeration
335
338
</simpara></listitem></varlistentry>
336
339
</variablelist></refsect2>
337
340
<refsect2 id="raptor-features-enumerate" role="function">
338
341
<title>raptor_features_enumerate ()</title>
339
 
<indexterm zone="raptor-features-enumerate"><primary>raptor_features_enumerate</primary></indexterm><programlisting><link linkend="int">int</link>                 raptor_features_enumerate           (const <link linkend="raptor-feature">raptor_feature</link> feature,
 
342
<indexterm zone="raptor-features-enumerate"><primary sortas="raptor_features_enumerate">raptor_features_enumerate</primary></indexterm><programlisting><link linkend="int">int</link>                 raptor_features_enumerate           (const <link linkend="raptor-feature">raptor_feature</link> feature,
340
343
                                                         const <link linkend="char">char</link> **name,
341
344
                                                         <link linkend="raptor-uri">raptor_uri</link> **uri,
342
345
                                                         const <link linkend="char">char</link> **label);</programlisting>
344
347
Get list of syntax features.
345
348
</para>
346
349
<para>
347
 
If uri is not NULL, a pointer toa new raptor_uri is returned
348
 
that must be freed by the caller with <link linkend="raptor-free-uri"><function>raptor_free_uri()</function></link>.</para>
349
 
<para>
350
 
 
 
350
If uri is not NULL, a pointer to a new raptor_uri is returned
 
351
that must be freed by the caller with <link linkend="raptor-free-uri"><function>raptor_free_uri()</function></link>.
 
352
</para>
 
353
<para>
 
354
<link linkend="raptor-init"><function>raptor_init()</function></link> MUST have been called before calling this function.
 
355
Use <link linkend="raptor-features-enumerate-v2"><function>raptor_features_enumerate_v2()</function></link> if using raptor_world APIs.</para>
 
356
<para>
351
357
</para><variablelist role="params">
352
 
<varlistentry><term><parameter>feature</parameter>&nbsp;:</term>
 
358
<varlistentry><term><parameter>feature</parameter>&#160;:</term>
353
359
<listitem><simpara> feature enumeration (0+)
354
360
</simpara></listitem></varlistentry>
355
 
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
361
<varlistentry><term><parameter>name</parameter>&#160;:</term>
356
362
<listitem><simpara> pointer to store feature short name (or NULL)
357
363
</simpara></listitem></varlistentry>
358
 
<varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
 
364
<varlistentry><term><parameter>uri</parameter>&#160;:</term>
359
365
<listitem><simpara> pointer to store feature URI (or NULL)
360
366
</simpara></listitem></varlistentry>
361
 
<varlistentry><term><parameter>label</parameter>&nbsp;:</term>
 
367
<varlistentry><term><parameter>label</parameter>&#160;:</term>
362
368
<listitem><simpara> pointer to feature label (or NULL)
363
369
</simpara></listitem></varlistentry>
364
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> 0 on success, &lt;0 on failure, &gt;0 if feature is unknown
 
370
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> 0 on success, &lt;0 on failure, &gt;0 if feature is unknown
365
371
</simpara></listitem></varlistentry>
366
372
</variablelist></refsect2>
367
373
<refsect2 id="raptor-feature-from-uri" role="function">
368
374
<title>raptor_feature_from_uri ()</title>
369
 
<indexterm zone="raptor-feature-from-uri"><primary>raptor_feature_from_uri</primary></indexterm><programlisting><link linkend="raptor-feature">raptor_feature</link>      raptor_feature_from_uri             (<link linkend="raptor-uri">raptor_uri</link> *uri);</programlisting>
 
375
<indexterm zone="raptor-feature-from-uri"><primary sortas="raptor_feature_from_uri">raptor_feature_from_uri</primary></indexterm><programlisting><link linkend="raptor-feature">raptor_feature</link>      raptor_feature_from_uri             (<link linkend="raptor-uri">raptor_uri</link> *uri);</programlisting>
370
376
<para>
371
377
Turn a feature URI into an feature enum.
372
378
</para>
373
379
<para>
374
 
The allowed feature URIs are available via <link linkend="raptor-features-enumerate"><function>raptor_features_enumerate()</function></link>.</para>
375
 
<para>
376
 
 
 
380
The allowed feature URIs are available via <link linkend="raptor-features-enumerate"><function>raptor_features_enumerate()</function></link>.
 
381
</para>
 
382
<para>
 
383
<link linkend="raptor-init"><function>raptor_init()</function></link> MUST have been called before calling this function.
 
384
Use <link linkend="raptor-feature-from-uri-v2"><function>raptor_feature_from_uri_v2()</function></link> if using raptor_world APIs.</para>
 
385
<para>
377
386
</para><variablelist role="params">
378
 
<varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
 
387
<varlistentry><term><parameter>uri</parameter>&#160;:</term>
379
388
<listitem><simpara> feature URI
380
389
</simpara></listitem></varlistentry>
381
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> &lt; 0 if the feature is unknown
 
390
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> &lt; 0 if the feature is unknown
382
391
</simpara></listitem></varlistentry>
383
392
</variablelist></refsect2>
384
393
<refsect2 id="raptor-feature-value-type" role="function">
385
394
<title>raptor_feature_value_type ()</title>
386
 
<indexterm zone="raptor-feature-value-type"><primary>raptor_feature_value_type</primary></indexterm><programlisting><link linkend="int">int</link>                 raptor_feature_value_type           (const <link linkend="raptor-feature">raptor_feature</link> feature);</programlisting>
 
395
<indexterm zone="raptor-feature-value-type"><primary sortas="raptor_feature_value_type">raptor_feature_value_type</primary></indexterm><programlisting><link linkend="int">int</link>                 raptor_feature_value_type           (const <link linkend="raptor-feature">raptor_feature</link> feature);</programlisting>
387
396
<para>
388
397
Get the type of a features.
389
398
</para>
399
408
( <link linkend="raptor-serializer-set-feature-string"><function>raptor_serializer_set_feature_string()</function></link>
400
409
and <link linkend="raptor-serializer-get-feature-string"><function>raptor_serializer_get_feature_string()</function></link> )</para>
401
410
<para>
402
 
 
403
411
</para><variablelist role="params">
404
 
<varlistentry><term><parameter>feature</parameter>&nbsp;:</term>
 
412
<varlistentry><term><parameter>feature</parameter>&#160;:</term>
405
413
<listitem><simpara> raptor serializer or parser feature
406
414
</simpara></listitem></varlistentry>
407
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the type of the feature or &lt;0 if <parameter>feature</parameter> is unknown
 
415
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the type of the feature or &lt;0 if <parameter>feature</parameter> is unknown
408
416
</simpara></listitem></varlistentry>
409
417
</variablelist></refsect2>
410
418