Version du 3 mars 2011 à 14:36

Guide développeur

Ce guide a pour objectif de décrire la création d'une instance XIMF. Cela passe par la définition des champs d'entête spécifiques, par la description des formulaires de création et de visualisation.

Identification d'un message XIMF

Un message XIMF est un message IMF qui intègre des champs d'entête spécifiques qui peuvent être interprétés par le moteur XIMF.

Le traitement des messages XIMF (en réception) est réalisé par le client Trustedbird dans le cas où les champ d'entête suivants sont présents :

• X-XIMF-Name
• X-XIMF-Version

Dans le cas où un de ces champs d'entête n'est pas présent, le client Trustedbird n'affiche pas le formulaire XIMF à la réception du message.

Ces champs d'entête sont des champs techniques. C'est à dire qu'ils ne sont pas saisis par l'utilisateur mais générés automatiquement lors de l'envoi d'un message.

Structure de l'instance

Une instance XIMF est composée de plusieurs fichiers xml :

• un fichier ihm définissant l'agencement de l'interface
• un ou plusieurs fichiers headers définissant les types des champs de l'interface
• un fichier dictionnaire définissant les données d'internationalisation
• un ou plusieurs fichiers de règles définissant les contraintes spécifiques associées aux champs du formulaire

Les informations concernant les fichiers utilisés par une instance ce situent dans un autre fichier : ximfmail-profile.xml.

Glossaire des balises XIMF

Une description détaillée des balises XIMF est disponible.

Exemples d'instances XIMF

Instance simple : Example1 (un seul champ : type de correspondance)

Instance simple : Amoco (plusieurs champs aux types variés : nom de l'affaire, label, date limite ...)

Instance simple : lien vers l'instance simple Company (associée au RFC security label example)

instance intégrant les possibilités avancées de XIMF.

Création d'un add-on XIMF

Génération d'un add-on au format XPI. lien vers documentation Mozilla pour les XPI