Le sam. 28 sept. 2019 14:19, Eric Lupinacci a écrit :

> Re,
>
>
> Le ven. 27 sept. 2019 à 13:14, Ybbet Spip a écrit :
>
>>
>> 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.
>

Comme le faisait remarquer Rasta plus tôt, la finalité n'est pas à
proprement dit de faire de la documentation (bien que là dessus YAML
rejoigne PHPDoc ici, ou plus généralement le XML) mais d'afficher une
assistance de saisie (un peu comme les boutons du Porte-Plume finalement,
mais avec une boîte de dialogue de paramètres)

Surtout pour donner des informations presque inutiles comme le titre et
> l'icone.
>

D'où ma comparaison avec le Porte-Plume. Comme tous les trucs de
l'interface de rédaction, il faut bien une image (sauf que, les modèles
n'étant pas forcément liés à un plugin on ne peut pas envisager d'utiliser
les logos de plugin par exemple, et puis on peut avoir plusieurs modèles
qui ont besoin d'être différencié visuellement) et un nom/titre (pratique
quand on n'affiche pas les images ou quand on a des icônes similaires...)

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.
>

Je trouve que les deux approches se valent : dans tous les cas il faut bien
décider où trouver les infos (et là effectivement ta solution me plaît
mieux car je n'ai pas deux fichiers à maintenir haha) et leur formalisme
(et avec YAML c'est visiblement plus simple tu trouves pas ?)


> 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.
>

En soit ce n'est pas un vrai souci :-) Ceux qui en ont besoin installeront
le plugin qui va bien en attendant que ça rentre dans le Coeur (cf. Cfg et
Bonus)
Mais avant (d'en arriver à l'intégration dans le Core) il faut débattre
pour obtenir une convention utile à tous (dans ton exemple précédent le
PHPDoc doit être peaufiné pour qu'au "parsing" du fichier on puisse
reconnaître que c'est relatif à un modèle et qu'on ait aussi toutes les
informations pour déduire les saisies qui vont bien...)


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

Répondre à