diff --git a/docs/documentation/components/how-it-works.md b/docs/documentation/components/how-it-works.md index e69de29b..dd37b03f 100644 --- a/docs/documentation/components/how-it-works.md +++ b/docs/documentation/components/how-it-works.md @@ -0,0 +1,9 @@ +# Fonctionnement des composants graphiques + +Geotrek rando widget propose une multitude de composants graphiques. + +Parmi ces composants, il en existe un prêt à l'emploi : `grw-app`. Ce dernier peut s'utiliser comme une [application](../examples/application.html) à part entière et assemble d'autres composants. + +Il est aussi possible d'utiliser chaque composant graphique de manière indépendante. Par exemple, il est possible d'afficher [une page détail d'un itinéraire ainsi que sa carte](../examples/trek-detail-and-map.html). Pour cela, il faut utiliser les composants graphiques `grw-trek-detail` et `grw-map`. + +Pour pouvoir afficher un itinéraire, il convient de récupérer les informations nécessaires avec un composant qui le permet : `grw-trek-provider`. diff --git a/docs/documentation/contribution/development.md b/docs/documentation/contribution/development.md index e69de29b..50b93c42 100644 --- a/docs/documentation/contribution/development.md +++ b/docs/documentation/contribution/development.md @@ -0,0 +1,33 @@ +# Installation en mode développement + +## Prérequis + +**1. Cloner le dépot** + +```bash +git clone git@github.com:GeotrekCE/Geotrek-rando-widget.git +``` + +**2. Installer les modules npm** + +```bash +npm install +``` + +## Mise en place du composant à modifier + +Éditer le fichier index.html en y ajoutant le composant que vous souhaitez modifier. + +## Démarrer l'application + +Démarrer le serveur en mode développement en lançant cette commande : + +```bash +npm start +``` + +Rendez vous ensuite sur cette URL : + +```bash +http://localhost:3333/ +``` diff --git a/docs/documentation/contribution/documentation.md b/docs/documentation/contribution/documentation.md index b39167ba..c739bb7b 100644 --- a/docs/documentation/contribution/documentation.md +++ b/docs/documentation/contribution/documentation.md @@ -8,7 +8,7 @@ git clone git@github.com:GeotrekCE/Geotrek-rando-widget.git ``` -**2. Installer npm** +**2. Installer les modules npm** ```bash npm install @@ -16,11 +16,12 @@ npm install ## Démarrer l'application -Une fois npm installé, démarrer le serveur en mode développement en lançant cette commande : +Démarrer le serveur en mode développement en lançant cette commande : ```bash npm run docs:dev ``` + Rendez vous ensuite sur cette URL : ```bash @@ -65,10 +66,9 @@ Exemple de création de nouvelle section : Traduire une documentation utilisateur dans une autre langue que le français offre plusieurs avantages : - **Améliorer l'accessibilité** : en traduisant la documentation de Geotrek-rando-widget, vous contribuez à rendre le produit accessible à un public plus large à travers le monde -- **Améliorer l'expérience utilisateur** : la traduction de la documentation dans la langue des utilisateurs permet de faciliter la compréhension et l'utilisation et donc d'améliorer leur expérience globale du produit +- **Améliorer l'expérience utilisateur** : la traduction de la documentation dans la langue des utilisateurs permet de faciliter la compréhension et l'utilisation et donc d'améliorer leur expérience globale du produit - **Faciliter la collaboration** : si Geotrek-rando-widget est utilisé par une équipe internationale, avoir une documentation en anglais facilite la collaboration, le support et la communication - ## Ajouter du contenu en anglais Pour traduire le contenu existant de la documentation, il suffit de mettre à jour les fichiers markdown présents dans le dossier `/docs/en/documentation/`. @@ -89,7 +89,7 @@ L'ensemble des fichiers markdown de documentation se trouvent dans le dossier /d **2. Mettre à jour l'index** -Dans cet exemple, on met à jour le fichier `/docs/.vitepress/config/en.ts` en ajoutant la ligne mise en évidence : +Dans cet exemple, on met à jour le fichier `/docs/.vitepress/config/en.ts` en ajoutant la ligne mise en évidence : ```js { @@ -110,7 +110,7 @@ Dans cet exemple, on met à jour le fichier `/docs/.vitepress/config/en.ts` en a ## Ajouter une nouvelle langue -Pour ajouter le support d'une nouvelle langue (prenons ici l'exemple de l'*italien*), il faut : +Pour ajouter le support d'une nouvelle langue (prenons ici l'exemple de l'_italien_), il faut : **1. Créer un dossier `/docs/it/documentation/`** @@ -126,10 +126,10 @@ Pour des raisons de simplicité, les noms des sous-dossiers et fichiers markdown **3. Créer le fichier `it.ts` dans le dossier `/docs/.vitepress/config/`** -Il s'agit du fichier où l'arborescence des menus dans la langue sera effectuée. Les menus ont également besoin d'être traduits. +Il s'agit du fichier où l'arborescence des menus dans la langue sera effectuée. Les menus ont également besoin d'être traduits. ::: tip -Pour plus de facilité, il peut être intéressant de reprendre le contenu du fichier `en.ts` et de l'adapter au contenu de la nouvelle langue. +Pour plus de facilité, il peut être intéressant de reprendre le contenu du fichier `en.ts` et de l'adapter au contenu de la nouvelle langue. ::: **4. Inclure la langue dans le fichier /docs/.vitepress/config/index.ts** @@ -148,10 +148,10 @@ export default defineConfig({ label: 'English', ...en, }, - it: { + it: { label: 'Italiano', // [!code focus] ...it, }, }, }); -``` \ No newline at end of file +``` diff --git a/docs/documentation/data-provider/grw-outdoor-course-provider.md b/docs/documentation/data-provider/grw-outdoor-course-provider.md new file mode 100644 index 00000000..a75d02cb --- /dev/null +++ b/docs/documentation/data-provider/grw-outdoor-course-provider.md @@ -0,0 +1,25 @@ +# Récupérer les données liées à un parcours outdoor + +Ce composant permet de récupérer les données liées à un parcours outdoor. Il convient de renseigner les paramètres nécessaires. + +## Paramètres obligatoires + +- api: url de l'api du geotrek admin cible +- outdoor-course-id: identifiant du parcours outdoor + +## Paramètres optionnels + +- languages : identifiant de la langue, fr par défaut + +## Composants graphiques liés + +- grw-outdoor-course-detail +- grw-outdoor-course-card +- grw-map + +## Exemple d'affichage du détail d'un parcours outdoor + +```html + + +``` diff --git a/docs/documentation/data-provider/grw-outdoor-courses-provider.md b/docs/documentation/data-provider/grw-outdoor-courses-provider.md new file mode 100644 index 00000000..ee3282fc --- /dev/null +++ b/docs/documentation/data-provider/grw-outdoor-courses-provider.md @@ -0,0 +1,28 @@ +# Récupérer les données liées aux parcours outdoor + +Ce composant permet de récupérer les données liées aux parcours outdoor. Il convient de renseigner les paramètres nécessaires. + +## Paramètres obligatoires + +- api: url de l'api du geotrek admin cible + +## Paramètres optionnels + +- languages : identifiant de la langue, fr par défaut +- in-bbox : bounding box +- cities : liste d'identifiants des villes séparés par une virgule +- districts : liste d'identifiants des secteurs séparés par une virgule +- structures : liste d'identifiants des structures séparés par une virgule +- themes : liste d'identifiants des thèmes séparés par une virgule +- portals : liste d'identifiants des portails séparés par une virgule + +## Composants graphiques liés + +- grw-outdoor-courses-list +- grw-map + +## Exemple d'affichage d'une liste de parcours outdoor + +```html + +``` diff --git a/docs/documentation/data-provider/grw-outdoor-site-provider.md b/docs/documentation/data-provider/grw-outdoor-site-provider.md new file mode 100644 index 00000000..2c358db5 --- /dev/null +++ b/docs/documentation/data-provider/grw-outdoor-site-provider.md @@ -0,0 +1,24 @@ +# Récupérer les données liées à un site outdoor + +Ce composant permet de récupérer les données liées à un site outdoor. Il convient de renseigner les paramètres nécessaires. + +## Paramètres obligatoires + +- api: url de l'api du geotrek admin cible +- outdoor-site-id: identifiant du site outdoor + +## Paramètres optionnels + +- languages : identifiant de la langue, fr par défaut + +## Composants graphiques liés + +- grw-outdoor-site-detail +- grw-outdoor-site-card +- grw-map + +## Exemple d'affichage du détail d'un site outdoor + +```html + +``` diff --git a/docs/documentation/data-provider/grw-outdoor-sites-provider.md b/docs/documentation/data-provider/grw-outdoor-sites-provider.md new file mode 100644 index 00000000..e479781b --- /dev/null +++ b/docs/documentation/data-provider/grw-outdoor-sites-provider.md @@ -0,0 +1,28 @@ +# Récupérer les données liées aux sites outdoor + +Ce composant permet de récupérer les données liées aux sites outdoor. Il convient de renseigner les paramètres nécessaires. + +## Paramètres obligatoires + +- api: url de l'api du geotrek admin cible + +## Paramètres optionnels + +- languages : identifiant de la langue, fr par défaut +- in-bbox : bounding box +- cities : liste d'identifiants des villes séparés par une virgule +- districts : liste d'identifiants des secteurs séparés par une virgule +- structures : liste d'identifiants des structures séparés par une virgule +- themes : liste d'identifiants des thèmes séparés par une virgule +- portals : liste d'identifiants des portails séparés par une virgule + +## Composants graphiques liés + +- grw-outdoor-sites-list +- grw-map + +## Exemple d'affichage d'une liste de sites outdoor + +```html + +``` diff --git a/docs/documentation/data-provider/grw-touristic-content-provider.md b/docs/documentation/data-provider/grw-touristic-content-provider.md index e69de29b..96b025c1 100644 --- a/docs/documentation/data-provider/grw-touristic-content-provider.md +++ b/docs/documentation/data-provider/grw-touristic-content-provider.md @@ -0,0 +1,25 @@ +# Récupérer les données liées à un contenu touristique + +Ce composant permet de récupérer les données liées à un contenu touristique. Il convient de renseigner les paramètres nécessaires. + +## Paramètres obligatoires + +- api: url de l'api du geotrek admin cible +- touristic-content-id: identifiant de l'événement touristique + +## Paramètres optionnels + +- languages : identifiant de la langue, fr par défaut + +## Composants graphiques liés + +- grw-touristic-content-detail +- grw-touristic-content-card +- grw-map + +## Exemple d'affichage du détail d'un contenu touristique + +```html + + +``` diff --git a/docs/documentation/data-provider/grw-touristic-contents-provider.md b/docs/documentation/data-provider/grw-touristic-contents-provider.md index e69de29b..af733fdd 100644 --- a/docs/documentation/data-provider/grw-touristic-contents-provider.md +++ b/docs/documentation/data-provider/grw-touristic-contents-provider.md @@ -0,0 +1,29 @@ +# Récupérer les données liées aux contenus touristiques + +Ce composant permet de récupérer les données liées aux contenus touristiques. Il convient de renseigner les paramètres nécessaires. + +## Paramètres obligatoires + +- api: url de l'api du geotrek admin cible + +## Paramètres optionnels + +- languages : identifiant de la langue, fr par défaut +- in-bbox : bounding box +- cities : liste d'identifiants des villes séparés par une virgule +- districts : liste d'identifiants des secteurs séparés par une virgule +- structures : liste d'identifiants des structures séparés par une virgule +- themes : liste d'identifiants des thèmes séparés par une virgule +- portals : liste d'identifiants des portails séparés par une virgule + +## Composants graphiques liés + +- grw-touristic-contents-list +- grw-map + +## Exemple d'affichage d'une liste de contenus touristiques + +```html + + +``` diff --git a/docs/documentation/data-provider/grw-touristic-event-provider.md b/docs/documentation/data-provider/grw-touristic-event-provider.md index e69de29b..f0d88dee 100644 --- a/docs/documentation/data-provider/grw-touristic-event-provider.md +++ b/docs/documentation/data-provider/grw-touristic-event-provider.md @@ -0,0 +1,25 @@ +# Récupérer les données liées à un événement touristique + +Ce composant permet de récupérer les données liées à un événement touristique. Il convient de renseigner les paramètres nécessaires. + +## Paramètres obligatoires + +- api: url de l'api du geotrek admin cible +- touristic-event-id: identifiant de l'événement touristique + +## Paramètres optionnels + +- languages : identifiant de la langue, fr par défaut + +## Composants graphiques liés + +- grw-touristic-event-detail +- grw-touristic-event-card +- grw-map + +## Exemple d'affichage du détail d'un événement touristique + +```html + + +``` diff --git a/docs/documentation/data-provider/grw-touristic-events-provider.md b/docs/documentation/data-provider/grw-touristic-events-provider.md index e69de29b..556b5cd5 100644 --- a/docs/documentation/data-provider/grw-touristic-events-provider.md +++ b/docs/documentation/data-provider/grw-touristic-events-provider.md @@ -0,0 +1,29 @@ +# Récupérer les données liées aux événements touristiques + +Ce composant permet de récupérer les données liées aux événements touristiques. Il convient de renseigner les paramètres nécessaires. + +## Paramètres obligatoires + +- api: url de l'api du geotrek admin cible + +## Paramètres optionnels + +- languages : identifiant de la langue, fr par défaut +- in-bbox : bounding box +- cities : liste d'identifiants des villes séparés par une virgule +- districts : liste d'identifiants des secteurs séparés par une virgule +- structures : liste d'identifiants des structures séparés par une virgule +- themes : liste d'identifiants des thèmes séparés par une virgule +- portals : Liste d'identifiants des portails séparés par une virgule + +## Composants graphiques liés + +- grw-touristic-events-list +- grw-map + +## Exemple d'affichage d'une liste d'événements touristiques + +```html + + +``` diff --git a/docs/documentation/data-provider/grw-trek-provider.md b/docs/documentation/data-provider/grw-trek-provider.md index e69de29b..8f282d51 100644 --- a/docs/documentation/data-provider/grw-trek-provider.md +++ b/docs/documentation/data-provider/grw-trek-provider.md @@ -0,0 +1,24 @@ +# Récupérer les données liées à un itinéraire + +Ce composant permet de récupérer les données liées à un itinéraire. Il convient de renseigner les paramètres nécessaires. + +## Paramètres obligatoires + +- api: url de l'api du geotrek admin cible +- trek-id: identifiant de l'itinéraire + +## Paramètres optionnels + +- languages : identifiant de la langue, fr par défaut + +## Composants graphiques liés + +- grw-trek-detail +- grw-trek-card +- grw-map + +## Exemple d'affichage du détail d'un itinéraire + +```html + +``` diff --git a/docs/documentation/data-provider/grw-treks-provider.md b/docs/documentation/data-provider/grw-treks-provider.md index e69de29b..050e30a5 100644 --- a/docs/documentation/data-provider/grw-treks-provider.md +++ b/docs/documentation/data-provider/grw-treks-provider.md @@ -0,0 +1,31 @@ +# Récupérer les données liées aux itinéraires + +Ce composant permet de récupérer les données liées aux itinéraires. Il convient de renseigner les paramètres nécessaires. + +## Paramètres obligatoires + +- api: url de l'api du geotrek admin cible + +## Paramètres optionnels + +- languages : identifiant de la langue, fr par défaut +- in-bbox : bounding box +- cities : liste d'identifiants des villes séparés par une virgule +- districts : liste d'identifiants des secteurs séparés par une virgule +- structures : liste d'identifiants des structures séparés par une virgule +- themes : liste d'identifiants des thèmes séparés par une virgule +- portals : liste d'identifiants des portails séparés par une virgule +- routes : liste d'identifiants des types de parcours séparés par une virgule +- practices : liste d'identifiants des pratiques séparés par une virgule +- labels : liste d'identifiants des étiquettes séparés par une virgule + +## Composants graphiques liés + +- grw-treks-list +- grw-map + +## Exemple d'affichage d'une liste d'itinéraires + +```html + +``` diff --git a/docs/documentation/data-provider/how-it-works.md b/docs/documentation/data-provider/how-it-works.md index e69de29b..fe270b43 100644 --- a/docs/documentation/data-provider/how-it-works.md +++ b/docs/documentation/data-provider/how-it-works.md @@ -0,0 +1,5 @@ +# Fonctionnement des composants qui permettent de récupérer des données + +Geotrek-rando-widget propose une multitude de composants qui permettent de récupérer des données. + +Ces composants stockent les données reçues dans un entrepôt de données qui est utilisé par les composants graphiques.