[SPIP Zone] [Spip-zone-commit] r112644 - in _plugins_/noizetier_doc/trunk

Hello,

Je comprends pas bien ce plugin.
D’où vient la documentation et d’ailleurs de quelle documentation parle-t-on ?
Pourquoi ces fichiers dans saisies-doc/ ?

Si on devait faire de la documentation ça ne serait pas mieux d’en écrire une « vraie » ?
Le fait de générer une doc plus ou moins à partir du code (si c’est bien ça le but) doit être utilisé avec précaution car cela amène à se dire qu’on peut toujours tout modifier avant d’y réfléchir.
J’ai personnellement du mal à utiliser la doc de saisies qui est accessible dans le privé car elle n’est pas assez explicite.
C’est plus un pense-bête pour ceux qui savent déjà bien utiliser Saisies qui d’ailleurs évolue souvent.

Le 06/12/2018 à 09:17, Eric Lupinacci a écrit :

Hello,

Je comprends pas bien ce plugin.
D'où vient la documentation et d'ailleurs de quelle documentation parle-t-on ?
Pourquoi ces fichiers dans saisies-doc/ ?

Si on devait faire de la documentation ça ne serait pas mieux d'en écrire une "vraie" ?
Le fait de générer une doc plus ou moins à partir du code (si c'est bien ça le but) doit être utilisé avec précaution car cela amène à se dire qu'on peut toujours tout modifier avant d'y réfléchir.
J'ai personnellement du mal à utiliser la doc de saisies qui est accessible dans le privé car elle n'est pas assez explicite.
C'est plus un pense-bête pour ceux qui savent déjà bien utiliser Saisies qui d'ailleurs évolue souvent.

Hello

Je pense que le but ici est de lister/documenter les noisettes disponibles d'un squelette personnel, ou distribution ( a ce stade on peut dire ça),

tout comme pour les saisies… pas d'apporter une documentation développeur ou utilisateur

j'ai pleins de saisies (sur mesure) souvent réparties dans des plugins , mais des fois dans le plugin/sqkel d'un projet

cette page me permet de savoir quand je reprend un projet composé de 50 a 65 plugins d'avoir un etat des lieux

j'ai la mm chose pour mes modèles et mes css/js

--
Bonne journée
Arnaud B. (Mist. GraphX)

Le 06/12/2018 à 10:44, Mist. GraphX a écrit :

Le 06/12/2018 à 09:17, Eric Lupinacci a écrit :

Hello,

Je comprends pas bien ce plugin.
D'où vient la documentation et d'ailleurs de quelle documentation parle-t-on ?

en fait peut être que le mot inventaire serait plus exact que documentation

--
Bonne journée
Arnaud B. (Mist. GraphX)

Le jeu. 6 déc. 2018 à 10:50, Mist. GraphX <arnaud.berard@mister-graphx.com> a écrit :

Le 06/12/2018 à 10:44, Mist. GraphX a écrit :

Le 06/12/2018 à 09:17, Eric Lupinacci a écrit :

Hello,

Je comprends pas bien ce plugin.
D’où vient la documentation et d’ailleurs de quelle documentation
parle-t-on ?

en fait peut être que le mot inventaire serait plus exact que documentation

Oui, c’est bien ça. Lister les noisettes (dans le cadre de ce présent plugin) présents sur le site. Y compris celles offertes par des plugins maison.
Donc, une documentation en ligne sur contrib ne pourra jamais prendre cet aspect en compte.

Les fichiers dans « saisies-doc/ » sont les équivalents de saisies/xxx.html mais affichant les informations de paramétrage de la saisie. La « documentation ».
J’ai utilisé une fonction reprenant une partie du code de la fonction saisies_generer_aide() pour construire le contenu des fichiers saisies-doc/xxx.html
cf. https://zone.spip.net/trac/spip-zone/browser/spip-zone/plugins/saisies/trunk/inc/saisies.php#L601
https://zone.spip.net/trac/spip-zone/browser/spip-zone/plugins/noizetier_doc/trunk/noizetier_doc_fonctions.php#L15

Pour le terme « inventaire », je ne suis pas si sûr que ça. Car pour moi, un inventaire doit également te dire qui utilise telle ou telle noisette.
Exemple: la noisette XX est utilisée par la composition AA, BB, ZZ, etc.

Pour le répertoire saisies-doc/ je ne voulais pas modifier le plugin saisies tant que le concept n’est pas compris/stabilisé.
On pourra reporter dans le plugin saisies les fichiers qui sont offerts par le plugin officiel.
Le plugin annexe « noizetier_doc » étant un helper, il peut se permettre d’avoir l’ensemble des « saisies-doc » des plugins de la communauté. (exemple : formulaire-formidable, https://zone.spip.net/trac/spip-zone/browser/spip-zone/plugins/formidable/trunk/saisies/)

Toutefois, si le concept est adopté par la communauté, je verrais pour intégrer ce dev dans chaque plugin (Saisies, Noizetier, etc.). Il suffira à chaque développeur de plugin de créer le fichier saisies-doc/trucmuch.html dans son propre plugin pour que cela soit pris en compte.

Amicalement,


Bonne journée
Arnaud B. (Mist. GraphX)


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

re

Le jeu. 6 déc. 2018 à 09:17, Eric Lupinacci <eric@smellup.net> a écrit :

Hello,

Je comprends pas bien ce plugin.
D’où vient la documentation et d’ailleurs de quelle documentation parle-t-on ?
Pourquoi ces fichiers dans saisies-doc/ ?

Si on devait faire de la documentation ça ne serait pas mieux d’en écrire une « vraie » ?

Ce n’est justement par une « vraie » documentation utilisateur. Cette documentation ci est plus factuelle que littéraire. c’est un principe que j’utilise depuis un moment :
https://www.teddypayet.com/SPIP-Documentation-technique-nomenclature

https://www.teddypayet.com/SPIP-Documentation-technique-construction-des-pages

https://www.teddypayet.com/SPIP-Documentation-technique-mise-en-conformite

Le fait de générer une doc plus ou moins à partir du code (si c’est bien ça le but) doit être utilisé avec précaution car cela amène à se dire qu’on peut toujours tout modifier avant d’y réfléchir.

Là, c’est moi qui ne comprend ta partie « car ». :slight_smile:

J’ai personnellement du mal à utiliser la doc de saisies qui est accessible dans le privé car elle n’est pas assez explicite.
C’est plus un pense-bête pour ceux qui savent déjà bien utiliser Saisies qui d’ailleurs évolue souvent.

C’est également son but : un pense-bête. La page est construite à partir des infos contenu dans le fichier yaml fourni avec son équivalent html.
C’est le principe de la fonction saisies_lister_disponibles https://zone.spip.net/trac/spip-zone/browser/spip-zone/plugins/saisies/trunk/inc/saisies_lister.php#L336

++
Eric

Le jeu. 6 déc. 2018 à 01:59, <spip-zone-commit@rezo.net> a écrit :

Author: teddy.spip@gmail.com
Date: 2018-12-06 00:59:03 +0000 (Thu, 06 Dec 2018)
New Revision: 112644

Added:
plugins/noizetier_doc/trunk/lang/
plugins/noizetier_doc/trunk/lang/noizetier_doc_fr.php
plugins/noizetier_doc/trunk/lang/paquet-noizetier_doc_fr.php
plugins/noizetier_doc/trunk/noizetier_doc_autorisations.php
plugins/noizetier_doc/trunk/noizetier_doc_fonctions.php
plugins/noizetier_doc/trunk/paquet.xml
plugins/noizetier_doc/trunk/prive/
plugins/noizetier_doc/trunk/prive/squelettes/
plugins/noizetier_doc/trunk/prive/squelettes/contenu/
plugins/noizetier_doc/trunk/prive/squelettes/contenu/noisettes_doc.html
plugins/noizetier_doc/trunk/prive/squelettes/navigation/
plugins/noizetier_doc/trunk/prive/squelettes/navigation/noisettes_doc.html
plugins/noizetier_doc/trunk/prive/style_prive_plugin_noizetier_doc.html
plugins/noizetier_doc/trunk/prive/themes/
plugins/noizetier_doc/trunk/prive/themes/spip/
plugins/noizetier_doc/trunk/prive/themes/spip/images/
plugins/noizetier_doc/trunk/prive/themes/spip/images/noizetier_doc-12.png
plugins/noizetier_doc/trunk/prive/themes/spip/images/noizetier_doc-128.png
plugins/noizetier_doc/trunk/prive/themes/spip/images/noizetier_doc-16.png
plugins/noizetier_doc/trunk/prive/themes/spip/images/noizetier_doc-24.png
plugins/noizetier_doc/trunk/prive/themes/spip/images/noizetier_doc-32.png
plugins/noizetier_doc/trunk/prive/themes/spip/images/noizetier_doc-64.png
plugins/noizetier_doc/trunk/saisies-doc/
plugins/noizetier_doc/trunk/saisies-doc/case.html
plugins/noizetier_doc/trunk/saisies-doc/checkbox.html
plugins/noizetier_doc/trunk/saisies-doc/couleur.html
plugins/noizetier_doc/trunk/saisies-doc/date.html
plugins/noizetier_doc/trunk/saisies-doc/explication.html
plugins/noizetier_doc/trunk/saisies-doc/fieldset.html
plugins/noizetier_doc/trunk/saisies-doc/formulaire_formidable.html
plugins/noizetier_doc/trunk/saisies-doc/groupe_mots.html
plugins/noizetier_doc/trunk/saisies-doc/hidden.html
plugins/noizetier_doc/trunk/saisies-doc/input.html
plugins/noizetier_doc/trunk/saisies-doc/menu.html
plugins/noizetier_doc/trunk/saisies-doc/mot.html
plugins/noizetier_doc/trunk/saisies-doc/oui_non.html
plugins/noizetier_doc/trunk/saisies-doc/radio.html
plugins/noizetier_doc/trunk/saisies-doc/selecteur.html
plugins/noizetier_doc/trunk/saisies-doc/selecteur_document.html
plugins/noizetier_doc/trunk/saisies-doc/selecteur_rubrique.html
plugins/noizetier_doc/trunk/saisies-doc/selecteur_site.html
plugins/noizetier_doc/trunk/saisies-doc/selection.html
plugins/noizetier_doc/trunk/saisies-doc/textarea.html
plugins/noizetier_doc/trunk/saisies-doc/url.html
Log:
Et voilà le plugin. Plugin autonome en vu des changements dans noizetier en cours (pas encore testé la v3).
De ce fait, on peut mettre si besoin dans saisies-doc tous les équivalents des fichiers html du répertoire saisies/ des différents plugins de la zone.

Details: https://zone.spip.org/trac/spip-zone/changeset/112644


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