Skip to content

Commit

Permalink
Doku überarbeitet (#152)
Browse files Browse the repository at this point in the history
* Basis-Überarbeitung help.php

* Dokumentation inhaltlich und die techn. Umsetzung überarbeitet

* Kommentare bereinigt
  • Loading branch information
christophboecker authored Apr 26, 2024
1 parent c4e9167 commit 26e34a0
Show file tree
Hide file tree
Showing 19 changed files with 450 additions and 623 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Changelog

## xx-xx-2024

- Umbau
- Die Handbuchseiten sind technisch etwas anders realisiert.
- Fehlerkorrekturen
- geänderte Darstellung der Code-Blöcke im Handbuch; neue Verson von PrismJS


## 25.06.2023 2.1.3

- BugFix:
Expand Down
44 changes: 22 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,51 +8,51 @@ Kartenanzeige mit LeafletJS kann mit eigenen JS-Schnipseln rasch und on the fly

Kontakt: [Thomas Skerbis](https://github.com/skerbis)

![Titelbild](docs/assets/titel.jpg)
![Titelbild](https://github.com/FriendsOfREDAXO/geolocation/blob/master/docs/assets/titel.jpg?raw=true)

## Features:

- Backend
- [Karten-URLs](docs/admin.md#tile) zu Karten-Anbietern mit weiteren Parametern inkl.
- [Karten-URLs](https://github.com/FriendsOfREDAXO/geolocation/blob/master/docs/setings.md#tile) zu Karten-Anbietern mit weiteren Parametern inkl.
Sprachunterstützung und Cache-Verhalten
- [Kartensätze](docs/admin.md#mapset) zusammenstellen und verwalten, die auf einer oder mehreren
- [Kartensätze](https://github.com/FriendsOfREDAXO/geolocation/blob/master/docs/settings.md#mapset) zusammenstellen und verwalten, die auf einer oder mehreren
Karten-Urls basieren
- Datenverwaltung mit YForm
- [Proxy-Server](docs/proxy_cache.md#proxy) für Karten-Abrufe vom Browser
- [Cache](docs/proxy_cache.md#cache) für Karten-Abrufe
- [Proxy-Server](https://github.com/FriendsOfREDAXO/geolocation/blob/master/docs/proxy_cache.md#proxy) für Karten-Abrufe vom Browser
- [Cache](https://github.com/FriendsOfREDAXO/geolocation/blob/master/docs/proxy_cache.md#cache) für Karten-Abrufe
- Verschleierung der tatsächlichen Karten-Url ggü. dem Client / Schutz der ggf. kostenpflichtigen
appId´s z.B. von Google oder HERE
- Kartendarstellung im Moduloutput mit demselben Code wie im Frontend
- Ausführliche Dokumentation online im Backend bzw. auf GitHub
- Ausführliche Dokumentation online im Backend (bei installiertem Addon) bzw. auf GitHub

- Karten
- LeafletJS als Kartensoftware integriert
- Karten-HTML als [Custom-HTML-Element](#rm) `<rex-map .... ></rex-map>`
- [Erweiterbare Tools](docs/devtools.md) zur Datendarstellung inkl. geoJSON (Basis, erweiterbar)
- Anwendungsbeispiel für [Module](docs/devphp.md#module)
- [Erweiterbare Tools](https://github.com/FriendsOfREDAXO/geolocation/blob/master/docs/devtools.md) zur Datendarstellung inkl. geoJSON (Basis, erweiterbar)
- Anwendungsbeispiel für [Module](https://github.com/FriendsOfREDAXO/geolocation/blob/master/docs/devphp.md#module)
- Einfache Einbindung des komprimierten JS / CSS im Frontend passend zur individuellen Konfiguration.

- Demo
- [Stand-alone-Demo](docs/example/demo.html) zur Demonstration des Custom-HTML-Elements und des Cache
- [Stand-alone-Demo](https://github.com/FriendsOfREDAXO/geolocation/blob/master/docs/example/demo.html) zur Demonstration des Custom-HTML-Elements und des Cache
- *redaxo/src/addons/geolocation/docs/example/demo.html* bitte ins REDAXO-Root kopieren wg. der Pfade

- [Cache](docs/proxy_cache.md#cache)
- [Cache](https://github.com/FriendsOfREDAXO/geolocation/blob/master/docs/proxy_cache.md#cache)
- Je Tile-URL ein eigenes Verzeichnis, separat löschbar
- [Cronjob](docs/proxy_cache.md#cron) zum Aufräumen
- [Cronjob](https://github.com/FriendsOfREDAXO/geolocation/blob/master/docs/proxy_cache.md#cron) zum Aufräumen
- Dateien löschen, die älter sind als die Time-to-live der Tile-URL
- weitere ältere Dateien löschen wenn das Verzeichnis zu viele Dateien enthält

- [Rechnen mit Koordinaten (PHP)](docs/devmath.md)
- [class FriendsOfRedaxo\Geolocation\Calc\Point](docs/devmath.md#point): Koordinaten verwalten
- [Rechnen mit Koordinaten (PHP)](https://github.com/FriendsOfREDAXO/geolocation/blob/master/docs/devmath.md)
- [class FriendsOfRedaxo\Geolocation\Calc\Point](https://github.com/FriendsOfREDAXO/geolocation/blob/master/docs/devmath.md#point): Koordinaten verwalten
- verschiedene Format als Input/Output; Konvertierung
- Distanzen und Richtung ermitteln
- Zielpunkt aus Richtung und Distanz
- [class FriendsOfRedaxo\Geolocation\Calc\Box](docs/devmath.md#box): Rechteckigen Bereich verwalten
- [class FriendsOfRedaxo\Geolocation\Calc\Box](https://github.com/FriendsOfREDAXO/geolocation/blob/master/docs/devmath.md#box): Rechteckigen Bereich verwalten
- Anlegen aus zwei gegenüberliegenden Ecken
- Dynamisch erweitern
- diverse Abfragen (north, south, ....)
- Berechnete Werte (center, innerRadius, outerRadius)
- [class FriendsOfRedaxo\Geolocation\Calc\Math](docs/devmath.md#math): Rechteckigen Bereich verwalten
- [class FriendsOfRedaxo\Geolocation\Calc\Math](https://github.com/FriendsOfREDAXO/geolocation/blob/master/docs/devmath.md#math): Rechteckigen Bereich verwalten
- diverse Methoden und Defaults basierend auf phpGeo
- Distanzen und Richtung ermitteln
- Zielpunkt aus Richtung und Distanz
Expand Down Expand Up @@ -85,7 +85,7 @@ Der Cronjob für die Cache-Bereinigung hat die Einstellungen
- Scriptanfang
- aktiviert

Details - auch zu individualisierten Installationen - stehen in der [Installationsanleitung](docs/install.md)
Details - auch zu individualisierten Installationen - stehen in der [Installationsanleitung](https://github.com/FriendsOfREDAXO/geolocation/blob/master/docs/install.md)

## OSMProxy ersetzten
OSM-Proxy-Nutzer müssen im Abschnitt Karten die gewünschten Tileserver hinterlegen und im Anschluss die URL für die Tiles im z.B. Leaflet JS ändern.
Expand All @@ -100,22 +100,22 @@ OSM-Proxy-Nutzer müssen im Abschnitt Karten die gewünschten Tileserver hinterl

### Allgemeine Konfiguration

![Konfiguration](docs/assets/config.jpg)
![Konfiguration](https://github.com/FriendsOfREDAXO/geolocation/blob/master/docs/assets/config.jpg?raw=true)

### Kartensatz

![Kartensatz: Auflistung](docs/assets/maps_list.jpg)
![Kartensatz: Formular](docs/assets/maps_edit.jpg)
![Kartensatz: Auflistung](https://github.com/FriendsOfREDAXO/geolocation/blob/master/docs/assets/maps_list.jpg?raw=true)
![Kartensatz: Formular](https://github.com/FriendsOfREDAXO/geolocation/blob/master/docs/assets/maps_edit.jpg?raw=true)

### Layer-/Tile-Server

![Tile-Layer: Auflistung](docs/assets/tiles_list.jpg)
![Tile-Layer: Formular](docs/assets/tiles_edit.jpg)
![Tile-Layer: Auflistung](https://github.com/FriendsOfREDAXO/geolocation/blob/master/docs/assets/tiles_list.jpg?raw=true)
![Tile-Layer: Formular](https://github.com/FriendsOfREDAXO/geolocation/blob/master/docs/assets/tiles_edit.jpg?raw=true)

<a name="rm"></a>
### `<rex-map .... ></rex-map>`

Darstellung der Karte im Browser über ein [Custom-HTML-Element](docs/devphp#maphtml):
Darstellung der Karte im Browser über ein [Custom-HTML-Element](https://github.com/FriendsOfREDAXO/geolocation/blob/master/docs/devphp#maphtml):

```html
<rex-map mapset="..." dataset="..."></rex-map>
Expand Down
14 changes: 4 additions & 10 deletions assets/help.min.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 26e34a0

Please sign in to comment.