Le Journal de Nikrou - XUL

Empaqueter son extension!

Nicolas — Wed, 26 Oct 2005 21:35:00 +0000

Ecrire une extension n'est pas très compliqué même si cela peut s'avérer complexe. Mais une fois celle-là écrite il peut-être intéressant de la partager. Pour cela autant avoir pris dès le départ des bonnes habitudes, pour que cette fabuleuse extension s'intègre parfaitement dans firefox (ou mozilla ou thunderbird). Une première étape nécessaire est la répartition des différents fichiers constituants.

En règle générale, les différents fichiers d'une extension sont répartis dans trois répertoires: content, locale et skin. Le répertoire content contient les fichiers XUL, les fichiers Javascript et les fichiers XBL. Le répertoire locale contient tous les éléments liés à l'internationalisation (un répertoire par langue). Et enfin le répertoire skin contient les feuilles de style CSS.

Cela donne quelque chose comme ceci:

content
- fichiers XUL
- js
  - fichiers javascript
locale
- fr-FR
  - fichiers de localisation français
- en-US
  - fichiers de localisation anglais
skin
- fichiers css

Tout cela n'est pas très compliqué. Il ne reste plus qu'à déclarer l'extension auprès de firefox. C'est maintenant que cela devient un petit peu plus complexe. On peut de manière simple ajouter des références dans le répertoire chrome d'installation de firefox. Personnellement je ne trouve pas ça très propre surtout pour une extension en cours de développement. J'ai choisi de déclarer l'extension dans le répertoire du profil que j'utilise pour le développement.

En fait, ce qu'il y a de complexe c'est que cette déclaration se fait avec des fichiers RDF. Ces fichiers n'ont pas une structure si complexe que cela mais à la moindre erreur de synxtaxe cela ne fonctionne pas du tout et il est alors difficile et fastidieux de trouver l'erreur.

Voici comme j'ai procédé. Dans le répertoire chrome de mon profil (~/xul/chrome) j'ai crée ce fichier chrome.rdf. C'est tout pour le répertoire du profil. Après il faut créer un fichier contents.rdf par répertoire de l'extension déclaré dans le fichier chrome.rdf, c'est-à-dire un fichier dans content, un fichier dans chaque locale - en français et en anglais - et enfin un fichier dans skin.

J'ai placé mes extensions dans un répertoire ~/extensions/. L'extension est dans un répertoire hello. Pour l'adapter il suffit de remplacer tous les chemins du type file:///home/nicolas/extensions/hello/* par file:///chemin/vers/extension/nom_extension/* où * est content, skin ou locale/fr-FR (locale/en-US) dans le fichier chrome.rdf. Tous les endroits où il y a hello il faut le remplacer par l'identifiant de l'extension. Il faut faire de même pour les fichiers contents.rdf

En fermant puis relançant firefox on accède alors au fichier hello.xul à partir de l'url chrome://hello/content/hello.xul.

Bonjour le monde avec XUL!

Nicolas — Sat, 15 Oct 2005 11:26:00 +0000

Après avoir fait le nécessaire pour se créer un environnement de développement, on va pouvoir faire un premier essai. Manquant d'idée, on va faire dans l'orginal: un petit Hello World classique quel que soit le langage. Il manquait XUL, ce sera chose faite!

Ce qu'il faut savoir en premier lieu c'est qu'un fichier XUL n'est q'un fichier xml avec une DTD et donc une syntaxe à respecter. Comme c'est un fichier xml, il faut ajouter un prologue. L'élément racine est window (nous verrons plus tard qu'il en existe au moins un autre: overlay) auquel nous ajoutons l'espace de nom qui convient à savoir http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul. On met ensuite notre "hello world" dans un conteneur description. Cela donne ça:

<?xml version="1.0" encoding="iso-8859-1"?>
<window xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
<description>Hello World!</description>
</window>

Vous pouvez le testez vous même directement ou en récupérant ce code et en le copiant dans votre éditeur favori et ensuite taper dans la barre d'adresse file:///chemin/vers/ce/superbe/fichier/hello.xul

Comment débuter avec XUL ?

Nicolas — Fri, 14 Oct 2005 10:08:49 +0000

Les débuts avec XUL sont un peu chaotiques et complexes: il faut appréhender de nombreuses technologies (XML, javascript, CSS, RDF,...) et l'environnement firefox (ou mozilla ou thunderbird).

Il faut avant tout commencer par se créer un environnement de développement. J'ai choisi d'utiliser firefox en particulier pour l'extension webdevelopper. Il faut changer quelques préférences de celui-là pour se facilier la vie. Il faut fermer firefox et ajouter ceci dans votre fichier pref.js, situé dans le dossier profil de firefox:

user_pref("browser.dom.window.dump.enabled", true);
user_pref("javascript.options.showInConsole", true);
user_pref("javascript.options.strict", true);
user_pref("nglayout.debug.disable_xul_fastload", true);
user_pref("nglayout.debug.disable_xul_cache", true);

La première préférence rend possible l'utilisation de la fonction dump() de javascript qui permet d'envoyer des messages (d'erreurs!) sur la console à la condition de lancer firefox depuis cette même console. Que du bonheur! Ca change des alert! Les deux préférences concernant javascript activent respectivement les erreurs de syntaxe et les erreurs d'éxécutions. Les deux dernières désactivent le cache XUL et rendent possible des modifications des fichiers sources sans devoir relancer firefox à chaque modification!

Pour éviter de modifier mon profil général et avoir à relancer firefox à tout bout de champ, je me suis crée un deuxième profil. Il suffit depuis une console de taper la commande suivante: firefox -CreateProfile xul. Pour lancer firefox avec ce nouveau profil il suffira de faire: firefox -P xul. J'ai évidemment ajouter les préfénces précédentes dans ce nouveau profil.

Xul ça roule!

Nicolas — Sat, 24 Sep 2005 10:50:03 +0000

Je viens de créer une nouvelle catégorie Xul et j'y poste ce premier billet. Mais pourquoi donc ? Je viens d'acheter le livre Xul dans la collection les cahiers du programmeurs aux Editions Eyrolles.

Cette catégorie sera l'ocassion de répertorier au fur et à mesure mes découvertes et apprentissages de ce langage.