JavaScool:EditorCompletion

Comment définir la complétion automatique dans l'éditeur

Il suffit de définir un fichier completion.xml de la forme

<keywords>
  <keyword 
    name="nom de la complétion" 
    text="texte de la complétion" 
    title="description en ligne">
    <doc>Texte qui documente la fonction de l'on complète</doc>
  </keyword>
  <!-- autres keyword -->
</keywords>

• Le champ title permet, en autre, de distinguer deux complétions qui ont le même nom.
• Le texte qui documente la fonction est du texte ordinaire, il faut utiliser une construction <![CDATA[texte-HTML]]> pour insérer de l'HTML.

Exemple

<?xml version="1.0" encoding="UTF-8" ?>
<keywords>
    <keyword name="readString" 
        title="Stock dans une variable s une String"
        text="String s=readString();">
        <doc>Crée une variable s qui va contenir une chaîne de caractères demandé à l'utilisateur</doc>
    </keyword>
    <keyword name="readString" 
       title="Demande à l'utilisateur une chaîne" 
       text="readString()">
       <doc>Lit une chaîne de caractère dans une fenêtre présentée à l'utilisateur.
Il peut prendre un paramètre de type String qui décrit la valeur à entrer (optionel).</doc>
    </keyword>
</keywords>

Notes:

• Si les champs title et doc sont techniquement optionnels ils sont fortement recommandés.
• Si le champ name supplée au champ text, celui ci est fortement recommandé.