Re,

Le ven. 27 sept. 2019 à 13:14, Ybbet Spip <teddy.s...@gmail.com> a écrit :

> Bonjour à tous,
>
> Je cherche une solution me permettant de faire une petite documentation
> "automatique" des modèles disponibles sur un site SPIP. De préférence une
> solution un peu comme ce que j'ai mis en place dans le plugin Saisies (cf.
> https://zone.spip.net/trac/spip-zone/browser/spip-zone/_plugins_/saisies/trunk/prive/squelettes/contenu/saisies_doc.html)
> ou encore le plugin Vérifier (cf.
> https://zone.spip.net/trac/spip-zone/browser/spip-zone/_plugins_/verifier/trunk/prive/squelettes/contenu/verifier_doc.html
> )
>
> Pour les modèles, il n'y a rien qui est mis en place pour le moment,
> sachant que dans ce cas, il n'y a pas de plugin "Modèles". Chaque plugin
> distribué peut proposer ses propres modèles.
>
> Le plugin "Insérer les modèles" demande à ce que si l'on désire qu'un
> modèle puisse être insérer par son interface, ledit modèle doit avoir un
> fichier "modele.yaml" correspondant (le fameux couple html/yaml).
> Le fichier yaml indique :
> - Le nom du modèle ;
> - un logo ;
> - une icône pour la barre d'édition ;
> - la liste des paramètres pouvant être passés au modèle.
> cf.
> https://contrib.spip.net/Comment-declarer-un-modele-pour-le-plugin-Inserer
> Il lui manquerait peut-être un champ descriptif pour avoir quelque chose
> de plus didacticiel.
>

Bof, je vois vraiment l'intérêt d'un fichier YAML pour faire de la
documentation.
Surtout pour donner des informations presque inutiles comme le titre et
l'icone.
Ce qui est utile pour un modèle ou plus généralement une inclusion c'est
les paramètres.
C'est pour ça qu'une en-tête à la PHPDoc me parait nettement plus adaptée.



>
> La communauté SPIP va sur une utilisation généralisée des fichiers YAML.
> Est-ce qu'il est envisageable de mettre ce couple modeles/fichier.html +
> modeles/fichier.yaml en place pour l'ensemble des modèles ?``
>

Euh bof sur le YAML.
Il demande à utiliser une librairie spéciale qui n'est même pas intégrée
nativement dans le Core.

++
Eric
----
spip-zone@rezo.net - https://listes.rezo.net/mailman/listinfo/spip-zone

Répondre à