Icônes et décorateurs du plan du site

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

Présentation

Les icônes et les décorateurs ont pour rôle 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 les décorateurs disponibles dépendent de votre application.

Certaines icônes et décorateurs sont apportées par Ametys (ex: icône par type de page (contenu, lien ou redirection), icône verte pour les pages publiées, décorateurs pour les pages invisibles, avec publication programmée, ...) et par certain plugins (ex: page traduite)

Vous pouvez définir également vos propres icônes / décorateurs dans votre ou vos chartes graphiques (voir plus loin)

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 icônes à droite du titre de la page

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

Définir des icônes

Pour définir des icônes supplémentaires, vous devez définir ces icônes dans un fichier skins/[SKIN]/conf/sitemap-icons.xml de votre charte graphique.

Une icône est composée:

  • d'un libellé
  • d'un glyph ou d'un fichier image au dimension 18x18 pixels
  • des conditions sur le type de la page, étiquettes, métadonnée de la page pour afficher cette icône
  • d'un ordre

L'ordre est important car une seule icône sera associée à une page: il s'agira de la première icône de priorité la plus élevée dont les conditions correspondent aux propriétés de la page. 0 est la priorité la plus élevée.

Les types de conditions

Il existe 4 types de conditions.

Pour une condition sur le type de page (conteneur, lien ou nœud) on utilise <type> avec respectivement container, link ou node.

<!-- Type de page : container, link ou node-->
<type>container</type>

Pour une condition portant sur les étiquettes de la page, on écrira:

<!-- 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>

Pour une condition portant sur les métadonnées de la page, on écrira :

<!-- 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

Pour une condition sur le caractère publié de la page, on utilisera la balise <live/>

<live/>

Les conditions peuvent se cumuler. La page doit répondre à toutes les conditions pour être associée à l'icône.

Exemple de fichier sitemap-icons.xml

Généralement, les icônes apportées par votre charte graphique sont les icônes qui dépendent des étiquettes définies par votre charte.
Voici ci-dessus un exemple de fichier permettant d'ajouter 2 icônes:

  • une pour les rubriques principales (pages étiquetées SECTION) publiées sur le site
  • une pour les rubriques principales (pages étiquetées SECTION) non publiées (brouillon)
    <icons>
        <!-- Validated sections -->
        <icon>
            <order>5</order>
            <glyph>ametysicon-file94 validated</glyph>
            <conditions>
                <tags>
                    <tag>SECTION</tag>
                </tags>
                <live />
            </conditions> 
        </icon>
        <!-- Sections -->
        <icon>
            <order>6</order>
            <glyph>ametysicon-file94</glyph>
            <conditions>
                <tags>
                    <tag>SECTION</tag>
                </tags>
            </conditions>
        </icon>
    </icons>

Définir des décorateurs

Pour définir des décorateurs supplémentaires, vous devez définir ces décorateurs dans un fichier skins/[SKIN]/conf/sitemap-decorators.xml de votre charte graphique.

Comme les icônes, un décorateur est composé:

  • d'un libellé
  • d'un glyph ou d'un fichier image au dimension 18x18 pixels
  • des conditions sur le type de la page, étiquettes, métadonnée de la page pour afficher cette icône

L'ordre d'un décorateur n'a aucun important car ils ne sont pas exclusif.

Exemple de fichier sitemap-decorators.xml

Généralement, les décorateurs apportés par votre charte graphique sont les décorateurs qui dépendent des étiquettes définies par votre charte.
Voici ci-dessus un exemple de fichier permettant d'ajouter un décorateur pour les pages étiquetées "Accès direct" (DIRECTACCESS)

    <decorators>
        <!-- Direct access -->
        <decorator id="direct_access">
            <label i18n="true">PLUGINS_WEB_SITEMAP_DECORATOR_DIRECT_ACCESS</label>
            <glyph>ametysicon-link23</glyph>
            <conditions>
                <tags>
                    <tag>DIRECTACCESS</tag>
                </tags>
            </conditions>
        </decorator>
    </decorators>
Retour en haut

Manuel de paramétrage et d'intégration