Salut Teddy :)

Je cherche une solution me permettant de faire une petite documentation
> "automatique" des modèles disponibles sur un site SPIP.
>

Alors, qu'entends-tu par "documentation" ? Ou plus précisément, quel public
vise-tu et pour quel usage ? (je sais que dit comme ça, c'est un peu
cavalier mais ce qui est clair pour toi ne l'est pas forcément pour les
autres)


> 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
> )
>
> Là par exemple, j'aurais pas deviné que c'est de la doc... au vu du format
(fichier HTML avec des boucles et balises SPIP) et l'emplacement (un
répertoire squelettes) j'aurais pensé que c'est une noisette ...pour le
privé.


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

C'était le but des modèles il me semble : pouvoir foisonner et se
démultiplier presque viralement (ce que proposent les plugins n'étant que
des exemples pouvant être surchargés...)
https://www.spip.net/fr_article3454.html ^^ Donc il ne saurait y avoir de
lieu/plugin recensant tous les modèles dans la nature.
Les modèles étant découverts à la volée (ils ne sont pas "déclarés" par
quelque "pipeline" mais recherchés dans un "chemin" donné quand ils sont
rencontrés dans le corps du texte) je doute qu'on puisse faire du
recensement valide (en dehors d'avoir la liste des modèles découverts sur
une installation)

>
> 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).
> [...]
> 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.
>

De mon point de vue, "Insérer modèles" est aux modèles ce que "Saisies" est
aux formulaires ou "Champs-Extras" aux tables/objets... (qui s'appuient
aussi sur du YAML j'ai cru voir)
Personne n'a jamais eu besoin d'un champ descriptif je pense, mais ça
devrait pouvoir se rajouter. facilement.
Pour en revenir au sujet, je ne le voyais pas comme de la doc non plus (bon
c'est vrai que le format YAML est auto-descriptif et amicalement-humain,
mais du coup, comme "doc", c'est plutôt un "mémento" pour les ceux qui
lisent les fichiers sources... le plugin se basant sur cette doc pour
générer un assistant de saisie, pas un didacticiel sur le modèle...)

Pour moi, une "documentation" de modèle, à destination des rédacteurs (car
moi je préfère aller voir le code et le modifier pour adapter à mes
besoins) seraient plutôt comme (on y décrit tous les paramètres du point de
vue utilisateur) :
- https://contrib.spip.net/Plugin-Modeles-media
- https://contrib.spip.net/Modele-doc-unifie
-
https://contrib.spip.net/Cite-des-modeles-pour-les-references-bibliographiques
- https://contrib.spip.net/Modele-exergue
- etc.

>
> 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 ?
> C'est du travail, certes. Mais cela permettrait d'avoir facilement la
> connaissance des modèles disponibles sur un site SPIP. On pourra ainsi
> reprendre la mécanique de page de doc : ercire/?exec=modeles_doc
>
> Des avis sur le sujet ? :-)
>
> Spipement,
>
> Teddy aka Ybbet
>
>
----
spip-zone@rezo.net - https://listes.rezo.net/mailman/listinfo/spip-zone

Répondre à