Le dim. 29 sept. 2019 à 02:23, Ybbet SPIP a écrit :

> Salut à tous,
>
> Bonsoir tout le monde,

Me suis absenté quelques temps et je vois qu'il y a de la lecture ^^

Content de voir des réactions sur ce sujet.
>
> Gildas… Hum… Le lien que j’ai envoyé est le code source de la page
> consultable dans le BO. Oui, ceux sont des boucles SPIP. Ces boucles lisent
> les fichiers yaml du plugin Saisies (cf. /ecrire/?exec=saisies_doc). Et
> oui, pour consulter cette page, il faut avoir le plugin YAML installé. Mais
> c’est la même chose si on veut exploiter les fichiers YAML mis à
> disposition par le plugin Saisies. J’ai créé une fonction php qui va
> chercher les fichier yaml dans les répertoires saisies. (Pour vérifier, une
> fonction va cherche les fichiers yaml dans le répertoire verifier/)
>
> J'ai vu après coup ce que ça faisait (et l'intégration dans le menu
Développement) ^^
Vraiment pas mal, même si ça (la réalisation) reste un peu ésotérique pour
moi ^^

Pour beaucoup de ce que je lis c’est une documentation « développeur » et
> là… Je ne suis pas d’accord. Oui, de base les saisies sont utilisés pour
> générer des formulaires… Ah tiens… Formulaires ? Formidable ?
>
> Le plugin Formidable utilise toutes les saisies ayant un fichier
> html/yaml. De ce fait, cette page /ecrire/?exec=saisies_doc n’est pas
> destinée qu’aux développeurs mais également aux personnes créant des
> formulaires depuis l’espace privé de SPIP.
>
> Il n'y a pas si longtemps, cette page m'aurait été bien utile parce-que je
recherchais quels paramètres utiliser selon les différentes saisies que
j'avais, et que je n'avais pas accès au web. J'ai du sursoir mon travail en
attendant le retour à une connexion :-D

J’ai eu des clients qui ont eu besoin de cette page de documentation. Quand
> je parle de documentation, je ne parle pas d’un article sur SPIP-Contrib ou
> autre. Mais plus d’une page accessible depuis l’espace privé. Elle est
> présente pour des rédacteurs confirmés, voir des administrateurs. Je ne
> vois pas pourquoi les informations données par le fichier YAML pour générer
> une saisie (cf. Formidable) sont plus compréhensibles sous cette forme (à
> onglet entre autres) au lieu d’un texte « au kilomètre ». Ceux sont les
> même données, affichées différemment.
>
> Bon ça répond à mes questions de pour qui (webmestre) et pourquoi/comment
(page de "référence")
Et déjà je comprends que ce n'est pas le rédacteur de contenu (mais que ça
peut être utile aux rédacteurs avancés) ni le développeur (mot que je
n'aime pas car il regroupe trop de réalités qui ne sont pas égales)

[...] Les fichiers YAML de saisies sont utilisés pour construire la page
> /ecrire/?exec=saisies_doc et c’est compréhensible.
> Ces fichiers YAML sont des données structurées. Il nous suffit d’en faire
> ce que nous voulons.
> Le PHPDoc est documentation pour développeurs. Pas pour utilisateurs
> lambda.
>

Je ne suis pas entièrement d'accord ...parce-que le PHPDoc c'est des donnés
structurées aussi de mon point de vue. C'est juste un balisage plus
spécialisé pour couvrir un besoin existant en suivant le même chemin et
moyen d'expression que JavaDoc.
Si vraiment un utilisateur lambda peut comprendre :
=== exemple-y \==
- param:
  - type: str
  - name: foo
  - short: ma premiere variable
- param:
  - type: str
  - name: bar
  - short: ma second variable
=== exemple-y /==
...alors cet utilisateur lambda peut bien comprendre
=== exemple-p \ ==
@param str foo ma premiere variable
@param int bar ma seconde variable
=== exemple-p / ==
(encore que la syntaxe est plus riche que l'utilisation de tags puisque ça
peut comporter de la pure description avec quelques balises HTML)

[...] Le fait de mettre en place le couple html/yaml permet d’apporter de
> nouvelles possibilités d’utilisation. Oui, on est d’accord, il faut
> installer le plugin YAML. Mais ça devient une habitude pour tout le monde,
> non ? :-D
> (Je ne crée plus de sites sans l’ajout des plugins Saisies, Vérifier,
> YAML, SPIP Bonux et… Info SPIP)
>

Il y a encore des irréductibles gildas qui n'ont pas les habitudes dit de
tout le monde :-)
À moins d'utiliser en urgence un plugin qui me contraigne, je ne mets rien
de tout cela :-/ Et l'expérience montre que ce n'est pas plus mal (je n'ai
pas du temps à consacrer h24 à un site que je mets en place et c'est avec
les ruptures de compat de ces plugins que je me suis le plus pris le chou
au moment de monter de version de SPIP)

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

Répondre à