Le sam. 28 sept. 2019 12:25, RastaPopoulos a écrit :

Gildas, le YAML sert pas à aller le lire hein… il sert à afficher son
> contenu dans une page, donc bien pour les rédacs, d'où les squelettes
> qui l'affiche.


Si on veut... Je faisais juste remarquer que c'est un autre système de
balisage qui est justement plus facile à lire (en tout cas comparé à du
JSON ou autres formes de sérialisation, et pourtant on peut
programnaticalement le transformer en les autres) et accessoirement plus
léger (que du XML qui peut avoir les mêmes usages.)
Afficher du contenu dans une page est l'usage qui en est fait ici, mais je
l'utilise aussi par exemple pour de la configuration (avec TOML ce sont de
bons remplaçants des infâmes Ini, surtout pour décrire simplement des
transformations/traitements) ...et c'est bien l'usage qu'en fait Insérer
Modèles : dis moi les paramètres de ton modèle (le côté documentation) et
comment les traduire en formulaires saisies (qui génère l'affichage)
placées dans un cadre latéral. Sur le résultat, dans ce cadre ci, nous
sommes bien d'accord.

Quand aux docs, ou explications, c'est toujours mieux "in
> situ" qu'en devant aller les chercher/lire ailleurs, un manuel séparé,
> sur un autre site que là où on est en train d'écrire.


Cela me rappelle du coup que SPIP a un système d'aide (maintenant en plugin
et toujours dans la dist) extensible par les plugins... C'est aussi là une
source de documentation interne qui n'est pas exploité.

En théorie une
> interface ergonomique n'a pas besoin de doc, disons le moins possible en
> tout cas, et dès qu'il y a besoin, il faut toujours préférer la placer
> pile au bon endroit où la personne en a besoin.
>

C'est probablement pour ça que je n'ai jamais rien compris aux interfaces
dites ergonomiques [attention, c'est une perception personnelle et un
potentiel début de troll]


> Autant pour Saisies et Vérifier je vois pas trop l'intérêt car ce n'est
> que pour les développeurs.


Je suis contre l'idée que les développeurs n'ont pas besoin de doc ; ça
donne rarement de bons résultats...

Tiens, parlant de docs pour Saisies et Vérifier, je viens de voir que quand
ils sont installés et que j'active le menu Développement bah qu'ils ont
chacun leur entrée dans ce menu, et que leur page me réclame le plugin
YAML. Une fois fait, je retrouve la première partie (paramètre de chaque
saisie) de https://contrib.spip.net/Reference-des-saisies et (idem)
https://contrib.spip.net/Reference-des-verifications D'ailleurs, comment
sont générées ces pages du privée et est-ce que ça peut se généraliser à
d'autres plugins facilement ? C'est fait avec le "_doc.html" initialement
mentionné ?

Mais pour les modèles là c'est important que
> les rédacteurs puissent savoir *au moment d'écrire*, ce qu'ils ont à
> disposition, quels sont les paramètres possibles, etc.


Donc, il faudrait que les auteur(e)s de plugin qui proposent des modèles
ajoutent également le .yaml pour Insérer Modèles et croisent les doigts
pour que les surcharges restent compatibles.

Ceci dit, on voit bien l'importance de définir la cible (pour toi il ne
s'agit que des rédacteur(e)s alors qu'une autre personne pourrait penser
qu'on s'adresse aux gens qui utilisent la balise #MODELE{} etc.)
Et bien définir le besoin (s'il s'agit de l'aide à la rédaction ou de
l'amélioration du plugin d'insertion des modèles, ce n'est pas pareil que
de vouloir recenser tous les modèles existants partout comme je l'avais
compris) :-D

On ne devrait
> jamais devoir partir lire ailleurs pour savoir ça, je suis assez d'accord.
>
> --
> RastaPopoulos
>
> ----
> 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 à