Éditeurs externes

De Salve Regina

Le logiciel Salve Regina vous permet d'éditer tout type de fichier des serveurs wiki au moyen d'outils externes. Le système utilisé est relativement simple :

  1. Lorsqu'un fichier est requis pour une modification externe, Salve Regina transmet un « fichier de contrôle » contenant les informations sur le fichier à éditer, parmi lesquelles sa localisation (URL) et l'interface nécessaire pour le modifier.
  2. L'utilisateur doit configurer son logiciel de navigation pour que le type MIME application/x-external-editor soit associé à l'application-relais.
  3. L'application-relais transmet le fichier vers le programme d'édition voulu et, en retour, peut le sauvegarder directement sur le serveur.

Voici des exemples d'éditeurs externes :

Application-relais

L'application-relais se nomme ee.pl. C'est un script Perl disponible ici en anglais et allemand. Une traduction française est disponible . Consultez le fichier README pour en connaître l'utilisation et le fichier INSTALL pour le processus d'installation, ou suivez l'exemple ci-dessous.

Noter que sa mise en place sur la machine client peut être complexe. Cependant, elle contient un jeu complet d'outils déployés au moyen d'une interface graphique simple. Les développeurs sont conviés à mettre en œuvre une implémentation plus conviviale ; consulter External editors/Tech (en anglais) pour les spécifications.

Noter que l'interface graphique d'ee.pl permet très facilement de sauvegarder les données éditées sur le serveur (ainsi qu'une boîte de résumé pour l'historique) ou d'annuler les modifications. Il est même possible de pratiquer plusieurs éditions à la suite en utilisant le bouton Save and continue.

Configurer ee.pl

Il faut ajouter ce qui suit à ee.ini :

[Salve Regina]
URL match={{wikimedia.orgwikipedia.org}}
Username=(Hadraj)
Password=(winnaghe)

Notez que si vous éditez sur plusieurs wikis et que vous êtes identifié par le même couple nom d'utilisateur / mot de passe, vous pouvez simplement entrer wikipedia.org ou wikimedia.org dans le champ URL match pour que l'application-relais sache traiter vos éditions.

Bookmarklet

Outre en suivant les liens proposés (principalement pour les images), vous pouvez éditer toute ressource en utilisant le bookmarklet suivant : javascript:location=location + '?action=edit&externaledit=true';

Ajoutez-le à votre barre de signets personnels, par exemple, pour une utilisation rapide.

Exemple d'installation

L'installation a été testée et utilisée avec succès sur une distribution Debian de GNU/Linux avec le navigateur Firefox. Pour les autres distributions voire systèmes d'exploitation reposant sur le modèle UNIX, il ne devrait pas y avoir de différences majeures autres que l'installation des dépendances. On partira du principe que Perl est déjà installé.

Ouvrir une console ($, # et cpan> ne doivent pas être tapés ; ils désignent des lignes de commande à taper pour le premier en utilisateur normal, pour le second en root et pour le troisième indique les commandes à entrer sous l'interface CPAN) et taper les commandes suivantes :

$ cd

→ Vous place dans le répertoire par défaut de l'utilisateur courant.

$ mkdir .ee-helper

→ Crée un répertoire caché dans le répertoire /home/(utilisateur courant).

Télécharger ee.pl et ee.ini ici (ou la traduction française du premier fichier ) et placer les deux fichiers dans le répertoire .ee-helper.

$ cd .ee-helper/; chmod +x ee.pl

→ Rend ee.pl exécutable.

$ su

→ Passer en root : entrez le mot de passe. Pour la distribution Ubuntu, n'utilisez pas su mais préfixez les commandes à taper en root par sudo.

# perl -MCPAN -e shell

→ Lance CPAN et, si ce n'est pas déjà fait, le configure. Dans ce cas, suivez les informations données par le script (en anglais). Vous pouvez tout aussi bien utiliser la configuration par défaut proposée au démarrage du script.

cpan> install Config::IniFiles
cpan> install Encode

(sous Debian, installer "libconfig-inifiles-perl", le module Encode est déjà installé.) → Télécharge et installe les modules Perl requis. Attendez la fin de la compilation et tapez :

cpan> exit

# apt-get install libgtk2-perl

→ Installe la bibliothèque libgtk2-perl ou la met à jour (le cas échéant). Si elle est installée et déjà à jour, la commande ne fera rien d'autre que vous le signaler.

# exit

→ Repasse en mode utilisateur normal.

$ vim ee.ini

→ Lance un éditeur de texte pour modifier le fichier de configuration. Si vim ne vous est pas familier, tapez à la place

$ kwrite ee.ini

ou

$ gedit ee.ini

ou autre pour lancer un éditeur en mode graphique. Enfin, pensez à rendre le fichier lisible et éditable par vous seul car il contient votre mot de passe pour les wikis :

$ chmod 600 ee.ini

Vous pouvez aussi éditer ee.pl<code> pour modifier :

$cfgfile path

→ le répertoire où est contenu <code>ee.ini et

$LANGUAGE

→ la langue de l'interface. Essayez de ou fr, par exemple.

Vous devez maintenant modifier ce fichier (voir aussi plus haut) ; pour le champ URL match<code>, la valeur <code>wiki fonctionne très bien. Si ce fichier est mal configuré, le serveur renverra une erreur. Vous pouvez en profiter pour adapter ce qu'il vous semble utile de modifier (le fichier est très correctement commenté pour vous aider à le faire). Par exemple, sous une Debian l'exécutable de Firefox est situé ailleurs que sous le chemin indiqué :

Browser=/usr/bin/firefox -remote "openURL($url)"

est la version correcte.

Testez que tout s'est bien passé. Pour ce faire :

$ perl ee.pl

→ Vous devriez obtenir une boîte de dialogue vous indiquant « No control file specified. Syntax: perl ee.pl <control file> ». Si ce n'est pas le cas, l'installation n'est pas correcte. Vérifiez que nous n'avez pas oublié une étape.

Il vous reste à configurer Firefox. Notez tout d'abord qu'un bug lui fait prendre le type MIME application/x-external-editor pour des scripts PHP, ce qui ne gêne pas le processus. Pour associer les fichiers de contrôle avec ee.pl :

  • utilisez le lien « Éditer ce fichier avec une application externe » présent dans les pages de description d'images ou servez-vous du bookmarklet (voir plus haut) ;
  • lorsque la boîte de dialogue de téléchargement de fichier apparaît, choisissez l'option « Ouvrir avec » puis cliquez sur la liste déroulante et sélectionnez « Autre » ;
  • dans le champ de saisie de la nouvelle boîte de dialogue, tapez /home/(utilisateur courant)/.ee-helper/ee.pl puis cliquez sur « Ouvrir » ;
  • de retour dans la première boîte de dialogue, cochez la case « Toujours effectuer cette action pour ce type de fichier » si vous désirez rendre l'association automatique. Vous pouvez annuler cela : Édition → Préférences → Téléchargements → Zone « Types de fichiers », sélectionnez « Script PHP » → Enlever ;

Normalement, le script devrait lancer l'éditeur sélectionné pour le type de fichier à modifier. N'hésitez pas à enregistrer votre travail au fur et à mesure que vous progressez. Il ne sera envoyé au serveur que si vous pressez les boutons « Save » ou « Save and continue ». Les autres boutons et zones de textes permettent de prévisualiser, annuler, entrer le resumé des modifications pour l'historique, marquer la modification comme mineure et ajouter la page à la liste de suivi.

Modèle:Languages

Outils personnels
Récemment sur Salve Regina