Un snippet de code est un fragment de code source prêt à l'emploi. Il peut être inséré dans un document facilement grâce à un mot clé (un raccourci-clavier) associé. L'extension propose deux types de snippets :
les snippets basés sur les instructions du langage FreeMarker,
les snippets basés sur les bibliothèques externes fournies par l'APE,
Les snippets FreeMarker
Ces snippets représentent l'ensemble des instructions (les directives) du langage FreeMarker dans sa version 2.3.28.
Il existe deux types de snippet :
le snippet sans paramètres : Celui-ci s'insère dans le document sans que l'utilisateur ait besoin de le compléter (ex : <#break/>, <#continue/>, <#flush/>, etc.),
le snippet avec paramètres : Celui-ci s'insère dans le document sous la forme d'un "texte à trou" dans lequel l'utilisateur doit remplacer les paramètres par ses propres valeurs. La navigation entre les paramètres se fait via la touche "Tabulation".
L'activation (l'insertion) d'un snippet se produit en saisissant un mot clé associé : Les snippets FreeMarker s'activent en commençant la saisie par la chaîne de caractères "&#" puis en saisissant le nom de la directive (ou une sous-chaîne contenue dans ce nom) : une info-bulle s'affiche avec un ensemble de propositions.
La navigation au sein de cette liste se fait via les touches "Flèche Haut" et "Flèche Bas" et la sélection d'un snippet s'effectue via la touche "Tabulation" ou "Entrée".
Note : Il est possible d'afficher toutes les snippets FreeMarker disponibles en saisissant juste la chaîne de caractères "&#".
↑ Haut de page
Ces snippets permettent d'insérer l'appel aux macros et fonctions définies dans les bibliothèques Core, CSS, FO et Adv.
Suivant la nature de ces entités, les snippets associés peuvent être avec ou sans paramètres (cf. Les snippets FreeMarker). Lorsqu'une entité (macro ou fonction) admet des paramètres obligatoires et optionnels, alors le snippet associé représente l'appel à cette entité avec les paramètres obligatoires seuls.
L'activation (l'insertion) d'un snippet se produit en saisissant un mot clé associé : Les snippets des bibliothèques s'activent en commençant la saisie par la chaîne de caractères "&@" pour les macros ou par la chaîne de caractères "&§" pour les fonctions ; puis en saisissant le nom de la bibliothèque concernée ("core" ou "css" ou "fo" ou "adv") et enfin, le nom de la directive (ou une sous-chaîne contenue dans ce nom) : une info-bulle s'affiche avec un ensemble de propositions.
La navigation au sein de cette liste se fait via les touches "Flèche Haut" et "Flèche Bas" et la sélection d'un snippet s'effectue via la touche "Tabulation" ou "Entrée".
Remarque : Lors de l'activation de certains snippets de la bibliothèque FO, l'insertion d'une macro hardisFo entraîne l'insertion d'une macro imbriquée : Cela est dû au fait que la balise XSL-FO associée à la macro englobante possède obligatoirement une balise XSL-FO enfant caractérisée par la macro englobée. Celle-ci est donc automatiquement ajoutée pour faciliter la saisie.
Il est possible d'afficher tous les snippets des bibliothèques disponibles en saisissant juste la chaîne de caractères "&@" (liste les macros) ou "&§" (liste les fonctions).
↑ Haut de page
Ces snippets permettent de créer rapidement un template APE en se basant sur un modèle prédéfini.
Les modèles proposés sont les suivants :
minimalDoc : Un modèle de document minimaliste avec un layout de page élémentaire,
regionsDoc : Un modèle de document au format A4 portrait incluant marges et régions haut / bas / droite / gauche avec un layout de page élémentaire,
oddevenDoc : Un modèle de document au format A4 portrait incluant marges et régions haut / bas avec un layout de pages paires et impaires.
L'activation (l'insertion) d'un snippet se produit en saisissant un mot clé associé : Les snippets des modèles de templates s'activent en commençant la saisie par la chaîne de caractères "&@!" puis en saisissant le nom du modèle (ou une sous-chaîne contenue dans ce nom) : une info-bulle s'affiche avec un ensemble de propositions.
La navigation au sein de cette liste se fait via les touches "Flèche Haut" et "Flèche Bas" et la sélection d'un snippet s'effectue via la touche "Tabulation" ou "Entrée".
Il est possible d'afficher tous les snippets de modèles disponibles en saisissant juste la chaîne de caractères "&@!".
