<oXygen/> User Guide

Chapitre 3. Débuter

Cette section offre un aperçu de l'interface graphique utilisateur (GUI) de oXygen. Une explication de chaque composant de l'interface et une courte description de son but ou son usage sont données. L'espace de travail de Oxygen est divisé en trois panneaux :

Préférences

Une fois que oXygen est installé vous pouvez utiliser les préférences suivantes pour personnaliser oXygen selon vos besoins et votre environnement réseau.

Général

Figure 3.1. Les préférences générales

Les préférences générales
Changer la langue de l'interface

oXygen supporte plusieurs langues pour la localisation de l'interface utilisateur. Sélectionnez la liste déroulanteOptions->Préférences->Général+Langue pour afficher la langue de votre choix.

Changer l'apparence

Utilisez cette option pour modifier le style de l'interface.

Contrôle automatique de version

Lorsqu'il est activé, contrôle la disponibilité d'une nouvelle version de oXygen à http://www.oxygenxml.com.

Encodage pour les fichiers non-XML

Cette option définit l'encodage par défaut à utiliser lors de l'ouverture de documents non-XML.

Manipulation de la BOM

Cette option définit la manipulation de la BOM (marque d'ordre d'octet ou Byte Order Mark) quand le document est sauvegardé.

Les options possibles sont :

  • Ne pas écrire - n'écrit pas les octets de la BOM, les octets chargés de la BOM sont ignorés ;

  • Écrire - écrit les octets de la BOM associés au codage du document;

  • Préserver - si le document chargé avait une BOM, écrire les octets de la BOM associée au codage du document. C'est l'option par défaut.

Séparateur de ligne

Cette option définit le séparateur de ligne à utiliser. Le choix par défaut du système règle le séparateur de ligne selon la plate-forme.

Navigateur internet par défaut

Le chemin d'un exécutable de navigateur web. Le navigateur est utilisé pour ouvrir les résultats des transformations XSLT ou PDF, pour ouvrir la page d'accueil de Oxygen ou pour aller à des paragraphes spécifiques dans la recommandation du W3C des grammaires XML Schéma sur le site du W3C en cas d'erreurs de validation.

Éditeur

Utilisez ces options pour configurer l'aspect visuel, les paramètres de formatagee et le comportement de l'assistant de contenu.

Aspect

Figure 3.2. Le panneau Aspect

Le panneau Aspect
Police

Utilisez cette option pour sélectionner la la famille et la taille de la police utilisée pour afficher le texte dans l'éditeur.

Couleur de fond de l'éditeur

Utilisez cette option pour régler la couleur de fond de l'éditeur.

Couleur du curseur de l'éditeur

Utilisez cette option pour régler la couleur de fond de l'éditeur.

Couleur de la sélection active

Utilisez cette option pour régler la couleur du texte sélectionné.

Couleur de fond de la sélection

Utilisez cette option pour régler la couleur de fond du texte sélectionné.

Même police pour l'interface

Si coché, la police de l'interface sera celle de l'édition.

Anti-crénelage du texte

Cette option indique si les chaînes du texte doivent être dessinées avec un rendu anti-crénelage.

Saut de ligne

Cette option va automatiquement faire de sauts de ligne dans les documents édités.

Montrer marques EOL/EOF

Montre les EOL/EOF en utilisant de petits icônes, pour une meilleure visualisation du document.

Afficher les nombres de lignes

Cette option active la colonne des numéros de ligne se trouvant dans la partie gauche de l'espace d'édition. Si la case n'est pas cochée, l'option nombres de lignes est désactivée.

Formatage

Figure 3.3. Le panneau Formatage

Le panneau Formatage
Taille d'indentation

Règle le nombre d'espaces ou la taille de la tabulation qui équivaudra à une simple indentation. L'indentation peut être des espaces ou une tabulation, séléctionner la préférences en utilisant l'option Indentation avec Tabulation. Si réglé à 4 une tabulation équivaudra à 4 espaces blancs ou une tabulation de 4 caractères suivant quelle option a été réglée dans l'option Indentation avec Tabulation.

Indenter avec tabulation

Si coché active 'Indenter avec tabulation' pour régler l'indentation à une unité de tabulation. Si la case n'est pas cochée, 'Indenter avec tabulation' est désactivé et l'indentation sera du nombre d'espaces définis par l'option 'Largeur d'une indentation'.

Smart indent

Smart Indent a pour but d'indenter le formatage en accordance avec le texte/balise et sa position/contexte à l'intérieur du corps du document. Cette option active ou désactive l'usage de l'indentation intelligente.

Longueur de ligne - pretty print

Définit le point auquel la fonction "Formater et indenter" (Pretty-Print) va exécuter le saut de ligne. Si réglé à 100, Pretty-Print va faire un saut de ligne au 100ème espace, espaces vierges, balises, et éléments inclus.

Augmenter les éléments vides

Si coché, l'opération Format et indenter va représenter les éléments vides avec une balise de fermeture séparée, par ex. <a atr1="v1"></a>. Si non-coché, la même opération va représenter un élément vide dans une forme plus compacte : <a atr1="v1"/>

Trier les attributs

Si coché, l'opération Formater et indenter va trier alphabétiquement les attributs d'un élément. Si non-coché, la même opération va les laisser dans le même ordre qu'avant l'application de l'opération.

Préserver les éléments d'espace

Cette liste contient les noms des éléments pour lesquels les espaces blancs contenus comme les blancs, tabulations et lignes vierges sont préservés par l'opération Formater et indenter exactement comme avant l'application de l'opération.

Éliminer les éléments d'espace

Cette liste contient les noms des éléments pour lesquels les espaces blancs contigus comme les blancs, tabulations et lignes vierges sont fusionnés par l'opération Formater et indenter en un seul blanc.

Enregistrer

Figure 3.4. Le panneau Enregistrer

Le panneau Enregistrer
Faire une copie de sauvegarde à l'enregistrement

Si coché, à la sauvegarde d'un document édité une copie de sécurité est faite.

Activer l'enregistrement automatique

L'enregistrement automatique est une fonction pratique qui assure que votre travail est sauvegardé en fond. Vous pouvez spécifier le délai entre chaque sauvegarde automatique. Si coché, permet à l'enregistrement automatique d'utiliser la valeur spécifiée. Si non-coché, l'enregistrement automatique est désactivé.

Intervalle d'enregistrement automatique (minutes)

Sélectionner le délai en minutes pour l'intervalle entre chaque enregistrement automatique.

Tag-Insight

La fonction Tag-insight permet la recherche en ligne de syntaxe et l'auto-remplissage d'éléments et d'attributs de formatage pour rationnaliser le formatage et réduire les erreurs lors de l'édition.

Propriétés

Ces réglages définissent le mode opératoire de l'assistant de contenu.

Figure 3.5. Le panneau Propriétés de Tag Insight

Le panneau Propriétés de Tag Insight
Utilisation Tag-insight

Cette option active le Tag-insight. Si la case n'est pas cochée, toutes les fonctionnalités Tag-insight sont désactivées.

Fermer l'élément inséré

Lors de l'insertion d'éléments depuis l'assistant Tag-insight, les balises de début et de fin sont toutes deux insérées.

Ajouter les éléments requis

Lorsque la case est cochée, oXygen va insérer automatiquement les éléments de la DTD ou du Schema XML.

Remplissage automatique des balises de fin

Ayant manuellement tapé la balise de début d'un élément, oXygen va automatiquement insérer la balise de fin quand </ est tapé.

Insérer les attributs obligatoires

Lors de l'insertion d'un élément depuis l'assistant Tag-insight, le curseur est automatiquemennt positionné avant le crochet > de la balise de début. Entrer un espace affiche les attributs supportés par l'élément inséré.

Insérer les attributs fixés

Si coché, Oxygen va automatiquement insérer n'importe quels attributs FIXÉS de la DTD pour un élément inséré à l'aide de l'assistant Tag-Insight.

Montrer toutes les entités

Si coché, oXygen va afficher une liste avec toutes les entités internes et externes déclarées dans le document actuel quand l'utilisateur tape le caractère de début d'une entité (c.-à-d. &).

Position du curseur entre les balises

Si coché, Oxygen va mettre le curseur automatiquement entre les balises même si les éléments auto-insérés ont des attributs qui ne sont pas requis. La position du curseur peut être forcée entre les balises.

Apprendre les valeurs des attributs

Si coché, Oxygen va afficher une liste avec toutes les valeurs des attributs apprises depuis le document actuel.

Défaut

L'URL du DTD / XML Schéma à utiliser lorsque aucune grammaire n'est spécifiée dans le document édité.

Figure 3.6. Le panneau Défaut Tag Insight

Le panneau Défaut Tag Insight
DTD

Utilisé pour spécifier le chemin complet du fichier DTD qui sera utilisé pour initialiser l'assistant Tag-insight quand un document ne définit pas une DTD, un Schema XML ou un Relax NG Schema.

Schema XML

Utilisé pour spécifier le chemin complet du fichier Schema XML qui sera utilisé pour initialiser l'assistant Tag-insight quand un document ne définit pas une DTD, un Schema XML, un Relax NG Schema ou un NRL Schema.

XSL

Ces réglages définissent quels éléments sont suggérés par l'assistant de contenu en plus de ceux de la XSL.

Figure 3.7. Le panneau XSL de Tag Insight

Le panneau XSL de Tag Insight
Aucun

Le Tag-insight n'offrira que l'information XSL..

XHTML transitional

Inclut les éléments XHTML Transitional comme substitut pour xsl:element.

Formating objects

Inclut des éléments Formating Objects comme substitut pour xsl:element.

Autre

Inclut des éléments d'un fichier DTD ou Schema XML spécifié depuis une URL comme substitut pour xsl:element.

Catalogue XML

Un catalogue XML est un ensemble de correspondances entre fichiers DTD et/ou XML Schéma et/ou Relax NG et des copies locales de ces fichiers. Si l'accès à internet n'est pas disponible ou est lent, un ou plusieurs catalogues XML peuvent être ajoutés à la liste dans le dialogue ci-dessous et les copies locales des fichiers DTD et/ou XML Schéma et/ou Relax NG seront utilisées durant la validation. Quand vous ajoutez ou effacez un catalogue XML à la liste des catalogues XML dans le panneau Options -> Préférences -> XML Catalog vous devez relancer l'application pour que les changements prennent effet.

Figure 3.8. Le panneau XML Catalog

Le panneau XML Catalog

L'option Préférer est utilisée pour spécifier si oXygen va essayer de résoudre d'abord la référence PUBLIC ou SYSTEM en utilisant les catalogues XML spécifiés. Si une référence PUBLIC n'est pas référencée dans aucun des catalogues alors une référence SYSTEM est cherchée.

Le niveau de verbosité spécifie les types de messages de sortie affichés en standard qui peuvent avoir une de ces valeurs : debug, warn, info, erreur et fatal.

Si l'utilisateur n'a pas ajouté de catalogues XML à cette liste, alors Oxygen va ajouter par défaut les catalogues intégrés pour les documents DocBook et TEI situés dans les sous-répertoires located in the docbook et tei du répertoire d'installation.

Caractéristiques de la moulinette XML

Figure 3.9. Le panneau Options Parseur XML

Le panneau Options Parseur XML

http://apache.org/xml/features/validation/schema - Cette option règle la fonction 'schema' sur vrai.

http://apache.org/xml/features/validation/schema-full-checking - Cette option règle la fonction 'schema-full-checking' sur vrai.

Valider selon un schéma XML même si une DTD est spécifiée - Cette option force la validation selon un schéma XML référé même si le document inclut une déclaration de DTD.

Options de XSLT

Figure 3.10. Option du transformateur XSLT JAXP

Option du transformateur XSLT JAXP

Si vous souhaitez utiliser un autre transformateur XSLT que celui livré avec Oxygen c.-à-d. Apache Xalan et Saxon, il vous suffit de spécifier le nom de la classe du transformateur que Oxygen va régler comme valeur de la propriété Java "javax.xml.transform.TransformerFactory". Pour exécuter une transformation XSLT avec Saxon 7 par exemple, vous devez placer le fichier jar Saxon 7 dans le répertoire des bibliothèques de Oxygen (le sous-répertoire lib du répertoire d'installation), régler "net.sf.saxon.TransformerFactoryImpl" comme valeur de la propriété et sélectionnert JAXP comme le processeur XSLT dans le scénario de transformation associé au document XML transformé.

Valeur

Permet à l'utilisateur d'entrer le nom de la classe Java du transformateur.

Valider avec

Permet à l'utilisateur de régler le moteur XSLT utilisé pour la validation des documents XSL.

Réglages Debugger

Cette section explique les réglages disponibles pour le mode Debugger. Pour afficher les réglages, sélectionnez Options->Préférences+Options Debugger (voir Figure 3.11, « Réglages Debugger »).

Figure 3.11. Réglages Debugger

Réglages Debugger

Les réglages suivants sont disponibles :

Active la sortie XHTML

Active ou désactive la sortie en XHTML Vue du document de sortie durant la transformation. Pour des questions de performance, il est conseillé de désactiver la sortie XHTML pour les gros traitements. Par ailleurs, la zone XHTML ne peut afficher que les documents XHTML. Pour pouvoir voir le résultat de sortie d'autres formats, comme HTML, enregistrez la zone de sortie texte dans un fichier et utilisez le navigateur externe requis pour la visualisation.

Détection de boucle infinie

Activez cette option pour recevoir une notification lorsqu'une boucle infinie apparaît durant la transformation.

Profondeur maximale dans la pile des modèles

Combien d'instructions modèles (<xsl:templates>) peuvent apparaître sur la pile actuelle. Ce réglage est utilisé par la détection de boucle infinie.

Processeurs FO

En dehors du processeur d'objets de formatage intégré (Apache FOP) l'utilisateur peut utiliser d'autres processeurs externes. Oxygen a implémenté une façon aisée d'ajouter XEP comme processeur de FO externe si l'utilisateur a XEP d'installé.

Figure 3.12. Le panneau processeur FO

Le panneau processeur FO
Permettre le rendement du FOP intégré

Si coché, toutes les sorties FOP seront affichés dans un panneau de résultats en bas de la fenêtre de l'éditeur dont les messages ennuyants sur les instructions FO non-supportées par FOP.

Mémoire disponible pour le FOP intégré

Si vos transformations FOP échouent avec l'erreur "Out of Memory", sélectionnez depuis cette liste de choix une plus grande valeur pour le niveau de mémoire réservé pour les transformations FOP.

Fichier de configuration pour le FOP intégré

Vous devriez spécifier ici un chemin pour le fichier de configuration FOP, nécessaire par exemple pour sortir en PDF en utilisant une fonte True Type pour un document contenant de l'Unicode.

Les utilisateurs peuvent configurer les processeurs externes à utiliser avec Oxygen dans le dialogue suivant.

Figure 3.13. Configurer les processeurs externes

Configurer les processeurs externes
Nom

Le nom qui sera affiché dans la liste des processeurs FOP disponibles sur l'onglet FOP du dialogue configuration de la transformation.

Description

La description du processeur FO affichée dans l'option Préférences->Processeurs FO.

Répertoire de travail

Le répertoire dans lequel les résultats intermédiaires et finaux du traitement seront sauvés.

Ligne de commande

La ligne de commande qui lancera le processeur FO, spécifique à chaque processeur.

Modules d'extension

oXygen offre la possibilité d'ajouter des modules qui étendent les fonctions de l'application. Les modules sont livrés en tant que paquets séparés ; vérifiez l'arrivée de nouveaux modules sur le site de oXygen : http://www.oxygenxml.com.

Un module consiste en un sous-dossier séparé dans le dossier des modules dans le dossier d'installation de oXygen. Ce sous-dossier doit contenir un fichier plugin.xml valide en accord avec le fichier plugin.dtd file du dossier des modules.

oXygen détecte et charge automatiquement les modules correctement installés dans le dossier des modules et les affiche dans l'option Modules d'extension du dialogue Préférences.

Figure 3.14. Le panneau Modules

Le panneau Modules

Une courte description du module peut être obtenue avec un clic-droit sur le nom du module.

Outils externes

L'utilisateur peut utiliser à l'intérieur de oXygen d'autres outils comme à partir de la ligne de commande du shell du système d'exploitation. La configuration d'un tel outil se fait dans le dialogue suivant.

Figure 3.15. Configurer les outils externes

Configurer les outils externes
Nom

Le nom de l'entrée du menu correspondant à cet outil qui sera affiché dans le menu Outils externes et dans la boîte combo outils externes de la barre d'outils.

Description

La description de l'outil affichée dans l'option Préférences->Outils externes.

Raccourci clavier

Le raccourci clavier qui lance l'outil externe.

Répertoire de travail

Le répertoire que l'outil externe utilisera pour sauver les résultats intermédiaires et finaux.

Ligne de commande

La ligne de commande qui lancera l'outil externe.

Menu raccourcis clavier

L'utilisateur peut configurer dans un seul endroit tous les raccourcis clavier des entrées du menu disponibles dans oXygen. Les raccourcis actuels assignés aux entrées du menu sont affichés dans le tableau suivant.

Figure 3.16. Le panneau du menu raccourcis clavier

Le panneau du menu raccourcis clavier
Description

Une courte description de l'opération de l'entrée du menu.

Catégorie

Les raccourcis sont classés en catégories pour une gestion plus aisée. Par exemple l'opération "Couper" pour la vue de la source est distinguée de l'éditeur d'arbre en l'assignant à une catégorie différente.

Raccourci

Le raccourci clavier qui lance l'opération. Double-cliquer sur une rangée du tableau ou presser le bouton "Éditer" permet à l'utilisateur d'enregistrer un nouveau raccourci pour l'opération affichée dans cette rangée.

Types de fichiers

oXygen supporte une grande variété de types de fichiers, mais les utilisateurs sont libres d'ajouter de nouveaux types de fichiers spécifiés par l'extension et de les associer au type d'éditeur qui convient le mieux.

Figure 3.17. Les types de fichiers

Les types de fichiers
Extension

Les nouveaux types de fichiers.

Éditeur

Le type de l'éditeur auquel les extensions seront associées. Certains éditeurs offrent un accès aisé à des opérations fréquentes via des barres d'outils (ex. éditeur XML, éditeur XSL, éditeur de DTD) tandis que d'autres offrent juste une colorisation de syntaxe (ex. éditeur Java, SQL, Shell, etc.)

Configuration du proxy

Ouvrir le dialogue de configuration du proxy en sélectionnant Options->Préférences->Configuration du proxy.

Figure 3.18. Le dialogue de configuration du proxy

Le dialogue de configuration du proxy

Compléter le dialogue comme suit:

Utiliser serveur proxy

Si coché, permet à oXygen d'utiliser le serveur proxy spécifié. Si non-coché, le serveur proxy est désactivé.

Proxy web (HTTP)

L'adresse IP address ou le Fully Qualified Domain Name (FQDN) du serveur proxy.

Port

Le numéro du port TCP, normalement réglé sur 80 ou 8080.

Utilisateur

Le nom de l'utilisateur si nécessaire. Peut être vide.

Mot de passe

Le mot de passe pour l'authentification. Peut être vide.

Aucun proxy pour, No proxy for

Donne les domaines pour lesquels aucun proxy ne doit être utilisé.

SOCKS

Si coché, permet à SOCKS d'utiliser l'hôte et le port spécifiés pour le serveur. Si non-coché, SOCKS est désactivé.

Hôte

L'hôte SOCKS auquel vous souhaitez vous connecter.

Port

Le port SOCKS auquel vous souhaitez vous connecter.

Résultats / Sortie

Figure 3.19. L'option Résultats/Sortie

L'option Résultats/Sortie
Nombre maximal de lignes

Cette option règle le nombre maximal de lignes de la console de sortie où les outils externes placent leur sortie.

Imprimer

Figure 3.20. L'option échelle de l'impression

L'option échelle de l'impression

Il est parfois utile d'imprimer le contenu d'un document sur papier. oXygen vous permet d'ajuster l'échelle de l'impression pour rendre plus aisée la lecture de la page.

Échelle d'impression

Affiche une barre permettant d'ajuster l'échelle d'impression entre 40% et 100%.

Couleurs

oXygen supporte la colorisation de syntaxe pour les documents XML, DTD, Relax NG (XML et syntaxe compacte), Java, C++, C, PHP,CSS, Perl, Properties, SQL, Shell et Batch. Même si Oxygen offre une configuration des couleurs par défaut pour coloriser les signes, vous pouvez choisir de personnaliser, comme exigé, en utilisant le dialogue Couleurs.

Figure 3.21. Le panneau Couleurs

Le panneau Couleurs

Ouvrez le dialogue des Couleurs en sélectionnant Options->Préférences->Couleurs et choisissez un des Types de Document supporté. Chaque type de document contient un ensemble de signes. Quand le Type de Document est sélectionné, les signes associés sont listés. Sélectionner un signe affiche les propriété de couleur actuelles et vous permet de les modifier. Utiliser les modèles Échantillons, TSL ou RVB depuis le dialogue Couleur pour définir les propriétés des couleurs.

Utiliser les modèles Échantillons, TSL ou RVB du dialogue Couleurs pour définir les propriétés des couleurs.

Les modifications sont sauvées quand le bouton OK est cliqué. Annuler ne prend pas en compte les changements. Le bouton Reset remet les couleurs aux valeurs par défaut.

Échantillons

Affiche une palette de couleurs contenant une variété de couleurs parmi le spectre des couleurs et les ombres. Sélectionner une couleur.

TSL

Teinte, Saturation et Luminosité vous permettent de spécifier une couleur en la décrivant à l'aide de la teinte, la saturation et la luminosité.

RVB

Rouge, Vert et Bleu (RVB) vous permet de spécifier une couleur à l'aide des trios de nombres pour le rouge, le vert et le bleu.

Aperçu

Affiche les propriétés des couleurs du signe courant et les résultats de la personnalisation.