diff --git a/website/documentation/assets/images/printscreen/support-form-documents.png b/website/documentation/assets/images/printscreen/support-form-documents.png new file mode 100644 index 00000000..64af2872 Binary files /dev/null and b/website/documentation/assets/images/printscreen/support-form-documents.png differ diff --git a/website/documentation/desktop.fr.md b/website/documentation/desktop.fr.md deleted file mode 100644 index b1e31a4f..00000000 --- a/website/documentation/desktop.fr.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -title: Desktop -tx_slug: documentation_desktop -hide: - - navigation ---- - -# Edition - -## Ajout de signaux - -* Mettre la couche "Support" en édition et digitaliser un point pour ouvrir le formulaire. - -!!! info "Le formulaire est composé de trois onglets:" - - === "Général" - ![Onglet général](./assets/images/printscreen/support-form-general.png){loading=lazy} - - === "Azimut" - ![Onglet azimut](./assets/images/printscreen/support-form-azimut.png){loading=lazy} - - === "Photo" - ![Onglet azimut](./assets/images/printscreen/support-form-photo.png){loading=lazy} - -Dans l’onglet “Azimut”, les cadres et signaux peuvent y être saisis. L'attribut *Azimut* peut être rempli de manière graphique, grâce à la vue `vw_azimut_edit` du schéma `signalo_app`. - -
- !![Exemple](./assets/images/printscreen/support-all.png) -
Exemple d'un azimut avec plusieurs cadres et signaux
-
- -
- !![Azimut](./assets/images/printscreen/azimut-edit.png) -
Définition de l'azimut de manière graphique, grâce à la vue vw_azimut_edit
-
- -## Taille des panneaux - -La taille des panneaux peut être ajustée dans les propriétés du projet, dans l'onglet `Variables`, en modifiant la variable `signalo_img_size`. - -
- !![Réglage](./assets/images/printscreen/set-image-size.png) -
Réglage de la taille de l'image
-
- -## Décalage des panneaux - -En cas de supports portant de nombreux signaux, la visibilité des signaux sur la carte peut être améliorée avec les attributs `offset_x` et `offset_y` de la table `azimut` (attributs *décalage X* et *décalage Y* de la couche *Azimut* dans QGIS). - -## Panneaux spéciaux - -### Panneaux directionnels - -Le modèle des données permet une gestion fine des panneaux directionnels. Trois attributs définissent l'affichage de ces panneaux: - -* Dans la table `vl_official_sign` (couche *Signal officiel* dans le projet QGIS), l'attribut boolean `directional_sign` définit si un signal est un signal directionnel ou non. -* Dans la table `frame`, l'attribut `anchor` permet de définir le point d'ancrage du cadre: *Gauche*, *Centré* ou *Droite* (couche *Cadre* avec l'attribut *point d'ancrage* dans le projet QGIS). -* Dans la table `sign`, l'attribut boolean `natural_direction_or_left` permet de changer la direction naturelle du panneau par rapport à son point d'ancrage défini au niveau du cadre. Par défaut (la case est cochée), la direction du panneau sera à l'opposé de son point d'ancrage. C'est-à-dire, si le point d'ancrage est à droite, le panneau pointera à gauche et vice-versa. Cet automatisme peut être contourné en décochant la case *direction naturel ou gauche*. - -### Panneaux recto-verso - -Au niveau du signal, (table `sign`, couche *Signal* dans QGIS) l'attribut `hanging_mode` ou *mode d'accrochage* permet de définir si un panneaux porte le même signal des deux côtés. - -* *VERSO* -> le signal n'est affiché que d'un côté -* *RECTO-VERSO* -> le signal est affiché des deux côtés du panneau -* *RECTO* -> le signal n'est affiché que dans le dos du panneau. Cette valeur peut être choisi p.ex. quand le recto et le verso du panneau ne sont pas identiques. - -* A noter: la couche **cadre** contient également un attribut lié au recto-verso (case à cocher **montage recto-verso**). La valeur de cet attribut n'est néanmoins qu'informative, elle n'aura aucune influence sur l'affichage du panneau sur la carte.* - -### Signaux définis par l'utilisateur - -Il arrive qu'une certaine composition de signaux sur un même panneau n'existe pas dans la sélection des signaux officiels. La table `vl_user_sign` (couche *Signal défini par l'utilisateur* dans QGIS) permet la création de signaux personnalisés. Cette table contient les mêmes attributs que `vl_official_sign`, la liste des signaux officiels. Au minimum, les attributs suivants doivent être renseignés: - -* `id` - identifiant unique qui sera utilisé dans la liste déroulante dans QGIS -* `active` - à mettre sur *true*, autrement le signal n'apparaîtra pas dans la liste déroulante dans QGIS -* `value_fr`, ou `value_de` ou `value_it`, en fonction de la langue utilisateur - ce nom apparaîtra également dans la liste déroulante dans QGIS -* `img_fr` ou `img_de` ou `img_it`, en fonction de la langue de l'utilisateur. Cet attribut doit contenir le nom exact du fichier `.svg` du signal personnalisé -* `img_height` et `img_width` - deux valeurs qui contiennent la hauteur et la largeur de l'image `.svg` - -Les attributs suivants permettent en outre de créer et gérer des panneaux directionnels personnalisés: - -* `directional_sign` - à mettre sur true s'il s'agit d'un panneau directionnel -* `img_fr_right`, `img_de_right`, `img_it_right`, `img_ro_right`, qui contiendront le nom du fichier `.svg` avec direction à droite, par exemple *composite-r.svg*. Les attributs `img_fr`, `img_de` etc. contiendront alors le nom du fichier `.svg` avec direction à gauche, par exemple *composite-l.svg*. - -Afin d'accéder à la liste déroulante des signaux définis par l'utilisateur dans QGIS, le **type de signal** *défini par l'utilisateur* doit être choisi. - -
- !![Liste définie par l'utilisateur](./assets/images/printscreen/liste_defini_par_lutilisateur.png) -
Liste des types de signal
-
- -La création du `.svg` correspondant est donc dans la responsabilité de l'utilisateur. Le fichier d'image doit être enregistré dans les deux dossiers - -* project > images > user-defined > original : ceci est l'image non-dynamique qui sera aussi affichée dans le formulaire d'attributs -* project > images > user-defined > editable : ceci est l'image dynamique qui permet d'afficher des inscriptions - -Il est recommandé de prendre une des images officielles comme exemple et base pour créer un signal personnalisé, afin d'avoir une idée de la taille et pour comprendre comment configurer les inscriptions dynamiques. - -
- !![Projet QField](./assets/images/printscreen/folder_tree_images.png){ width="200"; loading=lazy; style="max-width: 900px"} -
Emplacement des fichiers `.svg` des signaux définis par l'utilisateur
-
- -## Environnements de travail - -Vous avez la possibilité d'avoir plusieurs environnements de travail: test, production, … -Plusieurs fichiers projets sont disponibles avec chaque version: - -| Fichier projet | nom du service PG | exemple d'utilisation | -| ------------- | ---------------------- | --------------------- | -| `signalo.qgs` | `pg_signalo` | demo | -| `signalo_prod.qgs` | `pg_signalo_prod` | production | -| `signalo_dev.qgs` | `pg_signalo_dev` | test et développement | - -## Langues - -Un système de traduction du projet QGIS a été mis en place. Les fichiers de traduction `signalo_XX.qm` doivent se situer dans le dossier du projet QGIS. Le projet `signalo.qgs` s'ouvre alors dans la langue du profil de l'utilisateur QGIS. Pour le moment, le projet existe en français (langue *master*) et en allemand (avec le fichier de traduction `signalo_de.qm`). Si la langue du logiciel est l'allemand, un fichier de projet `signalo_de.qgs` se créera alors automatiquement à l'ouverture du projet `signalo.qgs`. - -## Filtrage et analyse de la cohérence globale - -Cette fonctionnalité devrait être [améliorée](roadmap.md) dans les versions suivantes. - -Il est possible de filtrer l'affichage des panneaux au moyen de la couche "Vue filtrage". -Avec un clic-droit sur la couche, sélectionner "Filtrer…" dans le menu. -Il faut alors construire une requête pour filtrer les éléments. - -
- !![Projet QField](./assets/images/printscreen/filter.png) -
Filtrage des signaux
-
diff --git a/website/documentation/mobile.fr.md b/website/documentation/mobile.fr.md deleted file mode 100644 index e6b925b7..00000000 --- a/website/documentation/mobile.fr.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Mobile -tx_slug: documentation_mobile -hide: - - navigation - - toc ---- - - -* Utiliser le plugin “QFieldSync” pour créer un paquet projet pour QField -* Le dossier se compose d'un projet QGIS (qgs) et d'un fichier de base de données (gpkg) -* Ajouter le dossier “images” à ce dossier. Ceci permet d'avoir un rendu avec les images de la signalisation. -* Copier ce dossier sur votre appareil mobile à l'emplacement de votre choix -* Ouvrir QField ⇒ cliquer sur “Ouvrir un fichier local” -* Chercher le fichier qgs copié en local sur votre mobile - -!!! info "Édition sous QField" - - === "Général" -
- ![Projet QField](./assets/images/printscreen/qfield_signalo.jpg){ width="300" align="left"; loading=lazy } -
visualisation sous QField
-
- - === "Azimut" -
- ![Projet QField](./assets/images/printscreen/qfield_edit.jpg){ width="300" align="left"; loading=lazy } -
édition des supports
-
- - === "Signal" -
- ![Projet QField](./assets/images/printscreen/qfield_form.jpg){ width="300" align="left"; loading=lazy } -
édition du signal
-
- - -De retour au bureau, synchroniser le projet à l'aide de QFieldSync diff --git a/website/documentation/user-guide/adddata.fr.md b/website/documentation/user-guide/adddata.fr.md new file mode 100644 index 00000000..331c10e7 --- /dev/null +++ b/website/documentation/user-guide/adddata.fr.md @@ -0,0 +1,36 @@ +--- +title: Ajout de signaux +tx_slug: documentation_user-guide_adddata +--- + +# Ajout de signaux + +* Mettre la couche "Support" en édition et digitaliser un point pour ouvrir le formulaire. + +!!! info "Le formulaire est composé de quatre onglets:" + + === "Général" + ![Onglet général](../assets/images/printscreen/support-form-general.png){loading=lazy} + + === "Azimut" + ![Onglet azimut](../assets/images/printscreen/support-form-azimut.png){loading=lazy} + + === "Photo" + ![Onglet azimut](../assets/images/printscreen/support-form-photo.png){loading=lazy} + + === "Documents" + ![Onglet azimut](../assets/images/printscreen/support-form-documents.png){loading=lazy} + +Dans l’onglet “Azimut”, les cadres et signaux peuvent y être saisis. L'attribut *Azimut* peut être rempli de manière graphique, grâce à la vue `vw_azimut_edit` (couche Outil Azimut) du schéma `signalo_app`. + +
+ ![Exemple Azimut](../assets/images/printscreen/support-all.png) +
Exemple d'un azimut avec plusieurs cadres et signaux
+
+ +
+ ![Outil Azimut](../assets/images/printscreen/azimut-edit.png) +
Définition de l'azimut de manière graphique, grâce à l'Outil Azimut
+
+ +Dans l'onglet “Documents“, des fichiers de tout format peuvent être liés à un support à travers leur chemin de stockage. L'extension [Document Management System](https://plugins.qgis.org/plugins/document_management_system/) fournit une interface pour gérer les relations du système de gestion des documents des deux côtés (côté document et côté support). Elle prend en charge les relations 1-N et N-M. Les chemins vers les documents sont stockés dans la base de données dans la table `signalo_db.dms_document`. diff --git a/website/documentation/user-guide/advanced/add_values.fr.md b/website/documentation/user-guide/advanced/add_values.fr.md new file mode 100644 index 00000000..5e636fba --- /dev/null +++ b/website/documentation/user-guide/advanced/add_values.fr.md @@ -0,0 +1,16 @@ +--- +title: Ajout de valeurs dans les listes de valeurs +tx_slug: documentation_user-guide_advanced_add_values +--- + +# Ajouter une entrée dans une liste de valeurs + +Comme décrit dans le [modèle des données](https://www.signalo.ch/model-documentation), SIGNALO repose sur un certain nombre de listes de valeurs, intégrées comme listes déroulantes dans les formulaires des différents couches de données. + +Le contenu et la structure de ces listes de valeurs sont relativement fixes. Elles ne peuvent être modifiées que lors d'une mise à jour du modèle de données qui sera publiée avec une [release officielle](https://github.com/opengisch/signalo/releases). + +Si une utilisatrice ou un utilisateur souhaite ajouter une valeur dans une liste de valeurs, une demande peut être fait au groupe de pilotage SIGNALO via une issue sur [Github](https://github.com/opengisch/signalo/issues). +En cas d'une nouvelle valeur qui aurait une influence sur l'affichage des signaux sur la carte, p.ex. un nouveau type de support, une image `.svg` correspondant devrait être fourni avec. +Dans ce cas-là, le projet QGIS doit également être mis à jour. + +Il est fortement déconseillé de modifier les listes directement dans la base de données locale. A la sortie d'une nouvelle version du modèle de données SIGNALO, ces modifications locales seront écrasées et la mise à jour peut provoquer des conflits s'il y a eu utilisation de clés étrangères non-connues par la structure des données officielle. diff --git a/website/documentation/user-guide/advanced/coherence.fr.md b/website/documentation/user-guide/advanced/coherence.fr.md new file mode 100644 index 00000000..86b28a27 --- /dev/null +++ b/website/documentation/user-guide/advanced/coherence.fr.md @@ -0,0 +1,17 @@ +--- +title: Filtrage et cohérence +tx_slug: documentation_user-guide_advanced_coherence +--- + +# Filtrage et analyse de la cohérence globale + +Cette fonctionnalité devrait être [améliorée](../../roadmap.md) dans les versions suivantes. + +Il est possible de filtrer l'affichage des panneaux au moyen de la couche "Vue filtrage". +Avec un clic-droit sur la couche, sélectionner "Filtrer…" dans le menu. +Il faut alors construire une requête pour filtrer les éléments. + +
+ ![Filtrage des signaux](../../assets/images/printscreen/filter.png) +
Filtrage des signaux
+
diff --git a/website/documentation/user-guide/advanced/duplicateobject.fr.md b/website/documentation/user-guide/advanced/duplicateobject.fr.md new file mode 100644 index 00000000..91214d27 --- /dev/null +++ b/website/documentation/user-guide/advanced/duplicateobject.fr.md @@ -0,0 +1,14 @@ +--- +title: Duplication d'objets +tx_slug: documentation_user-guide_advanced_duplicateobject +--- + +# Duplication d'objets + +Afin de faciliter la création de plusieurs supports qui comportent des signaux similaires, il est possible de dupliquer un support avec tous ses enfants (azimuts, cadres, signaux). La clé primaire de l'objet dupliqué (et celles des enfants en relation) est créée fraîchement, les autres attributs sont repris de l'objet initial. + +* Mettre la couche "Support" en mode édition. +* Séléctionner dans la table d'attributs ou sur la carte le support à dupliquer. +* Click-droit sur l'objet sélectionné dans la table d'attribut et choisir "Dupliquer l'objet et numériser". +* De retour sur la carte: choisir l'emplacement de l'objet dupliqué. +* Enregistrer les modifications. \ No newline at end of file diff --git a/website/documentation/user-guide/advanced/export.fr.md b/website/documentation/user-guide/advanced/export.fr.md new file mode 100644 index 00000000..87887562 --- /dev/null +++ b/website/documentation/user-guide/advanced/export.fr.md @@ -0,0 +1,8 @@ +--- +title: Export de données +tx_slug: documentation_user-guide_advanced_export +--- + +# Export de données + +Vous avez la possibilité d'exporter les données aplaties ou de les intégrer dans un autre projet. La vue `signalo_app.vw_sign_export` contient toutes les données des signaux dans une hiérarchie aplatie, c'est-à-dire sans avoir besoin de tables relationnelles supplémentaires, en intégrant les valeurs des listes de valeur. Elle permet la visualisation des signaux dans un autre projet, en dehors de l'environnement SIGNALO. Les images en format `.svg` correspondantes doivent être livrées avec. diff --git a/website/documentation/user-guide/advanced/language.fr.md b/website/documentation/user-guide/advanced/language.fr.md new file mode 100644 index 00000000..0ae0e204 --- /dev/null +++ b/website/documentation/user-guide/advanced/language.fr.md @@ -0,0 +1,8 @@ +--- +title: Langues +tx_slug: documentation_user-guide_advanced_languages +--- + +# Langues + +Un système de traduction du projet QGIS a été mis en place. Les fichiers de traduction `signalo_XX.qm` doivent se situer dans le dossier du projet QGIS. Le projet `signalo.qgs` s'ouvre alors dans la langue du profil de l'utilisateur QGIS. Pour le moment, le projet existe en français (langue *master*) et en allemand (avec le fichier de traduction `signalo_de.qm`). Si la langue du logiciel est l'allemand, un fichier de projet `signalo_de.qgs` se créera alors automatiquement à l'ouverture du projet `signalo.qgs`. diff --git a/website/documentation/user-guide/advanced/offset.fr.md b/website/documentation/user-guide/advanced/offset.fr.md new file mode 100644 index 00000000..9eed3a5d --- /dev/null +++ b/website/documentation/user-guide/advanced/offset.fr.md @@ -0,0 +1,8 @@ +--- +title: Décalage des panneaux +tx_slug: documentation_user-guide_advanced_offset +--- + +# Décalage des panneaux + +En cas de supports portant de nombreux signaux, la visibilité des signaux sur la carte peut être améliorée avec les attributs `offset_x` et `offset_y` de la table `azimut` (attributs *décalage X* et *décalage Y* de la couche *Azimut* dans QGIS). diff --git a/website/documentation/user-guide/advanced/size.fr.md b/website/documentation/user-guide/advanced/size.fr.md new file mode 100644 index 00000000..612e007b --- /dev/null +++ b/website/documentation/user-guide/advanced/size.fr.md @@ -0,0 +1,13 @@ +--- +title: Taille des panneaux +tx_slug: documentation_user-guide_advanced_size +--- + +# Taille des panneaux + +La taille des panneaux peut être ajustée dans les propriétés du projet, dans l'onglet `Variables`, en modifiant la variable `signalo_img_size`. + +
+ ![Réglage](../../assets/images/printscreen/set-image-size.png) +
Réglage de la taille de l'image
+
diff --git a/website/documentation/user-guide/advanced/specialsigns.fr.md b/website/documentation/user-guide/advanced/specialsigns.fr.md new file mode 100644 index 00000000..f0193f0b --- /dev/null +++ b/website/documentation/user-guide/advanced/specialsigns.fr.md @@ -0,0 +1,63 @@ +--- +title: Panneaux spéciaux +tx_slug: documentation_user-guide_advanced_specialsigns +--- + +# Panneaux spéciaux + +## Panneaux directionnels + +Le modèle des données permet une gestion fine des panneaux directionnels. Trois attributs définissent l'affichage de ces panneaux: + +* Dans la table `vl_official_sign` (couche *Signal officiel* dans le projet QGIS), l'attribut boolean `directional_sign` définit si un signal est un signal directionnel ou non. +* Dans la table `frame`, l'attribut `anchor` permet de définir le point d'ancrage du cadre: *Gauche*, *Centré* ou *Droite* (couche *Cadre* avec l'attribut *point d'ancrage* dans le projet QGIS). +* Dans la table `sign`, l'attribut boolean `natural_direction_or_left` permet de changer la direction naturelle du panneau par rapport à son point d'ancrage défini au niveau du cadre. Par défaut (la case est cochée), la direction du panneau sera à l'opposé de son point d'ancrage. C'est-à-dire, si le point d'ancrage est à droite, le panneau pointera à gauche et vice-versa. Cet automatisme peut être contourné en décochant la case *direction naturel ou gauche*. + +## Panneaux recto-verso + +Au niveau du signal, (table `sign`, couche *Signal* dans QGIS) l'attribut `hanging_mode` ou *mode d'accrochage* permet de définir si un panneaux porte le même signal des deux côtés. + +* *VERSO* -> le signal n'est affiché que d'un côté +* *RECTO-VERSO* -> le signal est affiché des deux côtés du panneau +* *RECTO* -> le signal n'est affiché que dans le dos du panneau. Cette valeur peut être choisi p.ex. quand le recto et le verso du panneau ne sont pas identiques. + +* A noter: la couche **cadre** contient également un attribut lié au recto-verso (case à cocher **montage recto-verso**). La valeur de cet attribut n'est néanmoins qu'informative, elle n'aura aucune influence sur l'affichage du panneau sur la carte.* + +## Signaux définis par l'utilisateur + +Il arrive qu'une certaine composition de signaux sur un même panneau n'existe pas dans la sélection des signaux officiels. La table `vl_user_sign` (couche *Signal défini par l'utilisateur* dans QGIS) permet la création de signaux personnalisés. Cette table contient les mêmes attributs que `vl_official_sign`, la liste des signaux officiels. Au minimum, les attributs suivants doivent être renseignés: + +* `id` - identifiant unique qui sera utilisé dans la liste déroulante dans QGIS +* `active` - à mettre sur *true*, autrement le signal n'apparaîtra pas dans la liste déroulante dans QGIS +* `value_fr`, ou `value_de` ou `value_it`, en fonction de la langue utilisateur - ce nom apparaîtra également dans la liste déroulante dans QGIS +* `img_fr` ou `img_de` ou `img_it`, en fonction de la langue de l'utilisateur. Cet attribut doit contenir le nom exact du fichier `.svg` du signal personnalisé +* `img_height` et `img_width` - deux valeurs qui contiennent la hauteur et la largeur de l'image `.svg` + +Les attributs suivants permettent en outre de créer et gérer des panneaux directionnels personnalisés: + +* `directional_sign` - à mettre sur true s'il s'agit d'un panneau directionnel +* `img_fr_right`, `img_de_right`, `img_it_right`, `img_ro_right`, qui contiendront le nom du fichier `.svg` avec direction à droite, par exemple *composite-r.svg*. Les attributs `img_fr`, `img_de` etc. contiendront alors le nom du fichier `.svg` avec direction à gauche, par exemple *composite-l.svg*. + +L'attribut `no_dynamic_inscription` devrait contenir le nombre de textes dynamiques dans le `.svg` (ce qui équivaut au nombre de lignes). Cette information doit être renseignée manuellement. + +Afin d'accéder à la liste déroulante des signaux définis par l'utilisateur dans QGIS, le **type de signal** *défini par l'utilisateur* doit être choisi. + +
+ ![Liste définie par l'utilisateur](../../assets/images/printscreen/liste_defini_par_lutilisateur.png) +
Liste des types de signal
+
+ +La création du `.svg` correspondant est donc dans la responsabilité de l'utilisateur. Le fichier d'image doit être enregistré dans les deux dossiers + +* `project/images/user-defined/original` : ceci est l'image non-dynamique qui sera aussi affichée dans le formulaire d'attributs. Cette image doit contenir un text static d'exemple. +* `project/images/user-defined/editable` : ceci est l'image dynamique qui permet d'afficher des inscriptions + +> A noter: Il est recommandé de reprendre un des fichiers d'images officielles (`project/images/official/original` et `/éditable`) **comme exemple et base** pour créer un signal personnalisé, afin d'avoir une idée de la taille et pour comprendre comment configurer les inscriptions dynamiques. + +Si le signal personnalisé ne doit pas contenir d'inscription dynamique, les fichiers dans les dossiers `user-defined/original` et `user-defined/editable` peuvent être les mêmes. + +
+ ![Stockage fichiers personnalisés](../../assets/images/printscreen/folder_tree_images.png){width="200"; loading=lazy; style="max-width: 900px"} +
Emplacement des fichiers `.svg` des signaux définis par l'utilisateur
+
+ diff --git a/website/documentation/user-guide/advanced/workenvironment.fr.md b/website/documentation/user-guide/advanced/workenvironment.fr.md new file mode 100644 index 00000000..5d51c3ee --- /dev/null +++ b/website/documentation/user-guide/advanced/workenvironment.fr.md @@ -0,0 +1,15 @@ +--- +title: Environnements de travail +tx_slug: documentation_user-guide_advanced_workenvironment +--- + +# Environnements de travail + +Vous avez la possibilité d'avoir plusieurs environnements de travail: test, production, … +Plusieurs fichiers projets sont disponibles avec chaque version: + +| Fichier projet | nom du service PG | exemple d'utilisation | +| ------------- | ---------------------- | --------------------- | +| `signalo.qgs` | `pg_signalo` | demo | +| `signalo_prod.qgs` | `pg_signalo_prod` | production | +| `signalo_dev.qgs` | `pg_signalo_dev` | test et développement | diff --git a/website/documentation/data-model.fr.md b/website/documentation/user-guide/concepts.fr.md similarity index 88% rename from website/documentation/data-model.fr.md rename to website/documentation/user-guide/concepts.fr.md index 89a2d3a0..026b9c32 100644 --- a/website/documentation/data-model.fr.md +++ b/website/documentation/user-guide/concepts.fr.md @@ -1,12 +1,9 @@ --- -title: Data Model -tx_slug: documentation_data-model -hide: - - navigation - - toc +title: Concepts +tx_slug: documentation_user-guide_concepts --- -## Structure +# Structure On distingue 4 classes principales dans le modèle de données: -![Classes](./assets/images/signalo_classes.png#only-light) -![Classes](./assets/images/signalo_classes_dark.png#only-dark) +![Classes](../assets/images/signalo_classes.png#only-light) +![Classes](../assets/images/signalo_classes_dark.png#only-dark) Un support peut présenter des objets selon plusieurs azimuts, chacun pouvant présenter plusieurs cadres, chacun pouvant supporter plusieurs signaux. @@ -30,11 +27,11 @@ Ces tables, ansi que les tables de listes de valeurs, sont regroupé dans un sch Il existe par ailleurs un second schéma, `signalo_app` offrant quant à lui la vue permettant l'affichage des signaux sur la carte. Celle-ci regroupe les données des quatres tables principales dans une hierarchie aplatie et est générée de manière à ce que l'ordre des panneaux, cadres et azimuts est respecté. -## Documentation +# Documentation La description complète du modèle de données se trouve [ici](https://www.signalo.ch/model-documentation). -## Mise à jour du modèles de données +# Mise à jour du modèles de données La structure des données peut évoluer d'une release à une autre. Si votre base de données est déjà en place, les mises à jour peuvent facilement être faites grâce à des fichiers de migration `sql`. Ainsi, la structure est actualisée sans modification des données existantes. diff --git a/website/documentation/datamodel-doc.fr.md b/website/documentation/user-guide/datamodel-doc.fr.md similarity index 72% rename from website/documentation/datamodel-doc.fr.md rename to website/documentation/user-guide/datamodel-doc.fr.md index 60522678..4ce1bd89 100644 --- a/website/documentation/datamodel-doc.fr.md +++ b/website/documentation/user-guide/datamodel-doc.fr.md @@ -1,9 +1,6 @@ --- title: Data Model -tx_slug: documentation_datamodel-doc -hide: - - navigation - - toc +tx_slug: documentation_user-guide_datamodel-doc ---
diff --git a/website/documentation/installation.fr.md b/website/documentation/user-guide/installation.fr.md similarity index 83% rename from website/documentation/installation.fr.md rename to website/documentation/user-guide/installation.fr.md index 6bc3cfa8..afd7ea5c 100644 --- a/website/documentation/installation.fr.md +++ b/website/documentation/user-guide/installation.fr.md @@ -1,25 +1,24 @@ --- title: Installation -tx_slug: documentation_installation -hide: - - navigation - - toc +tx_slug: documentation_user-guide_installation --- -### Prérequis +# Installation + +## Prérequis * QGIS version LTR ou plus récente * Un serveur Postgresql version 10 ou plus récente -### Téléchargement +## Téléchargement 1. Pour installer signalo, trouvez la [dernière version](https://github.com/opengisch/signalo/releases/latest) et téléchargez * le fichier `project.zip` contenant le projet QGIS nécessaire à la visualisation des données. * le dump du modèle de données (avec ou sans données démo) -### Modèle de données +## Modèle de données 2. Créez un [service postgresl](https://www.postgresql.org/docs/current/libpq-pgservice.html) `pg_signalo` avec les informations de connexion. @@ -29,10 +28,11 @@ hide: `PGSERVICE=pg_signalo psql -v ON_ERROR_STOP=1 -f _chemin_vers_le_fichier_sql` -### Desktop +## Extensions 4. Dans QGIS, installez les plugins suivants: * [Ordered Relation Editor](https://plugins.qgis.org/plugins/ordered_relation_editor/) * [QFieldSync](https://plugins.qgis.org/plugins/qfieldsync/) (version min 4.0) + * [Document Management System](https://plugins.qgis.org/plugins/document_management_system/) 5. Ouvrez le projet QGIS du dossier extrait. diff --git a/website/documentation/user-guide/mobile.fr.md b/website/documentation/user-guide/mobile.fr.md new file mode 100644 index 00000000..ce188606 --- /dev/null +++ b/website/documentation/user-guide/mobile.fr.md @@ -0,0 +1,30 @@ +--- +title: Mobile +tx_slug: documentation_user-guide_mobile +--- + +Pour le travail de terrain, l'application mobile [**QField**](https://qfield.org/) et l'extension pour QGIS [**QFieldSync**](https://plugins.qgis.org/plugins/qfieldsync/) sont utilisées. + +Nous renvoyons ici vers la [documentation de QField](https://docs.qfield.org/get-started/) pour les étapes de préparation du projet de terrain. + +!!! info "Édition sous QField" + + === "Général" +
+ ![visualisation QField](../assets/images/printscreen/qfield_signalo.jpg){ width="300" align="left"; loading=lazy } +
visualisation sous QField
+
+ + === "Azimut" +
+ ![Edition supports](../assets/images/printscreen/qfield_edit.jpg){ width="300" align="left"; loading=lazy } +
édition des supports
+
+ + === "Signal" +
+ ![Edition signal](../assets/images/printscreen/qfield_form.jpg){ width="300" align="left"; loading=lazy } +
édition du signal
+
+ +> A noter : L'affichage des signaux sur la carte dépend d'une vue dans la base de données. Comme le travail de terrain est effectué hors ligne avec une copie locale des données, la couche dont dépend la symbologie n'est pas mise à jour sur le terrain. L'affichage des signaux nouveaux ou édités sur la carte ne fonctionne donc pas dans QField. diff --git a/website/documentation/user-guide/updates.fr.md b/website/documentation/user-guide/updates.fr.md new file mode 100644 index 00000000..b58a82bc --- /dev/null +++ b/website/documentation/user-guide/updates.fr.md @@ -0,0 +1,15 @@ +--- +title: Mises à jour +tx_slug: documentation_user-guide_updates +--- + + +# Mise à jour du modèles de données + +La structure des données peut évoluer d'une release à une autre. Si votre base de données est déjà en place, les mises à jour peuvent facilement être faites grâce à des fichiers de migration `sql`. Ainsi, la structure est actualisée sans modification des données existantes. + +1. Avant de procéder à la mise à jour, faire un backup de la base de données +2. Télécharger les changelogs et le fichier application (`signalo-1.X.Y-db-app.sql`) sur la page de la [release](https://github.com/opengisch/signalo/releases/latest) +3. Supprimer l'application: `psql -c "DROP SCHEMA signalo_app CASCADE"` +4. Lancer les différents scripts SQL de migration: `psql -v ON_ERROR_STOP=1 -v SRID=2056 -f datamodel/changelogs/XXXX/XXXX_zzzzzz.sql` (pour chaque fichier) +5. Recréer l'application avec le ficher SQL de la release: `psql -v ON_ERROR_STOP=1 -f signalo-1.X.Y-db-app.sql` diff --git a/website/mkdocs.yml b/website/mkdocs.yml index 75e9e708..d9188d93 100644 --- a/website/mkdocs.yml +++ b/website/mkdocs.yml @@ -20,7 +20,9 @@ theme: features: - navigation.tabs - navigation.tabs.sticky - - navigation.sections + - navigation.expand + - navigation.indexes + - navigation.top - navigation.tracking - search.suggest - search.highlight @@ -51,12 +53,25 @@ theme: nav: - Présentation: index.md - Participer: contribute.md - - Installation: installation.md - - Modèle de données: data-model.md - - Desktop: desktop.md - - Mobile: mobile.md + - Mode d'emploi: + - user-guide/installation.md + - user-guide/concepts.md + - user-guide/adddata.md + - Configuration avancée: + - user-guide/advanced/size.md + - user-guide/advanced/offset.md + - user-guide/advanced/specialsigns.md + - user-guide/advanced/add_values.md + - user-guide/advanced/duplicateobject.md + - user-guide/advanced/workenvironment.md + - user-guide/advanced/language.md + - user-guide/advanced/coherence.md + - user-guide/advanced/export.md + - Mobile: user-guide/mobile.md + - Mises à jour: user-guide/updates.md + - Documentation BD: /model-documentation/ - Feuille de route: roadmap.md - - Documentation BD: /model-documentation/ + # Css extra_css: @@ -82,6 +97,8 @@ markdown_extensions: - pymdownx.tabbed: alternate_style: true - pymdownx.superfences + - toc: + permalink: true plugins: - search @@ -99,12 +116,12 @@ plugins: nav_translations: Présentation: Präsentation Participer: Mitmachen - Installation: Installation - Modèle de données: Datenmodelle - Desktop: Desktop + Mode d'emploi: Mode d'emploi + Configuration avancée: Configuration avancée Mobile: Mobil - Feuille de route: Roadmap + Mises à jour: Mises à jour Documentation BD: DB Dokumentation + Feuille de route: Roadmap palette: # Palette toggle for automatic mode - media: "(prefers-color-scheme)"