Éditeur Offline pour les tutoriels de ZdS

Bonjour,

Je suis firm1, passionné de développement. Aujourd'hui je vous présente une version Alpha d'un éditeur de tutoriel Offline et multiplate-forme pour zeste de savoir. L'idée m'est venue depuis le jour ou j'ai envoyé cette Pull Request qui donne la possibilité d'importer son tutoriel sur Zeste De Savoir. Là je me suis dit, on peut importer son tutoriel sur le site, c'est bien mais comment on le modifie ? Dans un éditeur de texte basique, on ne voit pas forcément le rendu tout de suite … C'est comme ça qu'à germée l'idée et 2 heures de travail plus tard , on a un résultat pas trop mal.

Les fonctionnalités

• Navigation dans la structure d'un tutoriel (big ou mini)
• Edition avec prévisualisation instantanée du rendu markdown
• Support de la syntaxe zMarkdown
• Style du site ZesteDeSavoir

Les dépendances logicielles

• Python 2.7
• Java 1.6 et plus

L'utilisation

Pour lancer l'application, téléchargez le projet ici et dézippez le. Allez dans le dossier dist du projet et :

• Sur Windows : lancez run.bat
• Sur Linux/MacOs : lancez run.sh

Ensuite pour découvrir,

• Télécharger l'archive d'un tutoriel en ligne sur zestedesavoir, en allant sur le tutoriel en question, et dans la barre de gauche en bas, vous avez un lien "Archive".
• Dézippez l'archive que vous venez de télécharger
• Allez sur l'application et faites Fichier -> Ouvrir , puis sélectionnez le répertoire de votre tutoriel
• Vous voilà maintenant capable de parcourir votre document.

Des screens, des screens

Le développement

Le programme est réalisé essentiellement en langage Java, il s'appuie sur la bibliothèque Jython pour faire appel au parseur zMarkdown utilisé pour le site internet, pour éviter de le réecrire. L'avantage est donc que zMarkdown-Editor pourra bénéficier des mises à jour du dépot zMarkdown automatiquement.

La partie interface est basé sur la bibliothèque Swing appelant le look and feel natif de votre système d'exploitation. On utilise aussi le Pattern Observer pour réaliser les mises à jour d'interface.

Le projet est entièrement Opensource et sous Licence MIT. Si vous souhaitez regarder son code, vous pouvez y aller, vous avez même le droit de le forker en de proposer des corrections. Si par contre vous trouver des bugs, n'hésitez pas à les signaler.

Une Roadmap rapide

Quelques points que j'améliorerai quand je pourrai :

• Intégrer pleinement la coloration du code
• Télécharger l'archive depuis l'application sans passer par le site
• Intégrer des boutons d'aide à la rédaction zMarkdown comme ceux qui sont sur le site

Bonne découverte.

Alors ça, je teste immédiatement !

Je ferais part de mes impressions après quelques jours de teste !

Edit : Par-contre, je rencontre des difficultés à ouvrir le répertoire d'un tutoriel. Quand je clique sur ce dernier, la fenêtre de sélection du répertoire se ferme, mais rien ne se passe dans la fenêtre principal.

Tu peux me dire avec quoi tu teste ? OS, version Java, version Python et le tutoriel que tu utilise ?

Ah non, je n'ai rien dit ! Ça fonctionne.

C'est parce que j'utilisais une archive d'un tuto en cours de rédaction (donc pas encore publier), au lieu d'une archive d'un tuto complet et en ligne.

Mais est-ce un comportement normal ? Car l'archive du tuto en rédac', est similaire à l'archive d'un tuto en ligne, non ?

ça devrait marcher pour un tutoriel en rédaction aussi. Tu peux me dire le tuto en rédac sur lequel tu échoue ?

Et aussi, si tu le lance en console, tu devrais avoir une erreur dessus quand ça ne passe pas. Il me faudrait cette erreur.

Le tuto, c'est celui sur les licences, en co-rédaction avec Arius. Pour être précis le titre c'est : « Le Droit d'Auteur, les Licences CC et les Licences sur Zeste de Savoir »

Nope, je ne le lance pas en console, car si je tente de le lancer via cette dernière il me dit ceci : Error: Unable to access jarfile zMarkdown-JavaEditor.jar

Je vais quand même répondre à tes questions, si ça peut t'aider !

• OS : Ubuntu 14.04 LTS
• Version de Java : Je ne sais pas trop en fait.. J'ai fait une recherche rapide sur la doc pour l'installer pour pouvoir utiliser ton logiciel. Donc j'ai installé le paquet openjdk-7-jre.
• Version de Python : J'en ai deux d'installer sur mon système la 2.7 et la 3.4 je ne sais pas vers laquelle ton logiciel se dirige.

A première vue, tu as une bonne version de Java, par contre, j'ai un doute sur la version python qui est utilisée.

Merci pour ton rapport en tout cas, je regarderai ça de plus près dès que possbile.

Bonne nouvelle, je viens de corriger le souci (qui était du au fait que j'avais poussé la mauvaise lib sur le dépot).

Pour la peine, j'ai rajouté dans l'interface d'édition quelques boutons d'aide à la saisie (gras, italique, etc.)

Un petit screen.

Pourquoi il y a besoin de python 2.7 si tu fournit jython ?

Je ne sais pas.

Je dois avouer que je n'ai pas testé sans python

Ouh, c'est une bonne idée ça !

Est-ce que tu penses permettre la création de tuto directement hors ligne ?

Je pense qu'il est pour mais en l'occurrence le site ne permet pas (encore) de le faire. Donc je pense que ça viendra quand le site le permettra

Kje a bien parlé

Intégrer pleinement la coloration du code

Il faut que pygment soit accessible à python-zmarkdown pour ça

Sympa.

Sinon deux petits bugs :

• Sur windows, avec des locale en français les accents passent pas. Si j'ai 5 minutes, je regarde ça ce midi.

• Les images des tutoriels ne s'affichent pas.

Chouette idée !

Pour le coup c'est très proche de mon projet ZdS Reader, mais complémentaire à la fois.

À suivre de près je pense, pour éviter de se tirer dans les genoux

Arf, c'était donc ça. Je vais voir comment mélanger tout ça.

Arf, j'ai oublié de faire un textpane.setContentType("text/html;charset=UTF-8"); je vais tenter de régler ça pour mon prochain commit.

Arf, ça c'est parce que je n'ai pas géré les chemins relatifs. Un coup de textpane.setPage(new URL("http://zestedesavoir.com")); devrait m'aider à régler ça.

En effet. Je vois que de ton coté tu es en train de réecrire un parseur zmarkdown, c'est bien dommage, moi je réutilise le parseur python directement depuis son dépot, ça évite pas mal d'emmerdes et au moins les corrections des bugs arrivent directement dans l'application

Yes, j'avais commencé dans ce sens-là mais Kje est passé par là et m'a suggéré de passer par Python directement (chose à laquelle je n'avais pas pensé, en bon boulet que je suis). Du coup on aura une bonne base en commun au final, même si de mon côté ça tourne en JS (<troll>j'aime pas Java, c'est pour les barbus</troll>).

En attendant ce projet répond de manière concrète à une question que je me posais : Jython peut effectivement servir à quelque chose de concret

ça y est la dernière mise à jour rajoute :

• Le support de pygments (merci à Kje pour l'astuce)
• Le support des accents sur Windows
• Les images avec chemin relatifs (par rapport à zds) son désormais visibles

Prochaine étape, une belle interface pour aider à saisir des tableaux.

Ce qui serait vraiment bon, ce serait la possibilité de se brancher sur Vim dans la zone d'édition. Ça me ferait enfin une bonne raison d'installer un JRE.