Y a-t-il une manière générique d’afficher l’aide d’un plugin sur les pages qui le concernent (par exemple page de config) ?
Il y a une API pour étendre l’aide intégrée de SPIP (http://www.spip.net/fr_article4727.html) mais à ma connaissance assez peu utilisée. Néanmoins, dans le cadre d’un plugin qui sera utilisé essentiellement par le webmaster, il n’y a pas forcément besoin de doublonner avec la documentation du plugin sous Contrib.
Donc, à moins qu’une solution n’existe déjà (il y a tellement de features cachées dans SPIP), et maintenant que l’espace privé est sous forme de squelette, ne serait pas intéressant que le core fournisse une balise du type #CADRE_DOCUMENTATION_PLUGIN{prefixe}.
Cette dernière pourrait être utilisée dans les colonnes extra des pages de l’espace privée. Elle renverrai un cadre avec les CSS adéquates, un beau logo d’aide et un texte comme :
Pour plus d’informations sur le fonction du plugin Nom du plugin, n’hésitez pas à consultation sa documentation en ligne (cliquable).
Le nom du plugin et l’URL de sa page de doc étant déterminés automatiquement à partir du préfixe du plugin et du contenu de paquet.xml.
Est-ce une idée farfelue ou ça vous semble pertinent ?
C’est tout à fait ça. L’idée serait de ne pas avoir à refaire le modèle à chaque fois. D’où le fait de le fournir directement dans le core. Ca évite de recopier 20 fois un même fichier.
Après, personnellement, il me semble que le terme Documentation ou Documentation en ligne me semble plus pertinent que En savoir plus pour clairement savoir qu’on y trouvera une info d’utilisation.
Je rajouterai éventuellement le nom du plugin (voir son icône) au début du cadre, car le nom du plugin n’est pas forcément le titre de la page.
C’est tout à fait ça. L’idée serait de ne pas avoir à refaire le modèle à chaque fois. D’où le fait de le fournir directement dans le core. Ca évite de recopier 20 fois un même fichier.
Oui, il faudrait voir avec cedric ce qu’il en pense.
Après, personnellement, il me semble que le terme Documentation ou Documentation en ligne me semble plus pertinent que En savoir plus pour clairement savoir qu’on y trouvera une info d’utilisation.
Aucun souci c’est le terme actuel pour la liste des plugins que j’ai repris
Je rajouterai éventuellement le nom du plugin (voir son icône) au début du cadre, car le nom du plugin n’est pas forcément le titre de la page.
Oui je l’ai enlevé dans mon cas car c’est le titre de ma page Si on standardise pas de souci.
Si on standardise pas de souci.