Skip to content

Commit

Permalink
Add the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sbrunner committed Apr 29, 2016
1 parent 9a94f09 commit 7f15640
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 21 deletions.
21 changes: 0 additions & 21 deletions doc/administrator/administrate.rst.mako
Original file line number Diff line number Diff line change
Expand Up @@ -127,24 +127,3 @@ LayerGroup
* ``Internal WMS``: if true it can include only ``Internal WMS`` layers,
if false it can include only ``external WMS`` or ``WMTS`` layers.
* ``Group of base layers``: if not ``Internal WMS`` replace radio button by check box (deprecated in v2).

URL
---

In the admin interface we can use in all the URL the following special schema:

* ``static``: to use a static route,

* ``static:///icon.png`` will get the URL of the ``static`` static route of the project.
* ``static://c2cgeoportal/icon.png`` will get the URL of the ``static`` static route of ``c2cgeoportal``.
* ``static://prj:img/icon.png`` will get the URL of the ``img`` static route of ``prj``.

* ``config``: to get the server name from the URL, with the config from the ``vars`` file:

.. code:: yaml

servers:
my_server: http://example.com/test

``config://my_server/icon.png`` will be transformed into
the URL ``http://example.com/test/icon.png``.
50 changes: 50 additions & 0 deletions doc/integrator/customise.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
.. _integrator_customise:

=========================
Customise the application
=========================

There is to generic way to customise the application.

The ``functionnalities`` and the ``UI metadata``.

The functionalities will be attached to the ``role`` and the ``theme``,
and the UI metadata will be attached to all the elements of the theme.

Thy should be configured in the vars file, in the ``admin_interface`` /
``available_functionnalities`` or respectively ``available_matadata``.

It's a list of object who have a ``name`` and a ``type``.

The type can be::

* ``string``
* ``list`` a list fo string
* ``boolean``
* ``integer``
* ``float``
* ``date``
* ``time``
* ``datetime`` `see the python-dateutil documentation <http://labix.org/python-dateutil#head-b95ce2094d189a89f80f5ae52a05b4ab7b41af47>`
* ``url`` see bellow

URL
---

In the admin interface we can use in all the URL the following special schema:

* ``static``: to use a static route,

* ``static:///icon.png`` will get the URL of the ``static-ngeo`` static route of the project.
* ``static://static-cgxp/icon.png`` will get the URL of the ``static-cgxp`` static route of the project.
* ``static://prj:img/icon.png`` will get the URL of the ``img`` static route of ``prj``.

* ``config``: to get the server name from the URL, with the config from the ``vars`` file:

.. code:: yaml
servers:
my_server: http://example.com/test
``config://my_server/icon.png`` will be transformed into
the URL ``http://example.com/test/icon.png``.
1 change: 1 addition & 0 deletions doc/integrator/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Content:
docker
features
tilegeneration
customise
functionality
raster
internationalization
Expand Down

0 comments on commit 7f15640

Please sign in to comment.