CONTENU DU SITE

Cet article a pour objet d’expliquer chaque page et affichage de ce site ainsi que les principes de navigation. Sa lecture est conseillée à tout visiteur qui consulte ce site pour la première fois afin de comprendre comment en tirer partie au mieux.

La qualité de ce site n’est que le reflet de la qualité des informations saisies par les développeurs de plugins dans les fichiers paquet.xml et plugin.xml.

La navigation et les filtres

Le but du site étant de faciliter la recherche de plugins, il existe plusieurs menus de navigation et de filtres rapidement accessibles :

  • la barre de navigation du bandeau permet de se déplacer rapidement dans les pages « Plugins » —liste de tous les plugins— « Téléchargements » —liste de toutes les archives téléchargeables— « Préfixes » —liste de tous les préfixes de plugin utilisés— et « Dépôts » —liste de tous les dépôts hébergeant des plugins—. L’aide du site et la foire aux questions y est aussi accessible.
  • le menu des catégories permet de se déplacer en un clic dans la page des Plugins de la catégorie choisie.
  • le menu des branches SPIP ou des dépôts agit comme un filtre de la liste des plugins ou des téléchargements dans leur page respective. Ces filtres sont cumulables.

En outre, un menu de langue sous le logo du bandeau permet de changer en un clic la langue du site.

La page d’accueil

La page d’accueil du site est composée de trois blocs distincts :

  • une sélection de plugins exposés « en vedette » dans un cadre en haut de la page,
  • la liste des plugins les plus utilisés dans les sites de la galaxie
  • la liste des plugins ayant récemment subis des modifications.

Comme la plupart des affichages de plugin, ces listes présentent, si cela a un sens, le nom, le slogan et la version la plus récente de chaque plugin.

La liste des plugins en vedette est soit déterminée manuellement par l’administrateur du site pour exposer une liste de plugins précis —en utilisant le plugin Mes Favoris, soit choisie au hasard à chaque recalcul de la page si aucune sélection n’est active.

La liste des plugins les plus utilisés est calculée suite à la mise à jour des statistiques d’utilisation des plugins par le plugin SVP Statistiques. Ce plugin se sert des données que collecte régulièrement le site stats.spip.org en scannant les sites SPIP sur le net.
Pour l’instant, seules les statistiques globales —toutes versions SPIP confondues— sont stockées et restituées par Plugins SPIP. Mais des évolutions sont prévues pour améliorer l’heuristique de calcul de cette liste afin de la rendre plus dynamique et cohérente avec la période observée.

La liste des plugins récemment mis à jour est identifiée en extrayant la date du dernier commit des plugins référencés sur le site. Cette date ne tient pas compte non plus de la version SPIP.

La page des plugins

Cette page présente une liste paginée, avec pour chaque plugin, un résumé composé du nom, du logo et du slogan. il est possible de trier cette liste alphabétiquement par nombre d’installations (tri par défaut), par nom du plugin ou par date de mise à jour.

Par défaut, cette liste propose les plugins de toutes les catégories, compatibles avec la dernière branche stable de SPIP. Néanmoins il est possible de filtrer cette liste suivant une catégorie donnée, une autre branche SPIP (ou d’étendre la sélection à toutes les branches) voire de filtrer sur un dépôts de plugin particulier.

La page d’un plugin

Cette page présente toutes les données disponibles sur un plugin, à savoir, les informations standard du plugin (nom, préfixe, slogan...) ainsi que la description détaillée de tous ses « paquets » (zip) classés par numéro de version décroissant.

Elle est composée de trois blocs d’informations :

  • la définition du plugin avec son nom, son slogan, sa catégorie, son préfixe ainsi que les données de mise à jour, d’utilisation et de compatibilité SPIP.
  • la description détaillée de chaque paquet dont seuls le numéro de version, l’état, la compatibilité et les boutons de téléchargement et de documentation sont visibles. Pour afficher la description détaillée (les auteurs, les mentions, l’archive, les dépendances, les traductions...), il faut cliquer sur le bouton « Afficher la description ». Ce bloc est hachuré si le paquet ne possède pas l’état « stable ».
  • la liste des dernières modifications et des derniers messages de forum —uniquement pour un plugin ayant actuellement sa documentation sur SPIP-Contrib— concernant le plugin. Ce bloc est positionné au dessus du pied de page et possède un fond de la couleur attribuée à la catégorie du plugin.

La page des téléchargements

Cette page est destinée à remplacer à terme l’adresse http://files.spip.org/spip-zone/ en améliorant la présentation des informations.

Elle affiche la liste des paquets de plugin disponibles classée par ordre alphabétique (avec un index pour un accès rapide). Chaque paquet est désigné par son nom d’archive —qui fait aussi office de lien de téléchargement— et informe sur sa version, sa date de mise à jour et sa compatibilité SPIP, permettant ainsi à l’utilisateur de choisir l’archive qui lui convient.

Il est possible de filtrer cette page par catégories, par branches SPIP et par dépôts, tous ces filtres étant cumulables.

Outre les plugins, cette page propose le téléchargement des contributions « non plugin » comme par exemple, certains squelettes, l’ensemble des thèmes Zpip ou Sarka-SPIP, les jeux d’icônes...

La page des dépôts

Cette page présente la liste des dépôts proposant des plugins sur le site Plugins SPIP. Pour chaque dépôt sont affichés le nombre de plugins et de paquets hébergés ainsi que la date de dernière mise à jour sur le site. Le lien du dépôt renvoie sur la page « Plugins » filtrée sur le dépôt choisi.

La recherche d’un plugin

Le site offre, sous son bandeau, un formulaire simple pour rechercher des plugins par mots-clés et pour une branche de SPIP donnée. La recherche s’effectue sur le préfixe, le nom, le slogan, l’auteur et la description d’un plugin.

Le résultat de la recherche est fourni en utilisant la page Plugins filtrée cette fois sur la liste des plugins répondant aux critères choisis. Si la recherche ne fournit aucun résultat cela peut être du au filtre de compatibilité : il est donc possible d’étendre simplement la recherche à toutes les branches SPIP.

La validation d’un paquet.xml

Il est possible de valider un paquet.xml d’un plugin en cours de développement en se rendant sur la page Valider un paquet.xml du site. A l’instar du validateur W3C, cette page permet de vérifier la conformité des paquet.xml, ce qui est prérequis au fonctionnement de tout plugin.

Il suffit de copier-coller le contenu du paquet.xml dans le formulaire proposé et d’effectuer les corrections en ligne jusqu’à sa validation. Le contenu valide peut être alors recopié dans le fichier d’origine.