Serait il possible d’installer le plugin markdown dans contrib ?
Mon idée serait de créer un modèle SPIP pour inserer le contenu d’un fichier README.md d’un plugin de git.spip.net
Qu’en pensez vous ?
Je ne peux que être d’accord 
Readme et lien documentation - #3 par b_b & [spip-dev] Changer la gestion des catégories de plugin - #31 par b_b
1 « J'aime »
Ça devrait être faisable… cela dit je ne sais pas si le plugin markdown est très à jour ?
Le plugin s’appuie sur une lib pas très à jour je vois…
Je viens de faire un test, via le plugin markdown, c’est très facile de créer un modèle
cela donnerait ça (sans présager de la css de contrib) :
Par contre, quid du plugin markdown ?
pour avancer dans la discussion et faire des tests, j’ai ajouté un micro plugin qui ajoute un modèle pour afficher le README de gitea
ajoute un modèle pour afficher le README de gitea
Alors, il faudra revoir le code. Il faudra éviter de faire file_get_contents($url) sans cache à chaque affichage du modèle ! Et par ailleurs, allow_url_fopen n’est pas activé partout, il vaut mieux utiliser les fonctions dédiées, ie: recuperer_url ou copie_locale.
Merci @marcimat . pour mon POC, je ne m’étais pas poser ces questions ;-).
j’ai donc utilisé copie_locale, qui a l’avantage de gérer le cache du fichier.
Cette option a déjà été discuté il y a quelques mois.
C’est une idée mais ça va plus loin que juste l’affichage d’un readme.
Il faut prévoir comment l’intégrer dans la logique actuelle de la structure des plugins, de l’article par défaut, des rubriques plugin, etc.
Il faudrait alors s’attaquer vraiment à la refonte de Contrib pour y intégrer Plugins SPIP
Ya aussi recuperer_url_cache qui marche bien et permet un code très simple
Comme je le disais dans un des posts que je cite plus haut, on pourrait afficher le readme automatiquement quand un article de doc d’un plugin n’a pas de texte, ça serait déjà une première étape assez simple à mettre en place avant se lancer dans la refonte de contrib non ?
Un plugin sous Contrib est une rubrique, pas un article.
Il faut donc créer la rubrique en premier lieu.
Ensuite, il faudrait trouver une façon de choisir entre le readme et un article donné.
J’ai pas trop réfléchi mais je me rappelle qu’on en avait discuté et j’ai même le code de la récupération du readme dans le plugin de maintenance de contrib…
Ensuite, il faudrait trouver une façon de choisir entre le readme et un article donné.
Si on souhaite faire simple : créer un article de doc comme on le fait quand on souhaite rédier la doc depuis SPIP, laisser le texte vide, et zou récupération auto du readme ?
ça semble simple et rapide et ça permet d’avoir une structure opérationnelle sans aucun changement pour le jour où on souhaite faire une « vraie » documentation
[mode gros sabots on]
Au risque d’allumer une mèche, pourquoi ne pas imaginer rassembler le code et la documentation, ie utiliser les wiki de la Forge ?
[mode gros sabots off]
1 « J'aime »
Oui, et en plus tofulm nous propose un modèle qu’on peut essayer, adapter…
Gogogo
En fait, si on est bien d’accord sur le fait de suivre la structure actuelle, le plus simple c’est :
- on crée la rubrique-plugin (donc avec la saisie du préfixe comme cela est demandé)
- on crée un article que l’on identifie comme article principal (déjà en place)
- on remplit l’article avec un titre et un contenu réduit à un modèle readme
Et le jour où on se décide à faire un article complet on supprime le modèle pour le remplacer par du texte.
1 « J'aime »
Alors c’est pas ça qui est prévu depuis des années mais plutôt de rassembler Plugins SPIP et Contrib.
La structure actuelle de Contrib est déjà prévue pour ça, il « suffit » de créer les nouvelles pages.
Une ébauche textuelle a été élaborée ici : Fonctionnalité des nouvelles pages contrib.spip.net - HedgeDoc
Toutes les bonnes volontés seraient appréciées 
Il faut aussi se rappeler que Contrib ne contient pas que des plugins mais aussi le Carnet Wiki et d’autres rubriques de la vie de SPIP même si celles-ci deviennent de moins en moins utilisées.
mais ne peut on pas simplement laisser le texte vide ? ça permettrait qu’avec un truc style [(#TEXTE|sinon{#INCLURE{modeles/readme,plugin=#GET{prefixe_plugin}})] le modèle soit intégré automagiquement…
Surement, mais je trouve ça moins lisible et moins repérable à terme.
Le squelette est moins lisible, mais peu de monde le fréquente et ces personnes qui le fréquentent, expertes, ne seront pas gênées. Pour documenter un plugin, il est plus simple de laisser un article vide plutôt qu’insérer un code pour appeler un modèle (pour rendre cette manière de faire accessible il faudrait documenter à côté de la zone de saisie du texte genre « si vous ne mettez rien mettez ça : <....> »… pas cool)
KISS !