Compilation et intégration

Compilation et intégration

Une fois le développement du plugin terminé, il est nécessaire de le compiler pour générer une archive .jar constituant ansi le plugin à intégrer dans YellowBox.

Fichier build.xml #

La première partie du fichier est à modifier en fonction du plugin développé.

<project name="Plugin Yellowbox" default="CreateJar" basedir="." xmlns:ivy="antlib:org.apache.ivy.ant">

    <property name="extension.name" value="yellowbox_example-1.0.0" />
    <property name="src.dir" value="src" />
    <property name="build.dir" value="build" />
    <property name="classes.dir" value="${build.dir}/classes" />
    <property name="lib.dir" value="libs" />
    <property name="assets.dir" value="assets" />
    ...

La propriété extension.name correspond au nom du plugin développé suivi du numéro de la version, identique à celle du Header.

Pour compiler le plugin, il suffit de cliquer droit sur ce fichier, sélectionner “Run As” puis “Ant Build”.
Le résultat de la compilation apparaît alors dans la console d’Eclipse.
Si la compilation a réussi, BUILD SUCCESFUL doit apparaître ainsi que le chemin du dossier dans lequel le .jar s’est généré.

Configuration dans YellowBox #

Installation du package #

L’installation d’un plugin dans YellowBox nécessite d’être connecté sous un compte administrateur. En accédant au menu de paramétrage, il suffit d’accéder au menu “Plugins” en déroulant le menu “Interfaces” :

Cliquer ensuite sur le bouton “Packages installés” dans le bandeau haut. Cela affiche la liste de tous les packages déjà intégrés dans YellowBox.

En cliquant sur le bouton « Charger », une pop-up apparaît proposant de sélectionner un fichier dans le système de fichier. Il suffit alors de sélectionner le package (archive JAR) généré précédemment.
Une fois chargé, le package apparaît dans la liste comme suit :

Le package “Example Package” apparaît bien dans la liste.
Il faut maintenant paramétrer ce plugin.

Paramétrage d’un plugin #

Afin de rendre disponible une utilisation, il est nécessaire dans un premier temps de créer une instance de plugin.
Depuis la liste des plugins paramétrés, cliquer sur “Ajouter”.
L’interface du paramétrage du plugin s’affiche :

Saisir le nom de l’instance. Sélectionner le package dans le sélecteur “Plugin” puis la fonction ou le composant dans “Instance de”.
Les paramètres définis lors du développement s’affichent alors en dessous.

Utilisation dans YellowBox #

Des exemples complets comprenant le développement de fonctions et le développement de composants, sont disponibles dans la partie Exemple. Leur utilisation dans YellowBox y est également détaillée.