Documentation de XINX

Ce document représente la documentation du projet XINX.

XINX est un logiciel de développement essentiellement tournée vers l'édition de feuille de style XSL, utilisé pour générer des fichiers HTML. Une feuille de style XSL est un fichier qui décrit une liste de transformation à appliquer à chaque noeud d'un fichier XML pour le transformer en un autre fichier text (Text plat, HTML, ou un autre fichier XML). Le domaine de XINX s'est un peu étendue dans l'édition des JavaScript et des feuilles de styles CSS associé à la page XSL.

Bref XINX est fait pour vous aider à développer votre site internet à base de feuille de style XSL.

Le logiciel a été écris au début pour le développement des feuilles de styles de la société  Generix Group et été fortement tournée vers cette technologie. Maintenant XINX se concentre sur le développement de feuille de style, et tout spécificité lié à la société Generix Group a été déporté dans un plugins. Vous pouvez donc maintenant utiliser XINX pour tout développement de feuille de style XSL.

Le logiciel XINX peut voir ses fonctionnalité étendue à l'aide de modèle (parfois aussi appelé snipet ou template), à l'aide de script (au format ECMAScript, proche de ce qu'est le JavaScript), ou à l'aide de plugins (écrit en C++ et en utilisant le framework Qt). Sinon XINX étant un logiciel libre il vous est toujours possible de faire évoluer le logiciel dans son intégralité, voir même de proposer un patch si c'est un besoin qui manque au logiciel.

XINX utilise le framework  Qt comme base. Ce même framework est utilisé pour développé l'environnement de bureau  KDE, mais aussi des logiciels connues comme Skype, .... Qt est n'est pas seulement un framework graphique mais propose quelques extentions au langauge C++ à l'aide des signaux, des slots, des pointeurs partagées, des listes, des boucles foreach, ....

Ce manuel à pour but de vous aider à utiliser le logiciel XINX au mieux. Il vous expliquera comment installer le logiciel sur votre ordinateur, comment le paramètrer, puis comme l'utiliser pour développer vos feuilles de style.

L'application est livrée à titre gracieux et sans aucune garantie.

Son but est de simplifier l'écriture de feuille de style XSL à l'aide de la complétion. Cette complétion se trouve à plusieurs niveaux :

• Affichage d'un popup présentant les balises HTML/XSL, les attributs, les valeurs possibles de ses attributs. Et ceci à partir d'un fichier descriptif modifiable par l'utilisateur.
• Création automatique de la balise de fermeture.
• Création automatique des attributs par défaut.
• Création automatique des valeurs des attributs.
• Création automatique des sous-balises (par exemple pour les balises <xsl:choose>).
• Pour les balises de type xsl:call-template, ajout automatique des sous balise with-param avec les paramètres adéquates.

Un début de complétion sur le JavaScript a été écrit, présentant les fonctions et les variables définies sans le fichier. Seule la coloration syntaxique a été implémentée pour les feuilles de style en cascade CSS.

XINX propose également la création de projet. Ces projets permettent la copie automatique de feuilles de style dans un dossier projet (utilisé par la suite lors des migrations), la création de feuilles spécifiques à l'aide d'un préfixe, la recherche de fichier dans le dossier projet, l'utilisation du module CVS, SubVersion ...

Ci-dessous se trouve la documentation de XINX

Sommaire

1. Le guide de XINX
   1. InstallXinx - Comment installer
   2. XinxQuickStart - Démarrage rapide
   3. XinxProject - Le mode projet
   4. XinxCompletion - Utilisation de la complétion
   5. XinxSpecifique - Les spécifiques
   6. XinxServices - Les Web Services
   7. XinxRcs - Utilisation d'un gestionnaire de version
   8. XinxProperty - Personnalisation
   9. XinxShortCuts - Raccourcis
2. Extentions
   1. XinxPlugins - Écriture de plugins
   2. XinxScripts - Écriture de script
   3. XinxSnipets - Écriture de snipets