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.

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

New Routing.rst file and images, to document the Routing element #514

Merged
merged 9 commits into from
Jan 7, 2025
1 change: 1 addition & 0 deletions de/elements/search.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ Suchen

search/search_router.rst
search/simplesearch.rst
search/routing.rst
69 changes: 69 additions & 0 deletions de/elements/search/routing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
.. _routing_de:

Routing
*******

Das Routing-Element fügt einer Anwendung ein Streckenführung-Werkzeug hinzu. Nach Angabe von Start, Ziel und ggf. Zwischenpunkten wird eine geeignete Streckenführung in der Karte angezeigt. Zusätzlich können Informationen zur Strecke ausgegeben werden.

.. image:: ../../../figures/de/routing.png
:scale: 70


Konfiguration
=============

.. image:: ../../../figures/de/routing_configuration.png
:scale: 70

* **Erweiterte Einstellung:** Ermöglicht es weitere Einstellungen vorzunehmen (Standard: false).
* **Titel:** Titel des Elements.
* **Route direkt ausgeben:** Konfiguration zum Deaktivieren/Aktivieren des automatischen Routings ohne Interaktion des Nutzers (Standard: false).
* **Zwischenpunkte erlauben:** Konfiguration zum Deaktivieren/Aktivieren der Zwischenpunkten (Standard: false).
* **Suche aktivieren:** Konfiguration zum Deaktivieren/Aktivieren der Suchoption (Standard: false).
* **Zoompuffer(m):** Definition eines Zoompuffers für die Ergebnisanzeige in Meter (Standard: 0).
* **Linienfarbe:** Anpassen der Lineinfarbe und Deckkraft per rgba Standard (Standard: rgba(66, 134, 244, 1)).
* **Linienbreite:** Anpassen der Linienbreite (Standard: 3).
* **Infotext zur Route:** Option einen Infotext zur Route zu implementieren (Standard: {start} → {destination} </br> {length} will take {time}).

.. image:: ../../../figures/de/routing_configuration_icons.png
:scale: 70

* **Pfad Starticon:** Anpassen des Starticons (Standard: /bundles/mapbenderrouting/image/start.png).
* **Pfad Zwischenicon:** Anpassen des Zwischenicons (Standard: /bundles/mapbenderrouting/image/intermediate.png).
* **Pfad Zielicon:** Anpassen des Zielicons (Standard: /bundles/mapbenderrouting/image/destination.png).
* **Größe Icons:** Die Größe der verschiedenen Icons ist anpassbar.
* **Offset icons:** Das Offset der verschiedenen Icons ist anpassbar.

.. image:: ../../../figures/de/routing_configuration_service.png
:scale: 70

* **Routingsoftware:** Auswählen der Routingsoftware (OSRM, GraphHopper, PgRouting, Trias).
* **URL:** Setzen der URL-Adresse für die Routingsoftware (Standard: https://).
* **Services:** Auswahl aus verschiedenen Services (Standard: Route).
* **Transportmodus:** Auswählen der Routing-Profile (Auto, Fahhrad, Füßgänger). Auch die Auswahl mehrerer ist möglich (Standard: false).
* **API-Version:** Version der API bestimmen (Standard: v1).
* **Wegbeschreibung ausgeben:** Auswählen ob es eine Wegbeschreibung geben soll oder nicht (Standard: nein).

.. image:: ../../../figures/de/routing_configuration_search.png
:scale: 87

* **Suchsoftware:** Auswählen des Such-Dienstes (derzeit nur Solr).
* **Query URL:** Setzen der URL-Adresse für die Suchsoftware.
* **Query URL-Parameter:** Der Suchparameterschlüssel, der angehängt wird (Standard: q).
* **Query Whitespace Ersetzung:** Setzen von Paramteren zum Ersetzung im Such-Therm.
* **Query Key Format:** Setzen des Such-Formats (Standard: %s).
* **Token Split-/Such-/Ersetzungs-Regex (JavaScript regex):** Tokenizer spaltet/sucht/ersetzt regexp.
* **Token Split**, z.B.: ``[^a-zA-Z0-9äöüÄÖÜß]``
* **Token Such**, z.B..: ``([a-zA-ZäöüÄÖÜß]{3,})``
* **Token Ersetzung**, z.B..: ``$1*``
* **Pfad zu den Ergebnissen:** Setzen des Pfads, der vom Abfrageergebnis extrahiert wird (Standard: response.docs).
* **Attribut für Beschriftung:** Attribut oder mehrere Attribute , die als Ergebnis angezeigt werden sollen (Standard: label).
* **Attribut für Geometrie:** Attributname der Geometrie (Standard: geom).
* **Geometrieformat:** Geometrieformat, kann WKT oder GeoJSON sein (Standard WKT).
* **Quell-SRS:** EPSG-Code des primären Koordinatenbezugsystems (Standard EPSG:4326).


YAML-Definition
---------------


1 change: 1 addition & 0 deletions en/elements/search.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ Search

search/search_router.rst
search/simplesearch.rst
search/routing.rst
69 changes: 69 additions & 0 deletions en/elements/search/routing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
.. _routing:

Routing
*******

The routing element adds a routing tool to an application. After specifying the start, destination and any intermediate points, a suitable route is displayed on the map. Information about the route can also be displayed.

.. image:: ../../../figures/de/routing.png
:scale: 70

Configuration
=============


.. image:: ../../../figures/routing_configuration.png
:scale: 70

* **Advanced route settings:** Allows you to make further settings (default: false).
* **Title:** Elements Title.
* **Route immediately:** Configuration to deactivate/activate automatic routing without the users interaction (default: false).
* **Allow intermediate points:** Configuration for deactivating/activating intermediate points (default: false).
* **Enable Search:** Configuration to deactivate/activate the search option (default: false).
* **Zoom buffer (m):** Definition of a zoom buffer for the result display in meters (default: 0).
* **Line color:** Option to adjust the line color and opacity with the rgba standard (default: rgba(66, 134, 244, 1)).
* **Line width:** Option to adjust the line width (default: 3).
* **Route info text:** Option to add an info text for the rout (default: {start} → {destination} </br> {length} will take {time}).

.. image:: ../../../figures/routing_configuration_icons.png
:scale: 70

* **Path start icon:** Customize the start icon (default: /bundles/mapbenderrouting/image/start.png).
* **Path intermediate icon:** Customize the intermediate icon (default: /bundles/mapbenderrouting/image/intermediate.png):
* **Path destination icon:** Customize the destination icon (default: /bundles/mapbenderrouting/image/destination.png).
* **Size Icon:** Adjust the size of the different icons.
* **Offset Icon:** Adjust the offset of the different icons.

.. image:: ../../../figures/routing_configuration_service.png
:scale: 70

* **Routing software:** Select the routing software (OSRM).
* **URL:** Set the URL address for the routing software (default: https://).
* **Services:** Select from various services (defaut: Route).
* **Transportation mode:** Select the routing profiles (car, bicycle, pedestrian). It is also possible to select more than one (default: none).
* **API-Version:** Determine the version of the API (default: v1).
* **Route description:** Select whether there should be a route description or not (default: no).

.. image:: ../../../figures/routing_configuration_search.png
:scale: 87

* **Search software:** Select the search service (default: Solr).
* **Search URL:** Set the URL address for the search software.
* **Search parameter key:** Set the search parameter key (default: q).
* **Whitespace replacement pattern:** Set parameters to replace the search term.
* **Search format:** Set the search format (default: %s).
* **Token split/search/replace (JavaScript regex):** Tokenizer splits/searches/replaces regexp.
* **Token split**, z.B.: ``[^a-zA-Z0-9äöüÄÖÜß]``
* **Token search**, z.B..: ``([a-zA-ZäöüÄÖÜß]{3,})``
* **Token replace**, z.B..: ``$1*``
* **Collection path:** Set the attribute path that is extracted from the query result (default: response.docs).
* **Label attribute:** Name of the attribute's to show as result (default: label).
* **Geom attribute:** Name of the geometry attribute (default: geom).
* **Geom format:** Geometry data format, can be WKT or GeoJSON (default. WKT).
* **Projection Geom:** EPSG code of the spatial reference system(default EPSG:4326).



YAML-Definition
---------------

Binary file added figures/de/routing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added figures/de/routing_configuration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added figures/de/routing_configuration_icons.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added figures/de/routing_configuration_search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added figures/de/routing_configuration_service.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added figures/routing_configuration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added figures/routing_configuration_icons.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added figures/routing_configuration_search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added figures/routing_configuration_service.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.