JavaScool:EditorCompletion : Différence entre versions

De Sciencinfolycee
Aller à : navigation, rechercher
m (Comment définir la complétion automatique dans l'éditeur)
m (Exemple)
Ligne 24 : Ligne 24 :
 
         title="Stock dans une variable s une String"
 
         title="Stock dans une variable s une String"
 
         text="String s=readString();">
 
         text="String s=readString();">
         <doc>Crée une variable s qui va contenir une chaîne de caractères demandé à l'utilisateur</doc>
+
         <doc>Crée une variable s qui va contenir une chaîne de caractères demandée à l'utilisateur.</doc>
 
     </keyword>
 
     </keyword>
 
     <keyword name="readString"  
 
     <keyword name="readString"  
 
       title="Demande à l'utilisateur une chaîne"  
 
       title="Demande à l'utilisateur une chaîne"  
 
       text="readString()">
 
       text="readString()">
       <doc>Lit une chaîne de caractère dans une fenêtre présentée à l'utilisateur.
+
       <doc>Lit une chaîne de caractère dans une fenêtre présentée à l'utilisateur.</doc>
Il peut prendre un paramètre de type String qui décrit la valeur à entrer (optionel).</doc>
 
 
     </keyword>
 
     </keyword>
 
</keywords>
 
</keywords>
 
</pre>
 
</pre>
 
  
 
=== Notes: ===
 
=== Notes: ===
 
* Si les champs <tt>title</tt> et <tt>doc</tt> sont techniquement optionnels ils sont fortement recommandés.
 
* Si les champs <tt>title</tt> et <tt>doc</tt> sont techniquement optionnels ils sont fortement recommandés.
 
* Si le champ <tt>name</tt> supplée au champ <tt>text</tt>, celui ci est fortement recommandé.
 
* Si le champ <tt>name</tt> supplée au champ <tt>text</tt>, celui ci est fortement recommandé.

Version du 26 août 2011 à 11:27

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ée à 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.</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é.