Icônes et décorateurs du plan du site (Ametys 4.3)

Cette page traite des icônes et décorateurs du plan du site pour les version Ametys 4.3 et inférieures.
Pour les versions Ametys 4.4 et plus rendez-vous sur la page Icônes et décorateurs du plan du site

Présentation

Les icônes et les décorateurs ont pour role d'apporter des informations sur la nature ou le status de la page dans le plan du site: rubrique principale, accès direct, page de redirection, page à accès limité, publiée en ligne, ...

Les icônes et  décorateurs disponibles dépendent de votre application.  Ils sont définis dans le fichier de configuration WEB-INF/param/sitemap-icons.xml. Il s'agit de la configuration par défaut.
Chaque charte graphique peut remplacer la configuration par défaut en ayant son propre fichier de configuration skins/[nom_skin]/conf /sitemap hey -icons.xml.

La structure du fichier sitemap-icons.xml est la suivante :

<?xml version="1.0" encoding="UTF-8"?>
<sitemap>
<icons>
<!-- Ici la liste des icônes -->
</icons>

<decorators>
<!-- Ici la liste des décorateurs -->
</decorators>
</sitemap>

Dans l'outil Plan du site, les icônes correspondent à l’icône à gauche du titre de la page, tandis que les décorateurs correspondent aux icones à droite du titre de la page

Définir des icônes et des décorateurs pour vos pages

Déclaration d'une icône

Pour définir une icône vous devez définir:

  • le chemin du fichier image. Les dimensions de l'image doit être de 18 x 18 pixels.
  • les conditions sur le type de la page, étiquettes, métadonnée de la page pour afficher cette icône
<icon>
<!-- Chemin du fichier image (16x16 pixels) -->
<image plugin="pluginName">img/path/to/icon.png</image>
<conditions>
<!-- Type de page : container, link ou node-->
<type>container</type> 
<!-- Condition sur les étiquettes de la page : AND ou OR. AND par défaut-->
<tags type="AND"> 
<tag>TAG_KEY_1</tag> <!-- Clé de l'étiquette -->
<tag>TAG_KEY_2</tag>
</tags>
<!-- Condition sur les métadonnée de la page : AND ou OR. AND par défaut-->
<metadata type="OR"> 
<metadata name="path/to/metadata1">value1</metadata> <!-- Test si 'metadata1' est égale à 'value1' '-->
<metadata name="path/to/metadata2"></metadata> <!-- Utiliser une valeur vide pour tester l'existance d'une métadonnée -->
</metadata>
<live /> <!-- La balise live signifie que la page est publiée (en ligne) -->
</conditions>
</icon>

Il y a seulement une icône par page. L’icône qui sera utilisée pour une page donnée sera la première icône dans l'ordre de déclaration dans le fichier pour laquelle l'ensemble des conditions est respectée.  

Exemple 1 : icône pour une rubrique principale publiée sur le site

<icon>
<image plugin="default-sitemap">img/icons/section_online.png</image>
<conditions>
<tags>
<tag>MAIN_SECTION</tag>
</tags>
<live/>
</conditions>
</icon>

Exemple 2 : icône pour une page "vierge" publiée sur le site

<icon>
<image plugin="default-sitemap">img/icons/page_blank_online.png</image>
<conditions>
<type>node</type>
<live/>
</conditions>
</icon>

Déclaration d'un décorateur

La déclaration d'un décorateur est similaire à la déclaration d'une icône.
Vous devrez ajouter en plus un libellé.
La dimension de l'image doit être de 14 x 14 pixels.

<decorator>
<!-- Libellé -->
<label i18n="true">plugin.pluginName:I18N_KEY</label>
<!-- Chemin du fichier image (14x14 pixels -->
<image plugin="pluginName">img/path/to/icon.png</image> <!-- the icon path -->
<conditions>
<!-- Type de page : container, link ou node-->
<type>container</type> 
<!-- Condition sur les étiquettes de la page : AND ou OR. AND par défaut-->
<tags type="AND"> 
<tag>TAG_KEY_1</tag> <!-- Clé de l'étiquette -->
<tag>TAG_KEY_2</tag>
</tags>
<!-- Condition sur les métadonnée de la page : AND ou OR. AND par défaut-->
<metadata type="OR"> 
<metadata name="path/to/metadata1">value1</metadata> <!-- Test si 'metadata1' est égale à 'value1' '-->
<metadata name="path/to/metadata2"></metadata> <!-- Utiliser une valeur vide pour tester l'existance d'une métadonnée -->
</metadata>
<live /> <!-- La balise live signifie que la page est publiée (en ligne) -->
</conditions>
</decorator>

Une page peut avoir plusieurs décorateurs.

Exemple 1: un décorateur indiquant une page privée ou à accès limité

<decorator>
<label i18n="true">plugin.default-sitemap:PLUGIN_DEFAULT_SITEMAP_DECORATOR_LIMITED_ACCESS</label>
<image plugin="default-sitemap">img/icons/private.png</image>
<conditions>
<metadata type="OR">
<metadata name="granted-users"></metadata>
<metadata name="granted-groups"></metadata>
</metadata>
</conditions>
</decorator>

Exemple 2: un décorateur indiquant une page étiquetée comme une page à accès direct

<decorator>
<label i18n="true">plugin.default-sitemap:PLUGIN_DEFAULT_SITEMAP_DECORATOR_DIRECT_ACCESS</label>
<image plugin="default-sitemap">img/icons/direct_access.png</image>
<conditions>
<tags>
<tag>DIRECT_ACCESS</tag>
</tags>
</conditions>
</decorator>
Retour en haut

Manuel de paramétrage et d'intégration