Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] reorganize integrator guide #3203

Merged
merged 7 commits into from
Oct 30, 2017
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,6 @@
/doc/administrator/administrate.rst
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to be removed ...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, thanks (next commit)

/doc/developer/client_side.rst
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to be removed ...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, thanks (next commit)

/doc/index.rst
/doc/integrator/legacy_cgxp.rst
/doc/integrator/editing.rst
/doc/integrator/features.rst
/doc/integrator/fulltext_search.rst
/doc/integrator/print.rst
/doc/integrator/upgrade_application.rst
/dist/
/coverage.xml
/gatling/.classpath
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,10 +127,10 @@ The layers in the admin interface have the following attributes:
the given layer, used to zoom to visible scale, with WMS if it is empty
we get the values from the capabilities.
* ``Disclaimer``: optional, copyright of the layer, used by
`Disclaimer <http://docs.camptocamp.net/cgxp/${main_version}/lib/plugins/Disclaimer.html>`_.
`Disclaimer <http://docs.camptocamp.net/cgxp/2.2/lib/plugins/Disclaimer.html>`_.
* ``Identifier attribute field``: field used to identify a feature from the
layer, e.g.: 'name', used by
`FeaturesWindow <http://docs.camptocamp.net/cgxp/${main_version}/lib/plugins/FeaturesWindow.html>`_.
`FeaturesWindow <http://docs.camptocamp.net/cgxp/2.2/lib/plugins/FeaturesWindow.html>`_.
* ``Restrictions area``: the areas throw witch the user can see the layer.

On ``internal WMS`` layer we have the following specific attributes:
Expand Down
3 changes: 2 additions & 1 deletion doc/administrator/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Administrator Guide
===================

This chapter describes how to install, deploy, and administrate a c2cgeoportal
This chapter describes how to administrate a c2cgeoportal
application.

The application administrator configures and administrates the application
Expand All @@ -23,3 +23,4 @@ Content:
editing
mapfile
tinyows
wmstime
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Dependencies

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we put ngeo before cgxp, anf mark cgxp as legacy?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok done (for next commit)

Major dependencies docs:

* `CGXP <http://docs.camptocamp.net/cgxp/${main_version}/>`_
* `CGXP <http://docs.camptocamp.net/cgxp/2.2/>`_
* `GXP <http://gxp.opengeo.org/master/doc/>`_
* `GeoExt <http://dev.geoext.org/geoext/docs/lib/>`_
* `OpenLayers <http://dev.openlayers.org/apidocs/files/OpenLayers-js.html>`_
Expand Down
10 changes: 4 additions & 6 deletions doc/integrator/authentication.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
.. _integrator_authentication:

Authentication
==============
--------------

The default policy
------------------
~~~~~~~~~~~~~~~~~~

By default ``c2cgeoportal`` applications use an *auth ticket* authentication
policy (``AuthTktAuthenticationPolicy``). With this policy the user name is
Expand All @@ -14,7 +12,7 @@ The policy is created, and added to the application's configuration, in the
application's main ``__init__.py`` file.

Using another policy
--------------------
~~~~~~~~~~~~~~~~~~~~

When using ``AuthTktAuthenticationPolicy`` an "auth ticket" cookie should be
set in the request for the user to be identified. In some applications using
Expand Down Expand Up @@ -168,7 +166,7 @@ an alias in a project-specific callback and use it instead of the standard
You should be set at this point.

Custom user validation
----------------------
~~~~~~~~~~~~~~~~~~~~~~

For logging in ``c2cgeoportal`` validates the user credentials
(username/password) by reading the user information from the ``user`` database
Expand Down
6 changes: 3 additions & 3 deletions doc/integrator/backend.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
.. _integrator_backend:

Specific Backend Documentation
Specific Backend Configuration
==============================

This section describes the specificities required by some specific backend.

By defaut C2cgeoportal is configured to use Mapserver, but it is possible to
user other backends.
By default C2cgeoportal is configured to use Mapserver, but it is possible to
use other backends.

.. toctree::
:maxdepth: 1
Expand Down
22 changes: 22 additions & 0 deletions doc/integrator/configuration.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
.. _configuration_guide:

Configuration Guide for advanced settings
-----------------------------------------

This chapter describes advanced configuration settings.

.. toctree::
:maxdepth: 1

make
ngeo
backend
caching
cluster
filter
fulltext_search
internationalization
shortener
subdomain
tilegeneration
windows_tools
13 changes: 10 additions & 3 deletions doc/integrator/customise.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,18 @@
Customise the application
=========================

There is two generic ways to customise the application.
.. toctree::
:maxdepth: 2

The ``functionnalities`` and the ``UI metadata``.
The application can be customised in the following manners:

``functionalities``, ``UI metadata`` and data model extensions.

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.

They should be configured in the vars file, in the ``admin_interface`` /
``available_functionnalities`` or respectively ``available_metadata``.
``available_functionalities`` or respectively ``available_metadata``.

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

Expand Down Expand Up @@ -54,3 +57,7 @@ In the admin interface we can use in all the URLs the following special schema:

``config://my_server/icon.png`` will be transformed into
the URL ``http://example.com/test/icon.png``.

.. include:: functionality.rst

.. include:: extend_data_model.rst
4 changes: 1 addition & 3 deletions doc/integrator/extend_data_model.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
.. _integrator_extend_data_model:

Extend the data model
=====================
---------------------

The Data model can be extended in the file ``<package>/models.py``
and the corresponding admin interface configuration
Expand Down
22 changes: 22 additions & 0 deletions doc/integrator/features.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
.. _integrator_features:

Additional features
===================

This section describes how to add features to a c2cgeoportal project,
and configure them.

Features that require additional steps (most of the time):

.. toctree::
:maxdepth: 1

ngeo
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Legacy

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Which one is legacy here?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

??? I'm tied :-)

object_editing
raster
print
api
reset_password
intranet
urllogin
pdfreport
40 changes: 0 additions & 40 deletions doc/integrator/features.rst.mako

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,6 @@
Full-text search
================

Enabling the *full-text search* feature involves adding a ``FullTextSearch``
plugin to the viewer, and creating and populating a dedicated table in the
database.

The FullTextSearch plugin
-------------------------

The viewer should include a ``FullTextSearch`` plugin for the *text search*
feature to be available in the user interface.

See the `FullTextSearch API doc
<http://docs.camptocamp.net/cgxp/${main_version}/lib/plugins/FullTextSearch.html>`_ for the
list of options the plugin can receive.

*The main viewer includes a FullTextSearch plugin by default.*

The full-text search table
--------------------------

Expand Down Expand Up @@ -153,7 +137,7 @@ For instance to specify a ``floor``:

Query string ``floor=1`` is then automatically appended to all WMS requests.

See `FloorSlider <http://docs.camptocamp.net/cgxp/${main_version}/lib/plugins/FloorSlider.html>`_
See `FloorSlider <http://docs.camptocamp.net/cgxp/2.2/lib/plugins/FloorSlider.html>`_
for more information.

Actions
Expand Down
16 changes: 6 additions & 10 deletions doc/integrator/functionality.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
.. _integrator_functionality:

Customizing the Application using Functionalities
=================================================
Functionalities
---------------

c2cgeoportal provides the concept of *functionality* that can be used to customize
the application according to the user's permissions.
Expand All @@ -25,10 +23,8 @@ the ``user`` database table, then the ``functionalities:anonymous`` and
``functionalities:registered`` configuration variables, as well as any
functionality associated with his/her role, will be ignored.

.. _integrator_functionality_configuration:

Configuration
-------------
~~~~~~~~~~~~~

The ``vars_<project>.yaml`` file includes variables for managing *functionalities*.

Expand Down Expand Up @@ -95,10 +91,10 @@ The ``vars_<project>.yaml`` file includes variables for managing *functionalitie
then the ``functionality`` template variable will be set to a dict with one
key/value pair: ``"<functionality_name>": ["value1","value2"]``.

Using Functionalities in Templates
----------------------------------
Usage in Templates
~~~~~~~~~~~~~~~~~~

As explained in the :ref:`integrator_functionality_configuration` section above,
As explained in the configuration section above,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why removing the link?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, purely for rst-technical reasons. Because the file functionality is now included by the file customisation, there is a otherwise a warning about duplicate labels - the html is generated fine anyway, but Travis will fail if I leave this warning.
For a better solution, we would need to restructure the files even more (but I would like to avoid that - take it one step at a time)

a functionality can be used in the Mako templates as long as it has been
enabled using the ``functionalities:available_in_templates`` parameter in the
``vars_<project>.yaml`` configuration file.
Expand Down
4 changes: 1 addition & 3 deletions doc/integrator/https.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
.. _integrator_https:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why removing that?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This label is not used, so I simply removed it (to avoid warnings - see above)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok


HTTPS
=====
-----

If your application is accessed in HTTPS, you have to make sure that all URLs
generated by the application (CSS and Javascript files, images, MapServer
Expand Down
50 changes: 11 additions & 39 deletions doc/integrator/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,51 +4,23 @@
Integrator Guide
================

This chapter describes how to install, deploy, and customize a
c2cgeoportal application. Furthermore, it describes how to
configure the files of the application.

Content:

.. toctree::
:maxdepth: 2

api
authentication
backend_arcgis
backend_geoserver
backend_qgis
backend
caching
checker
cluster
requirements
create_application
install_application
upgrade_application
configuration
customise
docker
editing
extend_data_model
security
features
filter
fulltext_search
functionality
https
install_application
internationalization
intranet
legacy_advanced
legacy_cgxp
legacy_print
docker
operations
legacy
make
ngeo
object_editing
pdfreport
print
raster
requirements
reset_password
security
shortener
statistics
subdomain
tilegeneration
upgrade_application
urllogin
windows_tools
wmstime
1 change: 1 addition & 0 deletions doc/integrator/legacy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@ Legacy components
:maxdepth: 1

legacy_cgxp
legacy_editing
legacy_print
legacy_advanced
Loading