Skip to content

Commit

Permalink
Merge branch 'release/3.2.0' into docs/versions
Browse files Browse the repository at this point in the history
  • Loading branch information
rschwammborn authored Feb 2, 2022
2 parents 9f53947 + c8c9f55 commit 34944ff
Show file tree
Hide file tree
Showing 26 changed files with 230 additions and 140 deletions.
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,15 @@ 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/book/development/documentation_howto.rst).
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).


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

```bash
$ apt install python-sphinx
sudo apt-get install sphinx-common python3-sphinx
sudo apt-get install pip3
sudo pip3 install sphinxcontrib-phpdomain
```

You can then build the documentation by running:
Expand All @@ -23,7 +25,23 @@ You can then build the documentation by running:
$ make
```

Example

```bash

cd /data
git clone 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
sphinx-build . _build -A version=3.2.0

http://localhost/mb-doc/
```

To participate in the documentation, create a fork and submit a pull request with your changes.


Have fun!
Have fun!
16 changes: 16 additions & 0 deletions de/functions/basic/basesourceswitcher.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,22 @@ Zu jeder Datenquelle kann eine Gruppe definiert werden. Alle Definitionen einer
Konfiguration
=============

Vorbereitung: Um den BaseSourceSwitcher konfigurieren zu können,
müssen WMS-Instanzen als BaseSource definiert sein (CheckBox BaseSource aktiv).
Beachten Sie, dass in der Anwendung beim Start die Themen aktiviert werden,
bei denen der root-Layer aktiv ist (neu ab Version 3.2).

Konfiguration aktiver ausgewählter root-Layer - Thema ist aktiv beim Start:

.. image:: ../../../figures/de/basesourceswitcher_instance_active.png
:scale: 80

Konfiguration nicht aktivierter ausgewählter root-Layer - Thema ist beim Start nicht aktiv:

.. image:: ../../../figures/de/basesourceswitcher_instance_not_active.png
:scale: 80


Die Konfiguration geschieht in zwei Schritten im Content-Bereich:

#. Erzeugen eines Elements zum Wechseln der vordefinierten Themen (Titel, Tooltip und Target)
Expand Down
26 changes: 14 additions & 12 deletions de/functions/basic/feature_info.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ Mit diesem Element können Sie Informationen eines WMS abfragen. In der folgende

.. image:: ../../../figures/de/feature_info.png
:scale: 80

Der Dienst Krankenhäuser NRW (https://www.wms.nrw.de/wms/krankenhaus?Service=WMS&Version=1.3.0&Request=getCapabilities) dienst zur Veranschaulichung.

Konfiguration
=============
Expand Down Expand Up @@ -37,7 +39,7 @@ Das Element FeatureInfo wird im Content eingebunden:

Für das Element wird zudem ein Button benötigt. Zu der Konfiguration des Buttons besuchen sie die Dokumentationsseite unter `Button <../misc/button.html>`_.

Einstellungen im Layertree
Einstellungen im Ebenenbaum
---------------------------

Layer ist sichtbar und FeatureInfo-Abfrage für den Layer ist aktiviert:
Expand All @@ -59,14 +61,14 @@ Layer ist nicht sichtbar; es erfolgt keine FeatureInfo-Abfrage, auch wenn diese
Anzeige als Tabs und Accordion
------------------------------

Mit dem Schalter "Type" können die Responses mehrerer Dienste in unterschiedlichen Tabs oder als Accordion angezeigt werden.
Mit dem Schalter "Type" können die Antworten der einzelnen Dienste in unterschiedlichen Reitern oder als Akkordeon angezeigt werden.

Beispiel Tabs:
Beispiel Reiter:

.. image:: ../../../figures/de/feature_info_tabs.png
:scale: 80

Beispiel Accordion:
Beispiel Akkordeon:

.. image:: ../../../figures/de/feature_info_accordion.png
:scale: 80
Expand All @@ -76,7 +78,7 @@ Beispiel Accordion:
Ausdruck der Resultate
----------------------

Mit dem Schalter "Print result" kann die Information des FeatureInfo ausgedruckt werden. Eine Druckschaltfläche ist dann in dem FeatureInfo-Dialog sichtbar. Das Drucken geschieht über den Druckdialog des Webbrowsers.
Mit dem Schalter "Drucken" kann die Information des FeatureInfo ausgedruckt werden. Eine Druckschaltfläche ist dann in dem FeatureInfo-Dialog sichtbar. Das Drucken geschieht über den Druckdialog des Webbrowsers.

Um alle Bilder und Hintergrundfarben im Ausdruck zu erhalten, sollten Sie die Druckeinstellungen des Webbrowsers beachten: In Firefox kann man die Option "Hintergrund drucken" im Druckoptionendialog anschalten, in Chrome-basierten Browsern nennt sich die Option "Hintergrundgrafiken". Die übermittelten Schriften können bei einem Ausdruck in PDF je nach Viewer unterschiedlich gut funktionieren. Des Weiteren modifizieren die meisten Browser Webseiten etwas vor dem Druck, damit nicht so viel Tinte/Toner verbraucht wird.

Expand All @@ -94,7 +96,7 @@ Eine Infoabfrage mit aktiviertem FeatureInfo Highlighting könnte beispielsweise
.. image:: ../../../figures/de/feature_info_highlighting.png
:scale: 80

In der Abbildung wurden mehrere Geometrien in der Karte ausgewählt (PLZ: 53111, 53113 und 53115). Der FeatureInfo Dialog zeigt nur die Informationen dieser Geometrien an. Die Fläche mit der PLZ 53115 wird durch Hovering rot in der Karte markiert.
In der Abbildung wurden mehrere Geometrien in der Karte ausgewählt (PLZ: 53111, 53113 und 53115). Der FeatureInfo Dialog zeigt die Informationen zu diesen Objekten an. Die Fläche mit der PLZ 53115 wird durch Hovering rot in der Karte markiert.

Das FeatureInfo Highlighting kann im FeatureInfo-Element im Content-Bereich aktiviert werden. Dort sind auch Grund- und Hoverfarbe auswählbar.

Expand All @@ -105,13 +107,13 @@ Die notwendige Anpassung wird hier am Beispiel von MapServer gezeigt. In der DAT

.. code-block:: bash
$ DATA "geom from (Select *, ST_AsText(geom) as geom_wkt from plz) as foo USING UNIQUE gid USING SRID 4326"
DATA "geom from (Select *, ST_AsText(geom) as geom_wkt from plz) as foo USING UNIQUE gid USING SRID 4326"
$ <div class="geometryElement" id="[gid]" data-geometry="[geom_wkt]" data-srid="EPSG:4326">
$ <table>
$ ...
$ <table>
$ </div>
<div class="geometryElement" id="[gid]" data-geometry="[geom_wkt]" data-srid="EPSG:4326">
<table>
...
<table>
</div>
YAML-Definition:
Expand Down
9 changes: 4 additions & 5 deletions de/functions/basic/layertree.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ Funktionen

.. figure:: ../../../figures/layertree/layertree_example_dialog.png
:scale: 80
:alt: Einfacher Layertree mit einem Layerset und Layer als Dialog
:alt: Ebenenbaum im Dialogfenster zeigt Dienste mit Ebenen

Einfacher Layertree mit einem Layerset und Layer als Dialog, über einen Button eingebunden.
Einfacher Ebenenbaum im Dialogfenster zeigt Dienste mit Ebenen. Der Ebenenbaum wurde über einen Button eingebunden.

.. figure:: ../../../figures/layertree/layertree_example_sidepane.png
:scale: 80
:alt: Komplexer Layertree mit mehreren Layersets in der Seitenleiste, unterteilt in thematische Gruppen.
:alt: Die Nutzung in der Seitenleiste ist möglich. Thematischer Ebenenbaum zeigt die Titel der Layersets in der Seitenleiste.

Komplexer Layertree mit mehreren Layersets in der Seitenleiste, unterteilt in thematische Gruppen.
Die Nutzung in der Seitenleiste ist möglich. Thematischer Ebenenbaum zeigt die Titel der Layersets in der Seitenleiste.

Zur Konfiguration des Layerbaums gibt es verschiedene Verknüpfungspunkte zu anderen Elementen, die beachtet werden müssen:

Expand All @@ -40,7 +40,6 @@ Zur Konfiguration des Layerbaums gibt es verschiedene Verknüpfungspunkte zu and
Konfiguration
=============


Allgemeine Konfiguration
------------------------

Expand Down
4 changes: 2 additions & 2 deletions de/functions/editing/sketch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,6 @@ Diese Vorlage kann genutzt werden, um das Element in einer YAML-Applikation einz
target: ~ # ID des Kartenelements
auto_activate: false # (Standard: false).
deactivate_on_close: true # Gezeichnete Geometrien werden durch Schließen des Elements deaktiviert (Standard: true).
geometrytypes: 'point', 'line' # Liste der unterstützten Geometrietypen
'polygon', 'rectangle', "circle"
geometrytypes: point,line,polygon,text,rectangle,circle # Liste der unterstützten Geometrietypen
3 changes: 2 additions & 1 deletion de/functions/export/imageexport.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ YAML-Definition:

.. code-block:: yaml
target: ~ # ID des Kartenelements (z.B. map)
class: Mapbender\PrintBundle\Element\ImageExport
target: map # ID des Kartenelements (z.B. map)
Für das Element wird ein Button verwendet. Zu der Konfiguration des Buttons besuchen Sie die Dokumentationsseite unter :ref:`button_de`.

6 changes: 3 additions & 3 deletions de/functions/search/search_router.rst
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ Der Elementitel (*Title*) lautet Suchen. Dieser wird in der Sidepane als Titel a
usertype: # Feld für die Suche nach dem Nutzertyp
type: choice # Feld mit Auswahlmöglichkeiten als Dropdown
options:
empty_value: 'Bitte auswählen...' # Text, der angezeigt wird, bevor etwas ausgewählt wurde
placeholder: 'Bitte auswählen...' # Text, der angezeigt wird, bevor etwas ausgewählt wurde
choices: # die Auswahlmöglichkeiten; werden wie folgt angegeben: "Eintrag in der Spalte der Datenbank": "Angezeiger Name in der Dropdown-Liste"
1: Company
2: Administration
Expand Down Expand Up @@ -252,7 +252,7 @@ Auf dieser Abbildung wird gezeigt, welche Auswirkungen die vorgenommenen Konfigu

Dargestellt ist der Ausschnitt der yaml-Definiton, der das Formular konfiguriert. Tabellenspalten orga, town und usertype werden im Formular verwendet und sind jeweils als die Felder Mapbender User, Stadt und Nutzertyp eingebunden. Mapbender User und Stadt sind jeweils vom type Text. Nutzertyp hingegen gibt Auswahlmöglichkeiten in Form einer Dropdown-Liste vor.

Der Text, der angezeigt werden soll, wenn noch nichts ausgewählt wurde, ist hier "Bitte auswählen…" (siehe Nr. **1** – empty_value: ‚Bitte auswählen...‘). Der Titel über den Feldern wird mit label festgelegt (siehe Nr. **2**). Das Attribut data-autocomplete: ‚on‘ bewirkt, dass Vorschläge aus der Datenbank zu dem eingegebenen Begriff vorgegeben und als Dropdown angezeigt werden (siehe Nr. **3**). Da der Vergleichsmodus ilike (compare: ilike) konfiguriert wurde, muss der Begriff nicht exakt eingegeben werden. Die Suche findet ebenfalls Ergebnisse die ähnlich zu dem eingegebenen Begriff sind (siehe Nr. **4** – Wheregr (das g wurde klein geschrieben, trotzdem werden die Ergebnisse WhereGroup mit großem G gefunden)). Bei dem Feldtyp choice werden Auswahlmöglichkeiten vorgegeben. Diese Auswahlmöglichkeiten werden unter choices angegeben (siehe Nr. **5**). In der Tabelle sind die Auswahlmöglichkeiten als Zahlen hinterlegt (1, 2, 3, 4). In diesem Beispiel wurde jeder Zahl ein Text zugeordnet, der in der Dropdown-Liste angezeigt werden soll.
Der Text, der angezeigt werden soll, wenn noch nichts ausgewählt wurde, ist hier "Bitte auswählen…" (siehe Nr. **1** – placeholder: ‚Bitte auswählen...‘). Der Titel über den Feldern wird mit label festgelegt (siehe Nr. **2**). Das Attribut data-autocomplete: ‚on‘ bewirkt, dass Vorschläge aus der Datenbank zu dem eingegebenen Begriff vorgegeben und als Dropdown angezeigt werden (siehe Nr. **3**). Da der Vergleichsmodus ilike (compare: ilike) konfiguriert wurde, muss der Begriff nicht exakt eingegeben werden. Die Suche findet ebenfalls Ergebnisse die ähnlich zu dem eingegebenen Begriff sind (siehe Nr. **4** – Wheregr (das g wurde klein geschrieben, trotzdem werden die Ergebnisse WhereGroup mit großem G gefunden)). Bei dem Feldtyp choice werden Auswahlmöglichkeiten vorgegeben. Diese Auswahlmöglichkeiten werden unter choices angegeben (siehe Nr. **5**). In der Tabelle sind die Auswahlmöglichkeiten als Zahlen hinterlegt (1, 2, 3, 4). In diesem Beispiel wurde jeder Zahl ein Text zugeordnet, der in der Dropdown-Liste angezeigt werden soll.

Eine vollständig ausgefüllte Suche nach dem Mapbender User WhereGroup, in der Stadt Bonn, des Nutzertyps Company und deren Ergebnis sieht wie folgt aus:

Expand Down Expand Up @@ -353,7 +353,7 @@ In der mapbender.yml Datei:
type:
type: choice
options:
empty_value: Please select a type.
placeholder: Please select a type.
required: false
choices:
A: A
Expand Down
41 changes: 33 additions & 8 deletions de/installation/installation_symfony.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,42 @@
.. _installation_symfony_de:

Installation im Symfony Webserver
Installation von Mapbender unter Verwendung des Symfony-eigenen Webservers
#################################

Mapbender baut auf dem `Symfony <http://symfony.com/>`_ Framework auf und kann daher den in `Symfony eingebauten Webserver <http://symfony.com/doc/current/cookbook/web_server/built_in.html>`_ nutzen. Das ermöglicht Ihnen einen schnellen Test von Mapbender, ohne eine Integration in einen Webserver vorzunehmen. Dies eignet sich nicht für Produktivumgebungen. In dieser Anleitung wird die SQLite Datenbank verwendet.
Mapbender baut auf das `Symfony <http://symfony.com/>`_ Framework auf und kann
daher den `Symfony-eigenen Webserver <http://symfony.com/doc/current/cookbook/web_server/built_in.html>`_ nutzen.
Das ermöglicht Ihnen einen schnellen Test von Mapbender, ohne eine Integration in einen Webserver vorzunehmen.

* Systemvoraussetzungen in der Installationsanleitung `Linux <installation_ubuntu.html>`_ bzw. `Windows <installation_windows.html>`_
* Download der aktuellen Mapbender Version unter https://mapbender.org/builds/
.. hint:: Der Symfony-eigenen Webserver eignet sich nicht für die Produktivumgebungen.

In dieser Anleitung wird die im Installationspaket mitgelieferte SQLite-Datenbank verwendet.

* Bitte prüfen Sie die Systemvoraussetzungen in der Installationsanleitung `Linux <installation_ubuntu.html>`_ bzw. `Windows <installation_windows.html>`_
* Laden Sie die aktuellen Mapbender-Version herunter https://mapbender.org/builds/
* Entpacken in ein beliebiges Verzeichnis.
* Start des Symfony Webserver:
* Starten Sie den Symfony-eigenen Webserver.

.. code-block:: bash
app/console server:run
Der Befehl führt einen lokalen Webserver aus.

Standardmäßig lauscht der Server auf die Adresse 127.0.0.1 und den ersten freien Port ab 8000.

Mapbender ist nun auf dem lokalen Rechner über die Adresse http://127.0.0.1:8001/ erreichbar.
Beachten Sie, dass über diesen Aufruf standardmäßig der Entwickler-Modus gestartet wird.

Sie können den Aufruf auch mehrfach ausführen. Es wird dann der nächste freie Port verwendet.

Die gewünschte Adresse kann auch über die Angabe der IP und des Ports angegeben werden:

.. code-block:: bash
.. code-block:: bash
app/console server:run 0.0.0.0:8000
app/console server:run 127.0.0.1:80002
[OK] Server listening on http://127.0.0.1:8002
// Quit the server with CONTROL-C.
Mapbender ist dann vom Host-Rechner aus über http://ip-adresse:8000/app.php erreichbar.
[Mon Jan 31 15:56:57 2022] PHP 7.4.3 Development Server (http://127.0.0.1:8002) started
8 changes: 4 additions & 4 deletions de/installation/installation_ubuntu.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ Installation auf Ubuntu/Debian
Die mitgelieferte SQLite Datenbank ist für Testinstallationen geeignet. In dieser Datenbank befinden sich bereits vorkonfigurierte Demoanwendungen (die Datenbank liegt unter **<mapbender>/app/db/demo.sqlite**).
Eine Anleitung für eine Testinstallation auf Basis des Symfony Webservers finden Sie unter `Installation auf dem Symfony eigenen Webserver <installation_symfony.html>`_.

Für den Produktiveinsatz wird PostgreSQL empfohlen.
.. hint:: Für den Produktiveinsatz wird PostgreSQL empfohlen.
Weitere Installationshinweise finden Sie im Kapitel `Optional > Mapbender Einrichtung auf PostgreSQL <#optional>`_.


Voraussetzungen
---------------

- PHP (ab Version 5.6, maximal 7.2)
- PHP >= 7.1
- Apache Installation mit folgenden aktivierten Modulen:

* mod_rewrite
Expand All @@ -36,7 +36,7 @@ Installation der benötigten PHP-Extensions:
Entpacken und im Webserver registrieren
---------------------------------------

Download der aktuellen Mapbender Version und entpacken nach /var/www/mapbender:
Download der aktuellen Mapbender Version und entpacken nach /var/www/mapbender oder ein anderes Verzeichnis:

.. code-block:: bash
Expand Down Expand Up @@ -90,7 +90,7 @@ Verzeichnisrechte
Nächste Schritte
----------------
Es kann nun auf die Mapbender Installation unter **http://hostname/mapbender/** zugegriffen werden.
Es kann nun auf die Mapbender Installation unter **http://[hostname]/mapbender/** zugegriffen werden.

Per Voreinstellung lauten die Anmeldedaten

Expand Down
12 changes: 6 additions & 6 deletions de/installation/installation_update.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,12 @@ Um Mapbender zu aktualisieren, müssen Sie die folgenden Schritte durchführen:

* Laden Sie die neuste Version von http://mapbender.org/builds/ herunter
* Sichern Sie Ihre Konfigurationsdateien (parameters.yml und config.yml) und Ihre alte Mapbender Version (Dateien und Datenbank)
* Ersetzen Sie die Dateien durch die neuen Mapbender Dateien
* Ersetzen Sie die Dateien durch die neuen Mapbender-Dateien
* Vergleichen Sie die Konfigurationsdateien und prüfen diese auf neue Parameter und Änderungen
* Aktualisieren Sie Ihre Mapbender Datenbank
* Übernahme Ihrer Screenshots: Kopieren Sie die Dateien Ihrer alten Mapbender Version von /web/uploads/ in das /web/uploads Verzeichnis Ihrer neuen Mapbender Version
* Aktualisieren Sie Ihre Mapbender-Datenbank
* Übernahme Ihrer Screenshots: Kopieren Sie die Dateien Ihrer alten Mapbender Version von mapbender/web/uploads/ in das mapbender/web/uploads Verzeichnis Ihrer neuen Mapbender Version
* Wenn Sie Ihre eigenen Templates verwenden sollten, müssen Sie diese mit denen der neuen Version vergleichen (kam es zu Änderungen?)
* Importieren Sie die Anwendungen aus der mapbender.yml Datei, um sich den neusten Stand der Entwicklungen anzuschauen
* Abhängig von Ihrer alten Mapbender Version, muss unter Umständen noch der Apache Alias für Mapbender in der Datei **/etc/apache2/sites-available/mapbender.conf** angepasst werden
* Importieren Sie die Demo-Anwendungen (über den Befehl bin/composer run reimport-example-apps oder über die Web-Administration), um sich den neusten Stand der Entwicklungen anzuschauen
* Unter https://doc.mapbender.org/de/installation/installation_ubuntu.html im Bereich **Entpacken und im Webserver registrieren** ist beschrieben, wie die Konfigurationsdatei für den Apache Alias aussehen sollte
* Das war's auch schon! Schauen Sie sich Ihre neue Mapbender Version an.

Expand Down Expand Up @@ -54,9 +53,10 @@ Im Folgenden sind die einzelnen Schritte als Befehle aufgeführt.
app/console doctrine:schema:update --dump-sql
app/console doctrine:schema:update --force
# Importieren Sie die Anwendungen aus der mapbender.yml Datei, um sich den neusten Stand der Entwicklungen anzuschauen
# Importieren Sie die Demo-Anwendungen, um sich den neusten Stand der Entwicklungen anzuschauen
bin/composer run reimport-example-apps
# export the web directory
app/console assets:install web --symlink --relative
# Setzen Sie die Schreibrechte für Besitzer (u), Gruppe (g) und Andere (a). Weisen Sie die Skripte dem Apache User (www-data) zu.
Expand Down
Loading

0 comments on commit 34944ff

Please sign in to comment.