doc/reference/json-glib-docs.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   4 <!ENTITY version SYSTEM "version.xml">
   5 ]>
   6
   7 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
   8   <bookinfo>
   9     <title>JSON-GLib Reference Manual</title>
  10     <releaseinfo>for JSON-GLib &version;</releaseinfo>
  11
  12     <copyright>
  13       <year>2007, 2008</year>
  14       <holder>OpenedHand LTD</holder>
  15     </copyright>
  16
  17     <copyright>
  18       <year>2009, 2010, 2011</year>
  19       <holder>Intel Corporation</holder>
  20     </copyright>
  21
  22     <legalnotice>
  23       <para>
  24         Permission is granted to copy, distribute and/or modify this
  25         document under the terms of the <citetitle>GNU Free
  26         Documentation License</citetitle>, Version 1.1 or any later
  27         version published by the Free Software Foundation with no
  28         Invariant Sections, no Front-Cover Texts, and no Back-Cover
  29         Texts. You may obtain a copy of the <citetitle>GNU Free
  30         Documentation License</citetitle> from the Free Software
  31         Foundation by visiting <ulink type="http"
  32         url="http://www.fsf.org">their Web site</ulink> or by writing
  33         to:
  34
  35         <address>
  36           The Free Software Foundation, Inc.,
  37           <street>59 Temple Place</street> - Suite 330,
  38           <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
  39           <country>USA</country>
  40         </address>
  41       </para>
  42     </legalnotice>
  43
  44     </bookinfo>
  45
  46   <part id="json-glib">
  47     <title>JSON-GLib Overview</title>
  48
  49     <partintro>
  50
  51     <para>
  52     JSON-GLib is a library aimed at providing an API for efficient parsing
  53     and writing of JSON (JavaScript Object Notation) streams, using GLib's
  54     data types and API.
  55     </para>
  56
  57     </partintro>
  58
  59   </part>
  60
  61   <part id="json-base">
  62     <title>JSON-GLib Reference</title>
  63
  64     <partintro>
  65
  66       <para>
  67       JSON-GLib provides wrappers around the complex data types defined
  68       by the JSON specification. The fundamental types are handled using
  69       the Generic Value container (GValue) provided by GLib.
  70       </para>
  71
  72       <para>
  73       JSON complex data types are either arrays (a n-tuple of items)
  74       or objects (a mapping between a string and a value); arrays and
  75       objects can contain multiple values, including other arrays and
  76       objects.
  77       </para>
  78
  79     </partintro>
  80
  81     <chapter>
  82       <title>Data Types</title>
  83       <xi:include href="xml/json-node.xml"/>
  84       <xi:include href="xml/json-array.xml"/>
  85       <xi:include href="xml/json-object.xml"/>
  86     </chapter>
  87
  88   </part>
  89
  90   <part id="json-streams">
  91     <title>Reading and writing</title>
  92
  93     <partintro>
  94
  95       <para>
  96       JSON-GLib provides a parser object to read any valid JSON data
  97       stream and build the data object model in memory.
  98       </para>
  99
 100     </partintro>
 101
 102     <chapter>
 103       <title>Parser</title>
 104       <xi:include href="xml/json-parser.xml"/>
 105       <xi:include href="xml/json-reader.xml"/>
 106       <xi:include href="xml/json-path.xml"/>
 107     </chapter>
 108
 109     <chapter>
 110       <title>Generator</title>
 111       <xi:include href="xml/json-generator.xml"/>
 112       <xi:include href="xml/json-builder.xml"/>
 113     </chapter>
 114
 115   </part>
 116
 117   <part id="json-advanced">
 118     <title>JSON-GLib Advanced API</title>
 119
 120     <xi:include href="xml/json-gobject.xml"/>
 121     <xi:include href="xml/json-serializable.xml"/>
 122     <xi:include href="xml/json-gboxed.xml"/>
 123     <xi:include href="xml/json-gvariant.xml"/>
 124   </part>
 125
 126   <part id="json-tools">
 127     <title>JSON-GLib Additional Reference</title>
 128
 129     <xi:include href="xml/json-version.xml"/>
 130
 131     <chapter>
 132       <title>Object Hierarchy</title>
 133       <xi:include href="xml/tree_index.sgml"/>
 134     </chapter>
 135
 136   </part>
 137
 138   <index>
 139     <title>Index</title>
 140     <xi:include href="xml/api-index-full.xml"><xi:fallback/></xi:include>
 141   </index>
 142
 143   <index role="deprecated">
 144     <title>Index of deprecated symbols</title>
 145     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback/></xi:include>
 146   </index>
 147
 148   <index role="0.4">
 149     <title>Index of new symbols in 0.4</title>
 150     <xi:include href="xml/api-index-0.4.xml"><xi:fallback/></xi:include>
 151   </index>
 152
 153   <index role="0.6">
 154     <title>Index of new symbols in 0.6</title>
 155     <xi:include href="xml/api-index-0.6.xml"><xi:fallback/></xi:include>
 156   </index>
 157
 158   <index role="0.8">
 159     <title>Index of new symbols in 0.8</title>
 160     <xi:include href="xml/api-index-0.8.xml"><xi:fallback/></xi:include>
 161   </index>
 162
 163   <index role="0.10">
 164     <title>Index of new symbols in 0.10</title>
 165     <xi:include href="xml/api-index-0.10.xml"><xi:fallback/></xi:include>
 166   </index>
 167
 168   <index role="0.12">
 169     <title>Index of new symbols in 0.12</title>
 170     <xi:include href="xml/api-index-0.12.xml"><xi:fallback/></xi:include>
 171   </index>
 172
 173   <index role="0.14">
 174     <title>Index of new symbols in 0.14</title>
 175     <xi:include href="xml/api-index-0.14.xml"><xi:fallback/></xi:include>
 176   </index>
 177
 178   <xi:include href="xml/annotation-glossary.xml"/>
 179
 180   <appendix id="license">
 181     <title>License</title>
 182
 183     <para>
 184       This library is free software; you can redistribute it and/or
 185       modify it under the terms of the <citetitle>GNU Library General
 186       Public License</citetitle> as published by the Free Software
 187       Foundation; either version 2 of the License, or (at your option)
 188       any later version.
 189     </para>
 190
 191     <para>
 192       This library is distributed in the hope that it will be useful,
 193       but WITHOUT ANY WARRANTY; without even the implied warranty of
 194       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 195       <citetitle>GNU Library General Public License</citetitle> for
 196       more details.
 197     </para>
 198
 199     <para>
 200       You may obtain a copy of the <citetitle>GNU Library General
 201       Public License</citetitle> from the Free Software Foundation by
 202       visiting <ulink type="http" url="http://www.fsf.org">their Web
 203       site</ulink> or by writing to:
 204
 205       <address>
 206         Free Software Foundation, Inc.
 207         <street>59 Temple Place</street> - Suite 330
 208         <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
 209         <country>USA</country>
 210       </address>
 211     </para>
 212   </appendix>
 213
 214 </book>