doc/reference/json-glib-docs.xml

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