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.

Sign up for GitHub

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

Jump to bottom

Enhance metadata administration description #3102

Merged
merged 2 commits into from
Sep 20, 2017
Merged

Enhance metadata administration description #3102

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
85f32cc
Enhance metadata administration description
jwkaltz Sep 18, 2017
68cedef
remove trailing whitespace
jwkaltz Sep 20, 2017
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
20 changes: 11 additions & 9 deletions doc/administrator/administrate.rst.mako
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,19 @@ you should define two ``OGC servers``. Attributes:
Metadata
--------

All the Theme elements can have some Metadata to trigger some features,
mainly UI features. Attributes:
You can associate metadata to all theme elements (tree items).
The purpose of this metadata is to trigger specific features, mainly UI features.
Each metadata entry has the following attributes:

* ``Item``: the concerned tree item.
* ``Name``: the type of ``Metadata`` we want to set (configured in the ``vars``
* ``Item``: the tree item the metadata is associated to.
* ``Name``: the type of ``Metadata`` we want to set (the available names are configured in the ``vars``
files in ``admin_interface/available_metadata``).
* ``Value``: the value of the metadata.
* ``Descritpion``: a description.
* ``Value``: the value of the metadata entry.
* ``Description``: a description.

As the metadata are used by the layers on the client side, you'll find the effect
of each metadata in the `NGEO documentation <https://camptocamp.github.io/ngeo/master/apidoc/gmfThemes.GmfMetaData.html>`_.
To set a metadata entry, create or edit an entry in the Metadata view of the administration UI.
Regarding effect on the referenced tree item on the client side, you will find a description for each sort of
metadata in the `NGEO documentation <https://camptocamp.github.io/ngeo/master/apidoc/gmfThemes.GmfMetaData.html>`_.

Functionalities
---------------
Expand All @@ -54,7 +56,7 @@ Functionalities
* ``Name``: the type of Metadata we want to set (configured in the ``vars``
files in ``admin_interface/available_functionalities``).
* ``Value``: the value of the metadata.
* ``Descritpion``: a description.
* ``Description``: a description.

Layers
------
Expand Down
2 changes: 1 addition & 1 deletion doc/builddoc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ Build this doc

.. prompt:: bash

make doc
./docker-run make doc

The HTML should now be available in the ``doc/_build/html`` directory.