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" 
    title="description en ligne">
    <code>texte source de la complétion</code>
    <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">
       <code>String s=readString();</code>  
        <doc>Crée une variable s qui va contenir une chaîne de caractères demandée à l'utilisateur.</doc>
    </keyword>
    <keyword name="readString" 
       title="Demande à l'utilisateur une chaîne">
       <code>readString()</code>
       <doc>Lit une chaîne de caractère dans une fenêtre présentée à l'utilisateur.</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é.