Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Unknown committed Sep 17, 2024
0 parents commit 63c9f40
Show file tree
Hide file tree
Showing 64 changed files with 17,650 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 0a9b554389ca26a291d91f2badfd2960
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added .doctrees/development.doctree
Binary file not shown.
Binary file added .doctrees/environment.pickle
Binary file not shown.
Binary file added .doctrees/history.doctree
Binary file not shown.
Binary file added .doctrees/index.doctree
Binary file not shown.
Empty file added .nojekyll
Empty file.
Binary file added _images/add_all_option_en.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/add_all_option_fr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/add_group_option_en.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/add_group_option_fr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/config_window_access_en.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/config_window_access_fr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/config_window_en.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/config_window_fr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/drop_down_menu_en.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/drop_down_menu_fr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/mapping.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions _sources/development.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Development

## Staging (_recette_)

### Project through HTTP

Use the project from the repository: <https://github.com/xcaeag/MenuFromProject-Qgis-Plugin/raw/master/test/projets/aeag-tiny.qgz>
2 changes: 2 additions & 0 deletions _sources/history.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
```{include} ../CHANGELOG.md
```
152 changes: 152 additions & 0 deletions _sources/index.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
# {{ title }} - Documentation

> **Author and contributors:** {{ author }}
>
> **Version:** {{ version }}
>
> **Source code:** {{ repo_url }}

## Table of Contents

- [English version](#english-version)

- [How to use it ?](#how-to-use-it)
- [1. Set up a classical qgis project somewhere](#set-up-a-classical-qgis-project-somewhere)
- [2. Configure the plugin to read those projects](#configure-the-plugin-to-read-those-projects)

- [En Français](#en-francais)
- [Comment l'utiliser ?](#comment-lutiliser)
- [1. Construire un beau projet](#construire-de-beaux-projets)
- [2. Configurer le plugin](#configurer-le-plugin)

```{toctree}
---
maxdepth: 1
caption: Others
---
history.md
On QGIS Plugins repository <https://plugins.qgis.org/plugins/menu_from_project/>
```

## English version

That plugin provides a convenient way to add prestyled and preconfigured frequently used layers using dropdown menus built by simply reading existing QGIS projects (qgs, qgz, postgres, http)

Styling, actions, labeling, metadata, joined layers and relations are reused as defined in source projects

![dropdown menu en](static/drop_down_menu_en.png)

### How to use it ?

When the plugin is configured (choice of a project via the plugin menu), a new menu appears, based on all the layers that contain the original project.

#### 1. Set up a classical qgis project somewhere

Save a project somewhere with some styling, labeling, and so on.

The project might be stored in a PostgreSQL database, or on a web server, which makes it accessible via http. [(see feature-saving-and-loading-projects-in-postgresql-database)](https://qgis.org/en/site/forusers/visualchangelog32/index.html#feature-saving-and-loading-projects-in-postgresql-database). You need to copy/paste the project URI (Project properties -> General) into the field.

...and QGZ [(see feature-new-zipped-project-file-format-qgz)](https://qgis.org/en/site/forusers/visualchangelog30/index.html#feature-new-zipped-project-file-format-qgz).

If you want some hierarchical menu, just use groups and sub groups in layer's panel, they will be reused to build the same hierarchical menu.

```{tip}
Create an empty group named "-" to build a separator line in dropdown menu
```

```{note}
If you want users to access that project, save it to a shared network place, better read only fo users except for the project administrator. Using a version control system could be a very good idea here.
```

![dropdown menu en](static/mapping.png)

#### 2. Configure the plugin to read those projects

- Go to menu / Plugins / Layer menu from project :

![Open plugin configuration window](static/config_window_access_en.png)

![configuration window](static/config_window_en.png)

- Press "+" button to add a .qgs, .qgz project to the list (or paste a pg URI, a http URL).
You can change the alias that will be the menu name in QGIS

The name will become the title of the menu.

The menu can be placed either in the main menu bar, or in the "layer / add layer" sub-menu, or (since version 1.1) to be merged with the previous project in the same menu.

Following options are available:

- _Show title and abstract in tooltip_ : this is a convenient way to show some metadata to end users before they add it o the working session even if they don't know that metadata are available in layer properties

- _Load all layers item_: adds an entry at the end of every menu's node that allow user to load all menu items at once. Very useful when you want to load all topo maps for every zoom level for instance.

![](static/add_all_option_en.png)

![](static/add_group_option_en.png)

- _Create Group_ : Layer will be added inside a group, taking the name of the menu node.

- _Also load linked layers._ : if relations or joins are defined, the opening of a layer will be accompanied by the opening of the associated child layers.

You can hide the administration dialog of the plugin by adding a `menu_from_project/is_setup_visible` to `false` in the QGIS INI file. This is useful when you deploy QGIS within an organization.

---

## En Français

Cette extension pour QGIS permet de construire automatiquement des menus déroulants permettant d'ajouter des couches pré-stylées définies dans des projets QGIS externes "modèles" (qgs, qgz, postgres, web).

Tous les paramètrages des couches, le style, les étiquettes, les actions, les métadonnées, les jointures et relations sont conservées. La maintenance se résume à la gestion de quelques projets QGIS centralisés.

![dropdown menu en](static/drop_down_menu_fr.png)

### Comment l'utiliser ?

Lorsque le plugin est configuré (choix des projets et attribution d'un nom associé via le menu Extensions - Layers menu from projects), de nouveaux menus apparaissent, pour chacun des projets sélectionnés. Chaque item de menu correspond alors à une couche du projet et déclenche son ouverture.

#### 1. Construire de beaux projets

Sauver vos projets sur un espace partagé (réseau, web, postgres) avec leurs styles, leurs étiquettes... une arborescence de groupes à l'image du futur menu.

```{tip}
Créer un groupe vide nommé "-" pour placer un séparateur à cet endroit dans le futur menu.
```

Les projets peuvent être sauvés au format qgz, dans une base PostgreSQL [(cf. feature-saving-and-loading-projects-in-postgresql-database)](https://qgis.org/en/site/forusers/visualchangelog32/index.html#feature-saving-and-loading-projects-in-postgresql-database) ou déposée en tant que ressource web.

```{note}
Le projet placé dans un espace partagé du réseau, sous postgres ou un serveur web permettra à différents utilisateurs d'exploiter les mêmes ressources (à condition bien sûr que celles-ci soit accessible).
```

![dropdown menu en](static/mapping.png)

#### 2. Configurer le plugin

- menu / Extension / Layer menu from project :

![Open plugin configuration window](static/config_window_access_fr.png)

![configuration window](static/config_window_fr.png)

- Bouton ajouter un projet ("+"), puis "éditer" pour ajouter un projet .qgs, .qgz à la liste, ou coller l'URI d'un projet PostgreSQL, coller l'URL d'un projet distant. ex : https://adour-garonne.eaufrance.fr/upload/DATA/SIG/aeag-web.qgz

Le nom (modifiable), deviendra le titre du menu.

Le menu pourra être placé soit dans la barre de menu principale, soit dans le sous-menu "couche / ajouter une couche", ou encore (depuis la version 1.1) d'être fusionné avec le projet précédent dans un même menu.

Quelques options :

- L'option du plugin _option de menu 'tout ajouter'_, si elle est cochée permet de charger l'ensemble des couches d'un même niveau de sous-menu

![](static/add_all_option_fr.png)

![](static/add_group_option_fr.png)

- L'option _Créer un groupe au chargement de la couche_ place la nouvelle couche sous un groupe portant le nom du menu

- _Ouvrir aussi les couches liées_ : si des relations ou jointures sont définies, l'ouverture d'une couche s'accompagnera de l'ouverture des couches filles associées.

- _Afficher titre et résumé_... assez parlant.

Vous pouvez cacher la fenêtre d'administration du plugin en ajoutant une variable `menu_from_project/is_setup_visible` à `false` dans le fichier INI de QGIS. Ceci est utile quand QGIS est déployé au sein d'une organisation.
Binary file added _static/add_all_option_en.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _static/add_all_option_fr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _static/add_group_option_en.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _static/add_group_option_fr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 63c9f40

Please sign in to comment.