Projet Spip Typo : Comment participer ?

Contours du projet

Spip Typo est un projet d’intégration des raccourcis typographiques de Spip au sein de BBComposer.

BBComposer est une extensions Firefox qui permet d’éditer le contenu d’un champs de formulaire de type textarea en WYSIWYG (ou plutôt WYSIWYM). BBComposer est architecturé pour permettre l’édition de tout langage de balisage et assimilés. Les raccourcis typographiques de Spip sont maintenant supportés.

Parmi les principales fonctionnalités de BBComposer, on retrouve :
-  le WYSIWYM : éditer son site avec le bon markup est la priorité de BBComposer.
-  l’auto-complétion lors de la création des liens grâce à l’historique du navigateur.
-  l’ajout et l’upload d’image locales grace à un glisser/déposer ou un copier/coller (non supporté pour les images internes à Spip).
-  la possibilité de coupler BBComposer avec d’autres extensions : KGen (outil SEO) et CanImage (manipulation d’image avant l’upload).

Voici les fichiers concernés par Spip Typo dans BBComposer :

• le fichier de description : il s’occupe de la conversion HTML vers Spip et Spip vers HTML, de déterminer quelles barres d’outils et barres latérales peuvent être utilisées ainsi que les différentes balises HTML. Il en existe deux, un pour les racourcis originaux (spip.js), un autre pour les raccourcis de la BTE (spip2.js).
• les fichiers d’interface XUL : ils permettent d’ajouter des boutons qui seraient nécessaires à Spip Typo. C’est peu probable puisque les boutons Editer avec Spip sont déjà présents.

Version de développement

Pour aider au développement, il faut que vous utilisiez la version de développement de BBComposer. Celle-ci se trouve sur GitHub. Vous pouvez cloner le projet avec Git ou simplement télécharger les sources. Le tout est que les sources soient déposées dans le dossier des extensions de votre profil (Linux/Mac : /.mozilla/firefox/(FirefoxProfile)/extensions/bbcomposer@elitwork.com , Windows : C :\Documents and Settings\(WindowsProfiles)\Application Data\Mozilla\Firefox\Profiles\(FirefoxProfile)\extensions\bbcomposer@elitwork.com ).

En redémarrant Firefox, vous utiliserez la dernière version de développement. Il ne vous reste plus qu’à l’utiliser sur vos sites et à remonter les problèmes rencontrés ou demandes d’améliorations.

Points a connaître

Le support des raccourcis typographiques consiste à transformer les raccourcis typo en HTML spécifique, à faire l’édition en Wysiwyg, puis à restituer le texte avec sa mise en forme codée avec les bons raccourcis typographiques une fois l’édition terminée.

Voici les problèmes possibles et ce qu’il convient alors de faire :

• un ou plusieurs raccourcis typographiques sont mal détectés ou convertis par BBComposer : soumettre le contenu concerné, rapporter le bug (en commentaire de cet article par exemmple) et indiquer comment le reproduire.
• normalement, vous pouvez éditer un textarea contenant des raccourcis typo avec BBComposer simplement en double cliquant. Cependant, il peut exister des cas où cela ne se produit pas et vous serez alors obligés de choisir manuellement le langage d’édition (clic droit, BBComposer, éditer avec spip typo). Signalez moi ces cas afin que j’affine la détection des champs contenant des raccourcis spip. Cette détection peut être basée sur une classe ou sur un id, à vous de me donner les caractéristique du textarea à détecter.
• certaines parties des raccourcis typographiques ne sont pas aisément éditables avec BBComposer car il nécessiteraient une communication avec le serveur (liens internes, image internes etc...). Pour supporter cela, il faudrait créer un plugin Spip permettant de récupérer les documents / images internes à Spip, permettre l’upload de fichier. N’étant pas expert Spip, je ne peut pas me pencher dessus. En revanche si quelqu’un est intéressé pour permettre cette communication, je serai enchanté de participer à l’exploitation de ce plugin par BBComposer (auto-complétion des liens avec liens internes, modification de l’upload de fichier pour permettre l’envoi etc...).

D’une manière générale, je ne suis pas utilisateur de Spip et donc je ne suis pas très au courant de ses évolutions, n’hésitez donc pas à me tenir au courant des dernières nouveautés qui pourraient entraîner une incompatibilité de BBComposer.

Voilà, j’espère que vous avez tout ce qu’il faut pour m’aider à faire de Spip Typo un outil indispensable à tous les passionnés de Spip.