diff --git a/doc/source/administrator/impressions.md b/doc/source/administrator/impressions.md new file mode 100644 index 0000000000000000000000000000000000000000..381aeac57ff7735cf12716b49eb13f28612d0b6e --- /dev/null +++ b/doc/source/administrator/impressions.md @@ -0,0 +1,115 @@ +# Impressions + +Le mode "Impressions" est une composante essentielle de l'administration de vMap. Il offre trois fonctionnalités principales : la création et la modification de modèles, de styles et d'échelles d'impression. + +**Les trois sous-modes disponibles sont :** + + - **Modèles** : Pour concevoir et ajuster des modèles d'impression. + - **Styles** : Pour personnaliser et gérer les styles d'impression réutilisables entre modèles. + - **Échelles** : Configuration d'une liste d'échelles d'impression définies par défaut. + + + +Une fois ces trois modes renseignés, les utilisateurs pourront ajouter le mode d'impression dans leur carte vMap pour générer des fichiers PDF contenant des cartes, des paramètres et d'autres types d'entités. + +**Configuration du mode d'impression dans une carte** + +Les utilisateurs doivent ajouter l'outil d'impression dans leur carte respective pour activer l'impression, car c'est une option configurable. + +L'icon présent ci dessous doit être ajouté dans les barres latérales ou inférieures de la carte + + + + + + +## Modèles + +Les Modèles dans le mode "Impressions" de vMap sont des templates utilisés pour les impressions sur une carte. Ils permettent de définir et ajuster la disposition, le contenu et le format des cartes imprimées, assurant une présentation cohérente et personnalisée selon les besoins spécifiques de l'utilisateur. + +La première étape consiste à créer un modèle d'impression. Pour cela, cliquez sur "Ajouter" et remplissez le formulaire en associant, un nom, un format de page, une orientation, les groupes d'utilisateurs autorisés à utiliser ce modèle, ainsi qu'une définition HTML. + +### Identifiants Clés + +Comme mentionné précédemment, il existe plusieurs identifiants clés permettant d'afficher différents éléments cartographiques dans le modèle d'impression. + +- **map_image** : En attribuant cet identifiant à une balise `<img>`, la carte résultante de l'impression sera placée dans cette balise. +- **map_overview** : En attribuant cet identifiant à une balise `<img>`, la carte de supervision sera affichée dans cette balise. +- **map_legend** : En attribuant cet identifiant à une balise `<div>`, le contenu de la légende de la carte sera copié dans cette balise. + +### Mode comparaison + +- **map_image_compare_1** : En attribuant cet identifiant à une balise `<img>`, la carte principale sera imprimée dans cette balise. +- **map_image_compare_2** : En attribuant cet identifiant à une balise `<img>`, la carte de comparaison sera imprimée dans cette balise. +- **map_legend_compare** : En attribuant cet identifiant à une balise `<div>`, le contenu de la légende de la carte de comparaison sera copié dans cette balise. + +### Exemple d'affichage de la légende dans une impression + +Pour intégrer la légende d'une carte dans une impression, vous pouvez utiliser le code suivant. Ce code utilise les directives AngularJS ng-if et ng-repeat pour afficher dynamiquement les éléments de la légende. + +``` +<div id="map_legend" ng-if="map_legend"> + <div ng-repeat="legendLayer in map_legend"> + <div ng-repeat="legend in legendLayer.legendObjects" class="legend_object"> + <div class="legend_layer_name">{{ legend.layerName }}</div><br> + <img ng-src="{{ legend.legendURL }}" class="legend_image" /> + </div> + </div> +</div> +``` + +**Description des Directives Utilisées** : + +- `ng-if="map_legend"` : Cette directive AngularJS conditionne l'affichage de la légende. Le contenu ne sera affiché que si la variable `map_legend` existe et contient des données. +- `ng-repeat="legendLayer in map_legend"` : Cette directive permet de parcourir chaque élément de la variable `map_legend`. Pour chaque élément (qui représente un calque de la légende), une nouvelle `<div>` sera créée. +- `ng-repeat="legend in legendLayer.legendObjects"` : À l'intérieur de chaque calque de légende, cette directive parcourt les objets de la légende (les éléments individuels à afficher). Pour chaque objet, une nouvelle `<div>` sera créée avec la classe `legend_object`. +- `{{ legend.layerName }}` : Cette interpolation affiche le nom du calque de la légende. +- `ng-src="{{ legend.legendURL }}"` : Cette directive AngularJS lie dynamiquement l'URL de l'image de la légende à l'attribut `src` de la balise `<img>`. Cela permet d'afficher l'image correspondante à chaque élément de la légende. + +### Variables Disponibles + +Tous les paramètres que vous définissez depuis le mode "Paramètres" seront interprétés comme des variables et pourront être inclus dans le résultat en les encadrant par des accolades dans la définition. Par exemple, si vous définissez un paramètre `map_title` dans le formulaire de votre modèle, vous pouvez l'utiliser dans votre modèle en écrivant `{{map_title}}`. + +En plus des paramètres définis par l'utilisateur, certains paramètres dynamiques sont automatiquement affectés et peuvent également être utilisés de cette manière. + +- **map_scale** : échelle de la carte imprimée +- **date** : date du jour +- **date_hour**: date + heure du jour +- **layer_sources** : sources des couches +- **map_legend**: légende de la carte principale +- **user_name** : nom de l”utilisateur +- **user_login** : login de l”utilisateur +- **user_company** : société de l”utilisateur +- **user_department** : service de l”utilisateur +- **user_email** : adresse mail de l”utilisateur +- **user_user_id** : identifiant de l”utilisateur + +## Styles + +Le "style" des impressions permettent aux utilisateurs de sélectionner le style qu'ils souhaitent appliquer lors de la phase de préparation des impressions. Chaque utilisateur possède ses propres styles configurés par l'administrateur et définis en HTML avec des balises de styles CSS. Ces styles surchargent ceux du modèle d'impression utilisé et peuvent, entre autres, impacter les couleurs, les espacements, etc. + + + +### Exemple de modification du logo dans une impression + +Pour modifier le logo dans le header du modèle d'impression par défaut de vMap, nommé "Modèle par défaut", nous devons d'abord identifier la balise contenant notre image. Cette balise peut être identifiée grâce à sa classe unique utilisée uniquement pour l'image du logo. + + + +Lors de la création de notre style d'impression permettant la permutation du logo, nous allons ajouter dans la définition CSS le bout de code suivant. Ce code permet de remplacer le contenu de la balise image avec la classe `logo` par l'image en base 64 fournie. + +``` +<style> + .logo { + content: url('data:image/png;base64,...'); + } +</style> +``` + +Ce style va surcharger le logo existant dans le modèle d'impression par défaut avec la nouvelle image fournie. + +## Échelles + +Le mode "Impressions" de vMap inclut une liste d'échelles par défaut qui permettent aux utilisateurs de choisir la représentation la plus appropriée pour leurs cartes imprimées. Les échelles définissent le rapport entre les distances sur la carte et les distances réelles sur le terrain, assurant ainsi une représentation précise et adaptée aux besoins spécifiques de l'utilisateur. + + \ No newline at end of file diff --git a/doc/source/administrator/index.rst b/doc/source/administrator/index.rst index 441baea252f2071ebff8ae912d1d21abd088df56..8220ffcd4458d5d116b9afa5e354c14a8d2a4467 100644 --- a/doc/source/administrator/index.rst +++ b/doc/source/administrator/index.rst @@ -11,6 +11,7 @@ Il est conseillé aux administrateurs de consulter en premier la `Documentation :maxdepth: 2 authentification/index.rst + impressions.md users.md configuration/index.rst api/api.rst diff --git a/doc/source/images/administrator/impressions/ajouter_outil_impression_dans_la_carte.png b/doc/source/images/administrator/impressions/ajouter_outil_impression_dans_la_carte.png new file mode 100644 index 0000000000000000000000000000000000000000..2e4f4377628dba37f784ee9ba1f078890d18bab1 Binary files /dev/null and b/doc/source/images/administrator/impressions/ajouter_outil_impression_dans_la_carte.png differ diff --git a/doc/source/images/administrator/impressions/echelles.png b/doc/source/images/administrator/impressions/echelles.png new file mode 100644 index 0000000000000000000000000000000000000000..ed1194af82b961e2f031af73fb96120d764da474 Binary files /dev/null and b/doc/source/images/administrator/impressions/echelles.png differ diff --git a/doc/source/images/administrator/impressions/exemple-boucle-map-legende.png b/doc/source/images/administrator/impressions/exemple-boucle-map-legende.png new file mode 100644 index 0000000000000000000000000000000000000000..140940eee74988c89db7818108aa12b4152d985d Binary files /dev/null and b/doc/source/images/administrator/impressions/exemple-boucle-map-legende.png differ diff --git a/doc/source/images/administrator/impressions/html_logo.png b/doc/source/images/administrator/impressions/html_logo.png new file mode 100644 index 0000000000000000000000000000000000000000..839b0dfc8f8ca290c51230859ea2308b3bd8e4a3 Binary files /dev/null and b/doc/source/images/administrator/impressions/html_logo.png differ diff --git a/doc/source/images/administrator/impressions/icon_outil_impression.png b/doc/source/images/administrator/impressions/icon_outil_impression.png new file mode 100644 index 0000000000000000000000000000000000000000..d9cb48d2891d86a08b0e96a2d491083b699b9047 Binary files /dev/null and b/doc/source/images/administrator/impressions/icon_outil_impression.png differ diff --git a/doc/source/images/administrator/impressions/mode_impressions.png b/doc/source/images/administrator/impressions/mode_impressions.png new file mode 100644 index 0000000000000000000000000000000000000000..858d6ec60fb3d50217f03691cc3719204c4840a0 Binary files /dev/null and b/doc/source/images/administrator/impressions/mode_impressions.png differ diff --git a/doc/source/images/administrator/impressions/selection_du_style_des_impressions.png b/doc/source/images/administrator/impressions/selection_du_style_des_impressions.png new file mode 100644 index 0000000000000000000000000000000000000000..b98415fd7b89954ac61e99aae6e6acba467e6818 Binary files /dev/null and b/doc/source/images/administrator/impressions/selection_du_style_des_impressions.png differ