Skip to content

Commit

Permalink
Merge pull request #319 from mapbender/release/3.20_merged_with_master
Browse files Browse the repository at this point in the history
Release/3.20 merged with master
  • Loading branch information
kartoffelfee authored Sep 29, 2022
2 parents 6d1fce1 + cf0351e commit 38c2997
Show file tree
Hide file tree
Showing 83 changed files with 515 additions and 515 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@

This is the Mapbender documentation repository.

You find the compiled pages of [the latest released version](https://github.com/mapbender/mapbender-documentation/releases) at [https://doc.mapbender.org/](https://doc.mapbender.org/). Other versions of the documentation are also available at [https://docs.mapbender.org/](https://docs.mapbender.org/current/#other-versions-of-this-documentation).
You can find the compiled pages of [the latest released version](https://github.com/mapbender/mapbender-documentation/releases) at [https://doc.mapbender.org/](https://doc.mapbender.org/). Other versions of the documentation are also available at [https://docs.mapbender.org/](https://docs.mapbender.org/current/#other-versions-of-this-documentation).

The sources are [on Github](https://github.com/mapbender/mapbender-documentation).

The website code is generated using [Sphinx](http://sphinx-doc.org/), therefore the documentation source is written in [Restructured Text](http://sphinx-doc.org/rest.html).

You find a documentation about how the documentation is structured in the documentation itself in chapter [How to write Mapbender Documentation?](http://doc.mapbender.org/en/book/development/documentation_howto.html) or directly [here in this Git-Repository](https://github.com/mapbender/mapbender-documentation/blob/master/en/documentation_howto.rst).
You can find instructions on how the documentation is structured in chapter [How to write Mapbender Documentation?](http://doc.mapbender.org/en/book/development/documentation_howto.html) or directly [in this Git-Repository](https://github.com/mapbender/mapbender-documentation/blob/master/en/documentation_howto.rst).


To build the website locally, you need to install Sphinx. Install it in Debian-based distributions via

```bash
sudo apt-get install sphinx-common python3-sphinx
sudo apt-get install sphinx-common python3-sphinx
sudo apt-get install pip3
sudo pip3 install sphinxcontrib-phpdomain
```
Expand All @@ -30,12 +30,12 @@ Example
```bash

cd /data
git clone git clone git@github.com:mapbender/mapbender-documentation
git clone [email protected]:mapbender/mapbender-documentation
git checkout release/3.2.0

ln -s /data/mapbender-documentation/_build/ /var/www/html/mb-doc

rm -Rf _build
rm -rf _build
sphinx-build . _build -A version=3.2.0

http://localhost/mb-doc/
Expand All @@ -44,4 +44,4 @@ http://localhost/mb-doc/
To participate in the documentation, create a fork and submit a pull request with your changes.


Have fun!
Have fun!
20 changes: 16 additions & 4 deletions _static/theme_overrides.css
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
* Background of logo upper left
*/
.wy-side-nav-search {
background-color: #e0e0e0;
color: #000;
background-color: #fff;
color: #3A3A3A;
}

/*
Expand All @@ -31,10 +31,10 @@
}

/*
* Menu Color of inactive entry in nice blue ($nav-background-color)
* Menu Color of inactive entry in nice blue ($nav-background-color) ALT 008fc3
*/
.wy-nav-side {
background: #008fc3;
background: #0087b9;
}

/*
Expand Down Expand Up @@ -70,3 +70,15 @@
.wy-side-nav-search input[type="text"] {
border-radius: 0px;
}

.wy-nav-content-wrap {
background: none;
}

/*
* Content area
*/
.wy-nav-content {
max-width: 1000px;
color: #3A3A3A;
}
2 changes: 1 addition & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@

# General information about the project.
project = u'Mapbender'
copyright = u'2021, The Mapbender Team'
copyright = u'2022, The Mapbender Team'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down
36 changes: 18 additions & 18 deletions de/customization/yaml.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ parameters.yml

Hier werden grundlegende Parameter von Mapbender bestimmt:

**Datenbank**
*************
Datenbank
*********

Zur Konfiguration der Datenbankverbindung werden die Dateien config.yml und parameters.yml verwendet. Während in der config.yml nur die Platzhalter angegeben werden, werden die Werte in der parameters.yml gefüllt.

Expand Down Expand Up @@ -59,8 +59,8 @@ Die Datenbankkonfiguration in der parameters.yml sieht folgendermaßen aus, wenn
database_user: postgres
database_password: geheim
**Verwendung mehrerer Datenbanken**
***********************************
Verwendung mehrerer Datenbanken
*******************************

Mit Mapbender können Sie auch mehrere Datenbanken verwenden. Dies wird empfohlen, wenn Sie Ihre eigenen Daten von den Mapbender-Daten trennen möchten. Das kann nützlich sein, wenn Sie eigenen Code verwenden, der nicht zu einem Mapbender-Bundle gehört.

Expand Down Expand Up @@ -101,8 +101,8 @@ Symfony Dokumentation <http://symfony.com/doc/current/best_practices/configurati
Mapbender verwendet Doctrine. Doctrine ist eine Sammlung von PHP-Bibliotheken und bietet einen objektrelationalen Mapper und eine Datenbankabstraktionsschicht (`Doctrine Projektseite <http://www.doctrine-project.org/>`_).


**Disclaimer**
**************
Disclaimer
**********

.. image:: ../../figures/disclaimer.png

Expand All @@ -118,8 +118,8 @@ Es kann ein Disclaimer mittels Sitelinks hinzugefügt werden. Dafür muss Folgen
Die Sitelinks werden mittels "|" voneinander getrennt.
**Logo**
********
Logo
****

Das Logo (Standard ist das Mapbender Logo) kann in der Datei parameters.yml angepasst werden. Diese Änderung wirkt sich global auf die gesamte Mapbender Installation aus.

Expand All @@ -130,8 +130,8 @@ Das Logo (Standard ist das Mapbender Logo) kann in der Datei parameters.yml ange
Die Datei des neuen Logos muss unter application/web eingefügt werden.
**Mailer**
**********
Mailer
******

Die Mailerangaben starten mit mailer (z.B. smtp oder sendmail).
Eine Konfiguration könnte wie folgt aussehen:
Expand All @@ -149,8 +149,8 @@ Ein Mailer wird für die Funktionen 'Self-Registration' und 'Passwort zurückset
Weitere Informationen im Kapitel :ref:`users_de`.


**Projektname**
***************
Projektname
***********

Der Projektname (Standard: Mapbender) kann in der Datei parameters.yml angepasst werden. Diese Änderung wirkt sich global auf die gesamte Mapbender Installation aus.

Expand All @@ -162,8 +162,8 @@ Der Projektname (Standard: Mapbender) kann in der Datei parameters.yml angepasst
**Wichtiger Hinweis:** In der parameters.yml dürfen **keine Tabulatoren für Einrückungen** verwendet werden.


**Proxy-Einstellungen**
***********************
Proxy-Einstellungen
*******************

Wenn ein Proxy verwendet wird, muss dieser in der Datei parameters.yml im Bereich OWSProxy Configuration angegeben werden.

Expand All @@ -184,8 +184,8 @@ Eine Konfiguration könnte wie folgt aussehen:
- 192.168.1.123
**Spracheinstellung**
*********************
Spracheinstellung
*****************

Die Sprache (locale) der Mapbender Installation kann angepasst werden, jedoch nicht die einer einzelnen Anwendung.

Expand Down Expand Up @@ -219,8 +219,8 @@ Diese Datei enthält grundlegende Architektur-Vorgaben von Mapbender. Gleichzeit
* **fom_user.reset_password**: Über diesen Parameter kann die Möglichkeit de/aktiviert werden, das Passwort neu zu setzen.
* **framework.session.cookie_httponly**: Stellen Sie für HTTP-only session cookies sicher, dass der Parameter framework.session.cookie_httponly auf true steht.

**Datenbank**
*************
Datenbank
*********
Wichtig: Jede Datenbank, die in der parameters.yml definiert wird, muss auch als Platzhalter in der config.yml stehen:

.. code-block:: yaml
Expand Down
2 changes: 1 addition & 1 deletion de/development/introduction.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _development_introcution_de:
.. _development_introduction_de:

Einführung
##########
Expand Down
24 changes: 13 additions & 11 deletions de/functions/backend/FOM/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,19 @@ Benutzer mit der ID 1 zurücksetzen

Der Befehl ``app/console fom:user:resetroot`` setzt den User mit der ID 1 zurück. Dieser Benutzer hat generell alle Rechte.

.. code-block:: bash
$ app/console fom:user:resetroot
Welcome to the Mapbender root account management command
Enter the username to use for the root account.
Username [root]: root
Enter the e-mail adress to use for the root account.
E-Mail [[email protected]]: [email protected]
Enter the password to use for the root account.
Password: secret
Do you confirm reset [yes]? yes
The root is now usable. Have fun!
.. code-block:: yaml
app/console fom:user:resetroot
Welcome to the Mapbender root account management command
Enter the username to use for the root account.
Username [root]: root
Enter the e-mail adress to use for the root account.
E-Mail [[email protected]]: [email protected]
Enter the password to use for the root account.
Password: secret
Do you confirm reset [yes]? yes
The root is now usable. Have fun!
Neue Benutzer anlegen
Expand Down
Binary file not shown.
Binary file removed de/functions/backend/FOM/user_forgot_password.png
Binary file not shown.
8 changes: 4 additions & 4 deletions de/functions/backend/FOM/users.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Passwort vergessen

Falls ein Benutzer sein Passwort vergessen hat, kann er in der Login-Maske über den Link "Passwort vergessen" ein neues Passwort anfordern. Dazu gibt er dann seinen Benutzernamen oder seine E-Mail Adresse an.

.. image:: ../../../../de/functions/backend/FOM/user_forgot_password.png
.. image:: ../../../../figures/de/fom/user_forgot_password.png

Danach bekommt der Benutzer eine E-Mail mit einem Link zur Zurücksetzung des Passworts. Der Link ist nach der Nutzung nicht mehr gültig. Der Text der Mail kann in der Datei /FOM/UserBundle/Resources/translations/messages.de.xlf angepasst werden.

Expand All @@ -43,7 +43,7 @@ Benutzer können sich in Mapbender selbst registrieren. Dafür stellt man in der
Im Login-Dialog erscheint der "Register" Link. Der Benutzer wird zu einer Maske geführt, in der er Name, Passwort und E-Mail Adresse angeben kann.

.. image:: ../../../../de/functions/backend/FOM/user_self_register.png
.. image:: ../../../../figures/de/fom/user_self_register.png

Danach erhält er eine Bestätigungsmail, mit der er seine Anmeldung abschließen kann. Bis zu diesem Zeitpunkt ist er als inaktiver Nutzer in Mapbender hinterlegt.

Expand All @@ -55,7 +55,7 @@ Aktivieren von Nutzern

Benutzer können von Administratoren mit der ACL-Rolle *edit* aktiviert oder deaktiviert werden. Ein Benutzer mit Administrationsrechten kann sich selbst nicht aktivieren oder deaktivieren.

.. image:: ../../../../de/functions/backend/FOM/edit_user_activated.png
.. image:: ../../../../figures/de/fom/edit_user_activated.png

Ein Benutzer, der deaktiviert ist, kann sich so lange nicht mehr im Mapbender anmelden, bis er wieder aktiviert wird.

Expand All @@ -71,7 +71,7 @@ Mit einem Klick auf den Schlüssel wird der Benutzerzugriff auf ein Element ange

Ein gesetzter Haken neben dem entsprechenden Nutzer-Account erlaubt dem jeweiligen Nutzer den Zugriff. Der Schlüssel wird nach erfolgreicher Rechtevergabe rot. Wenn Sie nun den Cursor über den Schlüssel halten, sehen Sie die Namen der berechtigten Nutzer in einem Pop-Up Fenster.

.. image:: ../../../../de/functions/backend/FOM/element_security_key_popup.png
.. image:: ../../../../figures/de/fom/element_security_key_popup.png


Login Fehler
Expand Down
18 changes: 9 additions & 9 deletions de/functions/backend/layerset.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ Layersets und Layerset-Instanzen

Ein Layerset ist ein logischer Container, der einen oder mehrere Layerset-Instanzen (WMS-Dienste) beinhalten kann. Ein typisches Beispiel ist die Unterscheidung zwischen dem Layerset "main" (Hauptkarte) und "overview" (Übersichtskarte). Es besteht die Möglichkeit, weitere Layersets zu definieren. Diese werden entweder in der Karte direkt oder auch im Layertree als eigener Ordner dargestellt (thematische Layer).

.. image:: ../../../figures/de/layerset/mapbender_service_edit_DE.png
.. image:: ../../../figures/de/layerset/mapbender_service_edit.png


Layerset-Instanzen
==================

Layerset-Instanzen enthalten unterschiedliche Optionen, mit denen WMS-Dienste angesprochen werden können: das Bildformat, das Infoformat, Exceptionformat, die Maßstäbe für die einzelnen Layer und vieles mehr. Aus der Layerset-Übersicht können mit dem Zahnrad-Button einzelne Instanzen konfiguriert werden.

.. image:: ../../../figures/de/layerset/mapbender_wms_application_settings_DE.png
.. image:: ../../../figures/de/layerset/mapbender_wms_application_settings.png

Sobald ein WMS-Dienst in ein Layerset eingebunden wird, ist er als Layerset-Instanz mit der Anwendung verknüpft.
Der Screenshot zeigt die `private Instanz <layerset.rst#freie-und-private-instanzen>`_ ``2/28`` basierend auf einem WMS-Dienst. Die zugehörige Datenquelle ist die Nr. 2. Die Layerset-Instanz selbst hat die Laufnummer 28.
Expand Down Expand Up @@ -88,23 +88,23 @@ Alle Layerset-Instanzen werden standardmäßig als private Instanzen erstellt. P

Eine Layerset-Instanz kann in der Bearbeitungsansicht über den blauen Button "In freie Instanz umwandeln" umgeändert werden. Über den gleichen Button lässt sich eine freie Instanz wieder in eine private Instanz umwandeln.

.. image:: ../../../figures/de/layerset/convert_to_shared_instance_DE.png
.. image:: ../../../figures/de/layerset/convert_to_shared_instance.png

In der Layersets-Übersicht sind freie Instanzen in der Spalte "Typ" mit einem Funk-Symbol gekennzeichnet.

.. image:: ../../../figures/de/layerset/convert_to_bound_instance_DE.png
.. image:: ../../../figures/de/layerset/convert_to_bound_instance.png

Private Instanzen sind wiederum mit einem Anker-Symbol gekennzeichnet.

.. image:: ../../../figures/de/layerset/instances_labels_DE.png
.. image:: ../../../figures/de/layerset/instances_labels.png

Um eine freie Instanz in eine Anwendung einzubinden, kann diese als Datenquelle beim Hinzufügen einer Instanz ausgewählt werden.

.. image:: ../../../figures/de/layerset/incorporate_shared_instance_DE.png
.. image:: ../../../figures/de/layerset/incorporate_shared_instance.png

Zu einer Übersicht aller freien Instanzen kann über das Menü zu **Datenquellen -> Freie Instanzen** navigiert werden.

.. image:: ../../../figures/de/layerset/shared_instances_overview_DE.png
.. image:: ../../../figures/de/layerset/shared_instances_overview.png


.. _layer_konfiguration:
Expand All @@ -114,7 +114,7 @@ Layerkonfiguration

Über die verschiedenen Checkboxen können Sie verschiedene Einstellungen treffen. Beachten Sie dabei, dass die oberste Checkbox der Liste jeweils für alle Instanzen denselben Status auswählt.

.. image:: ../../../figures/de/layerset/layerset_instance_DE.png
.. image:: ../../../figures/de/layerset/layerset_instance.png

* Titel: Layertitel der Service Information (anpassbar).
* Aktiv an/aus (active on/off): Aktiviert/deaktiviert ein Thema in dieser Anwendung. Sobald dieser Haken nicht gesetzt ist, werden alle anderen Haken derselben Instanz ignoriert.
Expand Down Expand Up @@ -166,7 +166,7 @@ In einer Layerset Instanz können Vendor Specific Parameter angegeben werden, di
In Mapbender können die Vendor Specific Parameter genutzt werden, um Benutzer und Gruppeninformation des angemeldeten Benutzers an die WMS-Anfrage zu hängen. Es können auch feste Werte übermittelt werden.
Das folgende Beispiel zeigt die Definition eines Parameters „group“, der als Inhalt die Gruppe des gerade in Mapbender angemeldeten Nutzers weitergibt.

.. image:: ../../../figures/de/layerset/mapbender_vendor_specific_parameter_DE.png
.. image:: ../../../figures/de/layerset/mapbender_vendor_specific_parameter.png

* Name: Parameter Name im WMS Request.
* Default: Standardwert
Expand Down
Loading

0 comments on commit 38c2997

Please sign in to comment.