Merge pull request #309 from GeotrekCE/mfu-improve-doc

[Doc] Add config examples

Author: bruhnild

docs/.vitepress/config/en.ts

@@ -43,6 +43,12 @@ function sidebar(): DefaultTheme.SidebarItem[] {
           { text: 'Offline', link: '/en/documentation/features/offline' }
         ]
       },
+      {
+        text: 'Configuration',
+        items: [
+          { text: 'Configuration', link: '/en/documentation/configuration/configuration' }
+        ]
+      },
       {
         text: 'Architecture',
         items: [

docs/.vitepress/config/fr.ts

@@ -43,6 +43,12 @@ function sidebar(): DefaultTheme.SidebarItem[] {
           { text: 'Offline', link: '/documentation/features/offline' }
         ]
       },
+      {
+        text: 'Configuration',
+        items: [
+          { text: 'Configuration', link: '/documentation/configuration/configuration' }
+        ]
+      },
       {
         text: 'Architecture',
         items: [

docs/documentation/configuration/configuration.md

@@ -0,0 +1,92 @@
+# Principales options de configuration
+
+Cette page présente les principales options de configuration à modifier dans le fichier :
+
+`mobile/config/src/environments/environment.prod.ts`
+
+## Activer la page d'accueil
+
+Par défaut, l’application présente un affichage des itinéraires par liste ou par vignette. Pour afficher une **page d'accueil** avec un menu :
+
+Modifier la ligne suivante :
+
+```diff
+- navigation: 'tabs',
++ navigation: 'menu',
+```
+
+## Afficher les vignettes vers les pratiques outdoor
+
+Pour activer l’affichage des **pratiques outdoor** (via ferrata, escalade, parapente, etc.) en page d’accueil :
+
+Modifier la ligne suivante :
+
+```diff
+- enableOutdoorPracticesShortcuts: false,
++ enableOutdoorPracticesShortcuts: { portals: [] },
+```
+
+**Astuce** :
+Si vous souhaitez activer cette fonctionnalité uniquement pour certains portails, ajoutez leurs identifiants dans le tableau `portals`.
+
+Exemple :
+
+```ts
+enableOutdoorPracticesShortcuts: { portals: ['2,5'] },
+```
+
+## Choisir le tri initial des itinéraires
+
+L’ordre d’affichage initial des contenus peut être défini par l’une des options suivantes :
+
+* `alphabetical` (ordre alphabétique, par défaut)
+* `random` (ordre aléatoire)
+* `location` (par proximité géographique)
+
+Exemple pour un tri par **proximité géographique** :
+
+```ts
+initialOrder: 'location',
+```
+
+## Définir la distance de déclenchement des notifications POI
+
+L’application peut notifier l’utilisateur à l’approche d’un point d’intérêt (POI).
+
+Pour modifier la distance à partir de laquelle la notification s’affiche (en mètres) :
+
+```ts
+metersToNotify: 200,
+```
+
+Exemple : pour notifier à 300 mètres :
+
+```ts
+metersToNotify: 300,
+```
+
+## Modifier le fond de carte
+
+Voici un exemple de configuration pour afficher le fond de carte **Plan IGN V2** :
+
+```ts
+sources: {
+  'tiles-background': {
+    type: 'raster',
+    tiles: [
+      'https://data.geopf.fr/wmts?SERVICE=WMTS&REQUEST=GetTile&VERSION=1.0.0&LAYER=GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2&STYLE=normal&FORMAT=image/png&TILEMATRIXSET=PM&TILEMATRIX={z}&TILEROW={y}&TILECOL={x}'
+    ],
+    tileSize: 256
+  }
+}
+```
+
+**À noter** :
+- Il est possible d’utiliser d’autres fonds de carte compatibles avec Mapbox GL JS (raster ou vectoriel), en adaptant l’URL et les paramètres `sources` et `layers`.
+- Les tuiles pour le mode hors lignes sont à configurer côté Geotrek-admin (voir le paramètre `MOBILE_TILES_URL` dans le fichier [geotrek/settings/base.py](https://github.com/GeotrekCE/Geotrek-admin/blob/master/geotrek/settings/base.py))
+
+# Paramètres de configuration disponibles
+
+Vous pouvez consulter l’ensemble des paramètres configurables pour la personnalisation de l’application mobile dans le fichier suivant : [/main/src/environments/environment.prod.ts](https://github.com/GeotrekCE/Geotrek-mobile/blob/main/src/environments/environment.prod.ts)
+
+

docs/en/documentation/configuration/configuration.md

@@ -0,0 +1,92 @@
+# Main configuration options
+
+This page presents the main configuration options that can be modified in the following file:
+
+`mobile/config/src/environments/environment.prod.ts`
+
+## Enable the home page
+
+By default, the application displays treks in a list or grid view. To display a **home page** with a menu:
+
+Edit the following line:
+
+```diff
+- navigation: 'tabs',
++ navigation: 'menu',
+```
+
+## Display shortcuts to outdoor practices
+
+To enable the display of **outdoor practices** (via ferrata, climbing, paragliding, etc.) on the home page:
+
+Edit the following line:
+
+```diff
+- enableOutdoorPracticesShortcuts: false,
++ enableOutdoorPracticesShortcuts: { portals: [] },
+```
+
+**Tip**:
+If you want to enable this feature only for certain portals, add their IDs to the `portals` array.
+
+Example:
+
+```ts
+enableOutdoorPracticesShortcuts: { portals: ['2,5'] },
+```
+
+## Set the initial treks sorting order
+
+The default display order of treks can be set to one of the following options:
+
+* `alphabetical` (alphabetical order, default)
+* `random` (random order)
+* `location` (by geographical proximity)
+
+Example for sorting by **geographical proximity**:
+
+```ts
+initialOrder: 'location',
+```
+
+## Set the notification distance for POIs
+
+The app can notify users when approaching a Point of Interest (POI).
+
+To change the distance (in meters) at which the notification is triggered:
+
+```ts
+metersToNotify: 200,
+```
+
+Example: to trigger the notification at 300 meters:
+
+```ts
+metersToNotify: 300,
+```
+
+## Change the map background
+
+Here is an example configuration to display the **IGN Plan V2** map background:
+
+```ts
+sources: {
+  'tiles-background': {
+    type: 'raster',
+    tiles: [
+      'https://data.geopf.fr/wmts?SERVICE=WMTS&REQUEST=GetTile&VERSION=1.0.0&LAYER=GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2&STYLE=normal&FORMAT=image/png&TILEMATRIXSET=PM&TILEMATRIX={z}&TILEROW={y}&TILECOL={x}'
+    ],
+    tileSize: 256
+  }
+}
+```
+
+**Note**:
+
+* You can use other raster or vector tile sources compatible with Mapbox GL JS by adapting the `sources` and `layers` parameters.
+* Offline map tiles must be configured in Geotrek-admin (see the `MOBILE_TILES_URL` setting in the [geotrek/settings/base.py](https://github.com/GeotrekCE/Geotrek-admin/blob/master/geotrek/settings/base.py) file).
+
+# Available Configuration Parameters
+
+You can find all available parameters for customizing the mobile app in the following file: [/main/src/environments/environment.prod.ts](https://github.com/GeotrekCE/Geotrek-mobile/blob/main/src/environments/environment.prod.ts)
+