Écriture de Snipets

XINX permet d'utiliser des Snipets pour aider aux développements. Les snipets sont des morceaux de code qui sont insérés dans le texte, soit en les appelant à partir d'un menu, soit en écrivant une clé suivie du raccourci Ctrl+Space.

Configuration

Boite de configuration

Les snipets se configurent dans la boite de dialogue de personnalisation de XINX.

Dans cette boite de dialogue, il est possible d'importer/exporter des Snipets depuis/vers un fichier XML. Cette fonctionnalités vous permet d'écrire vos propres Snipets et de les exporter dans un fichier, pour les transmettre à une autre personne ou pour les réimporter dans une nouvelle version.

Il est également possible d'ajouter, de supprimer ou de modifier des Snipets.

Propriété du Snipet

L'ajout et la modification se fait à l'aide de la boite de dialogue suivante :

Cette boite de dialogue permet de définir différentes informations :

• Nom : Le nom que vous allez donner au Snipet
• Image : Le chemin vers une image représentant le Snipet. Si le chemin commence par :/ il est interne à l'application.
• Extension : L'extension correspondant au type de fichier. Elle est utilisée pour déterminer la coloration syntaxique à utiliser dans l'éditeur.
• Clé du snipet : Cette clé utilisée permet d'appeler le snipet lors de la saisie dans l'éditeur. Par exemple si dans la clé le mot est sort alors, au moment de la saisie dans l'éditeur du mot sort suivi de Ctrl+Space.
• Catégorie : La catégorie dans laquelle doit être classé le snipet.

Elle permet également de définir le texte à utiliser pour le snipet (le texte qui devra être inséré). Ce texte peut être parsemé de joker. Un joker est défini par le sigle % suivi d'un numéro. Le même joker peut être défini plusieurs fois.

Le code du snipet suivant demande deux jokers. XINX permet alors la saisie d'un nom pour chaque Joker. Le nom utilisé pour le Joker est utilisé lors de l'appel à celui-ci.

<xsl:call-template name="GnxSort">
        <xsl:with-param name="title">%1</xsl:with-param>
        <xsl:with-param name="sortkey_asc">%2</xsl:with-param>
        <xsl:with-param name="sortkey_desc">-%2</xsl:with-param>
</xsl:call-template>

Le code ci-dessus, avec comme Joker Mon titre et TITLE, deviendra alors :

<xsl:call-template name="GnxSort">
        <xsl:with-param name="title">Mon titre</xsl:with-param>
        <xsl:with-param name="sortkey_asc">TITLE</xsl:with-param>
        <xsl:with-param name="sortkey_desc">-TITLE</xsl:with-param>
</xsl:call-template>

Script dans les snipets

De plus il est possible d'insérer des morceaux de scripts dans le template afin de générer un template automatiquement. Les scripts sont entourés des balises <? et ?> ainsi que de la balise <?= et ?>.

La balise <?= récupère et affiche le résultat du script alors que la balise <? ne permet que définir des variables.

<?
var text, cinematique;
if( '%1' == '' ) {
  text = '';
  cinematique = 'propose(0);assimilate();';
} else {
  text = '<input type="hidden" name="sourceview" value="%1"/>\n';
  cinematique = '';
} 
?>
<?= text ?><input type="hidden" name="cinematic" value="<?= cinematique ?>%2"/>
<input type="hidden" name="entity" value="{$ENTITY}"/>
<input type="hidden" name="id" value="{$ID}"/>
<input type="hidden" name="frame" value="{$FRAME}"/>