Plugin Afficher la Zone

A partir du flux de RSS de la Zone (ref.xml.gz), ce plugin permet de trier, classer et afficher une sélection de plugins personnalisée.
Trois formats de sortie : RSS, HTML (page spip) et carte freemind.

Fonctionnement du plugin :

“Rien de mieux qu’un dessin” :

Installation et configuration

Installation

  • téléchargez le zip du plugin
    Afficher les plugins de la Zone (0.1.0)
  • pour l’installation et l’activation, suivez la procédure standard : cf la documentation officielle
  • en principe, lors de son activation, le script d’installation crée un groupe de mots clés « statut des plugins » contenant les 4 statuts possibles (stable, test, dev et experimental).
    Par la suite, si vous souhaitez restreindre les plugins à traiter à un ou quelques uns de ces statuts, il suffira d’enlever les mots clés des catégories que vous ne souhaitez pas voir apparaître.
  • de la même manière le script d’installation ajoute le flux RSS de la Zone dans les sites syndiqués. Ce flux est placé dans la rubrique n°1 de votre spip : par la suite vous pourrez le déplacer dans la rubrique de votre choix.

NB : lors du premier chargement de l’interface de gestion, le plugin indexe l’ensemble des plugins présents dans le fichier RSS de la Zone ce qui peut prendre un certain temps... Par la suite, seuls les plugins ajoutés seront indexés.

Configuration

Ce plugin utilise CFG pour sa configuration vous permettant ainsi de définir :

  • (obligatoire) le groupe de mots clés qui contient les statuts
  • (obligatoire) les groupes de mots clés que vous utiliserez pour classer les plugins.
    Ces groupes constituent le premier niveau de classement de vos plugins.
    Dans chacun de ces groupes, les mots clés que vous y placerez constitueront les catégories (classement de 2d niveau) que vous pourrez associer à vos plugins.
    Pour que l’interface de classement des plugins soit opérationnelle, il vous faudra définir au moins un groupe avec un mot clé et le cocher dans l’interface de configuration (ceci dit, si vous souhaitez que l’interface de gestion n’ait pas l’air trop ridicule, je vous conseille de créer plusieurs groupes avec quelques mots clés dedans avant de commencer...)
    Ce système vous permet donc de gérer votre propre système de classement des plugins simplement en ajoutant/modifiant des groupes de mots clés et des mots clés.
  • (facultatif) le titre et le descriptif de votre sélection de plugins. Ces 2 éléments seront utilisés en en-tête du flux RSS émis à partir de votre sélection de plugins ainsi que dans l’interface spip de consultation de cette sélection.
  • (obligatoire) l’URL des liens sur les plugins dans les cartes Freemind : soit sur la page de la Zone (Trac) du plugin, soit sur le zip du plugin (https://files.spip.net/spip-zone)
  • (obligatoire) le mode d’affichage de l’interface HTML de consultation des plugins : soit compact (détails masqués, un clic sur le titre pour les afficher), soit complet (détails des plugins affichés).

Utilisation du plugin : tri et classement

L’interface de gestion des plugins est accessible via le bouton « Afficher la Zone » du menu « Edition ».

Interface privée : système de classement des plugins par catégories


A priori son fonctionnement est relativement intuitif :

  1. choisir un statut
  2. pour celui-ci, tous les plugins disponibles sur la zone sont listés : choisissez une catégorie dans la colonne de gauche
  3. cochez les plugins qui doivent êtres associés à cette catégorie
  4. validez votre sélection avant de changer de catégorie.

Les plugins déja associés à une catégorie sont surlignés en bleu. Si vos souhaitez retrouver la catégorie associée à un plugin, cliquez sur l’icone « mot clé » située à sa droite.

Le principe général de ce plugin est que seuls les mots clés associés à une catégorie seront visibles dans la partie publique.

Consultation de votre sélection / classement

3 formats de sorties sont immédiatement disponible une fois votre sélection faite (voir le site de démonstration : http://tice.aix-mrs.iufm.fr/spip_sv...).

  • un squelette spécifique permet de disposer d’une interface de consultation de votre sélection (affichage de la sélection par statut et/ou par groupes de catégories) à l’adresse : http://www.mon-site-spip.tld/?page=affzone_html&statut=stable.
    L’affichage de cette page est configurable via CFG :
    • mode complet : l’ensemble des détails de chaque plugin est visible (ce qui peut conduire à une page *très* longue si dans votre sélection de plugins certains d’entre eux ont une description dithyrambique)
    • mode compact : seul le titre de chaque plugin est visible, un clic dessus affiche les détails.
Interface publique de consultation de la sélection de plugins (mode compact)

Pour chaque combinaison statut(s) / catégorie(s) l’interface propose :

  • un lien vers le flux RSS correspondant (http://www.mon-site-spip.tld/?page=affzone_rss&statut=stable)
  • exemple de fichier Freemind généré par le squelette affzone_fm.html

    un lien pour télécharger une carte Freemind représentant la sélection des plugins affichés sur la page (http://www.mon-site-spip.tld/?page=affzone_fm&statut=stable).
    Pour cette carte, chaque plugin est lié avec une URL : soit celle de la page de la Zone de ce plugin soit celle du zip du plugin sur http://files.spip.org/spip-zone. Le choix de l’url à utiliser est déterminé dans l’interface de configuration (CFG) de Afficher la Zone.

Ce système vous permet donc : d’afficher votre sélection / classement de plugins de façon globale ou fragmentée, d’émettre autant de flux RSS que vous le souhaitez et de récupérer toutes les cartes Freemind associées.

Outils complémentaires : faites ce qu’il vous plaît !

Afin de laisser le maximum de souplesse, 2 modèles (cf la documentation officielle sur les modèles) sont fournis avec ce plugin :

  • un modèle affzone permettant d’afficher tout ou partie de votre sélection dans les articles, brèves ou rubriques de votre spip (voir cet article sur le site de démo : http://tice.aix-mrs.iufm.fr/spip_sv... .
    Sa syntaxe est classique : <affzone|statut=stable> affiche votre sélection de plugins ayant le statut « stable ». Dans ce cas, toutes les catégories sont visibles.
    Facultativement vous pouvez passez un deuxième paramètre pour indiquer le(s) groupe(s) de catégorie(s) qu’il faut afficher : <affzone|statut=tout|cat=4,5,8> affichera les plugins des groupes de catégories 4,5 et 8 quelque soit leur statut (soit tous les plugins associés à des mots clés appartenants aux groupes de mots clés n°4, 5 et 8).
    Il est également possible de déterminer le mode d’affichage de la liste des plugins obtenue en passant le paramètre mode : <affzone|statut=tout|mode=compact> affiche la liste en mode compact alors que <affzone|statut=tout|mode=complet> l’affiche en mode complet. Le paramètre passé dans le modèle est prioritaire sur celui configuré « par défaut » pour tout votre spip via CFG.
    Comme n’importe quel modèle, vous pouvez bien sûr l’utiliser directement dans vos squelettes : [(#MODELE{affzone}{statut=stable})] correspond au premier exemple ci-dessus et [(#MODELE{affzone}{statut=tout}{cat=4,5,8})] au deuxième.
    Pour faire un modèle « ouvert », utilisez : [(#MODELE{affzone}{statut=#ENV{statut}}{cat=#ENV{cat}}{mode={#ENV{mode}})] ce qui vous permettra (par exemple) de pouvoir changer la sélection affichée via l’url d’un lien pointant sur cette page : par exemple, si vous avez intégré ce modèle dans un squelette toto.html, vous pouvez obtenir les résultats des 2 exemples précédents avec des liens ayant comme url : http://www.mon-site-spip.tld/?page=toto&statut=stable et http://www.mon-site-spip.tld/?page=toto&statut=tout&cat=4,5,8
  • le deuxième modèle fourni est nettement plus spécifique puisqu’il complète le modèle fourni par le plugin « eva-freemind » afin de gérer l’affichage des cartes Freemind générées (voir cet article sur le site de démo : http://tice.aix-mrs.iufm.fr/spip_sv....
    En effet, le plugin eva-freemind (téléchargement et documentation) permet d’afficher des cartes Freemind (format .mm) attachées comme document à un article via un composant Flash appelé lors du chargement du modèle : par exemple <freemind|doc58> affiche la carte associée comme document à l’article avec le n°58.
    Le modèle complémentaire freemind_az livré ici permet d’afficher les cartes générées dynamiquement par le plugin Afficher la Zone (à condition que vous ayez préalablement installé et activé le plugin eva-freemind bien sûr !).
    Il s’utilise de façon similaire au modèle affzone : <freemind_az|statut=stable> placé dans un article affiche la carte Freemind correspondant au premier exemple vu ci-dessus et <freemind_az|statut=tout|cat=4,5,8> la carte correspondant au deuxième exemple.
    un article intégrant le modèle freemind_az

TO DO

  • Comme d’habitude, piètre graphiste que je suis, si quelqu’un avait le courage de faire un logo moins crasseux, il est le bienvenu !
  • Enrichir les modèle d’un paramètre supplémentaire pour pouvoir afficher les plugins par catégories de 2e niveau
  • Ajouter la possibilité de pouvoir placer un plugin dans plusieurs catégories (classement du type « tags »)

Notes techniques

  • à priori les flux RSS générés par ce plugin sont exactement au même format que celui du flux initial (cf http://trac.rezo.net/trac/spip-zone...) si ce n’est que pour chaque plugin 2 tags (microformats) sont ajoutés : un pour le groupe, un pour la catégorie dans lesquels le plugin est classé.
  • ce plugin utilise la table spip_mots_syndic_articles fraichement intégrée au core pour associer des mots clés aux éléments (plugins) du flux de syndication venant de la Zone. En principe cette structure est totalement compatible avec celle du plugin mots arborescents / mots partout : lorsque celui-ci sera opérationnel sous spip 1.9.3 (2.0 ?), il sera possible d’étendre les capacités de Afficher la Zone afin de pouvoir bénéficier d’une arborescence de catégories de classement avec plus de 2 niveaux.
  • le squelette affzone_fm.html associé au modèle freemind_az.html devrait constituer un bon point de départ pour toute personne susceptible de vouloir générer des fichiers Freemind via spip : la structure des fichiers Freemind (« XML like » avec des balises <node> imbriquées) est spécialement bien adaptée aux fonctionnement des BOUCLEs de spip.
  • en principe les squelettes et modèles de ce plugin sont totalement compatible avec le style de la « dist » : pas d’ajout de définitions CSS si ce n’est marginales.

Remerciements :

  • de façon posthume à toggg à qui j’ai cassé les pieds pendant des mois pour qu’il intègre une sortie RSS à son (génial) script paquet.sh
  • à Gilles Vincent pour l’idée du classement des plugins sous forme d’un schéma arborescent
  • à Paolo pour le dépannage sur l’utilisation de paramètres #GET, #CONFIG ou #ENV dans les critères IN et LIKE des BOUCLEs

Discussion

2 discussions

  • Au lieu (ou en plus) d’indiquer dans la version RSS les mots-clé avec des « tags microformats », il serait judicieux d’utiliser l’élément category de RSS.

    Avez vous songé à faire une version atom ?

    Répondre à ce message

  • 1
    assobachant

    pour info dans l’interface configuration ; le point d’interrogation a la place de l’accent

    choix du type de lien dans les cartes Freemind : choisissez quel type de lien vous d�sirez

    • assobachant

      en principe, lors de son activation, le script d’installation crée un groupe de mots clés « statut des plugins » contenant les 4 statuts possibles (stable, test, dev et experimental).
      Par la suite, si vous souhaitez restreindre les plugins à traiter à un ou quelques uns de ces statuts, il suffira d’enlever les mots clés des catégories que vous ne souhaitez pas voir apparaître.

      et bien non seul le groupe de mot clef Administration est créer avec comme mot clef test

    Répondre à ce message

Ajouter un commentaire

Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :

  • Désactiver tous les plugins que vous ne voulez pas tester afin de vous assurer que le bug vient bien du plugin X. Cela vous évitera d’écrire sur le forum d’une contribution qui n’est finalement pas en cause.
  • Cherchez et notez les numéros de version de tout ce qui est en place au moment du test :
    • version de SPIP, en bas de la partie privée
    • version du plugin testé et des éventuels plugins nécessités
    • version de PHP (exec=info en partie privée)
    • version de MySQL / SQLite
  • Si votre problème concerne la partie publique de votre site, donnez une URL où le bug est visible, pour que les gens puissent voir par eux-mêmes.
  • En cas de page blanche, merci d’activer l’affichage des erreurs, et d’indiquer ensuite l’erreur qui apparaît.

Merci d’avance pour les personnes qui vous aideront !

Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.

Qui êtes-vous ?
[Se connecter]

Pour afficher votre trombine avec votre message, enregistrez-la d’abord sur gravatar.com (gratuit et indolore) et n’oubliez pas d’indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici

Ce champ accepte les raccourcis SPIP {{gras}} {italique} -*liste [texte->url] <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.

Ajouter un document

Suivre les commentaires : RSS 2.0 | Atom