Skip to content

Commit

Permalink
Updating main page, API is gxp only
Browse files Browse the repository at this point in the history
  • Loading branch information
bmmpxf committed Aug 11, 2014
1 parent 0faa5c1 commit 62dae04
Showing 1 changed file with 7 additions and 12 deletions.
19 changes: 7 additions & 12 deletions src/doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,15 @@
.. _api-reference:

Boundless SDK Client API Reference
==================================
Boundless SDK API reference - ``gxp`` template
==============================================

For information about **how to use** the Boundless SDK please refer to the Suite User Manual section on **webapps** located at `Suite > Building complete web applications <http://localhost:8080/opengeo-docs/webapps/>`_ or visit our `online Suite documentation <http://suite.opengeo.org/opengeo-docs/webapps/>`_.
This document describes the API for using the ``gxp`` template of the Boundless SDK. Other templates, such as ``ol3-view`` and ``ol3-edit``, do not use this API, instead relying on the standard OpenLayers 3 API.

The gxp components and data utility classes extend map related functionality to
equivalent classes in Ext. The API reference here documents the properties,
methods, and events that are extensions or modifications to the Ext parent
classes. Documentation for each class contains links to the Ext parent class,
and for a full picture of the API, it is essential to have a copy of the
`Ext API Documentation`_ at hand.
The ``gxp`` components and data utility classes extend map related functionality to equivalent classes in Ext. This API reference here documents the properties, methods, and events that are extensions or modifications to the Ext parent classes. Documentation for each class contains links to the Ext parent class, and for a full picture of the API, it is essential to have a copy of the `Ext API Documentation`_ at hand.

gxp classes are typically configured with OpenLayers or GeoExt objects. For
detail on methods and properties provided by these objects, see the
`OpenLayers API Documentation`_ and `GeoExt API Documentation`_.
The ``gxp`` classes are typically configured with OpenLayers or GeoExt objects. For detail on methods and properties provided by these objects, see the `OpenLayers API Documentation`_ and `GeoExt API Documentation`_.

For more information about how to use the Boundless SDK, please see the :guilabel:`Building complete web applications` section of the OpenGeo Suite User Manual. This can be found in your local installation or at our `online documentation <http://suite.opengeo.org/docs/latest/webapps/>`_.

.. _`Ext API Documentation`: http://extjs.com/deploy/dev/docs/
.. _`OpenLayers API Documentation`: http://dev.openlayers.org/apidocs
Expand Down

0 comments on commit 62dae04

Please sign in to comment.