PreviousNextIndex

Un overlay ? c'est quoi ? Comment on s'en sert ?

Pour évoluer en fonction de vos besoins, YACS dispose de prises d'extensions ("hooks" en anglais), de layouts (mise en forme) adaptables et, surtout, d'overlays. Un puissant moyen d'adaptation à découvrir.

[title]Un overlay, c'est quoi ?[/title]
En anglais, overlay veut dire "recouvrir". En programmation, on utilise ce mot lorsque l'on spécialise un objet.

Dans YACS, les overlays sont un moyen de spécialiser les articles. Par exemple, indiquer l'overlay "poll" dans une section fait que tous les articles de cette section deviennent des sondages... ou alors, indiquer "recipe" pour obtenir un livre de recettes de cuisine...

Pour les développeurs, l'intérêt est d'ajouter le minimum de code pour étendre YACS, en bénéficiant directement de la puissance du logiciel : images, commentaires, fichiers attachés, etc... sont préservés, l'overlay s'intègre à l'existant. Généralement, quelques lignes de PHP suffisent pour ajouter quelques champs à un article et rendre le service recherché.

Pour en savoir plus sur la construction des overlays, voir la le guide de développement, et en particulier, pour une première approche, cet article.

Pour le webmaster, l'intérêt réside dans la souplesse d'évolution de YACS, puisqu'il choisit le ou les overlays dont il a besoin pour étendre son système.
[title]À quoi s'appliquent les overlays ?[/title]
Les overlays peuvent s'appliquer aux articles d'une section, aux sous-sections d'une section mère et aux sous-catégories d'une catégorie principale.

!!!Les overlays sont spécifiques aux sous-sections, sous-catégories ou articles. Un overlay d'article ne s'applique pas à une sous-section ou une sous-catégorie, et c'est valable dans les autres sens ! Choisissez soigneusement votre overlay.
[title]Quels sont les overlays à disposition ?[/title]
L'archive de Yacs contient par défaut un certain nombre d'overlays, qui sont maintenus d'une version à l'autre.

Vous en trouverez la liste dans le répertoire /overlays de votre serveur).

Les overlays livrés avec Yacs :
* contact - overlays d'article : créer une sorte d'annuaire avec des coordonnées, tel, mail etc... Paramétré dans la configuration des utilisateurs via le panneau de contrôle, il permet d'étendre les fiches utilisateurs.
* day - overlays d'article : créer un calendrier d'évènements
* form - overlays d'article : utilisé pour la création des formulaires
* issue - overlays d'article : utilisé ici pour la gestion des remontées de bugs et autres disfonctionnement (voir par ex. les articles de ce forum).
* overlay_test : cet overlay est utilisé par les testeurs de Yacs
* petition - overlay d'article : créer des pétitions et recueillir l'avis des votants.
* poll - overlay d'article : réaliser des sondages et recueillir l'avis des votants
* recipe - overlay d'article : réaliser un livre de cuisine
* select : utilisé lors de la création de pages modèles pour choisir un overlay à associer à un type de page modèle, le cas échéant
* vote - overlay d'article : réaliser un vote menant à une prise de décision, et recueillir l'avis des votants.
Par ailleurs, vous trouverez d'autres overlays, réalisés par des contributeurs de Yacs, dans la rubrique overlays de la zone de téléchargement sur ce site.

Tout le monde peut proposer un overlay qu'il aura créé de toute pièce ou qu'il aura adapté, et tout le monde peut en bénéficier. C'est l'avantage des logiciels libres en général et de la communauté Yacs en particulier.
[title]Comment mettre en oeuvre un overlay ?[/title]
Éditez la section ou catégorie mère (cliquez sur le menu modifier) si elle existe), ou créez-en une nouvelle. Rendez-vous sur l'onglet contenu du formulaire d'édition.

Pour appliquer un overlay d'article :

Déroulez l'option pages et dans le champ overlay, indiquez simplement le nom de l'overlay. Par exemple : vote.

Pour appliquer un overlay de section ou de catégorie :

Déroulez l'option sous-sections ou sous-catégorie selon le cas. Dans le champ overlay, indiquez simplement le nom de l'overlay à appliquer.

Une fois que vous avez enregistré, les articles, sous-sections ou sous-catégories que vous allez créer se verront appliquer l'overlay choisi.

[title]Modifier l'overlay après coup[/title]
Cette fonctionnalité est maintenant disponible. Elle permet après coup d'appliquer un overlay ou d'en changer.

Très utile par exemple si l'on déplace une page d'une section sans overlay vers une section comportant un overlay. Ou encore si l'on rajoute après coup un overlay à une section, pour faire prendre en compte cet overlay aux pages déjà créées.

En mode édition de votre article, section ou catégorie, rendez-vous sur le troisème onglet options et déroulez plus d'options. Vous allez trouver une liste déroulante vous permettant de basculer à un nouvel overlay - ou d'enlever celui existant, avec l'entrée //aucun.

[title]Quelques remarques importantes[/title]
  1. Si vous déplacez un article (ou une section...) créé avec un overlay, les informations complémentaires resterons attachées à cet élément après le déplacement, même si le nouvel ancrage ne comporte aucun overlay. Vous pouvez ôter l'overlay ou en appliquer un autre correspondant au nouveau point d'ancrage.
  2. Si vous déplacez dans une section ou une catégorie comportant un overlay, un article, une sous-section ou une sous-catégorie n'en comportant pas, l'overlay ne sera pas appliqué aux éléments déplacés, sauf si vous le spécifiez lors du déplacement. Bien entendu, vous aurez à saisir les informations requises par le nouvel overlay.

PreviousNextIndex