Breadcrumbs : mettre en place un fil d'Ariane pour un site MODx
0 Commentaire(s)
23/08/2011 à 18:22
Le snippet Breadcrumbs permet de mettre en place un fil d'Ariane pour un site Internet MODx. Cela permet d'aider les internautes à naviguer sur votre site.
Élément Requis
MODx Revolution 2.0.0-beta5 ou supérieur.
Téléchargement
Vous pouvez télécharger Breadcrumbs à partir du manager de MODx Révolution via la catégorie "Système", "Gestion des paquets", "Télécharger des extras".
Utilisation
Breadcrumbs est un snippet qui doit être appelé en utilisant la variable [[!Breadcrumbs]].
Comme tous les snippets, vous pouvez ajouter des paramètres pour personnaliser votre fil d'Ariane.
Pour ajouter une propriété, il suffit d'ajouter &nompropriete=`valeurdelapropriete` à la variable de cette manière : [[!Breadcrumbs? &nompropriete=`valeurdelapropriete`]].
Voici une liste des ces propriétés :
Paramètres de Breadcrumbs
| Nom | Description | Valeur par défaut |
| crumbSeparator | Permet de définir le caractère qui sépare chaque élément du fil d'Ariane. | » |
| currentAsLink | Permet de choisir si l'élément qui correspond à la page où on se trouve soit un lien ou non. Valeur "true" ou "1" pour qu'il soit un lien sinon mettre la valeur "false" ou "0". | true |
| descField | Indiquez la variable qui servira de texte affiché dans l'attribut "title" des liens du fil d'Ariane. Par défaut ce champ est la description de vos ressources. Si la description est vide, le titre de la page sera affiché. | description |
| homeCrumbDescription | Permet de donner une description personnalisée pour le lien correspondant à la page d'accueil de votre site. Cette description s'affiche dans l'attribut "title" sur lien de l'élément. | Home |
| homeCrumbTitle | Permet de personnaliser le texte du lien concernant la page d'accueil de votre site. | Home |
| maxCrumbs | Nombre maximum d'éléments à afficher dans le fil ariane. Par exemple si vous êtes au niveau 5 de l'arborescence de votre site et que vous indiquez vouloir afficher 2 éléments alors le fil d'Ariane s'affichera de cette manière : Accueil >> ... >> Niveau 4 >> Niveau 5. "..." correspond à la valeur indiquée dans le paramètre maxDelimiter. L'élément correspondant à la page d'accueil n'est pas compté dans les niveaux du fil d'Ariane. | 100 |
| maxDelimiter | Chaîne de caractères qui s'affichera lorsque le nombre maximum est atteint dans le fil d'Ariane. | ... |
| pathThruUnPub | Pour que les dossiers non publiées soient affichés dans le fil d'Ariane, indiquez la valeur "true" ou "1". Par contre si vous voulez afficher tout de même les dossiers non publiés dans ce fil d'Ariane, mettez la valeur "false" ou "0". | true |
| respectHidemenu | Si la valeur est "true" ou "1", les éléments qui ont la case "caché dans le menu" cochés s'afficheront dans le fil d'Ariane. Indiquez la valeur "false" ou "0" pour ne pas les afficher. | true |
| showCrumbsAtHome | Si la valeur est "true" ou "1", le fil d'Ariane s'affichera sur la page d'accueil. Indiquez "false" ou "0" pour qu'il ne soit pas pris en compte sur cette page. | false |
| showCurrentCrumb | Si la valeur est à "true" ou "1", la où l'on se trouve s'affichera dans le fil d'Ariane. Indiquez la valeur "false" ou "0" pour ne pas l'afficher. | true |
| showHomeCrumb | Si la valeur est à "true" ou "1", le lien vers la page d'accueil sera affiché dans le fil d'Ariane. La valeur doit être false ou "0" pour ne pa l'afficher. | true |
| titleField | Indiquez la variable qui sera le texte du lien affiché dans le fil d'Ariane pour chaque élément. | pagetitle |
Les exemples d'utilisation de Breadcrumbs
L'appel minimum de Breadcrumbs
[[!Breadcrumbs]]
Cet appel affichera les éléments en fonction des valeurs par défaut de ce snippet.
Autres Exemples
[[!Breadcrumbs? &crumbSeparator=`|`]]
Tous les éléments seront séparés par le caractère "|".
[[!Breadcrumbs? &homeCrumbDescription=`Page d'accueil` &homeCrumbTitle=`Accueil`]]
Pour l'élément concernant la page d'accueil du site, l'attribut "title" du lien aura comme valeur Page d'accueil et le texte du lien sera Accueil.
Modifier l'affichage des éléments
Lorsque vous installer l'extension Breadcrumbs, différents chunks sont créés et ajoutés à la liste de vos chunks. Vous les trouverez dans la partie gauche du manager de votre site, dans l'onglet "Eléments", déroulez l'arborescence des chunks et du dossier Breadcrumbs.
Chacun de ces chunks correspond à un type d'élément affiché.
| Nom du Chunk | Description |
| bcTplCrumb | Permet de définir l'affichage de tous les éléments qui ne correspondent à aucun des autres chunks ci-dessous |
| bcTplCrumbCurrent | Permet de définir l'affichage de l'élément qui correspond à la page où l'on se trouve |
| bcTplCrumbCurrentLink | Permet de définir l'affichage du lien correspondant à l'élément de la page en cours. Pour que ce lien s'affiche, il faut activer le paramètre currentAsLink. Le lien s'affiche dans le chunk bcTplCrumbCurrent. |
| bcTplCrumbFirst | Permet de définir l'affichage du premier élément. |
| bcTplCrumbHome | permet de définir l'affichage de l'élément correspondant à la page d'accueil du site. |
| bcTplCrumbLast | Permet de définir l'affichage du dernier élément. |
| bcTplCrumbLink | Permet de définir l'affichage du lien dans chaque élément. |
| bcTplCrumbMax | Permet de définir l'affichage lorsque le nombre maximum d'éléments est atteint. |
| bcTplCrumbOuter | Permet de définir l'affichage qui contient tout le fil d'Ariane. |
