Skip to content

Commit

Permalink
Doc: update with new algo
Browse files Browse the repository at this point in the history
  • Loading branch information
@pdrillin
pdrillin committed Sep 22, 2020
1 parent 79937f0 commit 7f5f07c
Show file tree
Hide file tree
Showing 6 changed files with 123 additions and 6 deletions.
1 change: 1 addition & 0 deletions Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,4 @@ github-pages:

processing-doc:
cd .docker && ./processing_doc.sh
@docker run --rm -w /plugin -v $(shell pwd):/plugin 3liz/pymarkdown:latest docs/processing/README.md docs/processing/index.html
25 changes: 25 additions & 0 deletions docs/processing/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,31 @@ OUTPUT_STRING|Output message|String||
## Données


### Mise en place des données pour certificat de numérotation

Ajout des données parcellaire et création des vues pour les certificats de numérotation.

![algo_id](./gestion_adresse-data_parcelle.png)

#### Parameters

| ID | Description | Type | Info | Required | Advanced |
|:-:|:-:|:-:|:-:|:-:|:-:|
DATABASE|Connexion à la base de données|String||✓||
SCHEMA|Schéma du cadastre contenant les données des parcelles est propriétaires|String||||


#### Outputs

| ID | Description | Type | Info |
|:-:|:-:|:-:|:-:|
OUTPUT|Couches de sortie|MultipleLayers||
OUTPUT MSG|Message de sortie|String||


***


### Chargement des couches depuis la base

Charger toutes les couches de la base de données.
Expand Down
Binary file added docs/processing/gestion_adresse-data_parcelle.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
77 changes: 71 additions & 6 deletions docs/processing/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,21 @@ <h1>Gestion des adresses</h1>
</ul>
</li>
<li><a href="#donnees">Données</a><ul>
<li><a href="#chargement-des-couches-depuis-la-base">Chargement des couches depuis la base</a><ul>
<li><a href="#mise-en-place-des-donnees-pour-certificat-de-numerotation">Mise en place des données pour certificat de numérotation</a><ul>
<li><a href="#parameters_3">Parameters</a></li>
<li><a href="#outputs_3">Outputs</a></li>
</ul>
</li>
<li><a href="#chargement-des-styles-depuis-le-dossier-resources">Chargement des styles depuis le dossier resources</a><ul>
<li><a href="#chargement-des-couches-depuis-la-base">Chargement des couches depuis la base</a><ul>
<li><a href="#parameters_4">Parameters</a></li>
<li><a href="#outputs_4">Outputs</a></li>
</ul>
</li>
<li><a href="#chargement-des-styles-depuis-le-dossier-resources">Chargement des styles depuis le dossier resources</a><ul>
<li><a href="#parameters_5">Parameters</a></li>
<li><a href="#outputs_5">Outputs</a></li>
</ul>
</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -240,10 +245,70 @@ <h4 id="outputs_2">Outputs</h4>
</table>
<hr>
<h2 id="donnees">Données</h2>
<h3 id="mise-en-place-des-donnees-pour-certificat-de-numerotation">Mise en place des données pour certificat de numérotation</h3>
<p>Ajout des données parcellaire et création des vues pour les certificats de numérotation.</p>
<p><img alt="algo_id" src="./gestion_adresse-data_parcelle.png"></p>
<h4 id="parameters_3">Parameters</h4>
<table>
<thead>
<tr>
<th align="center">ID</th>
<th align="center">Description</th>
<th align="center">Type</th>
<th align="center">Info</th>
<th align="center">Required</th>
<th align="center">Advanced</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">DATABASE</td>
<td align="center">Connexion à la base de données</td>
<td align="center">String</td>
<td align="center"></td>
<td align="center">✓</td>
<td align="center"></td>
</tr>
<tr>
<td align="center">SCHEMA</td>
<td align="center">Schéma du cadastre contenant les données des parcelles est propriétaires</td>
<td align="center">String</td>
<td align="center"></td>
<td align="center"></td>
<td align="center"></td>
</tr>
</tbody>
</table>
<h4 id="outputs_3">Outputs</h4>
<table>
<thead>
<tr>
<th align="center">ID</th>
<th align="center">Description</th>
<th align="center">Type</th>
<th align="center">Info</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">OUTPUT</td>
<td align="center">Couches de sortie</td>
<td align="center">MultipleLayers</td>
<td align="center"></td>
</tr>
<tr>
<td align="center">OUTPUT MSG</td>
<td align="center">Message de sortie</td>
<td align="center">String</td>
<td align="center"></td>
</tr>
</tbody>
</table>
<hr>
<h3 id="chargement-des-couches-depuis-la-base">Chargement des couches depuis la base</h3>
<p>Charger toutes les couches de la base de données.</p>
<p><img alt="algo_id" src="./gestion_adresse-load_layers.png"></p>
<h4 id="parameters_3">Parameters</h4>
<h4 id="parameters_4">Parameters</h4>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -274,7 +339,7 @@ <h4 id="parameters_3">Parameters</h4>
</tr>
</tbody>
</table>
<h4 id="outputs_3">Outputs</h4>
<h4 id="outputs_4">Outputs</h4>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -303,7 +368,7 @@ <h4 id="outputs_3">Outputs</h4>
<h3 id="chargement-des-styles-depuis-le-dossier-resources">Chargement des styles depuis le dossier resources</h3>
<p>Charger les styles pour les différentes couches.</p>
<p><img alt="algo_id" src="./gestion_adresse-load_styles.png"></p>
<h4 id="parameters_4">Parameters</h4>
<h4 id="parameters_5">Parameters</h4>
<table>
<thead>
<tr>
Expand All @@ -326,7 +391,7 @@ <h4 id="parameters_4">Parameters</h4>
</tr>
</tbody>
</table>
<h4 id="outputs_4">Outputs</h4>
<h4 id="outputs_5">Outputs</h4>
<table>
<thead>
<tr>
Expand Down
14 changes: 14 additions & 0 deletions docs/user_guide/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,20 @@ croix de couleur verte.

![lizmap_edit](./lizmap_edit.png)

### Fonctionnalité des certificats de numérotation

Pour ajouter cette fonctionnalité il suffit d'utiliser l'algorithme
**Mise en place des données pour certificat de numérotation**. Il dispose de 2 paramètres:

* La connexion à la base de données
* Le schéma de données où sont les données du cadastre

![algo_certif_num](../processing/gestion_adresse-data_parcelle.png)

Une fois utilisé, de nouvelles couches apparaîtrons dans le projet. Il restera donc à enregistrer le projet
puis ouvrir le plugin Lizmap et cliquer sur le bouton appliquer pour comptabiliser les couches dans la
config Lizmap.

___

Voilà maintenant il ne vous reste qu'à configurer votre un projet dans Lizmap web client. Vous pouvez vous
Expand Down
12 changes: 12 additions & 0 deletions docs/user_guide/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ <h1>Gestion des adresses</h1>
<li><a href="#configurer-les-variables-de-projet">Configurer les variables de projet</a></li>
<li><a href="#configuration-des-proprietes-du-projet">Configuration des propriétés du projet</a></li>
<li><a href="#configuration-pour-lizmap">Configuration pour Lizmap</a></li>
<li><a href="#fonctionnalite-des-certificats-de-numerotation">Fonctionnalité des certificats de numérotation</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -99,6 +100,17 @@ <h3 id="configuration-pour-lizmap">Configuration pour Lizmap</h3>
et <code>document</code>. Pour pouvoir ajouter une couche à l'édition il suffit de cliquer sur le bouton représentant une
croix de couleur verte.</p>
<p><img alt="lizmap_edit" src="./lizmap_edit.png"></p>
<h3 id="fonctionnalite-des-certificats-de-numerotation">Fonctionnalité des certificats de numérotation</h3>
<p>Pour ajouter cette fonctionnalité il suffit d'utiliser l'algorithme
<strong>Mise en place des données pour certificat de numérotation</strong>. Il dispose de 2 paramètres:</p>
<ul>
<li>La connexion à la base de données</li>
<li>Le schéma de données où sont les données du cadastre</li>
</ul>
<p><img alt="algo_certif_num" src="../processing/gestion_adresse-data_parcelle.png"></p>
<p>Une fois utilisé, de nouvelles couches apparaîtrons dans le projet. Il restera donc à enregistrer le projet
puis ouvrir le plugin Lizmap et cliquer sur le bouton appliquer pour comptabiliser les couches dans la
config Lizmap.</p>
<hr>
<p>Voilà maintenant il ne vous reste qu'à configurer votre un projet dans Lizmap web client. Vous pouvez vous
aider de la <a href="https://docs.lizmap.com/next/fr/publish/lizmap_configuration.html">Documentation</a> de Lizmap.</p>
Expand Down

0 comments on commit 7f5f07c

Please sign in to comment.