[SPIP Zone] Plugins SPIP, Contrib et Autodoc des plugins sont dans un bateau...

Hello,

Un récapitulatif des mises à jour faites et à faire pour améliorer la synchronisation et surtout les liens entre les 3 sites mentionnés.
Le but faire en sorte que la documentation de chaque plugin soit accessible depuis chacun des sites.

  1. Premier sujet le lien de Contrib vers la page du plugin sur Plugins SPIP : la synchronisation a été rétablie par Maieul.
    => @nicod_ : il faudrait afficher à nouveau ce lien et l’endroit le plus approprié serait le bloc du plugin à droite de la page.

  2. Ensuite, sur Plugins SPIP il arrivait que les messages de forums d’une page de plugin soient incohérents avec le plugin. Cela se produisait si l’URL du lien de doc était de la forme https://contrib.spip.net/4556 ou faisait référence à une rubrique.
    Pour corriger cela j’ai modifié le code du squelette pour, dans le premier cas, modifier l’url à la volée en https://contrib.spip.net/article4556 et dans le deuxième cas ne rien afficher.
    J’ai aussi remplacé dans les 7 plugins concernés le lien vers la rubrique par un lien vers l’article le plus représentatif.
    Donc aujourd’hui le bloc des messages de forums devrait soit être vide soit être cohérent. Si il existe encore des pbs, m’en faire part.

  3. Ce qu’il manque dans Plugins SPIP :
    Sur une page de plugin on a donc le lien de documentation si il existe, le RSS des commits et le RSS des messages de forum si une doc existe dans Contrib.
    Il ne manque plus que l’Autodoc des plugins (PHPDoc).
    Pour cela il faut trouver une façon de lire le fichier autodoc.txt d’une façon ou d’une autre @eric @marcimat

  4. Ce qu’il manque à Contrib :
    Outre le lien vers Plugins SPIP qu’il faut réafficher, il manque le préfixe du plugin et aussi le lien vers l’Autodoc des plugins.
    Ce qui serait pas mal c’est de rajouter ces informations dans le bloc de droite où l’on trouve déjà la compat et les zips.
    Pour l’autodoc, un champ extra dans l’article suffirait et une mise à jour manuelle car la liste est limitée.
    Pour le préfixe on pourrait se baser sur l’url de Plugins SPIP car elle est basée sur le préfixe (basename).
    => @nicod : pourrais tu faire un essai de ce nouveau bloc stp ?

Je dirais aussi que je séparerais bien de ce bloc la liste des articles de la même rubrique et surtout je les afficherais tous !
En effet, on en affiche 5 et quand il y en a plus ça pose un problème pour la navigation (voir Saisies par exemple).

Enfin, je me pose la question de l’intérêt de la liste interminable des rubriques.
Je m’en sert jamais, surtout pour aller chercher un plugin.
Et si je veux chercher autre chose et bien ça me désespère cette liste.
Revoir le but de cette liste serait intéressant.

  1. Ce qu’il manque à Autodoc des plugins :
    Dans la liste des plugins on a les deux liens vers Contrib et Plugins SPIP (documentation et annuaire).
    Mais on perd ses liens quand on navigue dans pages du plugin.
    => @marcimat : ça serait bien d’avoir un bloc (préfixe, doc et annuaire) dans chaque page en haut à droite par exemple.

  2. Catégories des plugins :
    C’est la proposition de Rasta et nicod, revoir cette liste.
    J’ai fourni un fichier qui récapitule l’association plugin - catégorie actuelle.
    Reste à faire une proposition alternative qui puisse être répercutée dans Contrib.
    => qui se lance ?

Voilà l’état des lieux et quelques demandes de modifications.
On avance sur ces points déjà ?

Le 16/03/2019 à 15:06, Eric Lupinacci a écrit :

4) Ce qu'il _manque à Contrib _:
Outre le lien vers Plugins SPIP qu'il faut réafficher, il manque le préfixe du plugin et aussi le lien vers l'Autodoc des plugins.
Ce qui serait pas mal c'est de rajouter ces informations dans le bloc de droite où l'on trouve déjà la compat et les zips.
Pour l'autodoc, un champ extra dans l'article suffirait et une mise à jour manuelle car la liste est limitée.
Pour le préfixe on pourrait se baser sur l'url de Plugins SPIP car elle est basée sur le préfixe (basename).
=> @nicod : pourrais tu faire un essai de ce nouveau bloc stp ?

Je dirais aussi que je séparerais bien de ce bloc la liste des articles de la même rubrique et surtout je les afficherais tous !
En effet, on en affiche 5 et quand il y en a plus ça pose un problème pour la navigation (voir Saisies par exemple).

Ça, c'est fait, sauf l'autodoc.
Pour le préfixe, on utilise #URL_SITE|basename (si l'url contient plugins.spip.net), reste à voir s'il y a des erreurs.

Enfin, je me pose la question de l'intérêt de la liste interminable des rubriques.
Je m'en sert jamais, surtout pour aller chercher un plugin.
Et si je veux chercher autre chose et bien ça me désespère cette liste.
Revoir le but de cette liste serait intéressant.

Certes, mais la supprimer complètement serait problématique aussi, on ne pourrait plus naviguer du tout à part avec le moteur de recherche, qui est... très bavard.

--
nicod_

Cette liste (effectivement interminable actuellement) correspond à une hiérarchie de rubriquage trop aplatie ! Je pense que la réorg. de l’arborescence améliorera naturellement…

Le 16/03/2019 à 16:33, nicod_ a écrit :

Ça, c'est fait, sauf l'autodoc.

Hop, le lien d'autodoc est intégré, si la case est cochée sur l'article (champs extra Autodoc), ça génère l'url à partir du préfixe.

--
nicod_

Génial !

On vient de clore les points 1), 2) et 4).
Go go go.

Je viens d’ajouter l’autodoc sur Contrib pour les plugins qui possèdent donc une doc et un PHPDoc.
Ca fonctionne bien.
Reste à voir à l’usage surtout quand certains plugins possèdent plusieurs articles.

Hop,

Le 16/03/2019 à 17:16, Eric Lupinacci a écrit :

Génial !

On vient de clore les points 1), 2) et 4).
Go go go.

Grande classe, merci à vous deux pour ces améliorations :slight_smile:

++
b_b

Le 16/03/2019 à 19:47, Bruno Bergot a écrit :

Grande classe, merci à vous deux pour ces améliorations :slight_smile:

Je n'ai fait que tenir la truelle, c'est Eric qui a suggéré toutes ces améliorations :slight_smile:

--
nicod_

Juste une remarque (car je n’ai pas fait le lien immédiatement avec l’apparition d’un texte supplémentaire en fin d’article) :

cgnjkcnhlhlbkfob.png

Hello,

cgnjkcnhlhlbkfob.png

OK ce n'est que dans l'espace privé (j'ai aussi tellement l'habitude d'y etre que..)
désolé pour l'interruption/bruit.

Le 17/03/2019 à 09:59, YannX SPIP a écrit :
Le 16/03/2019 à 18:32, Eric Lupinacci a écrit :
Je viens d'ajouter l'autodoc sur Contrib pour les plugins qui possèdent donc une doc et un PHPDoc.
Ca fonctionne bien.
Reste à voir à l'usage surtout quand certains plugins possèdent plusieurs articles.

++
Eric

Le sam. 16 mars 2019 à 17:16, Eric Lupinacci <eric@smellup.net<mailto:eric@smellup.net>> a écrit :
Génial !

On vient de clore les points 1), 2) et 4).
Go go go.

++
Eric

Le sam. 16 mars 2019 à 16:57, nicod_ <nicod@lerebooteux.fr<mailto:nicod@lerebooteux.fr>> a écrit :
Le 16/03/2019 à 16:33, nicod_ a écrit :

Ça, c'est fait, sauf l'autodoc.

Hop, le lien d'autodoc est intégré, si la case est cochée sur l'article
(champs extra Autodoc), ça génère l'url à partir du préfixe.

Juste une remarque (car je n'ai pas fait le lien immédiatement avec l'apparition d'un texte supplémentaire en fin d'article) :

-> pourquoi ne pas conditionner cet affichage à un simple [(#AUTODOC|oui) .... ??
           Parce que vraiment, coller d'autorité un tel placard sur des articles complètement hors plugins me choque !

Exemple:

[cid:part4.AA5C8C39.5910A677@hotmail.fr]

Ensuite, si l'idée évoquée hier soir de typer des natures d'articles s'inscrit dans des mots-clés,
     on pourrait affiner ...

--
YannX

[https://ipmcdn.avast.com/images/icons/icon-envelope-tick-round-orange-animated-no-repeat-v1.gif\]<Sécurité des e-mails Mac | Avast; Garanti sans virus. www.avast.com<Sécurité des e-mails Mac | Avast;

--
YannX

cgnjkcnhlhlbkfob.png

Salut,

je ne suis pas convaincu de l'ajout des commits dans le bloc d'infos du plugin.

Ça occupe de la place et ça fait descendre la navigation vers les autres articles encore plus bas, alors que ce bloc est important aussi.
En afficher juste 3 n'est pas assez, en afficher plus serait pire.
On avait justement fait le choix de les retirer lors de la refonte pour ces raisons.

On a le lien vers le code source, qui permet d'aller les lire là bas, ça me parait suffisant pour qui s'y intéresse.

Ce qu'on peut conserver par contre, c'est la date du dernier commit, juste en dessous du lien vers la zone, entre parenthèses et en <small>.

--
nicod_

Yo,

Yop,

En effet, les commit en pied d’article c’est mieux car le lien vers la zone suffit largement avec pourquoi pas en small la date du dernier commit comme dit nicod_

Une autre solution pour gagner un peu de place : plutôt que des blocs <h2> + <a href="https://…">https://…</a>, on pourrait faire un seul bloc <h2>Liens utiles<h2>, et y mettre la liste des liens en mettant le libellé dans le a : <a href="https://…">Annuaire des plugins</a> etc.

Du coup, on pourrait mettre le lien vers le code source :
https://zone.spip.net/trac/spip-zone/browser/spip-zone/plugins/saisies
et le lien vers les commits :
https://zone.spip.net/trac/spip-zone/log/spip-zone/plugins/saisies

--
nicod_

Re,

Le dim. 17 mars 2019 à 15:36, nicod_ <nicod@lerebooteux.fr> a écrit :

Une autre solution pour gagner un peu de place : plutôt que des blocs

+ https://..., on pourrait faire un seul bloc

Liens utiles

, et y mettre la liste des liens en mettant le libellé dans le a : Annuaire des plugins etc.

Du coup, on pourrait mettre le lien vers le code source :
https://zone.spip.net/trac/spip-zone/browser/spip-zone/plugins/saisies
et le lien vers les commits :
https://zone.spip.net/trac/spip-zone/log/spip-zone/plugins/saisies

Bof.
Je trouve le bloc très lisible comme il est là.
Je serais d’avis de juste enlever les commits.

++

Eric

Le dimanche 17 mars 2019 à 15:06 +0100, nicod_ a écrit :

Salut,

je ne suis pas convaincu de l'ajout des commits dans le bloc d'infos
du
plugin.

Ça occupe de la place et ça fait descendre la navigation vers les
autres
articles encore plus bas, alors que ce bloc est important aussi.
En afficher juste 3 n'est pas assez, en afficher plus serait pire.
On avait justement fait le choix de les retirer lors de la refonte
pour
ces raisons.

On a le lien vers le code source, qui permet d'aller les lire là bas,
ça
me parait suffisant pour qui s'y intéresse.

Ce qu'on peut conserver par contre, c'est la date du dernier commit,
juste en dessous du lien vers la zone, entre parenthèses et en
<small>.

ouais, sur les commits j'ai pas d'avis. Mais en plein milieu du bloc
principal, ca fait vraiment bizzare, car ca interrompt une doc
utilisateur pour un truc technique.

Du coup je propose de ne garder nul part le liens vers les commits, et
juste mettre la date de dernier commit (mais est-ce utile, sachant que
par ailleurs on a le numéro de version qui est actualisé).

L'avantage de ne pas actualiser est qu'on évite des requetes RSS depuis
contrib, donc c'est plus ecolo.

Le 17/03/2019 à 15:38, Eric Lupinacci a écrit :

Je trouve le bloc très lisible comme il est là.
Je serais d'avis de juste enlever les commits.

Par soucis d'accessibilité mais pas seulement, est-ce que sémantiquement
ce bloc d'infos sur le plugin ne serait pas plus pertinent en encart
flottant dans le corps de l'article plutôt que dans la colonne de
navigation latérale ? Par exemple entre le titre et le chapeau de
l'article ?...

(en mode texte ce bloc d'infos se retrouve tout en bas, alors que les
révisions apparaissent quant à elles dans le corps de l'article...
peut-être indiquer au moins le titre «caractéristiques du plugin»)

fred

Le 17/03/2019 à 16:09, homere1974 via spip-zone a écrit :

Par soucis d'accessibilité mais pas seulement, est-ce que sémantiquement
ce bloc d'infos sur le plugin ne serait pas plus pertinent en encart
flottant dans le corps de l'article plutôt que dans la colonne de
navigation latérale ? Par exemple entre le titre et le chapeau de
l'article ?...

(en mode texte ce bloc d'infos se retrouve tout en bas, alors que les
révisions apparaissent quant à elles dans le corps de l'article...
peut-être indiquer au moins le titre «caractéristiques du plugin»)

Bonne remarque.
Un lien d'évitement, masqué sur écran mais utilisable en synthèse vocale au début de l'article, pourrait être utile.

--
nicod_

Le 17/03/2019 à 16:07, Maïeul Rouquette a écrit :

Du coup je propose de ne garder nul part le liens vers les commits, et
juste mettre la date de dernier commit (mais est-ce utile, sachant que
par ailleurs on a le numéro de version qui est actualisé).

Ça indique juste si le développement sur le plugin est actif, mais ça ne me parait pas une info capitale.
Tout ce bloc doit vraiment être synthétique, on peut avoir plus d'infos avec les différents liens.

--
nicod_