summaryrefslogtreecommitdiff
path: root/docs/raptor-docs.xml
blob: bcfaef3fa37a69cd119b0efc09a34d80ba89d394 (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
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" 
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
  <bookinfo>
    <title>Raptor RDF Syntax Library Manual</title>
    <releaseinfo>Manual for <ulink url="http://librdf.org/raptor/">Raptor</ulink> &version;</releaseinfo>

    <author>
      <firstname>Dave</firstname>
      <surname>Beckett</surname>
      <affiliation>
	<address>
	  <otheraddr><ulink url="http://www.dajobe.org/">http://www.dajobe.org/</ulink></otheraddr>
	</address>
      </affiliation>
    </author>

    <legalnotice>
    <para>
      This documentation is Free Software / Open Source - you can
      redistribute it and/or modify it under the same licenses as
      <ulink url="http://librdf.org/raptor/">Raptor</ulink>.
      It is licensed under the following three licenses as alternatives:
      <orderedlist>
	<listitem><para>GNU Lesser General Public License (LGPL) V2.1 or any newer version</para></listitem>
	<listitem><para>GNU General Public License (GPL) V2 or any newer version</para></listitem>
	<listitem><para>Apache License, V2.0 or any newer version</para></listitem>
      </orderedlist>
      You may not use this documentation except in compliance with at
      least one of the above three licenses. See the
      <ulink url="http://librdf.org/raptor/">Raptor</ulink>
      site for the full license terms.
    </para>

    </legalnotice>

    <copyright>
      <year>2001</year>
      <year>2002</year>
      <year>2003</year>
      <year>2004</year>
      <year>2005</year>
      <year>2006</year>
      <year>2007</year>
      <year>2008</year>
      <year>2009</year>
      <year>2010</year>
      <year>2011</year>
      <year>2012</year>
      <year>2013</year>
      <year>2014</year>
      <year>2015</year>
      <year>2016</year>
      <year>2017</year>
      <year>2018</year>
      <year>2019</year>
      <year>2020</year>
      <year>2021</year>
      <year>2022</year>
      <year>2023</year>
      <holder>Dave Beckett</holder>
    </copyright>
    <copyright>
      <year>2001</year>
      <year>2002</year>
      <year>2003</year>
      <year>2004</year>
      <year>2005</year>
      <holder>University of Bristol</holder>
    </copyright>
  </bookinfo>

   <chapter id="introduction">
    <title>Raptor Overview</title>
    <para>
<ulink url="http://librdf.org/raptor/">Raptor</ulink>
is a free software / Open Source C library that provides
a set of parsers and serializers that
generate Resource Description Framework (RDF) triples
by parsing syntaxes or serialize the triples into a syntax.
It also includes supporting functionality for managing Unicode,
UTF-8, URIs, retrieving from URIs and reading and writing XML.
    </para>

  </chapter>

  <part id="tutorial"> 
    <title>Raptor Tutorial</title>

    <partintro id="tutorial-introduction">
      <para>This part describes how to use the
      <ulink url="http://librdf.org/raptor/">Raptor</ulink> APIs to
      turn syntaxes into RDF triples and RDF triples into syntaxes.</para>

      <para>The next part contains the
      <link linkend="reference-manual">Raptor Reference Manual</link>
      which comprehensively describes every class and function of the API.
      </para>

      <para>For the latest information, see the
      <ulink url="http://librdf.org/raptor/">Raptor Home Page</ulink>
      and the <ulink url="../README.html">main document overview</ulink>
      in this document tree.
      </para>
    </partintro>

    <xi:include href="raptor-tutorial-intro.xml"/>
    <xi:include href="raptor-tutorial-querying-functionality.xml"/>
    <xi:include href="raptor-tutorial-parsing.xml"/>
    <xi:include href="raptor-tutorial-serializing.xml"/>
  </part>


  <part id="reference-manual">
    <title>Raptor Reference Manual</title>

    <partintro id="reference-manual-introduction">
      <para>This part contains the Raptor Reference Manual
      which comprehensively describes every class and function of the API.
      </para>
      
      <para>The previous part contains the
      <link linkend="tutorial">Raptor Tutorial</link>
      explaining how to use the API parts.
      </para>

      <para>For the latest information, see the
      <ulink url="http://librdf.org/raptor/">Raptor Home Page</ulink>
      and the <ulink url="../README.html">main document overview</ulink>
      in this document tree.
      </para>
    </partintro>

    <xi:include href="raptor-parsers.xml"/>
    <xi:include href="raptor-serializers.xml"/>


    <xi:include href="xml/section-world.xml"/>
    <xi:include href="xml/section-general.xml"/>
    <xi:include href="xml/section-memory.xml"/>
    <xi:include href="xml/section-avltree.xml"/>
    <xi:include href="xml/section-constants.xml"/>
    <xi:include href="xml/section-option.xml"/>
    <xi:include href="xml/section-iostream.xml"/>
    <xi:include href="xml/section-locator.xml"/>
    <xi:include href="xml/section-parser.xml"/>
    <xi:include href="xml/section-sax2.xml"/>
    <xi:include href="xml/section-sequence.xml"/>
    <xi:include href="xml/section-serializer.xml"/>
    <xi:include href="xml/section-stringbuffer.xml"/>
    <xi:include href="xml/section-triples.xml"/>
    <xi:include href="xml/section-unicode.xml"/>
    <xi:include href="xml/section-uri.xml"/>
    <xi:include href="xml/section-www.xml"/>
    <xi:include href="xml/section-xml-namespace.xml"/>
    <xi:include href="xml/section-xml-qname.xml"/>
    <xi:include href="xml/section-xml.xml"/>

    <xi:include href="raptor-formats.xml"/>

    <!-- <xi:include href="xml/section-unused.xml"/> -->

    <xi:include href="raptor-changes.xml"/>
  </part>

  <index>
    <title>Index</title>
  </index>
</book>