Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
amandine-sahl authored Sep 11, 2019
1 parent fd7abeb commit ae92402
Showing 1 changed file with 46 additions and 51 deletions.
97 changes: 46 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,62 +8,18 @@ Extension python permettant de générer un composer de carte à partir de templ

Versions Qgis
-------------------
Plugin testé avec Qgis 2.6, 2.8, 2.14
Plugin testé avec Qgis 3.4

Configuration
-------------------

Les paramètres du plugins sont contenus dans le fichier preferences.xml (répertoire resources).
Ils permettent de spécifier :
- La liste des échelles possibles pour la carte

````XML
<scales>
<scale>2000</scale>
..
<scale>300000</scale>
<scale>500000</scale>
<scale>1000000</scale>
</scales>
````
- La liste des templates accessibles à l'utilisateur.
Fonctionnement du plugin
-------------------------
Le plugin récupère les templates contenus dans le dossier `composer_templates` du profil de l'utilisateur. Puis se base sur les identifiant des blocks des templates pour remplir les informations contenues dans le formulaire.

````XML
<templates>
<template id="nom_du_fichier.qpt">Nom à afficher</template>
....
</templates>
````
- La liste des checkboxs permettant d'ajouter des copyrights prédéfinis

````XML
<copyrights>
<copyright>© IGN SCAN25 2012</copyright>
...
</copyrights>
````
- Un texte s'affichant par défaut dans la source (en plus du nom du projet et de la date de création de la carte)

````XML
<editions>
<edition>I love Maps</edition>
</editions>
````
- Le nom du fichier logo à afficher

````XML
<logos>
<logo>logo_pnc_orange.tif</logo>
</logos>
````
- Un paramètre permettant de spécifier si la légende des fichiers raster doit ou non figurer sur la carte

````XML
<params>
<hide_raster>true</hide_raster>
</params>
````

Un ensemble de templates et icone sont initialement présentes dans le répertoire profile. Ce répertoire est copié lors de l'installation du plugin dans le profil de l'utilisateur dans les répertoires standards de Qgis:
* composer_templates
* svg


Création de template
Expand All @@ -78,3 +34,42 @@ Pour que le plugin fonctionne correctement les templates doivent respecter des c
- Source = sources-copyright
- Numéro de la carte = num-map

Une fois un template créé, il faut l'enregistrer dans le dossier `composer_templates` du profil de l'utilisateur.
Pour rajouter des icones, il est également conseillé de les placer dans le répertoire `svg` du profil de l'utilisateur

Configuration
-------------------
Les paramètres du plugins sont contenus dans le fichier preferences.json (répertoire resources).
Ils permettent de spécifier :
- La liste des échelles possibles pour la carte

````json
"scales": [
100,
250,
500,
1000,
2000,
5000,
10000,
25000,
50000,
100000,
200000,
300000,
500000,
1000000
],
````
- La liste des checkboxs permettant d'ajouter des copyrights prédéfinis

````json
"copyrights": [
"IGN SCAN25®",
"IGN BD ORTHO®",
"IGN BD ORTHO®",
"© OpenStreetMap contributors"
]

````

0 comments on commit ae92402

Please sign in to comment.