Guide utilisateur

Installation

Pré-requis

  • Sun ou Apple Java[tm] runtime 1.4.1 ou plus.
  • Au moins 256Mb de RAM et une CPU de 600MHz.
  • 100Mb d'espace disque libre.
  • Sur Windows NT/2000/XP ou sur Linux.

Installation sur Windows

  1. Assurez vous que un runtime Java™ 1.4.1 ou plus est déjà installé sur votre machine. Pour le vérifier, ouvrir une fenêtre de commande DOS et taper "java -version" suivi de la touche Enter. Vous devriez obtenir quelque chose comme ceci:

    C:\> java -version
    java version "1.5.0_04"
    Java(TM) 2 Runtime Environment, Standard Edition 
    (build 1.5.0_04-b05)
    Java HotSpot(TM) Client VM 
    (build 1.5.0_04-b05, mixed mode, sharing)
  2. Utilisez un outil tel que WinZip, 7-Zip ou Info-Zip [1] pour décompresser l'archive XXE dans le répertoire de votre choix:

    C:\> unzip xxe-std-3_1_0.zip
    C:\> dir xxe-std-3_1_0
    ... <DIR> addon
    ... <DIR> bin
    ... <DIR> demo
    ... <DIR> doc
  3. XXE est supposé être utilisé directement à partir du répertoire xxe-std-3_1_0 . Cela signifie que vous pouvez simplement démarrer XXE en exécutant:

    C:\XMLmind> xxe-std-3_1_0\bin\xxe.bat

Installation sur Linux

  1. Assurez vous que le répertoire Java[tm] bin/ est référencé par la variable d'environnement $PATH et, en même temps, vérifiez que le Java[tm] runtime référencé par $PATH a la bonne version:

    $ java -version
    java version "1.5.0_04"
    Java(TM) 2 Runtime Environment, Standard Edition 
    (build 1.5.0_04-b05)
    Java HotSpot(TM) Client VM 
    (build 1.5.0_04-b05, mixed mode, sharing)
  2. Décompresser l'archive XXE dans le répertoire de votre choix:

    $ cd 
    $ unzip xxe-std-3_1_0.zip
    $ ls xxe-std-3_1_0
    addon/
    bin/
    demo/
  3. XXE est supposé être utilisé directement à partir du répertoire xxe-std-3_1_0/ . Cela signifie que vous pouvez simplement démarrer XXE en exécutant:

    $ xxe-std-3_1_0/bin/xxe &

    Après cela, vous pouvez désirer ajouter le répertoire xxe-std-3_1_0/bin/ à votre variable d'environnement $PATH.

Représentation d'un bracelet

Voici comment on va décrire un bracelet au format XML.

  • Un bracelet est représenté par l'élément <Bracelet>
  • Un bracelet <Bracelet> est composé d'un premier rang <HeadRow>, suivi de un ou plusieurs autres rangs <Row>, autant que nécessaires.
  • Le premier rang <HeadRow> sert à définir le nombre de fils du bracelet et leur couleur. Chaque fil est représenté par un élément <Thread> dont l'attribut color définit la couleur. Les valeurs de couleurs sont disponibles sur le nuancier suivant.
  • Les rangs suivants <Row> servent à définir les noeuds. Les diverses possibilités sont: le noeud vers la droite <RightNode>, le noeud vers la gauche <LeftNode>, le demi-noeud vers la gauche puis la droite <RightHalfNode>, le demi-noeud vers la droite puis la gauche <LeftHalfNode>, la prolongation du fil jusqu'au rang suivant <Thread>. A noter qu'un node occupe toujours la largeur de deux thread, et qu'au final chaque rang doit avoir la même largeur.
  • Pour des raisons techniques uniquement, l'élément <HeadRow> contient toujours un élément <HeadCell> qui lui-même contient les fils. De même l'élément <Row> contient toujours un élément <Cell> qui lui-même contient les noeuds.

Créer un bracelet

  1. Lancer XXE (voir ci-dessus)
  2. Dans le menu principal, choisir File --> New
  3. Double-cliquer sur le mot "Bracelet". Un bracelet apparaît avec 10 fils verts sur une première rangée, et 10 autres sur une deuxième rangée.
  4. Sauvegarder immédiatement sous le nom de fichier de votre choix (garder de préférence l'extension .xml) à partir du menu principal File --> Save As...
  5. Cliquer sur un fil du premier rang du bracelet pour le sélectionner. Un cadre rouge montre l'élément sélectionné.
  6. Commençons par décider de la couleur de chaque fils du bracelet. Pour cela , le sélectionner. Dans l'onglet Attribut qui doit apparaître sur la partie basse à droite, on voit l'attribut color. Dans la colonne Value, on peut activer par un clic un sous-menu permettant de sélectionner la couleur de votre choix. Le dessin du fil dans l'éditeur prend immédiatement la couleur voulue.
  7. Continuons en décidant du nombre de fils du bracelet. Pour supprimer un fil, le sélectionner puis tapez Ctrl-K. Pour rajouter un fil, on peut par exemple sélectionner un fil de la même couleur, et le copier par Ctrl-C. Ensuite on peut le coller à l'emplacement voulu: on sélectionne un autre fil, puis Ctrl-V pour coller le fil précédemment copié à la place du fil sélectionné, ou Ctrl-U pour le rajouter avant le fil sélectionné, ou Ctrl-W pour le rajouter après le fil sélectionné.
  8. Il est temps maintenant de travailler sur le premier rang de noeuds. Cliquer sur un fil pour le sélectionner. En maintenant Ctrl-Shift enfoncé, cliquer sur le fil suivant. On a maintenant deux fils sélectionnés. Pour faire un noeud vers la droite, cliquer sur l'icône Replace, en haut à droite, et cliquer sur le type de noeud désiré RightNode, juste en dessous de l'icône. Les deux fils sont maintenant remplacés par le noeud choisi. A noter que la couleur du nouveau noeud est automatiquement calculée en fonction des rangs précédents.
  9. Pour rajouter un nouveau rang, cliquer sur un des fils du rang précédent. Il est maintenant sélectionné et l'on peut voir en haut à gauche, sous la barre d'icône, la hiérarchie des éléments qui le contiennent. Bracelet - Row - Cell - Thread. En cliquant sur le mot Row, on peut sélectionner tout le rang. On peut donc rajouter un rang soit en cliquant sur l'icône Insert After puis sur Row, soit en tapant simplement Ctrl-Ins (touche qui ajoute après l'élément sélectionné un élément de même type).
  10. Maintenant vous pouvez construire tout le bracelet, en utilisant les fonctions Replace, Insert Before, Insert, Insert After que l'on a entraperçu ci-dessus. Elles sont disponible soit dans le menu Edit, soit en icônes dans la fenêtre en haut à droite, soit avec les touches de fonction.
  11. Enfin n'oubliez pas que tout bracelet est répétitif, et que donc le Copier/Coller de plusieurs rangs (utilisez encore le Ctrl-Shift) va vous faire gagner beaucoup de temps pour obtenir le bracelet complet.
  12. Personnellement, je finis toujours par un rang de fils simples par symétrie avec la façon dont on a commencé.
Note
Il est important de ne saisir l'attribut color que sur le premier rang. Tout est toujours calculé à partir de ce rang. Mais si on force un attribut color sur un Thread des rangs suivants, cela n'est pas sensible dans l'éditeur, mais cela altère la construction du schéma SVG qui n'aura plus les bonnes couleurs. Donc attention, notamment avec les copier/coller.
Note
Seul le noeud inséré est redessiné de la bonne couleur. Normalement comme on crée le bracelet de haut en bas, c'est parfait. Mais si on s'est trompé et que l'on remplace un noeud des rangs supérieurs, il ne faut pas s'étonner de ne pas retrouver les bonnes couleurs sur les rangs du bas. Je n'ai pas encore développé de fonction refresh, donc le seul moyen de le faire c'est de sauvegarder le fichier, le fermer, puis le rouvrir.
Note
Il n'est pas naturel de travailler row par row, car lorsqu'on tisse on le fait plutôt en diagonale. Mais on s'y habitue. On peut cependant commencer un rang sans finir le précédent, mais pour que cela fonctionne bien, il faut au moins que tous les fils ou noeuds des rangs du dessus existent, jusqu'à la position du noeud construit. Sinon on peut tout de même insérer des noeuds, mais on ne verra pas leurs couleurs correctes.

Visualisation du bracelet

  1. On peut obtenir un dessin SVG du bracelet, de façon à mieux visualiser son aspect après réalisation. Dans le menu principal, choisir Bracelet --> dessin (SVG)... et choisir le nom du fichier *.svg.
  2. On peut obtenir les dimensions du bracelet conçu, et surtout une estimation de la longueur des fils nécessaires. Dans le menu principal, choisir Bracelet --> dimensions (SVG)... et choisir le nom du fichier *.svg.
Note
Pour visualiser le SVG sur votre navigateur, il faut un plugin, ADOBE par exemple pour Internet Explorer. Pour Firefox, c'est déjà inclus.

Exemples de bracelets

Dans le répertoire addon/bracelet/samples de la distribution de l'outil se trouvent quelques exemples permettant de mieux comprendre comment concevoir des bracelets avec cet outil.

Ouvrez les avec XXE, et pratiquez. On peut par exemple modifier les couleurs sur le premier rang pour tester différents effets.