Attention : Le contenu de ces pages n'a pas été mis à jour depuis longtemps. Il est probablement obsolète pour Firefox 4.0/Gecko 4.0 et supérieur. Pour du contenu plus récent, allez consulter developer.mozilla.org.

Subversion

Travailler avec les sources du tutoriel XUL

Le contenu du tutoriel XUL est sauvegardé dans un dépot Subversion. Subversion est un outil de gestion de versions.

Outils

Pour travailler avec les sources du tutoriel, il vous faut donc installer Subversion, éventuellement un client « graphique » (mais toutes les instructions seront données avec la version originale, en ligne de commande).

Vous pouvez trouver les sources de Subversion, ainsi que des packages d'installation à cette adresse : http://subversion.tigris.org/project_pac(..).

Il vous faut aussi installer PHP CLI (la version ligne de commande de PHP) pour générer éventuellement les pages HTML du tutoriel.

Vous pouvez trouver des informations sur PHP CLI à l'adresse : http://www.php.net/manual/fr/features.co(..)

Récupérer les sources

Vous devez executer en ligne de commande, dans un répertoire de travail :

 svn checkout [[svn://svn.berlios.de/xulfr/xulplanet/xultu/trunk/]]

Les sources vont alors se télécharger et s'enregistrer sur votre disque. Vous obtenez :

 builds/                       répertoire qui contiendra les fichiers HTML générés
 buildsinglefile.php           script qui génère le tutoriel dans un seul fichier
 buildsinglefile_pour_pdf.php  idem, mais formaté pour être transformer en pdf
 buildtuto.php                 script qui génère les pages HTML du tutoriel
 changlogs/                    à ignorer, vieux fichiers
 diffs-xultu-mar18-05.txt      à ignorer, vieux fichier
 liste_articles.php            include, contenant la liste des articles du tuto
 src/                          contient tout les articles
 statiques/                    contient les exemples, images, etc du tuto

Ce que vous modifierez principalement, ce sont les fichiers situés dans le répertoire 'src/'.

Effectuer des corrections

Les fichiers dans 'src/' contiennent le texte HTML des articles. Ces fichiers ne sont pas des fichiers HTML complet (pas de <head>, etc.). C'est le script 'buildtuto.php' qui rajoutera le complément pour en faire des pages HTML complètes, prêtes à être installées sur le site.

Éditer les sources

Les fichiers que vous modifierez avec vos corrections sont donc les fichiers situés dans src. Vous devez les éditer dans un éditeur de texte classique, en respectant les régles suivantes :

l'encodage utilisé est iso-8859-1. veillez donc bien à ce que votre éditeur sauvegarde avec cet encodage
vous ne devez pas transformer les entités html présentes en leur caractère correspondant : les exemples ne s'afficheraient plus
vous ne devez pas ajouter des nouvelles balises html, sauf pour ajouter du nouveau contenu. Ne rajoutez pas les balises <html>, <head>, <body> etc..
veillez à ce que les sauts de lignes respectent la convention unix. (\n, et non \r\n par exemple; voir la configuration de votre éditeur)

Générer le tutoriel

Une fois les corrections effectuées, ou en cours de correction, vous pouvez générer les fichiers finaux, afin de pouvoir faire une relecture via un navigateur.

Pour ce faire, exécutez d'abord en ligne de commande :

  php buildtuto.php

Les fichiers HTML résultants sont placés dans le repertoire 'builds/', et vous pouvez les visualiser dans votre navigateur.

Renvoyer les corrections

envoyez nous les fichiers que vous avez modifié. Aprés acceptation de vos corrections, nous sauvegarderons votre fichier dans le dépot subversion

Mettre à jour votre copie du dépot

Vous devez toujours travailler avec la version la plus récente du tutoriel. Il faut donc régulièrement effacer le repertoire crée lors de svn checkout, et refaire un svn checkout comme indiqué plus haut.

Le contenu de cette page est disponible selon certaines conditions de réutilisation.
Cette page du wiki n'est pas éditable. Le système wiki n'étant plus fonctionnel.