Merge pull request #80 from GeotrekCE/mfu-add-documentation

[Documentation] Starting documentation

docs/.vitepress/config/fr.ts

@@ -59,7 +59,7 @@ function sidebar(): DefaultTheme.SidebarItem[] {
         items: [
           { text: 'Les couleurs', link: '/documentation/theme/colors' },
           { text: 'Responsive design', link: '/documentation/theme/responsive-design' },
-          { text: 'Personnalisation avancées', link: '/documentation/theme/advanced-customization' },
+          { text: 'Personnalisations avancées', link: '/documentation/theme/advanced-customization' },
           { text: 'Paramètres supplémentaires', link: '/documentation/theme/additional-settings' },
         ],
       },
@@ -70,13 +70,13 @@ function sidebar(): DefaultTheme.SidebarItem[] {
           { text: 'Fonctionnement', link: '/documentation/components/how-it-works' },
           { text: 'Application', link: '/documentation/components/grw-app' },
           { text: 'Liste de randonnées', link: '/documentation/components/grw-treks-list' },
-          { text: "Vue simplifiée d'une randonnée", link: '/documentation/components/grw-trek-card' },
+          { text: "Vignette d'une randonnée", link: '/documentation/components/grw-trek-card' },
           { text: "Détail d'une randonnée", link: '/documentation/components/grw-trek-detail' },
           { text: 'Liste des contenus touristiques', link: '/documentation/components/grw-touristic-contents-list' },
-          { text: "Vue simplifiée d'un contenu touristique", link: '/documentation/components/grw-touristic-content-card' },
+          { text: "Vignette d'un contenu touristique", link: '/documentation/components/grw-touristic-content-card' },
           { text: "Détail d'un contenu touristique", link: '/documentation/components/grw-touristic-content-detail' },
           { text: 'Liste des évènements touristiques', link: '/documentation/components/grw-touristic-events-list' },
-          { text: "Vue simplifiée d'un évènement touristique", link: '/documentation/components/grw-touristic-event-card' },
+          { text: "Vignette d'un évènement touristique", link: '/documentation/components/grw-touristic-event-card' },
           { text: "Détail d'un évènement touristique", link: '/documentation/components/grw-touristic-event-detail' },
           { text: 'Carte', link: '/documentation/components/grw-map' },
         ],

docs/documentation/about/geotrek/projects.md

@@ -0,0 +1,51 @@
+# Les quatre briques
+
+La suite logicielle Geotrek dispose de quatre briques à la fois distinctes et complémentaires :
+
+* [Geotrek-admin](https://geotrek.readthedocs.io/en/master//about/geotrek.html): outil de gestion et de saisie de l’ensemble des informations, intégrant les données des Systèmes d’Informations Touristiques (SIT) et pouvant être connecté à votre SIG ou à des systèmes d’information transport
+* [Geotrek-rando](https://github.com/GeotrekCE/Geotrek-rando-v3/blob/main/docs/presentation-fr.md) : site web, reprenant les informations saisies dans Geotrek-admin, à destination des internautes grand public
+* [Geotrek-mobile](https://github.com/GeotrekCE/Geotrek-mobile#geotrek-mobile) : application mobile fonctionnant sous Android et iOS, reprenant des informations saisies dans Geotrek-admin et optimisées pour l’usage mobile (volume, impact sur la batterie, hors-ligne, géolocalisation…)
+* [Geotrek-rando-widget](/documentation/introduction/overview.html) : nouveau composant web permettant de valoriser une offre de contenus touristiques et de randonnées auprès des usagers du territoire, en l'intégrant dans un site internet existant.
+
+::: info
+Cette documentation ne traite que de **Geotrek-rando-widget**, chaque brique ayant sa propre documentation.
+:::
+
+## Utilisateurs
+
+
+L’application Geotrek, **destinée à deux types de public**, est une solution web qui apporte :
+
+* des fonctionnalités de gestion des informations (itinéraires, sites outdoor, points d’intérêts, description, interprétation, médias…) et de gestion des infrastructures (signalétique, aménagements, travaux, réglementation…) pour les utilisateurs gérant un territoire (**Geotrek-admin**) 
+* des fonctionnalités simples et ludiques de recherche et de consultation d’itinéraires pour les internautes et les mobinautes (**Geotrek-rando V3**, **Geotrek-mobile** et **Geotrek-rando-widget**).
+
+Pour retrouver plus d'informations sur la suite applicative Geotrek, rendez-vous sur [https://geotrek.fr](https://geotrek.fr)
+
+## Composants libres
+
+L’application Geotrek utilise les technologies open source suivantes :
+
+### Geotrek-admin
+
+* **Python / Django**, l'épine dorsale de l'application qui prend en charge les principales fonctionnalités comme le module de configuration, l'exploitation de la base de données, la gestion des utilisateurs et de leurs droits ou l'intégration avec les bibliothèques cartographiques. La richesse de son écosystème permet de concevoir des applications aux possibilités infinies, en favorisant la production d'applications sécurisées, solides (tests automatiques) et robustes (Python).
+* **PostgreSQL / PostGIS** pour la base de données. La totalité des données de l'application est stockée dans une instance PostgreSQL avec l'extension spatiale PostGIS :
+
+  * attributs, comptes utilisateurs…,
+  * géométries,
+  * raster (Modèle Numérique Terrain).
+
+### Geotrek-rando
+* **Next.js** (*React, Typescript*), 
+* **Leaflet**, utilisé comme librairie cartographique
+
+### Geotrek-rando-widget
+
+* **Stencil**, framework permettant de créer des composants web personnalisables et légers.
+* **Leaflet**, utilisé comme librairie cartographique
+
+### Geotrek-mobile
+
+* **Angular**, framework utilisé pour l'application Geotrek-mobile.
+* **Ionic**, composant UI
+* **Capacitor**, boîte à outils nécessaires à la création d'applications mobile
+* **MapLibre**, utilisé comme librairie cartographique 

docs/documentation/about/geotrek/what-is-geotrek.md

@@ -0,0 +1,18 @@
+# Qu'est ce que Geotrek ?
+
+Geotrek est un ensemble d'outils web dédiés à la **gestion et la valorisation** des activités de randonnées, de sports de pleine nature et des informations touristiques.
+
+Ils sont open source et peuvent ainsi être déployés librement par les structures et territoires qui le souhaitent, mais aussi les faire évoluer, ou bénéficier des évolutions réalisées par d'autres structures sans avoir à les re-financer.
+
+Ces outils permettent la gestion de **nombreuses pratiques sportives** liées à des linéaires (randonnée pédestre, à vélo, en VTT, à cheval, avec poussette, etc.) mais également à des **contenus outdoor** non linéaires (escalade, vol libre, sports d’eau vive, etc.).
+
+C’est l’**application de référence** des parcs naturels, mais aussi de nombreuses structures publiques (conseils départementaux, communautés de communes, comités régionaux du tourisme, offices du tourisme, etc.).
+
+**Utiliser Geotrek vous permettra** :
+
+* d’intégrer une **communauté de gestionnaires de randonnées très active**
+* de **bénéficier de l’ensemble des évolutions** réalisées par les autres utilisateurs. Le projet est vivant et les outils s’améliorent sans cesse
+* de disposer d’une **offre complète** qui pourra également être utilisée par d’autres acteurs du territoire
+* de facilement pouvoir **accéder à d’autres fonctionnalités** quand le besoin s’en fera ressentir : site web, impression de fiches de parcours, gestion de la signalétique, organisation des travaux…
+* d’exporter facilement vos contenus valorisables (itinéraires, POIs, contenus touristiques, etc) vers d’autres **plateformes touristiques nationales** (IGNrando', Visorando, Outdooractive, Apidae, Cirkwi, etc.)
+

docs/documentation/components/grw-touristic-content-card.md

@@ -0,0 +1,12 @@
+# Vignette d'un contenu touristique
+
+Les informations affichées dans la vignette d'un contenu touristique sont :
+
+- La ou les photos (caroussel) 
+- Le type de contenu (hébergement, restauration, produits locaux, etc.)
+- Le nom du service
+
+<center>
+  <a title="Vignette d'un contenu touristique"><img src="/components/card_touristic_content.png" alt="Vignette d'un contenu touristique"></a>
+</center>
+

docs/documentation/components/grw-touristic-contents-list.md

@@ -0,0 +1,32 @@
+# Gestion de la liste des contenus touristiques (services)
+
+<center>
+  <a title="Liste des services"><img src="/components/list_touristic_content.png" alt="Liste des services"></a>
+</center>
+
+## Comportement et design
+
+- Au survol d'un service dans la liste, le pictogramme est agrandi sur la carte
+- Affichage d'un carrousel pour faire défiler plusieurs images
+- Le pictogramme de la catégorie du service est affiché (hébergements, sorties, musées etc.)
+
+## Filtre et recherche
+
+- Recherche d'un service par son nom
+- Filtre sur la catégorie de service
+- Réinitialisation des filtres
+
+## Désactiver l'affichage des services dans le widget
+
+Il est possible de paramétrer le widget de façon à valoriser une offre de contenus touristiques sans forcément mettre en avant les balades associées. 
+
+::: info
+Par défaut, celles ci sont visibles et matérialisées par une barre de segments permettant de les filtrer séparément des autres contenus (itinéraires, évènements touristiques).
+:::
+
+
+```js
+<grw-app
+	touristic-contents="false"
+></grw-app>
+```

docs/documentation/components/grw-touristic-event-card.md

@@ -0,0 +1,13 @@
+# Vignette d'un évènement touristique
+
+Les informations affichées dans la vignette d'un évènement touristique sont :
+
+- La ou les photos (caroussel) 
+- Le type d'évènement (nature et détente, culture, etc.)
+- Le nom de la commune où se déroule l'évènement et son nom
+- Les dates de début et de fin
+
+<center>
+  <a title="Vignette d'un évènement touristique"><img src="/components/card_touristic_event.png" alt="Vignette d'un évènement touristique"></a>
+</center>
+

docs/documentation/components/grw-touristic-events-list.md

@@ -0,0 +1,33 @@
+# Gestion de la liste des évènements touristiques
+
+<center>
+  <a title="Liste des évènements"><img src="/components/list_touristic_event.png" alt="Liste des évènements"></a>
+</center>
+
+
+## Comportement et design
+
+- Au survol d'un évènement dans la liste, le pictogramme est agrandi sur la carte
+- Affichage d'un carrousel pour faire défiler plusieurs images
+- Le pictogramme de la catégorie de l'évènement est affiché (exposition, atelier, conférence, etc.)
+
+## Filtre et recherche
+
+- Recherche d'un évènement par son nom
+- Filtre sur la catégorie d'évènement
+- Réinitialisation des filtres
+
+## Désactiver l'affichage des services dans le widget
+
+Il est possible de paramétrer le widget de façon à valoriser une offre de contenus touristiques sans forcément mettre en avant les évènements associés. 
+
+::: info
+Par défaut, ceux-ci sont visibles et matérialisés par une barre de segments permettant de les filtrer séparément des autres contenus (itinéraires, contenus touristiques).
+:::
+
+
+```js
+<grw-app
+	touristic-events="false"
+></grw-app>
+```

docs/documentation/components/grw-trek-card.md

@@ -0,0 +1,40 @@
+# Vignette d'une randonnée
+
+Les informations affichées dans la vignette d'une randonnée sont :
+
+- La ou les photos (caroussel) 
+- Le nom de la commune de départ
+- Le nom de l'itinéraire
+- Les thèmes associés (faune, géologie, archéologie et histoire, etc.)
+- La difficulté
+- La distance en kilomètres
+- Le type de parcours (aller-retour, boucle)
+- Le temps
+- Le dénivellé positif
+- Le type de pratique (pédestre, vélo, cheval, etc.)
+
+<center>
+  <a title="Vignette d'une randonnée"><img src="/components/card_trek.png" alt="Vignette d'une randonnée"></a>
+</center>
+
+# Vignettes présentes dans la fiche détail d'une randonnée
+
+La fiche détail d'une randonnée peut être même contenir des vignettes d'objets situés à proximté afin d'enrichir son contenu informatif.
+
+## Patrimoines à découvrir (POIs)
+
+<center>
+  <a title="Vignette des patrimoines à découvrir"><img src="/components/card_trek_poi.png" alt="Vignette des patrimoines à découvrir"></a>
+</center>
+
+## Lieux de renseignement
+
+<center>
+  <a title="Vignette des lieux de renseignement"><img src="/components/card_trek_informationdesk.png" alt="Vignette des lieux de renseignement"></a>
+</center>
+
+## Services à proximité
+
+<center>
+  <a title="Vignette des services à proximité"><img src="/components/card_trek_touristic_content.png" alt="Vignette des services à proximité"></a>
+</center>

docs/documentation/components/grw-trek-detail.md

@@ -0,0 +1,77 @@
+# Vue détaillée d'une randonnée
+
+La vue détaillée est composée de trois parties :
+
+- La fiche détaillée à gauche
+- La carte à droite
+- Le profil altimétrique sous la carte
+
+## Fiche détaillée d'une randonnée
+
+La fiche détaillée d'une randonnée comporte plusieurs sections intéragissant dynamiquement avec la carte.
+
+### Section "Présentation"
+
+La section "Présentation" est constituée :
+
+- de la vignette avec des informations plus détaillées comme le dénivelé négatif
+- des boutons de téléchargement au formats GPX, KML et PDF
+- du chapeau (bref résumé) et de l'ambiance (attractions principales et intérêts) de la randonnée
+
+<center>
+  <a title="Fiche détail d'une randonnée"><img src="/components/detail_trek.png" alt="Fiche détail d'une randonnée"></a>
+</center>
+
+### Section "Description"
+
+Cette section comporte une description technique pas à pas de l’itinéraire avec le plus souvent une liste numérotée (que l'on sur la carte) des différentes étapes clés.
+
+<center>
+  <a title="Fiche détail d'une randonnée"><img src="/components/detail_trek_description.png" alt="Fiche détail d'une randonnée"></a>
+</center>
+
+### Section "Patrimoines"
+
+La section "Patrimoine", en plus d'afficher les vignettes des éléments de patrimoines (POIs) situés à proximités de la randonnée (rayon de 500m par défaut), peut présenter des informations complémentaires comme :
+- le widget Météo France
+- Les accès routiers et parking
+- Les transports en commun pour venir
+
+::: info
+Les pictogrammes des POIs s'affichent sur la carte lorsque l'utilisateur arrive sur cette section.
+:::
+
+<center>
+  <a title="Fiche détail d'une randonnée"><img src="/components/detail_trek_poi.png" alt="Fiche détail d'une randonnée"></a>
+</center>
+
+### Sections "Recommandations" et "Lieux d'informations"
+
+La section "Recommandations" présente les recommandations sur les risques, danger ou meilleure période pour pratiquer l’itinéraire, ainsi que tout autre élément d'information utile à connaître.
+
+La section "Lieux d'informations" présente les lieux de renseignement (office du tourisme, bureau d'information, etc.) sous forme de vignettes. 
+
+::: info
+En cliquant sur le bouton "Centrer sur la carte", la carte est zoomée sur le lieu en question.
+:::
+
+
+<center>
+  <a title="Fiche détail d'une randonnée"><img src="/components/detail_trek_informationdesk.png" alt="Fiche détail d'une randonnée"></a>
+</center>
+
+### Sections "Accessibilité" et "A proximité"
+
+La section "Accessibilité" permet d'afficher les informations r'elatives à l'accessibilité (aménagements, pente, revêtements, exposition, etc.).
+
+La section "A proximité" présente les services à proximité de la randonnée (rayon de 500m par défaut).
+
+Une section complémentaire "En savoir plus" peut être affichée si le champ `source` est renseigné dans **Geotrek-admin** .
+
+::: info
+Les pictogrammes des services s'affichent sur la carte lorsque l'utilisateur arrive sur cette section.
+:::
+
+<center>
+  <a title="Fiche détail d'une randonnée"><img src="/components/detail_trek_touristis_content.png" alt="Fiche détail d'une randonnée"></a>
+</center>

docs/documentation/components/grw-treks-list.md

@@ -0,0 +1,33 @@
+# Gestion de la liste des randonnées
+
+<center>
+  <a title="Liste des randonnées"><img src="/components/list_trek.png" alt="Liste des randonnées"></a>
+</center>
+
+## Comportement et design
+
+- Au survol d'un itinéraire dans la liste, le pictogramme est agrandi sur la carte et le tracé est affiché
+- Affichage d'un carrousel pour faire défiler plusieurs images
+- Le pictogramme de la pratique de l'itinéraire est affiché (pédestre, vélo, cheval, etc.)
+
+## Filtre et recherche
+
+- Recherche d'une randonnée par son nom
+- Filtre sur les caractéristiques : type de parcours, longueur, dénivelé, accessibilité, labels (étiquettes)
+- Filtre sur les randonnées rattachées à une ou plusieurs communes, secteurs, thèmes
+- Réinitialisation des filtres
+
+
+## Désactiver l'affichage des randonnées dans le widget
+
+Il est possible de paramétrer le widget de façon à valoriser une offre de contenus touristiques sans forcément mettre en avant les balades associées. 
+
+::: info
+Par défaut, celles-ci sont visibles et matérialisées par une barre de segments permettant de les filtrer séparément des autres contenus (itinéraires, évènements touristiques).
+:::
+
+```js
+<grw-app
+	treks="false"
+></grw-app>
+```