Blob Blame History Raw
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
  <!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
  %gtkdocentities;
]>

<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
  <bookinfo>
    <title>&package_name; Reference Manual</title>
    <releaseinfo>
      <para>This document is the API reference for for &package_name; &package_version;.</para>
      <para>
        The latest version of this API reference is also available
        <ulink role="online-location" url="https://developer.gnome.org/json-glib/">online</ulink>.
      </para>
      <para>
        If you find any issues in this API reference, please report it
        using <ulink type="http" url="&package_bugreport;">the online
        bug reporting tool</ulink> at bugzilla.gnome.org.
      </para>
    </releaseinfo>

    <copyright>
      <year>2007, 2008</year>
      <holder>OpenedHand LTD</holder>
    </copyright>

    <copyright>
      <year>2009, 2010, 2011</year>
      <holder>Intel Corporation</holder>
    </copyright>

    <legalnotice>
      <para>
        Permission is granted to copy, distribute and/or modify this
        document under the terms of the <citetitle>GNU Free
        Documentation License</citetitle>, Version 1.1 or any later
        version published by the Free Software Foundation with no
        Invariant Sections, no Front-Cover Texts, and no Back-Cover
        Texts. You may obtain a copy of the <citetitle>GNU Free
        Documentation License</citetitle> from the Free Software
        Foundation by visiting <ulink type="http"
        url="http://www.fsf.org">their Web site</ulink> or by writing
        to:

        <address>
          The Free Software Foundation, Inc.,
          <street>59 Temple Place</street> - Suite 330,
          <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
          <country>USA</country>
        </address>
      </para>
    </legalnotice>

    </bookinfo>

  <part id="json-overview">
    <title>JSON-GLib Overview</title>

    <partintro>

    <para>
    JSON-GLib is a library aimed at providing an API for efficient parsing
    and writing of JSON (JavaScript Object Notation) streams, using GLib's
    data types and API.
    </para>

    <para>
    JSON (JavaScript Object Notation) is a lightweight data-interchange
    format. More information on the grammar is <ulink type="http"
    url="http://json.org">available on json.org</ulink>.
    </para>

    </partintro>

  </part>

  <part id="json-base">
    <title>JSON-GLib Reference</title>

    <partintro>

      <para>
      JSON-GLib provides wrappers around the complex data types defined
      by the JSON specification. The fundamental types are handled using
      the Generic Value container (GValue) provided by GLib.
      </para>

      <para>
      JSON complex data types are either arrays (a n-tuple of items)
      or objects (a mapping between a string and a value); arrays and
      objects can contain multiple values, including other arrays and
      objects.
      </para>

    </partintro>

    <chapter>
      <title>Data Types</title>
      <xi:include href="xml/json-node.xml"/>
      <xi:include href="xml/json-array.xml"/>
      <xi:include href="xml/json-object.xml"/>
    </chapter>

  </part>

  <part id="json-streams">
    <title>Reading and writing</title>

    <partintro>

      <para>
      JSON-GLib provides a parser object to read any valid JSON data
      stream and build the data object model in memory.
      </para>

    </partintro>

    <chapter>
      <title>Parser</title>
      <xi:include href="xml/json-parser.xml"/>
      <xi:include href="xml/json-reader.xml"/>
      <xi:include href="xml/json-path.xml"/>
    </chapter>

    <chapter>
      <title>Generator</title>
      <xi:include href="xml/json-generator.xml"/>
      <xi:include href="xml/json-builder.xml"/>
    </chapter>

    <chapter>
      <title>General Purpose API</title>
      <xi:include href="xml/json-utils.xml"/>
    </chapter>

  </part>

  <part id="json-advanced">
    <title>JSON-GLib Advanced API</title>

    <xi:include href="xml/json-gobject.xml"/>
    <xi:include href="xml/json-serializable.xml"/>
    <xi:include href="xml/json-gboxed.xml"/>
    <xi:include href="xml/json-gvariant.xml"/>
    <xi:include href="xml/json-version.xml"/>
  </part>

  <part id="json-tools">
    <title>JSON-GLib Additional Reference</title>

    <chapter id="tools">
      <title>JSON-GLib Tools</title>
      <xi:include href="json-glib-format.xml"/>
      <xi:include href="json-glib-validate.xml"/>
    </chapter>

    <chapter>
      <title>Object Hierarchy</title>
      <xi:include href="xml/tree_index.sgml"/>
    </chapter>

  </part>

  <index>
    <title>Index</title>
    <xi:include href="xml/api-index-full.xml"><xi:fallback/></xi:include>
  </index>

  <index role="deprecated">
    <title>Index of deprecated symbols</title>
    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback/></xi:include>
  </index>

  <index role="0.4">
    <title>Index of new symbols in 0.4</title>
    <xi:include href="xml/api-index-0.4.xml"><xi:fallback/></xi:include>
  </index>

  <index role="0.6">
    <title>Index of new symbols in 0.6</title>
    <xi:include href="xml/api-index-0.6.xml"><xi:fallback/></xi:include>
  </index>

  <index role="0.8">
    <title>Index of new symbols in 0.8</title>
    <xi:include href="xml/api-index-0.8.xml"><xi:fallback/></xi:include>
  </index>

  <index role="0.10">
    <title>Index of new symbols in 0.10</title>
    <xi:include href="xml/api-index-0.10.xml"><xi:fallback/></xi:include>
  </index>

  <index role="0.12">
    <title>Index of new symbols in 0.12</title>
    <xi:include href="xml/api-index-0.12.xml"><xi:fallback/></xi:include>
  </index>

  <index role="0.14">
    <title>Index of new symbols in 0.14</title>
    <xi:include href="xml/api-index-0.14.xml"><xi:fallback/></xi:include>
  </index>

  <index role="0.16">
    <title>Index of new symbols in 0.16</title>
    <xi:include href="xml/api-index-0.16.xml"><xi:fallback/></xi:include>
  </index>

  <index role="1.0">
    <title>Index of new symbols in 1.0</title>
    <xi:include href="xml/api-index-1.0.xml"><xi:fallback/></xi:include>
  </index>

  <index role="1.2">
    <title>Index of new symbols in 1.2</title>
    <xi:include href="xml/api-index-1.2.xml"><xi:fallback/></xi:include>
  </index>

  <index role="1.4">
    <title>Index of new symbols in 1.4</title>
    <xi:include href="xml/api-index-1.4.xml"><xi:fallback/></xi:include>
  </index>

  <xi:include href="xml/annotation-glossary.xml"><xi:fallback/></xi:include>

  <appendix id="license">
    <title>License</title>

    <para>
      This library is free software; you can redistribute it and/or
      modify it under the terms of the <citetitle>GNU Library General
      Public License</citetitle> as published by the Free Software
      Foundation; either version 2 of the License, or (at your option)
      any later version.
    </para>

    <para>
      This library is distributed in the hope that it will be useful,
      but WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      <citetitle>GNU Library General Public License</citetitle> for
      more details.
    </para>

    <para>
      You may obtain a copy of the <citetitle>GNU Library General
      Public License</citetitle> from the Free Software Foundation by
      visiting <ulink type="http" url="http://www.fsf.org">their Web
      site</ulink> or by writing to:

      <address>
        Free Software Foundation, Inc.
        <street>59 Temple Place</street> - Suite 330
        <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
        <country>USA</country>
      </address>
    </para>
  </appendix>

</book>