Skip to content

Commit

Permalink
Updating the user administration page with new text and new figures. …
Browse files Browse the repository at this point in the history
…Not complete yet
  • Loading branch information
archaeogeek authored and fxprunayre committed Nov 27, 2019
1 parent bda0cd5 commit 49e9bc0
Show file tree
Hide file tree
Showing 18 changed files with 137 additions and 19 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -14,63 +14,181 @@ using the web interface in ``Admin console`` > ``Settings`` > ``User Interface``

.. figure:: img/ui-settings.png

By default the catalog will use the default UI configuration, named ``srv``. To view and edit the settings for this configuration, choose ``Create a default UI configuration``.

Since the settings form is a long form, the 'save' button may be repeated between
the sections and will save all settings.
To add a new configuration, such as for a sub-portal (see :ref:`portal-configuration`) choose ``Add new UI configuration`` and choose one or more portal identifiers from the dropdown list ``UI Configuration identifier``. Additional configurations can also be used for building an external JS application, which is able to load a specific configuration.

Via `choose UI configuration` and `Add new UI configuration` it is possible to create multiple UI configurations.
These configurations can be used in 2 contexts:
.. note:: Since the settings form is a long form, the ``save`` button may be repeated between the sections and will save all settings.

- when creating a sub-portal (see :ref:`portal-configuration`), a UI configuration can be attached to one or more sub-portals.
Filter settings
---------------

- when building an external JS application, which is able to load a specific configuration.
- The search box can be used to filter settings in the form, for example searching for "social" will show only the settings related to the Social Bar.

.. figure:: img/ui-settings-filter.png

The main catalog is using the default UI configuration which should be named 'srv'.
General options
---------------

If no UI configuration is available, a default set of parameters will be used.
- Select the ``Humanize dates`` check box to show dates in a human-friendly format. If not set, the full date will be shown.

.. figure:: img/ui-settings-humanizedate.png

.. _user-interface-config-footer:

Footer
------

- Select the ``footer`` checkbox to determine whether the |project_name| footer is shown. If not set, no footer will be visible.
- Select the ``Social bar`` check box to show the social bar (links to twitter, facebook, linkedin etc) in the footer.

.. figure:: img/ui-settings-footer.png

.. _user-interface-config-toptoolbar:

Top Toolbar
```````````
-----------

On this section, an administrator can define some parameters to configure the top toolbar of the user interface.
- Select the ``Top toolbar`` check box to determine whether the |project_name| top toolbar will be shown. If not set, no toolbar will be visible.
- From the ``List of languages`` choose those that should be available for translating the interface strings (available from the dropdown list in the top toolbar). If only one language remains, then no dropdown will be shown. Note that additional languages can be added, if translations are available, by selecting the ``+`` button below the list and adding the appropriate ISO codes.

.. figure:: img/ui-settings-toptoolbar.png

..
- The checkbox ``Show the logo in the header`` determines where the catalog logo should be positioned. If selected, the logo will be positioned in the header, above the top toolbar and the toolbar logo (default) removed. If unset, the logo will appear in the top toolbar. The ``Position of logo`` options below determine where on the header the logo will be positioned.

.. figure:: img/ui-settings-toptoolbarlogo.png

.. _user-interface-config-homepage:


Home Page
`````````
On this section, the administrator user can define the URL of the home page. If the checkbox is disabled, there will be no Home tab.
---------
- Select the ``Home page`` check box to determine whether the Logo and Link to the Home Page are visible in the top toolbar. If not set, no logo and link is shown.
Define the URL for the home page. In the majority of cases this can be left as the default.
- Select the ``Fluid container for Home and Search`` to determine whether the search box is full width in the browser page or if it is fixed width and centred.

.. figure:: img/ui-settings-homepage.png

..
.. _user-interface-config-searchpage:


Search Page
```````````
Search Application
------------------

On this section, the administrator user can define some parameters to configure the user interface of the search page. If the checkbox is disabled, there will be no Search tab.
- Select the ``Search application`` check box to determine whether the search application is visible in the top toolbar. If not set, no link is shown.
- Define the URL for the search application. In the majority of cases this can be left as the default.
- Define the options to determine the number of records shown per page of results, and the default.
- In the ``Type of facet`` section, determine which set of search facets should be visible in the search page. The default is ``details`` but ``manager`` can be used to show the facets more normally used on the editor page.
- The ``Default search`` section allows you to define a default filter for the search.

.. figure:: img/ui-settings-searchpage.png

..
- ``Facet field to display using tabs`` creates a tab for each configured facet above the search results. This can be used to further narrow down the search results. The list of facet names can be found at https://github.com/geonetwork/core-geonetwork/blob/master/web/src/main/webapp/WEB-INF/config-summary.xml#L82. For example, to include the Topic Category filter above the search results, the administrator would add ``topicCat`` as the facet field to display.
- ``List of facets`` can be used to restrict the facets available for searching. For example, adding ``topicCat`` to this list would restrict the search options to ``Topic Category`` only. This can be useful for restricting the search options in a sub-portal or external web application. To add additional facets to the list, select the blue ``+`` button.
- ``Filters`` are additional search criteria added to all searches and again are used primarily for external applications and sub-portals.

.. figure:: img/ui-settings-searchpage2.png

..
- The ``Type of sort options`` section determines the different ways by which a user can sort a set of search results. The ``default sort by option`` is shown below. Note that to search for example on ``title`` in alphabetical order it is necessary to set the order to ``reverse``.
- The ``List of templates for search results`` section allows the administrator to configure templates for the layout of the search results. The default is ``grid`` whereas ``list`` is the default for the editor board.

.. figure:: img/ui-settings-searchpage3.png

..
- The ``Default template used for search results`` defines the template page for the search. Generally this can be left as the default.
- The ``List of formatter for record view`` determines the formatter used to display the search results. See :ref:`creating-custom-view` for information on creating a new formatter. To add an additional view, click the blue ``+`` button below the list and provide a name and a URL.

.. figure:: img/ui-settings-searchpage3.png

..
.. _user-interface-config-searchresults:


Search results configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This section determines the related metadata types to display when showing showing search results in the grid. format To add additional types, click the blue ``+`` button. The possible types are shown below the form.

.. figure:: img/ui-settings-searchresults.png

..
.. _user-interface-config-linktypes:

List of link types
~~~~~~~~~~~~~~~~~~

This section determines the types of links displayed when showing search results in the grid format. They are separated into ``links``, ``downloads``, ``layers`` and ``maps`` and for each type, a new entry can be added by clicking the blue ``+`` button below the list.

.. figure:: img/ui-settings-searchresults2.png

..
- ``Display filter tags in the search results``. When checked, the filter tags are visible above the search results. The default is to not show them.

.. _user-interface-customsearches:

User custom searches
~~~~~~~~~~~~~~~~~~~~

- If enabled, the user will have the ability to create and save custom searches in the search tab. This functionality will be visible above the facets list on the left.
- If ``Display featured user searches panel in home page`` is also enabled, an additional tab will be shown on the home page alongside ``Latest news`` and ``Most popular``.

Saved Selections
~~~~~~~~~~~~~~~~

- If enabled, the user will have the ability to save a selection of records in the search tab.

.. figure:: img/ui-settings-searchresults3.png

..

.. _user-interface-config-mappage:


Map Application
```````````````
---------------

This section describes how an administrator can configure the different maps in the user interface (the main map, the mini map displayed on the search result page, and the map used in the editor to draw an extent).

This section describes how an administrator can configure the different maps of the user interface (the main map, the mini map displayed on the search result page and a map used in the editor to draw an extent).
The initial checkbox allows to disable the main map, there will be no map tab.
- The initial checkbox allows the main map tab to be disabled. In this case there will be no map tab shown in the top toolbar but the mini map and extent map described above will still be visible.
- The ``Application URL`` defines the URL for the map tab. In the majority of cases this can be left as the default.

External viewer
~~~~~~~~~~~~~~~

- ``Use and external viewer`` allows a third party mapping application to be used in place of the default |project_name| map. In this case, most of the settings below will no longer be used.
- ``Allow 3D mode`` enables the option to switch to 3D mode in the main map (see :ref:`quick_start`).
- ``Allow users to save maps as metadata record`` enables users to save layers and base maps configuration as a record in the catalog. Optionally users can add a title and an abstract.
- ``Export map as image`` enables users to export the map as an image but requires CORS to be enabled on any external WMS services displayed on the map. This option is disabled by default to avoid issues with WMS layers.

.. figure:: img/ui-settings-mappage.png

..
- ``User preference persistence`` determines the behaviour of cookies related to the map. The various options are listed below.
- If ``Bing Map Key`` is filled in, then it is possible to use Bing Maps as base layers within the map application. You must get your own key for this to work.

... figure:: img/ui-settings-mappage2.png

..
List of preferred OGC services
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Default ``wms`` and ``wmts`` services can be defined here that will be available by default to the end user. New services can be added using the blue ``+`` button below the protocol lists.

You can configure each map with different layers and projections.

- **Map Projection** This is the default projection of the map. Make sure the projection is defined on ``Projections used in maps`` below.
Expand Down
2 changes: 1 addition & 1 deletion source/user-guide/quick-start/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Clicking the record will provide more in depth details about the resources:
To get more information, switch the advanced view mode.
To update the record, click the edit button.


.. _quick_start-3D:

From the results or the record view, you can easily add WMS layers referenced in
a metadata record on the map. With the map, you can visualize your data, choose
Expand Down

0 comments on commit 49e9bc0

Please sign in to comment.