Skip to content

Commit

Permalink
Update Documentation (#238)
Browse files Browse the repository at this point in the history
* first changes website

* website doc restructuring

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update mkdocs.yml translation

* include documents tab in documentation

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* add doc about data export

* correct docu paths

* correct img captions in docs

* nav translations

* correct nav translation

* enable toc + nav

* docs improvements

* Update mkdocs translations (#234)

* Update mkdocs.yml translation

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* typo

* complet user sign docu

* duplicate objects in docu

---------

Co-authored-by: Isabel Kiefer <its.akifa@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
5 people authored Jun 7, 2024
1 parent a957797 commit e2cc5d3
Show file tree
Hide file tree
Showing 19 changed files with 286 additions and 200 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
130 changes: 0 additions & 130 deletions website/documentation/desktop.fr.md

This file was deleted.

38 changes: 0 additions & 38 deletions website/documentation/mobile.fr.md

This file was deleted.

36 changes: 36 additions & 0 deletions website/documentation/user-guide/adddata.fr.md
Original file line number Diff line number Diff line change
@@ -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`.

<figure markdown>
![Exemple Azimut](../assets/images/printscreen/support-all.png)
<figcaption>Exemple d'un azimut avec plusieurs cadres et signaux</figcaption>
</figure>

<figure markdown>
![Outil Azimut](../assets/images/printscreen/azimut-edit.png)
<figcaption>Définition de l'azimut de manière graphique, grâce à l'Outil Azimut</figcaption>
</figure>

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`.
16 changes: 16 additions & 0 deletions website/documentation/user-guide/advanced/add_values.fr.md
Original file line number Diff line number Diff line change
@@ -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.
17 changes: 17 additions & 0 deletions website/documentation/user-guide/advanced/coherence.fr.md
Original file line number Diff line number Diff line change
@@ -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.

<figure markdown>
![Filtrage des signaux](../../assets/images/printscreen/filter.png)
<figcaption>Filtrage des signaux</figcaption>
</figure>
14 changes: 14 additions & 0 deletions website/documentation/user-guide/advanced/duplicateobject.fr.md
Original file line number Diff line number Diff line change
@@ -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.
8 changes: 8 additions & 0 deletions website/documentation/user-guide/advanced/export.fr.md
Original file line number Diff line number Diff line change
@@ -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.
8 changes: 8 additions & 0 deletions website/documentation/user-guide/advanced/language.fr.md
Original file line number Diff line number Diff line change
@@ -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`.
8 changes: 8 additions & 0 deletions website/documentation/user-guide/advanced/offset.fr.md
Original file line number Diff line number Diff line change
@@ -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).
13 changes: 13 additions & 0 deletions website/documentation/user-guide/advanced/size.fr.md
Original file line number Diff line number Diff line change
@@ -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`.

<figure markdown>
![Réglage](../../assets/images/printscreen/set-image-size.png)
<figcaption>Réglage de la taille de l'image</figcaption>
</figure>
Loading

0 comments on commit e2cc5d3

Please sign in to comment.