documentation

Documentation utilisateur [FR]
Gebruikersdocumentatie [NL]
User guide [EN]

Administration

This section is a first version of the admin documentation of cartostation.

For more technical (ie: developers infos), please refer to the readme about the server here and about the client applications here.

admin general

Applications

angled-project
metadata

angled-project

[angled-project] : Visualisation profiles

In the section admin/angled/profile/ you can configure viusalisation profiles.
Those profiles are used to filter and organize the information displayed to users in [angled-project] app.

nb : it is only related to data visualization, not data access control, and all profiles are available to use by anyone.

It is possible to display two types of informations :

Views are specific visualisation widgets.

Layout system

The layout system uses the following components :

Exemples :

Boxes can contain other boxes, UIs or views.

illustration Layout principle exemple with empty boxes

It is usually a good practice to start the design of a new profile on paper.

Options

Options can be used to customise the output of a IU or view, they are declared using key=value

Exemple :

title=”another_title”

ex : unit note title="another_title" will override the default title of the IU “note”.

hidden=1

usecase : show the IU in write mode but not in read mode. Usefull in combination with a view element, so you encode the datas, but only display the computed view.

class=”class_name”

Will add an extra css class on the IU.
This allows to invoke special style on the IU.

TO BE DOCUMENTED

filter=”field_name/term_ID”

It is possible to filter the content of a IU based on the Terms it uses.

The filter can be used this way : filter="field_name/term_ID"
Separators can be / or . or =.

Exemple : unit note filter="type/315" will display only the note content related to the Term ID 51 (which is “source/bron” ).

Since it is possible to display multiple times the same IUs in profiles, it this bring a bit of complexity, but gives the administrators a great flexibility to create highly customized profiles.

exclude=”field_name/term_ID”

To display all values except one, it is possible to exclude a specific value by using exclude="field_name/term_ID"

Exemple : unit note exclude="type/314" will display all notes except the one related to the initial import (tagged with term 314).

[angled-project] : Audience

Audience are created to restrict the visibility of the information to specifics users.

It is defined by informations authors in angled-project app, and used everywhere angled-project datas are used, such as in the angled-query app or in the maps showing project datas.

When visualizing a project in angled-project, users without the right Audience permissions will be nonetheless advertised that there is an information, that they are not allowed to see.

Create a new Audience

To create a new Audience, visit the section /admin/angled/audience/.

To add one, just give it name, a description, and attach it to a group.

The users part of that group will then be part that Audience.

[angled-project] : Domain field mapping

To limit the number of domains displayed in a list, it is possible to map a domain to a unit field in admin/angled/domainfieldmapping/