[SPIP Zone] [Spip-be-2008] Offre: rédaction du compte-rendu "plugins"

Le 24 novembre 2008 13:57, Augustin Chassine
<augustin.chassine@gmail.com> a écrit :

Merci crowf00t pour le retour et les idées.

Concernant le fait de mettre ça sur doc.spip.org, on verra ça une fois le
travail un peu avancé.

Oui bonne idée.

J'avoue que je ne sais pas trop entre doc.spip.org et
spip-contrib.

Si on met des choses sur contrib, je pense que ca doit rester simple
et renvoyer sur une doc complète de doc.spip.org pour ne pas encombrer
plus contrib. En tout cas, contrib est pour moi un endroit ou on
trouve des choses complète ou de la doc de base... Mais je peux me
tromper ...Admin de contrib êtes-vous là ?

Sinon, c'est vrai qu'il y a plusieurs façons de faire selon le but et
l'usage du plugin.
Je vais réfléchir ce soir à une façon de scénariser ça de façon progressive.

Cool. je rassemble mes idées aussi.

Une bonne piste serait de fragmenter les choses en plusieurs articles liés
entre eux. Par exemple :
- un article général sur le dev de plugins (description des fonctions des
repertoires de /ecrire, présentation rapide de la surcharge et du path et
introduction au plugin.xml + les var_mode et autres astuces qui vont bien
pour le dev)
- ensuite des sous articles selon les cas : ajout d'éléments dans l'espace
privé, création d'une nouvelle balise, creation et utilisation d"une
nouvelle table..etc...

Oui je pense que c'est une bonne idée sur le fond. Mais alors il faut
compléter / corriger / ajouter des articles qui se trouvent sur le
site de doc.spip.org si on met de la doc sur des points précis et pas
sur la création _complète_ d'un plugin simple.

Ce soir je recenserait les docs existants sur le sujet, et essaierais de
vous envoyer un proposition de plan.

Bien vu l'ami !
On fait comme ca !

En tout cas ce truc me motive, ça peut être une bonne manière pour moi de
"solidifier" le point de vue que m'a donné la présentation de crowf00t.

Je pense qu'on est une tripotée à être sortit de SPIP Media Bruxelles
2008 super motivé. Le tout maintenant c'est de mettre tout cette
motivation en route ... Et ca à l'air bien partit !! ^ _ ^

ps: Je met en copie la liste spip-zone, comme cela concerne les plugins ...

Hésitez pas à réagir,

Augustin

Le 24 novembre 2008 11:58, Denooz Sébastien <crovvfoot@gmail.com> a écrit :

Yo les gens !!

Je peux aussi aider pour le compte rendu de l'intervention sur les plug !
:slight_smile:
Je pense qu'une bonne idée serait de mettre ca sur doc.spip.org. Il
existe déjà des choses là qui traitent de sujets bien précis. Je pense
que c'est une bonne idée de créer un tuto sur la création d'un plugin
"de base" avec
- Création d'un formulaire dans l'espace privé (cvt ?)
- Création/installation d'une nouvelle table
- Un squelette de test avec une boucle sur notre nouvelle table.
On pourrait déja avoir un truc de base complet avec ca.
A mon avis, il serait bon de mettre tout ca dans une sous rubrique de
"plugins", et appeler ca du genre : 'Création d'un plugin simple' et
séparer chaque étape dans un article. Il faudrait voir ce que azerttyu
et d'autre admin de docspiporg en pensent ...
On pourrais prendre exemple sur la documentation du framework cakePHP
qui fournissent des exemple d'app complète basées sur leur machin :
http://book.cakephp.org/view/219/Blog

En plus de ca, plusieurs "plugins documentaires" existent déjà sur la
zone. Certain plus à jour que d'autre :

AA commencé par cy_alterne :
Connexion · GitLab
Plugin template :
Connexion · GitLab
....

Pendant l'atelier "Documentation de SPIP" qui a eu lieu au troglo, on
avait parler de cette problématique de faire un plugin complet de
présentation et on a vite été confronté au problème suivant : il y a
tellement de manière différente de faire un plugin que ca serait assez
compliquer de rassembler ca dans un plug "qui sert à rien"... Donc a
voir si on peut approfondir le sujet et/ou trouver une manière pérenne
de faire ca.

voilà voilà ...
Qu'en penssez vous ?

Seb

Le 24 novembre 2008 11:22, Augustin Chassine
<augustin.chassine@gmail.com> a écrit :
> Hello Suske !
>
> Tu parles de la présentation de crowf00t ?
> Si c'est le cas, je suis ok pour travailler dessus avec toi.
> ça pourrait prendre la forme d'un tuto : "mon premier plugin pas à pas".
>
> Une sorte de point d'introduction à la construction de plugin : fichier
> plugin.xml, utilisation des pipelines et modification de l'espace privé.
> Il
> ya déjà quelques excellents documents sur le sujet, d'Aurélie, crowf00t
> et
> Camille sur doc.spip.org. La présentation de crowf00t articulait tout
> cela.
>
> On se tient au jus.
>
> A bientôt !
>
>
> 2008/11/24 Suske <suske@brubel.net>
>>
>> Salut,
>>
>> Je surenchéris sur tout ce qui a été dit de bien à propos de spip-media
>> :wink: Merci à Peggy et Agnez en particulier. Et puis à celles et ceux qui
>> ont "poussé à la charrette" :wink:
>>
>> Je suis intéressé de taper le CR de l'atelier plugins: cela me
>> permettra
>> de savoir ce qui s'y est dit :wink:
>>
>> Donc, si je peux avoir le fichier audio, je vous envoie un odf dans la
>> semaine qui suit :wink:
>>
>> A pluche
>>
>> --
>> Suske
>> +32-476-764629
>>
>> _______________________________________________
>> Spip-be@rezo.net - http://listes.rezo.net/mailman/listinfo/spip-be
>
>
> _______________________________________________
> Spip-be@rezo.net - http://listes.rezo.net/mailman/listinfo/spip-be
>
>

--
Denooz Sébastien. Crowfoot pour les intimes...
Jabber : crowfoot@jabber.fr
Web : http://www.lattirail.org

Hacking For Freedom
Fellowship of F.S.F.E.
http://www.fsfe.org
_______________________________________________
Spip-be@rezo.net - http://listes.rezo.net/mailman/listinfo/spip-be

_______________________________________________
Spip-be@rezo.net - http://listes.rezo.net/mailman/listinfo/spip-be

--
Denooz Sébastien. Crowfoot pour les intimes...
Jabber : crowfoot@jabber.fr
Web : http://www.lattirail.org

Hacking For Freedom
Fellowship of F.S.F.E.

Denooz Sébastien a écrit :

Le 24 novembre 2008 13:57, Augustin Chassine

J'avoue que je ne sais pas trop entre doc.spip.org et
spip-contrib.

doc.spip.org est une doc technique de référence, donc à mon avis il ne doit pas y avoir d'exemples dessus.

Exemple au sens "l'ensemble de ce qu'il faut faire pour un truc complet". Car bien entendu qu'il peut y avoir des exemples pour l'utilisation de telle fonction/fonctionnalité précise.

Donc à mon sens, un exemple de plugin serait sur spip.net (ou spip-contrib à la limite). D'ailleurs ça y est déjà sur spip.net et ça serait donc à mettre jour.

Sur doc.spip.org, on aurait ce dont tu parlais dans la rubrique "Plugins" :
- un article sur l'ajout de bouton dans l'interface
- un article général sur les pipelines (ensuite chaque pipeline devrait être dans un article à part récolté automagiquement depuis inc_version.php, mais je n'ai pas encore eu le temps de m'y pencher)
- un article pour déclarer entièrement une nouvelle table
- etc, que des points précis.

Mes deux morceaux de fromage.

--
RastaPopoulos

Bonjour

Vu que je joue un peu avec doc.spip.org, voici mes remarques.

Je crois qu'il faut séparer les 2 problématiques :
-* exemple
-* documentation de référence.

Doc.spip.org à mon sens se doit d'être exhaustif et factuel concernant
les informations présentées.
Un article ou ensemble d'articles sur comment faire un plugin ne
pourra jamais etre exhaustif, c'est pourquoi je ne pense pas que sa
place soit ici. Ce serait mieux sur spip-contrib.net

Toutefois la documentation d'un plugin s'appuie sur pleins d'aspect
techniques très précis tel que plugin.xml, l'arborescence de fichiers
et répertoires, les pipelines, l'api sql_*, ... Ces informations quant
à elles doivent être documentées complètement sur doc.spip.org. Il y a
un début de chantier à ce propos.

Par exemple un article "comment faire son plugin" écrit sur contrib
devrait prendre un cas d'utilisation précis et à chaque étape renvoyer
sur doc.spip.org pour plus de détails.

Une idée de plugin complet pour laquelle existe déjà un bout de
documentation est un formulaire contact (voir "exemple CVT" sur
spip.net). Vous pourriez faire évoluer ce plugin vers une sauvegarde
en base de tous les mails envoyés par ce formulaire. Ainsi vous
pourriez balayer tous les points présenté lors de la féria.

Voili :slight_smile:

Km

Le 24 novembre 2008 19:15, cam.lafit@azerttyu.net
<cam.lafit@azerttyu.net> a écrit :

Bonjour

Vu que je joue un peu avec doc.spip.org, voici mes remarques.

Je crois qu'il faut séparer les 2 problématiques :
-* exemple
-* documentation de référence.

Doc.spip.org à mon sens se doit d'être exhaustif et factuel concernant
les informations présentées.
Un article ou ensemble d'articles sur comment faire un plugin ne
pourra jamais etre exhaustif, c'est pourquoi je ne pense pas que sa
place soit ici. Ce serait mieux sur spip-contrib.net

Toutefois la documentation d'un plugin s'appuie sur pleins d'aspect
techniques très précis tel que plugin.xml, l'arborescence de fichiers
et répertoires, les pipelines, l'api sql_*, ... Ces informations quant
à elles doivent être documentées complètement sur doc.spip.org. Il y a
un début de chantier à ce propos.

Par exemple un article "comment faire son plugin" écrit sur contrib
devrait prendre un cas d'utilisation précis et à chaque étape renvoyer
sur doc.spip.org pour plus de détails.

Oui ok, je suis partant pour ca aussi.
Et metre dansnos exemple des liens directe vers le site de doc sur les
fonction utilisée. Même si celle-ci ne sont pas encore documentée, ca
pourrais amener des gens à le faire par le suite.

Une idée de plugin complet pour laquelle existe déjà un bout de
documentation est un formulaire contact (voir "exemple CVT" sur
spip.net). Vous pourriez faire évoluer ce plugin vers une sauvegarde
en base de tous les mails envoyés par ce formulaire. Ainsi vous
pourriez balayer tous les points présenté lors de la féria.

Tu parle de mettre le compte rendu sur spip.net ou alors mettre un
lien sur spip net depuis cet exemple vers un plugin demo plus
important sur contrib ?

Voili :slight_smile:

Km
_______________________________________________
spip-zone@rezo.net - http://listes.rezo.net/mailman/listinfo/spip-zone

--
Denooz Sébastien. Crowfoot pour les intimes...
Jabber : crowfoot@jabber.fr
Web : http://www.lattirail.org

Hacking For Freedom
Fellowship of F.S.F.E.

Je crois qu'il faut séparer les 2 problématiques :
-* exemple
-* documentation de référence.

Un article ou ensemble d'articles sur comment faire un plugin [...]
Ce serait mieux sur spip-contrib.net

Toutefois la documentation d'un plugin s'appuie sur pleins d'aspect
techniques très précis [...] Ces informations quant
à elles doivent être documentées complètement sur doc.spip.org. [...]

Par exemple un article "comment faire son plugin" écrit sur contrib
devrait prendre un cas d'utilisation précis et à chaque étape renvoyer
sur doc.spip.org pour plus de détails.

Oui ok, je suis partant pour ca aussi.
Et metre dansnos exemple des liens directe vers le site de doc sur les
fonction utilisée. Même si celle-ci ne sont pas encore documentée, ca
pourrais amener des gens à le faire par le suite.

Bonne idée

Une idée de plugin complet pour laquelle existe déjà un bout de
documentation est un formulaire contact (voir "exemple CVT" sur
spip.net). Vous pourriez faire évoluer ce plugin vers une sauvegarde
en base de tous les mails envoyés par ce formulaire. Ainsi vous
pourriez balayer tous les points présenté lors de la féria.

Tu parle de mettre le compte rendu sur spip.net ou alors mettre un
lien sur spip net depuis cet exemple vers un plugin demo plus
important sur contrib ?

A mon sens :
-* le compte rendu propré à la feria c'est spip-party,
-* le travail de documentation d'un plugin suite à cette féria ça serait contrib
-* la doc technique sur doc.spip

Je faisais reference à spip.net car un article d'éxplication des CVT a
été rédigé et qui peut aider à prendre un point de départ sur "mon
premier plugin"

voili
Km

cam.lafit@azerttyu.net a écrit :

A mon sens :
-* le compte rendu propré à la feria c'est spip-party,
-* le travail de documentation d'un plugin suite à cette féria ça serait contrib
-* la doc technique sur doc.spip

Et l'endroit où l'on montre TOUT en un seul paquet, c'est le plugin "template" qui est à la racine des plugins de la Zone.
Il existe déjà mais est très loin d'être rempli (création de nouvelle table ou balise, notamment).

Dans ce plugin, il est évident que le but n'est pas de commenter à tout va, ça c'est dans un documentation, qui permet d'apprendre.
Là le but c'est d'avoir une base de référence pour toutes les actions communes, que l'on a plus qu'à reprendre et à modifier selon son besoin.

Par exemple, dès que je commence un nouveau projet, hop je copie le dossier template et je change le préfixe partout. Puis je supprime ce dont je n'ai pas besoin (par exemple je n'ai pas besoin de créer des formulaires) et j'adapte ce que je garde (par exemple je dois créer une nouvelle table et les jointures qui vont avec).

Cela évite d'apprendre par cœur chaque action OU de devoir aller chercher par-ci par-là en permanence, même lorsque l'on est un développeur confirmé.

Un super outil de productivité pour créer de la valeur et devenir le maître du monde !

--
RastaPopoulos