<oXygen/> XML Editor User Guide

Opening and closing documents

Comme la plupart des applications d'édition, <oXygen/> vous permet d'ouvrir des document existants, de sauver vos modifications et de les fermer comme requis.

Créer des nouveaux documents

The New dialog

<oXygen/> supporte de nombreux document types, utiliser la procédure suivante pour créer des documents.

Procédure 4.1. Créer des nouveaux documents

  1. Sélectionner Fichier-> Nouveau (Ctrl+N) or press the New toolbar button. Le dialogue Nouveau est affiché. Le dialogue Nouveau est affiché qui contient les types de documents supportés : XML, XSL, XML Schema, Document Type Definition, schéma Relax NG, XQuery, Web Services Definition Language, schéma Schematron, fichier CSS , fichier Texte, fichier Java, fichier JavaScript, fichier C, fichier C++, fichier Batch File, fichier Shell, fichier Properties, fichier SQL, fichier PHP et fichier PERL.

    Figure 4.2. Le dialogue Nouveau

    Le dialogue Nouveau
  2. Sélectionner un type de document, puis cliquer OK. Si XML a été sélectionné, le dialogue "Créer un document XML" est affiché, sinon un nouveau document est ouvert dans le panneau Éditeur.

  3. Le dialogue Créer un document XML permet la définition de Prologs Document XML utilisant soit des identifiants système schéma XML ou DTD. Comme il n'est pas nécessaire pour tous les documents XML d'avoir un Prolog, on peut choisir de passer cette étape en cliquant OK. Si le prolog est requis, utiliser les tables suivantes pour compléter les champs comme requis.

    Figure 4.3. Le document Créer un document XML - Onglet schéma XML

    Le document Créer un document XML - Onglet schéma XML

    Compléter le dialogue comme suit:

    Utiliser une DTD ou un schéma XML

    Si coché, permet la sélection entre DTD, schéma XML, schéma Relax NG ou schéma NRL.

    URL

    Spécifie l'emplacement d'un XML Schema Document (XSD).

    Namespace

    Spécifie le namespace du document.

    Racine du document

    Faite des éléments définis dans le XSD spécifié, permet la sélection de l'élément à utiliser comme racine du document.

    Description

    Affiche une petite définition de l'élément actuellement sélectionné.

    Figure 4.4. Le dialogue Créer un document XML - Onglet DTD

    Le dialogue Créer un document XML - Onglet DTD

    Compléter le dialogue comme suit :

    Utiliser une DTD, un schéma XML, un schéma Relax NG ou un schéma NRL.

    Si coché, permet la sélection entre DTD, schéma XML, schéma Relax NG ou schéma NRL.

    System ID

    Spécifie l'emplacement d'une Document Type Definition (DTD).

    Public ID

    Spécifie l'identifiant PUBLIC déclaré dans le Prolog.

    Racine du document

    Faire des éléments définis dans la DTD spécifiée, permet la sélection de l'élément à utiliser comme racine du document.

    Description

    Affiche une petite définition de l'élément actuellement sélectionné.

    Figure 4.5. Dialogue Créer un document XML - Onglet Relax NG

    Dialogue Créer un document XML - Onglet Relax NG

    Compléter le dialogue comme suit :

    Utiliser une DTD, un schéma XML, un schéma Relax NG ou un schéma NRL

    Si coché, permet la sélection entre DTD, schéma XML, Relax NG ou NRL.

    URL

    Spécifie l'emplacement d'un schéma Relax NG en syntaxe XML ou compacte (RNG/RNC).

    Syntaxe XML

    Si coché, l'URL spécifiée réfère à un schéma Relax NG en syntaxe XML. Il sera vérifié automatiquement si l'utilisateur sélectionne un document avec l'extension .rng.

    Syntaxe compacte

    Si coché, l'URL spécifiée réfère à un schéma Relax NG en syntaxe compacte. Il sera vérifié automatiquement si l'utilisateur sélectionne un document avec l'extension .rnc.

    Namespace

    Spécifie l'élément racine namespace.

    Racine du document

    Comprend les éléments définis dans le document RNG ou RNC spécifié, la sélection de l'élément sera utilisé comme racine du document.

    Figure 4.6. Le dialogue Créer un document XML - Onglet NRL

    Le dialogue Créer un document XML - Onglet NRL

    Compléter le dialogue comme suit :

    Utiliser une DTD, un XML Schéma, un schéma Relax NG ou NRL

    Si coché, permet la sélection entre DTD, XML Schéma, schéma Relax NG ou schéma NRL.

    URL

    Spécifie l'emplacement d'un schéma NRL.

Créer des documents basés sur des modèles

Les modèles sont des documents contenant une structure prédéfinie. Ils offrent des point de départ sur lesquels rapidement construire des nouveaux documents qui répètent les mêmes caractéristiques de base. <oXygen/> installe un riche ensemble de modèles pour de nombreuses applications XML. On peut aussi créer ses propres modèles et les partager avec d'autres utilisateurs.

Le dialogue Modèles vous permet de sélectionner des modèles qui ont déjà été créés dans des sessions précédentes ou par d'autres utilisateurs. Ouvrir un modèle en utilisant les options suivantes:

Figure 4.7. Le dialogue des modèles

Le dialogue des modèles

Ouvrir un modèle en utilisant les options suivantes :

Standard

Remplit la liste des modèles pour afficher les modèles livrés avec le paquet d'installation de <oXygen/>.

User defined

Remplit la liste des modèles pour afficher les modèles personnels auparavant sauvés.

Depuis une URL

Permet la définition d'une URL contenant des modèles.

Liste des modèles

Affiche les modèles disponibles pour les options Standard, Depuis un fichier et Depuis une URL.

Procédure 4.2. Créer des documents basés sur des modèles standards

  1. Sélectionnner Fichier-> A partir d'un modèle ... or press the A partir d'un modèle toolbar button. Le dialogue des modèles est affiché et utilisé pour chercher, sélectionner et ouvrir un nouveau document basé sur un document modèle existant. Les documents modèles agissent comme des points de départ qui ont des propriétés prédéfinies telles que le type de fichier, le prolog, l'élément root, les conteneurs, et même un contenu existant.

    Figure 4.8. Le dialogue des modèles

    Le dialogue des modèles
  2. Sélectionner l'option Standard depuis Charger les modèles. La liste des modèles affiche les modèles standards de <oXygen/>.

  3. Faire défiler la liste des modèles et sélectionner le type de modèle souhaité.

  4. Cliquer OK. Un nouveau document est ouvert qui contient déjà la structure et le contenu donné dans le point de départ du modèle.

Procédure 4.3. Créer des documents basés sur des fichiers modèles personnels

  1. Sélectionnner Fichier-> A partir d'un modèle ... or press the A partir d'un modèle toolbar button. Le dialogue des modèles est affiché.

    Figure 4.9. Le dialogue des modèles

    Le dialogue des modèles
  2. Select the User defined option from the Load Templates Group. The Templates list displays person templates.

  3. Faire défiler la liste des modèles et sélectionner le type de modèle souhaité.

  4. Cliquer OK. Un nouveau document est ouvert qui contient déjà la structure et le contenu donné dans le point de départ du modèle.

Procédure 4.4. Créer des documents basés sur des fichiers modèles d'une URL

  1. Sélectionnner Fichier-> A partir d'un modèle ... or press the A partir d'un modèle toolbar button. Le dialogue des modèles est affiché.

    Figure 4.10. Le dialogue des modèles

    Le dialogue des modèles
  2. Sélectionner l'option Depuis une URL depuis Charger les modèles. Le champ Depuis une URL est activé.

  3. Entrer l'URL des modèles, puis cliquer Charger . La liste des modèles est récupérée depuis l'URL et affichée dans la liste des modèles.

  4. Faire défiler la liste des modèles et sélectionner le type de modèle souhaité.

  5. Cliquer OK. Un nouveau document est ouvert qui contient déjà la structure et le contenu donné dans le point de départ du modèle.

Sauver des documents

The edited document can be saved with one of the actions :

  • Fichier-> Enregistrer (Ctrl+S) : Sauve le document actuel. Si le document n'a pas de fichier, affiche le dialogue Enregistrer sous.

  • Fichier->Enregistrer sous: Affiche le dialogue Enregistrer sous, utilisé pour nommer et sauver un document ouvert dans un fichier; ou sauver un fichier existant avec un nouveau nom.

  • Fichier->Enregistrer à l'URL or press the Save To URL ... toolbar button pour afficher le dialogue Enregistrer à l'URL, utilisé pour nommer et sauver un document ouvert dans un fichier ; ou sauver un fichier existant sous un nouveau nom, en utilisant FTP/WebDAV.

  • Fichier->Tout enregistrer: Sauve tous les documents ouverts. Si un document n'a pas de fichier, affiche le dialogue Enregistrer sous.

Opening existing documents

Les documents peuvent être ouverts en utilisant one of the actions :

  • Fichier-> Ouvrir (Ctrl+O) : Affiche le dialogue Ouvrir utilisé pour chercher, sélectionner et ouvrir un ou plusieurs fichiers.

  • Fichier->Ouvrir URL ... or press the Open URL ... toolbar button pour afficher le dialogue Ouvrir URL, utilisé pour ouvrir un document en utilisant FTP/WebDAV.

  • Fichier->Revenir: Charge la dernière version sauvegardée du document. Toutes les modifications non-sauvées sont perdues.

  • Fichier->Réouvrir: Affiche une liste des fichiers document récemment ouverts. Sélectionner un fichier à ouvrir.

  • Ouvrir: Ouvre le fichier sélectionné dans la vue du projet.

En plus <oXygen/> support l'ouverture directe de fichiers depuis l'invite de la commande. Utiliser la syntaxe de commande suivante :

  • Windows:

    oxygen.bat FichieràOuvrir.xml

  • Unix/Linux:

    sh ./oxygen.sh FichieràOuvrir.xml

  • Mac OS X:

    sh ./oxygenMac.sh FichieràOuvrir.xml

Also when the Tree Editor perspective is activated the current document in the Editor perspective will be opened and displayed as a tree of XML elements.

Ouvrir et Sauver des documents distants via FTP/WebDAV

<oXygen/> supporte l'édition de fichiers distants, en utilisant les protocoles FTP et WebDAV. Les fichiers distants ouverts peuvent être édités exactement comme les fichiers locaux. Ils peuvent être ajoutés au projet, et peuvent faire l'objet de transformations XSL et FO.

Figure 4.11. Ouvrir le dialogue URL

Ouvrir le dialogue URL
[Note]Note

L'accès WebDAV est implémenté en utilisant le paquet Slide de la Apache Software Foundation. Cette partie est expérimentale et doit être utilisée avec précaution. La partie FTP utilise un accès passif aux serveurs FTP. Vérifiez que le serveur auquel vous essayez de vous connecter supporte les connexions passives.

The FTP/WebDAV capabilities have been extensively tested with various servers running on Windows (IIS), Mac OS X and Linux (Apache).

[Note]Note

Si vous avez réglé un serveur proxy à utiliser par <oXygen/>, vérifiez qu'il support le protocole WebDAV. S'il ne le support pas, vérifiez d'avoir décoché la case "Utiliser serveur proxy" du panneau Options/Préférences/Configuration du proxy Proxy, sinon vous ne pourrez pas vous connecter à un serveur WebDAV.

Pour ouvrir des fichiers distants, choisissez Fichier->Ouvrir URL ... depuis le menu principal. Le dialogue affiché comprend trois parties.

  • La première est une boîte combo éditable, dans laquelle peut être directement spécifiée l'URL où ouvrir ou sauver.

    [Astuce]Les URLs qui peuvent être directement ouvertes

    Vous pouvez taper ici une URL comme http://some.site/test.xml, au cas où le fichier est accessible via un protocole HTTP normal, ou ftp://anonymous@some.site/home/test.xml si le fichier est accessible via un FTP en anonyme.

    Cette boîte combo affiche aussi la sélection actuelle quand l'utilisateur change la sélection par navigation dans l'arbre des dossiers and fichiers sur le serveur.

  • La deuxième partie contrôle les justificatifs d'accès. Si vous souhaitez chercher un fichier sur un serveur, vous devez spécifier l'utilisateur et le mot de passe. Cette information est liée à l'URL affichée dans la boîte combo "URL du fichier", et utilisée dans ouvrir/enregistrer le fichier. Si la case "Enregistrer" est sélectionnée, alors l'utilisateur et le mot de passe sont sauvés entre les sessions d'édition. Le mot de passe est encrypté par clé dans le fichier option.

    [Note]Note

    Votre mot de passe est bien protégé. Au cas où le fichier options est déplacé sur une autre installation, une autre machine, le mot de passe deviendra illisible, car l'encryptage est dépendant de l'utilisateur et de la machine. Ceci est aussi vrai si vous ajoutez des URL ayant un utilisateur et un mot de passe à votre projet.

  • La troisième partie contient le combo serveur et la case "Autoconnecter". Dans le combo serveur il peut être spécifié le protocole (HTTP ou FTP), le nom ou l'IP du serveur et, en cas de WebDAV, le chemin du dossier WebDAV.

    [Astuce]Les URL de serveur

    Lors de l'accès à un serveur FTP, vous devez uniquement spécifier le protocole et l'hôte, comme : ftp://server.com, ftp://ftp.apache.org, ou si vous utilisez un port non-standard : ftp://server.com:7800/ etc.

    Lors de l'accès à un serveur WebDAV, en plus du protocole et de l'hôte, le dossier du repository WebDAV doit être indiqué.

    [Important]Important

    Assurez-vous que le dossier du repository se termine par un slash "/".

    Ex : https://www.some-webdav-server.com:443/webdav-repository/, http://devel:9090/webdav/

    En appuyant sur le bouton "Naviguer" le listing du dossier sera affiché dans le bellow du composant. Quand "Autoconnecter" est sélectionné, à chaque fois que le dialogue est affiché, l'action de navigation sera exécutée.

  • La dernière partie consiste en une vue en arbre des documents entreposés sur le serveur. Vous pouvez naviguer dans les dossiers, et faire plusieurs sélections. En outre, vous pouvez utiliser "Renommer", "Effacer", et "Nouveau dossier" pour gérer le dépôt de fichiers.

Si vous souhaitez accéder à un dépôt WebDAV repository via un réseau peu sûr, <oXygen/> vous permet de charger et sauver les documents par le protocole HTTPS (si le serveur supporte ce protocole), ainsi tout échange de données avec le serveur WebDAV est encodé.

Quand un dépôt WebDAV est accéder pour la première fois via HTTPS, le serveur hébergeant le dépôt va présenter un certificat de sécurité à <oXygen/> comme partie du protocole HTTPS, sans intervention de l'utilisateur. <oXygen/> va utiliser ce certificat pour décoder tout flux de données reçu du serveur. Afin de réussir l'authentification, vous devriez vous assurer que le certificat de sécurité du serveur hébergeant le dépôt peut être lu par <oXygen/>. Ceci signifie que <oXygen/> peut trouver le certificat dans le trousseau de clés du Java Runtime Environment dans lequel il fonctionne. Vous savez que le certificat du serveur n'est pas dans le trousseau de clé du JRE si vous recevez l'erreur "No trusted certificate found" en essayant d'accéder au dépôt WebDAV :

Figure 4.12. Le certificat du serveur n'est pas disponible

Le certificat du serveur n'est pas disponible

Vous pouvez ajouter un certificat au trousseau de clés en l'exportant vers un fichier local en utilisant n'importe quel navigateur web (par ex. Internet Explorer) supportant HTTPS puis en important ce fichier dans le JRE en utilisant l'exécutable keytool livré avec le JRE. Les étapes sont les suivantes en utilisant Internet Explorer (si vous utilisez un autre navigateur, la procédure est similaire) :

Procédure 4.5. Importer un certificat de serveur HTTPS

  1. Exporter le certificat vers un fichier local

    1. Pointez votre navigateur compatible HTTPS vers l'URL du dépôt. Si c'est votre première visite sur le dépôt, un message d'alerte de sécurité expliquant que le certificat de sécurité présenté par le serveur n'est pas fiable sera affiché.

      Figure 4.13. Alerte de sécurité - le certificat n'est pas fiable

      Alerte de sécurité - le certificat n'est pas fiable
    2. Presser le bouton "Voir le certificat".

    3. Sélectionner l'onglet "Détails".

    4. Presser le bouton "Copier vers le fichier ...". Cela va lancer l'assistant d'export de certificat sous Windows

    5. Suivre les indications de l'assistant pour sauver le certificat dans un fichier local, par ex. server.cer.

  2. Importer le fichier local dans le JRE de <oXygen/>

    1. Ouvrir une console en mode textuel.

    2. Aller dans le sous-dossier lib/security du dossier du JRE, c.-à-d. le dossier où est installé le JRE sur lequel s'appuie <oXygen/>, par ex. sous Windows C:\Program Files\Java\j2re1.4.2\lib\security

    3. Lancer la commande suivante :..\..\bin\keytool.exe -import -trustcacerts -file local-file.cer -keystore cacertslocal-file.cer est le fichier contenant le certificat du serveur, créé à l'étape précédante. Keytool nécessite un mot de passe avant d'ajouter un certificat au trousseau de clés du JRE. Le mot de passe par défaut est "changeit". Si le mot de passe par défaut a été changé par une personne, alors elle seule peut faire l'importation. Pour contourner ce problème, vous pouvez effacer le fichier cacerts, re-taper la commande et entrer comme mot de passe n'importe quelle combinaison d'au moins 6 caractères. Cela va régler le mot de passe pour les opérations futures avec le trousseau de clés.

  3. Relancer <oXygen/>

Fermer des documents

Pour fermer des documents, utiliser un des méthodes suivantes :

  • Fichier-> Fermer (Ctrl+W) : Ferme uniquement l'onglet sélectionné. Tous les autres onglets restent.

  • Fichier->Tout Fermer: Ferme tous les documents ouverts. Si un document est modifié ou n'a pas de fichier, une invitation à sauver, ne pas sauver, ou annuler l'opération est affiché.

  • Close - accessed by right-clicking on an editor tab: Closes the selected editor.

  • Fermer les autres fichiers - accessed by right-clicking on an editor tab: :Ferme tous les fichiers en dehors de l'onglet sélectionné.

  • Fermer tous - accessed by right-clicking on an editor tab: : Ferme tous les editeurs ouverts à l'intérieur du panneau.

Creating and sharing new document templates

Creating a new document template

<oXygen/> permet de créer des modèles définis par l'utilisateur. Les modèles sont créés en ajoutant un document existant à la librairie des modèles.

Procédure 4.6. Créer des nouveaux modèles

  1. Ouvrir le document qui sera utilisé pour créer le modèle.

  2. Modifier la structure et le contenu comme souhaité.

  3. Fichier->Ajouter aux Modèles or press the toolbar button Add to templates pour afficher le dialogue Ajouter Modèles utilisé pour définir le nom avec lequel le modèle sera reconnu dans l'option Nouveau à partir de modèles option.

  4. Entrer le nom avec lequel le modèle sera reconnu. Cliquer OK, le document est ajouté à la liste des modèles personnels.

  5. Tester le modèle en utilisant l'option Depuis fichier.

Sharing document templates

<oXygen/> enregistre les modèles personnels dans un fichier XML nommé .com.oxygenxml/templates.xml, situé dans le dossier Home de l'utilisateur de <oXygen/>. En copiant ce fichier vers un dossier d'un serveur web et en le rendant accessible via HTTP, d'autres utilisateurs de <oXygen/> peuvent utiliser l'option Depuis une URL pour accéder aux modèles.

Procédure 4.7. Partager des modèles

  1. Créer un ou plusieurs modèles personnels.

  2. Copier [user home dir]\com.oxygenxml\templates.xml dans un dossier accessible sur votre serveur web.

  3. Tester le modèle en utilisant l'option Depuis une URL.

Viewing file properties

You can quickly access informations about the current edited document like the character encoding, full path on the filesystem, schema used for content completion and document validation, associated transformation scenario, if bidirectional text (left to right and right to left) is enabled, indent size by going to File-> Properties