[Présentation] ZAP

Bonjour.

Je viens aujourd'hui vous présenter un projet que j'ai développé pendant ces vacances : ZAP.

Qu'est-ce que c'est ?

Présentation

ZAP signifie Zcode À Plusieurs.

Il permet donc de rédiger des documents zcode à plusieurs.
Cela fonctionne actuellement comme un wiki : vous pouvez créer des documents, et tout le monde peut les modifier.

Il permet d'importer et d'exporter des fichiers .tuto : vous pouvez mettre vos tutos du SDZ sur ZAP (pour permettre la modification collaborrative d'un tuto déja existant), et les tutos de ZAP sur le SDZ (une fois que le tuto vous semble avoir avancé sur ZAP, vous allez le faire valider sur le SDZ).

Ce que vous pouvez faire avec

Les utilisations de ZAP sont diverses.

Tout d'abord, il peut être utile pour faire relire votre tuto à des gens, avant de demander à le faire valider.
Vous pouvez demander à ces relecteurs de faire les modifications eux-même : un lecteur peut par exemple corriger une faute d'orthographe qu'il repère dans votre tuto.

Il peut aussi être utilisé pour rédiger des tutos à plusieurs. De très bons tutos peuvent être rédigés à plusieus auteurs. Les auteurs du tuto python par exemple l'ont fait, et ils ont eu du mal pour passer d'un wiki au Zcode. ZAP peut vous aider dans les cas comme ça.

Évidemment, vous ne devez pas mettre un tuto sur ZAP si vous avez peur que les gens le voient : c'est un espace public. Ou alors, sur votre serveur privé, avec une URL tenue secrète.
N'ayez pas peur que des gens fassent des changement de tutos dont vous n'avez pas envie. Tout d'abord, parce que c'est le principe des wikis, et que cela marche bien : les utilisateurs sont respectueux, et ne font des modifications que quand ils pensent qu'elles sont vraiment irréprochables (ou sinon ils en parlent avec vous avant). Ensuite, parce que l'on peut toujours revenir à une ancienne version du tuto, au cas où : il existe un historique des modifications.

Et vous dans l'histoire ?

Vous pouvez l'utiliser

Je vous invite donc à utiliser ZAP.

C'est un logiciel écrit en PHP, qui peut donc être hébergé sur tout site web.
En particulier, la dernière version de ZAP est en activité ici : http://bluestorm.info/ZAP

Vous pouvez y rédiger vos tutos si vous le souhaitez.

Si vous voulez seulement tester ZAP, allez ici : http://bluestorm.info/ZAP_test

Si vous voulez installer ZAP sur votre propre serveur, il suffit d'utiliser les sources de ZAP, que vous trouverez ici :
http://bluestorm.info/projects/ZAP/list.php
la dernière version (pour l'instant )

Décompressez-les quelques part, et prenez soin de mettre un chmod 777 au répertoire data/ (depuis votre client FTP).
Sous free, vous ne pouvez pas chmoder, mais ça marche sans, donc tout va bien

Vous pouvez contribuer

ZAP est un logiciel Libre. Vous êtes encouragés à y contribuer si vous le souhaitez.

Si cela vous intéresse, lisez les sources. Même si vous n'apportez aucune avancée majeure, je suis très intéressé par les critiques sur un passage pas assez clair, ou mal écrit, etc...

Si vous tolérez le PHP , je pense que les sources devraient vous intéresser. Elles contiennent entre autre du code qui permet de traduire du zcode en html, et un petit moteur de templates (sans prétention, il est vraiment très simple).

Ce que ZAP n'est pas

ZAP n'est en aucun cas un remplacement au siteduzéro
Il apporte l'aspect wiki, et la possibilité qu'un grand nombre de personne relise votre cours avant sa validation.
Il est donc destiné à faciliter l'enrichissement de la catégorie "Vos Tutos" (ou "Tutos des Zéros").

Par ailleurs, les développeurs du SDZ sont en train de travailler sur un mode collaboratif pour Vos Tutos. Quand il sera disponible, il vous permettra peut-être de faire la même chose que ZAP, et dans ce cas vous aurez intérêt à l'utiliser de préférence.
Si je vous propose ZAP au lieu d'attendre cette sortie, c'est parce que ZAP m'est personellement utile maintenant (je rédige de nombreux documents dessus, il a aussi servi pendant l'organisation du zérothon)), et que je pense que vous devez en profiter aussi.


Amusez vous bien, et donnez moi votre avis (le plus constructif possible, évidemment) !

Pratique, mais une personne mal intentionné peut foutre en l'air le boulot des autres non ???

1) quelle personne mal intentionnée ? Il faut pas être trop parano, il n'y a pas que des salauds sur le site du zéro
2) tu peux (et tu devrais) faire des sauvegardes (exporter régulièrement ton tuto) sur ton PC
3) tu peux voir les anciennes versions du tuto, et les remettre : si un type passe et efface ton tuto, tu peux le rétablir en deux minutes.

ouais je viens de voir qu'il existait un historique.
Et sinon je ne suis pas parano je me posais juste la question

Excellente nouvelle ! C'est ce qui manquait au SDZ : la possibilité de faire un tuto à plusieurs et qu'il soit modifiable dans le but de l'améliorer !

@Curly >>> S'il était si simple de bousiller le travail des autres, Wikipédia aurait été un gros flop.

Je soutiens moralement bluestorm qui a fait toutes les modifications que je lui ai demandé pour un script dont je me sers assez fréquemment. Bref, c'est très utile, c'est bien fait, c'est léger, et nous la team, on l'a adopté.

Moi j'ais encore jamais rédigé de tutos mais je voulais juste féliciter l'auteur pour son oeuvre.

Je trouve qu'elle peut-être utile pour pas mal de choses et nottament pour la rédaction des TPE en groupe !

Donc merci

Je viens de le tester en proposant le tuto que je suis en train de réaliser.

Tout ça m'a l'air pas mal, mais j'ai quelques critiques à formuler.

• Il serait pas mal que l'on puisse voir qui a posté le tuto au départ. En effet, il faudrait que celui-ci reste "maître" de son tuto. Il est normal qu'il puisse être félicité ou critiqué.
• Un système de commentaires serait le bienvenu. En effet, imaginons qu'un Internaute modifie le document. Le problème, c'est qu'en faisant cette modification, il peut ne pas respecter la philosophie de l'auteur pour son tuto. Je m'explique : dans le tuto que j'ai posté, je parle de l'importance de séparer le Javascript du document HTML. Si un utilisateur ajoute une partie au cours dans laquelle il présente de l'HTML mélangé avec du Javascript, cela ne respectera pas ma visée. Oui, je peux toujours l'effacer. Mais lui peut le remettre... Et ainsi de suite. Les commentaires permettraient de mettre tout le monde d'accord.
• Il n'y a pas d'aperçu en direct. Flemme ou bien est-ce fait exprêt ? En tout cas, on perd tout de même l'un des côtés pratiques de la rédaction de tutos sur le SDZ.
• Le design n'est pas terrible... Désolu de dire ça, mais c'est vrai. Mais bon, ce n'est pas indispensable.

En tout cas, bon boulot Bluestorm. Le fait que ce logiciel soit libre va permettre de l'améliorer encore plus facilement, tant mieux.

EDIT: j'ai remarqué un bug.
Lorsque je tape ceci :
Code : Zcode
La page de visualisation du tuto affiche :
Citation : ZAP
Pour ceux qui n'auraient pas compris, j'ai ce smiley -> <- qui vient squatter un peu partout...
EDIT3: (oui, avant le 2, je sais) et j'ai compris pourquoi ! Dans le code HTML, on a "&gt;)". Tu as du créer un script PHP qui transforme tous les ";)" en , ce qui fait que l'on obtient : &gt , ce qui va afficher >

EDIT²: Je retire ce que j'ai dit sur les commentaires. Je n'avais pas vu le champ "Commantaires d'édition".

les cadres seraient mieux en bleu

Citation : Toul C'her
Tout d'abord merci d'abord pour ton attention (et pour celle de tous les zéros) et pour tes critiques, elles m'intéressent fortement.

Citation
Tu es libre de mettre ton nom dans le tuto. C'est d'ailleurs à mon avis la meilleure solution.
Dans les tout petits documents (autres et news), mettre une signature est très bien.
Dans les documents plus structurés, pourquoi ne pas dédier une page au information sur l'élaboration du document, son ou ses auteurs, etc ? Cela me semble plus riche en possibilité qu'un simple champ de texte qui donne l'auteur.

Citation
Pour tout dire, c'est quelque chose que je n'ai pas follement envie de faire, et pour lequel je n'ai pas les compétences (moi et le JS..). J'espère que vous pourrez vous en passer. Personellement je désactive ces machins parce qu'ils sont foireux sur mon navigateur, et ça ne me gêne pas trop.
Évidemment, si quelqu'un veut le faire

Citation
J'en suis bien conscient. Le Design et moi, ça fait deux. Seulement je préfère passer du temps sur les fonctionnalités que sur ça (ça ne m'intéresse pas tellement). J'ai réussi à obtenir quelque chose confortable à utiliser (enfin, j'espère), si quelqu'un veut faire quelque chose de beaucoup plus esthétique, il est le bienvenu.

Citation
Le problème pour l'instant c'est que les sources ne sont pas assez documentées. Si j'y arrive je met en place une documentation doxygen, ça sera plus facile pour appréhender le code.

Citation
Ton analyse est exacte, je change ça (j'ai déja corrigés quelques autres bugs pour la RC2), et je mettrais en ligne la nouvelle version demain.

Citation
Il faut avouer que le champ de modification est un peu gros, on ne vois pas forcément les commentaires.
Je ne sais pas trop comment régler ce problème : réduire le champ de modification serait une gêne, c'est un peu compliqué.

Merci encore pour tes critiques.

Bravo. Superbe .

La première fois qu'on le vois, le design paraît très léger et moche. Mais en fait il est parfait je trouve.

Il manque peut être les membres. Quand on éditerais ça marquerais le pseudo de l'auteur (ou son adresse IP).

Merci bluestorm .

Sympa comme applic, en plus j'étais curieux de voir un code php de toi bluestorm

Je sais que c'est contraire au principe du wiki (quoique) , mais ne serait-il pas possible de rédiger le tuto a deux ou trois ? C'est a dire a demander un mot de passe pour acceder a certains tutos si l'auteur le souhaite ? Ca permettrait de vraiment le rédiger a plusieurs tout en ne le laissant pas public.
Je sais que le wiki est basé sur la confiance entre les utilisateurs. Justement , j'ai pas confiance et je sais que beaucoup sont dans mon cas.
Après le module sur le sdz fonctionnera probablement comme ca, donc ca règlera la situation , mais ca pourrait être un petit plus je pense de pouvoir choisir entre rédiger un tuto privé ou public.

Citation
Dès le départ, une gestion plus fine des droits a été envisagée. Pour faire des tutos privés, comme tu dis.

Il y a deux problèmes :
1) c'est long à coder, et je ne sais pas si j'ai envie de m'embarquer dedans : je rédige moi-même des trucs, et je bosse sur un autre projet (et c'est lié au point 2)
2) le site du zéro apportera cette possibilité. Je le sais, les développeurs me l'ont dit. Est-ce que ça vaut la peine que je fasse ça si c'est pour que ça serve à rien ? À la limite je préfère développer ZAP sur les points qu'eux n'approfondissent pas, histoire que les fonctionnalités ne s'écrasent pas les unes les autres

Citation
C'est pas un problème. Il y a deux solutions :
1) mettre ZAP sur un site privé, ne pas donner l'URL. Je n'aime pas cette solution
2) modifier un peu le code actuel de ZAP pour implémenter des droits simples.

Pour le zérothon, j'ai fait une version modifiée (20 lignes de code en plus grosso modo) qui utilise un mot de passe (un seul pour tout le monde) et t'empêche de voir les pages si tu ne le possèdes pas. C'est basique, mais ça suffit pour l'instant.
Si cette solution te convient, je te met le code nécessaire demain (avec les autres modifications de la RC2).

Par ailleurs, ce que j'envisage comme possibilité, c'est celle de "mettre un mot de passe" : modifier le tuto demande un mot de passe, sans lequel tu ne peux rien faire. Et tu es libre de le garder, ou de le divulger à quelques personnes. Là encore, c'est pas forcément génial mais ça me paraît suffisamment efficace pour quelque chose qui n'est pas l'objectif principal (pour l'instant) de ZAP.

Qu'en penses-tu ?

Peut-etre manque t'il tout la "panoplie" du Zcode
(me souviens plus du nom :p)

Je veux dire que pour le moment, on doit retenir les balises du Zcode, ce serait pas mal d'ajouter le "module"
(me souviens toujours pas du nom :p)

Merci beaucoup pour vos critiques et vos commentaires, c'est vraiment très motivant.

Je viens de mettre en place la version 1.0

Tout d'abord, je suis absolument désolé mais j'ai merdé, et les tutos présents sur ZAP ont été effacés.
Pour ne plus rencontrer ce genre de problèmes à l'avenir, j'ai écrit un script (qui se trouve dans data/) permettant de faire des backup très simplement. On ne peut malheureusement l'utiliser que sur les hébergeurs utilisant des serveurs sous Linux (c'est un script bash).

ZAP 1.0

Venons-en aux modifications.

• J'ai corrigé le bug remarqué par Toul C'her (merci encore).
• J'ai corrigé d'autres petits bugs
• J'ai ajouté une possibilité de mettre un mot de passe, comme demandé par ErGo_404

Pour ce qui est du mot de passe, c'est pour l'instant très basique : il existe un seul mot de passe pour tout ZAP, et si vous ne le donnez pas vous ne pouvez _rien_ voir (même pas lire les tutos).
La mise en place du mot de passe est très simple, il suffit de lire le fichier conf/security.conf.
Si vous voulez faire un serveur ZAP privé, c'est maintenant très simple.

Des solutions de mot de passe plus évolués viendront peut-être ensuite, mais cela ne serait pas rentré dans le cadre de la 1.0 (on n'ajoute pas de fonctionnalités importantes entre la RC1 et la version officielle ).

J'espère que cette version vous plaira plus que la précédente, et que les prochaines seront encore mieux

La version 1.0 est encore mieux que la précédente, bravo!
Ca doit être vraiment pratique, je pense bien que je vais l'utiliser.
Sinon, c'est quoi toutes ces sections "Veuillez donner un nom potable" ?

Des gens qui ne précisent pas le nom, et laissent le nom par défaut.

Merci pour le mot de passe
Beau travail en tous cas , continue comme ça

Citation : bluestorm
Mais il n'y a aucun contenu?!

Pour les droits un htpasswd suffirait non?

Le wiki est sympa Mais l'arboressence est bizarre (on ne peut créer une page que depuis l'index?).

Pourquoi tu n'as pas repris un wiki existant?

Citation : OAO
Tu connais beaucoup de wikis qui utilisent le zCode?

Je n'est jamais regardé l'intérieur d'un wiki mais il aurait p-e suffit de changer le module de transformation du code wiki en html pour qu'il convertisse zCode<==>HTML.

Il faut aussi que le wiki respecte la structure des tutoriaux du SDZ, ce qui n'est pas le cas.

En plus, donc bon, étant donné que ça n'existe pas encore, bluestorm l'a fait!

Très très intéressant ! Et j'en avais justement besoin, parce que je suis embarqué dans un énorme projet (que je ne suis d'ailleurs pas certain de finir, d'autant que je ne suis pas sûr qu'il a sa place sur le sdz) qui porte sur le droit orienté vers les besoins potentiels des zéros, et étant donné la taille du tuto, j'envisageais justement de me faire aider par quelques spécialistes sur certains points... Donc cela vient vraiment à point pour moi ! Merci et bravo !

Edit : Par contre, je viens de voir qu'il y avait moyen de détruire le tuto, je ne suis pas sûr que cela soit pertinent, par contre. En plus, il semble impossible de réaccéder à l'historique pour rétablir la version précédente en cas de destruction. A méditer (?)

Edit² : Je viens d'avoir une erreur :
Citation : Erreur

Elle apparaît ici. Je ne sais pas à quoi elle est dûe.

Comme de nombreuses personnes me le demandaient, j'ai ajouté le support des zform.

C'est donc ZAP 1.1 que vous voyez maintenant !

Je rêve...
Je voulais sortir ma propre version, elle devait sortir dans quelques instants, mais bon je suis grillé pour pas grand chose !
Tant pis...

Citation : bluestorm
Très bien, mais il me semble que le site ne prend pas en considération les balises <question>, <information> et <erreur>, à moins que je ne me trompe. Je navigue sous firefox.

je ne peux que dire bravo

je trouve cette idée très bonne, cela pourrait faire avancé les tutos beaucoup plus vite, et aussi plus riche, je trouve que cela vas créé vraiment une communauté.

en tout cas si je dois faire des tutos avec d'autres personnes je pense que je passerais pas ton site

encore bravo !