<oXygen/> XML Editor User Guide

Éditer des documents

Si l'édition d'un document est une procédure aisée, il y a quelques points dont vous devez avoir connaissance qui vous rendront plus productif lors de l'édition.

Travailler avec Unicode

Unicode donne un numéro unique pour chaque caractère, peu importe quelle plateforme, quel programme, quelle langue. Unicode est un standard reconnu internationalement, adopté par les leaders du secteur. Unicode est requis par les standards modernes comme XML, Java, ECMAScript (JavaScript), LDAP, CORBA 3.0, WML, etc., et est la façon officielle d'implémenter ISO/IEC 10646.

Il est supporté par de nombreux systèmes d'exploitation, tous les navigateurs modernes, et de nombreux autres produits. L'émergence du standard Unicode, et la disponibilité des outils le supportant, sont parmi les plus importants courants actuels de la technologie logicielle dans le monde. Incorporer Unicode dans des applications client-server ou multi-couches et les sites web offre des réductions de coûts signifiques par rapport à l'utilisation de jeux de caractères précédents.

En tant qu'éditeur XML moderne, oXygen offre le support pour le standard Unicode standard. Permettant à votre application XML d'être ciblée vers de multiples plateformes, langues et pays sans re-développement. En interne l'éditeur oXygen utilise des caractères 16bit couvrant le jeu de caractères Unicode.

Au chargement de documents de type XML, XSL, XSD et DTD, oXygen lit le prolog du document pour déterminer le type d'encodage spécifié. Cela est ensuite utilisé pour ordonner au Java Encoder de charger le support correspondant et de sauver en utilisant le jeu de caractères spécifié. Au cas où le type d'encodage ne peut être déterminé, oXygen va afficher le dialogue des "Encodages Java disponibles". Le dialogue des "Encodages Java disponibles" offre une liste de tous les codages supportés par la plateforme Java.

Figure 4.11. Dialogue des encodages Java disponibles

Dialogue des encodages Java disponibles

Bien que dans la plupart des cas vous utiliserez UTF-8, simplement changer le nom de l'encodage va provoquer la sauvegarde du fichier avec le nouvel encodage. L'annexe Encodage des caractères Unicode offre un tableau qui donnent les noms Java de leurs équivalents communs. Elle explique aussi ce que vous devez taper dans le prolog XML pour que le document soit sauver dans l'encodage souhaité.

Pour éditer les documents écrits en Japonais ou Chinois, vous devrez changer la police pour en choisir une qui supporte les caractères spécifiques (une police Unicode). Pour la plateforme Windows, utiliser "Arial Unicode MS" ou "MS Gothic" est recommandé. Ne vous attendez pas à ce que Wordpad ou le Bloc-notes gèrent ces encodages. Utilisez Explorer ou Word pour examiner éventuellement les documents XML.

[Note]Note

La convention pour le nommage utilisé sous Java ne correspond pas toujours avec les noms communs utilisés par le standard Unicode. Par exemple, tandis qu'en XML on utilise encoding="UTF-8", en Java le même encodage a le nom "UTF8".

Optimiser avec Tag-insight

La fonctionnalité Tag-insight intelligente de oXygen est un assistant à l'édition qui permet une identification et une insertion rapide et en ligne d'éléments, d'attributs et dans certains cas leurs options de paramétrage, de langages structurés.

L'assistant Tag-insight est automatiquement affiché à chaque fois que le caractère < est entré dans un document ou en sélectionnant CTRL+Espace sur un élément partiel ou le nom d'un attribut. Surligner un élément et presser la touche Entrée, insère à la fois les parties d'ouverture et de fermeture de l'élément surligné. Si la fonction Ajouter le contenu de l'élément de Tag-Insight est activé, tous les éléments que le nouvel élément doit contenir, comme spécifié dans la DTD ou le schéma XML, sont insérés automatiquement dans le document . L'assistant Tag-Insight peut aussi ajouter du contenu optionnel et la particule du premier choix, comme spécifié dans la DTD ou le schéma XML, pour l'élément si les deux options sont activées. Après l'insertion, le curseur est positionné directement avant le caractère > de la balise d'ouverture, si l'élément a des attributs, afin de permettre l'insertion rapide de n'importe quel attribut supporté par l'élément, ou après le caractère > de la balise d'ouverture si l'élément n'a pas d'attributs. Appuyer sur la barre d'espace, juste après l'insertion de l'élément, va afficher à nouveau l'assistant. Dans ce cas, les attributs supportés par cet élément seront affichés. Si un attribut support un ensemble fixe de paramètres, l'assistant va afficher la liste des paramètres valides. Si le réglage du paramètre est défini par l'utilisateur, l'assistant sera fermé pour permettre l'insertion manuelle. Les valeurs des attributs peuvent être appris depuis les mêmes éléments dans le document actuel.

Si le XSD ou la DTD pour le document contient un élément, des attributs ou des annotations des valeurs des attributs, ils seront présentés lorsque la fenêtre de remplissage de contenu est affichée, si l'option correspondante est activée. Dans un XSD les annotations sont mises dans un élément <xs:annotation> :

<xs:annotation> <xs:documentation>Description de l'élément.</xs:documentation> </xs:annotation>

Pour les DTD <oXygen/> définit un mécanisme pour les annotations en utilisant les commentaires :

<!--doc: Description de l'élément. -->

L'assistant de contenu peut être appelé à tout moment en pressant CTRL+Espace et la liste sensible au contexte des propositions sera affichée à n'importe quelle position du curseur dans le document édité à l'endroit où l'insertion d'un élément, attribut ou de la valeur d'un attribut a du sens. De tels endroits sont : n'importe où dans le nom d'une balise, ou au début du nom d'une balise dans un document XML, XML Schéma, DTD ou schéma Relax NG (syntaxe complète ou compacte), n'importe où dans le nom d'un attribut ou au début du nom d'un attribut dans tout document XML avec une grammaire associée, et avec les valeurs d'un attribut ou au début de valeurs d'un attribut dans des documents XML où les listes de valeurs possibles ont été définies pour cet élément dans la grammaire associée au document.

Figure 4.12. Assistant Tag-insight

Assistant Tag-insight

Le contenu de l'assistant Tag-insight est dépendant de la structure de l'élément donné dans un fichier DTD, schéma XML, schéma Relax NG (syntaxe complète ou compacte) ou NRL donné.

Le nombre et le type des éléments affichés par l'assistant est sensible à la position actuelle du curseur dans le document structuré. Les éléments fils affichés dans un élément donné sont définis par la structure de la DTD, du schéma XML, schéma Relax NG (syntaxe complète ou compacte) ou NRL spécifié. Tous les éléments qui ne peuvent pas être des éléments fils de l'élément actuel sont retirés.

Si le schéma pour le document édité définit des attributs de type ID et IDREF alors l'assistant de contenu affiche pour les attributs IDREF une liste de toutes les valeurs ID déjà présentes dans le document pour un insertion aisée d'une valeur ID valide à la position du curseur dans le document. Cette fonction est disponible pour les documents qui utilisent DTD, XML Schema et Relax NG.

Pour les documents qui utilisent un schéma XML ou Relax NG l'assistant de contenu propose des valeurs pour les attributs et éléments qui ont comme type une énumération de marques.

La DTD, le schéma XML, le schéma Relax NG ou NRL utilisé pour remplir l'assistant Tag-insight est spécifié dans les méthodes suivantes, par ordre hiérarchique :

  • Depuis le fichier spécifié dans le sous-ensemble externe du prolog du document. Dans ce cas oXygen lit le prolog et trouve l'emplacement de la DTD, du schéma XML, du schéma Relax NG ou NRL.

  • Depuis le fichier spécifé dans le dialogue Tag-insight de oXygen. oXygen va lire les réglages Tag-insight quand le prolog n'arrive pas à donner ou trouver l'emplacement de la DTD, du schéma XML ou du schéma Relax NG.

Créer des DTD

En travaillant avec des documents qui ne spécifient pas de DTD, ou pour lesquels la DTD est inconnue ou n'existe pas, oXygen est capable d'apprendre et de traduire en une DTD, qui peut à son tour être sauvée dans un fichier pour offrir une DTD. En plus d'être utile pour une création rapide d'une DTD qui sera capable d'offre une source d'initialisation pour l'assistant Tag-insight, cette fonction peut être aussi utilisée pour produire des DTD pour les documents contenants des types d'éléments personnels.

Procédure 4.8. Pour créer une DTD :

  1. Ouvrir le document structuré à partir duquel une DTD sera créée.

  2. Sélectionner Document->Apprendre la structure (Ctrl+Shift+L). oXygen va apprendre la structure du document, et lorsqu'il aura fini il affichera "Apprentissage terminé" dans le panneau message de la barre de statut de l'éditeur.

  3. Sélectionner Document->Enregistrer la structure (Ctrl+Shift+S) pour enregistrer la DTD en mémoire directement dans un fichier.

[Note]Note

La DTD résultante n'est uniquement valide que pour les documents contenants les éléments et structures définis par le document utilisé comme entrée pour la création de la DTD. Si les nouveaux types des éléments sont définis dans un document, ils doivent être ajoutés à la DTD afin de réussir la validation.

Travailler avec des catalogues XML

Lorsqu'il n'y a pas d'accès internet disponible un ou plusieurs catalogues XML peuvent être ajoutés à la liste dans le dialogue en-dessous et les copies locales des fichiers DTD, schéma XML, schéma Relax NG et/ou NRL seront utilisées. 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 modifications prennent effet.

Si l'option "Utiliser catalogue par défaut" est cochée, <oXygen/> va utiliser les catalogues par défaut pour les documents DocBook, TEI et XHTML situés dans le sous-répertoire frameworks du répertoire d'installation. Sinon, <oXygen/> utilisera les catalogues spécifiés dans la liste.

L'option Préférer est utilisé pour spécifier si oXygen va essayer de résoudre d'abord la référence publique PUBLIC ou SYSTEM en utilisant les catalogues XML spécifiés. Si une référence PUBLIC ne se trouve dans aucun des catalogues alors une référence SYSTEM est recherchée. Le niveau de verbosité spécifie les types de messages de sortie affichés et peut avoir une ou plusieurs 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 frameworks/docbook et frameworks/tei du répertoire de l'installation.

Formater et indenter des documents (Pretty Print)

Dans les langages de formatage structurés, l'espace blanc entre les éléments, qui est créé par l'utilisation de la barre d'espacement , Tab ou l'insertion de multiples sauts de ligne par l'utilisation de Entrée, n'est pas reconnu par les outils d'analyse. Ceci signifie souvent que quand des documents structurés sont ouverts, ils sont arrangés comme une seule ligne sans saut de ligne, qui semble être un simple paragraphe.

Même si c'est une pratique tout à fait acceptable, elle rend l'édition difficile et augmente la probabilité d'erreurs introduites. Elle rend aussi l'identification des positions exactes des erreurs plus difficile. Formater et indenter, aussi appelé "Pretty Print", permet d'arranger proprement de tels documents, d'une façon qui est consistente et qui facilite la lecture à l'écran et sur l'impression.

Pretty print n'est en aucun cas associé avec la mise en page ou le formatage qui sera utilisée dans le document transformé. Cette mise en page est livrée avec la feuille de style XSL spécifiée au moment de la transformation.

Procédure 4.9. Pour formater et indenter un document :

  1. Ouvrir ou rendre actif le document qui doit être formaté et indenté.

  2. Sélectionner Document->Formater et indenter (Ctrl+Shift+P). Durant la progression le panneau message de la barre de statut de l'éditeur indiquera "Pretty print en cours". À la fin, "Pretty print terminé" sera inscrit et le document sera arrangé.

[Note]Note

Pretty Print peut formater des éléments vides comme une balise auto-fermante (par ex. <a/>) ou comme une balise régulière (par ex. <a></a> ). Il peut préserver l'ordre des attributs ou les classer alphabétiquement. Par ailleurs, l'utilisateur peut spécifier une liste d'éléments pour lesquels les espaces vides sont préservés exactement avant le Pretty print et une liste avec des éléments pour lesquels l'espace vide est éliminé. Tout cela peut être configuré depuis Options-> Préférences -> Editeur -> Format.

Pretty Print nécessite que le document structuré soit "bien formé". Si le document n'est pas "bien formé" un message d'erreur est affiché. Le message va habituellement indiquer qu'un problème a été trouvée dans la forme et vous conseillera sur le type de problème. Il ne signalera pas la position générale de l'erreur, pour faire ceci utilisez la fonction "bien formé" en sélectionnant Document->Contrôler que le document est bien formé (Ctrl+Shift+W).

Utiliser des expressions XPath

XPath est un langage pour traiter des différentes parties d'un document XML. XPath, comme le Document Object Model (DOM), modèle un document XML comme un arbre de nœuds. Une expression XPath est un mécanisme pour naviguer et sélectionner des nœud du document XML. Une expression XPath est d'une façon analogue à une requête d'un langage de requête structuré (SQL) utilisée pour sélectionner des enregistrements d'une base de données.

XPath modèle un document XML comme un arbre de nœuds. Il y a différents types de nœuds, dont les nœuds d'élément, les nœuds d'attribut, et les nœuds de texte. XPath définit une façon de calculer une valeur-chaîne unique pour chaque type de nœud.

XPath définit une librairie de fonctions standard pour travailler avec des chaînes, des nombres et des expressions booléennes.

child: : * sélectionne tous les fils du nœud root.

.//name sélectionne tous les éléments ayant le nom "nom", descendants du nœud actuel.

/catalog/cd[price>10.80]sélectionne tous les éléments cd qui ont un élément prix avec une valeur supérieure à 10.80

Pour utiliser XPath efficacement cela nécessite au moins une compréhension de la librairie des fonctions essentielles XPath (XPath Core Function Library). Une fois que vous avez cette connaissance la partie champ expression XPathyou de la barre d'outils de l'éditeur de oXygen peut être utilisée pour vous aider dans le développement de documents XML.

Si le document édité définit un namespace de défaut puis <oXygen/> liera ce namespace au premier libre préfixe de la liste: default, default1, default2, etc. Par exemple si le document définit le namespace de défaut xmlns="something" et le préfixe default n'est pas associé à un namespace alors vous pouvez assortir unprefixed étiquettes dans une expression de XPath en employant le préfixe default.

Pour en savoir plus sur XPath, l'URL suivante est recommandée : http://www.w3.org/TR/xpath

Dans oXygen les résultats d'une requête XPath sont retournés dans le panneau message. Cliquer sur un enregistrement dans la liste des résultat surligne les nœuds à l'intérieur du panneau d'édition.

Les résultats sont retournés dans un format qui lui-même est une expression XPath valide:

- [FileName.xml] /node[value]/node[value]/node[value] -

Exemple 4.3. Utilisation de XPath avec la DTD DocBook

Notre exemple est tiré d'un livre DocBook basé sur la DTD XML DocBook. Le livre contient un nombre de chapitres. DocBook définit que les chapitres qui ont une balise d'ouverture <chapter> et une balise de fermeture équivalente </chapter> doivent fermer l'élément. Pour retourner tous les nœuds de chapitres du livre, entrez //chapter dans le champ expression XPath, puis Entrée. Ceci va retourner tous les nœuds de chapitres du livre DocBook dans le panneau message. Si votre livre a six chapitres, il y aura six enregistrements dans la liste des résultats. Chaque enregistrement une fois cliqué va retrouver et surligner le chapitre et tous les nœuds ayant les mêmes parents contenus entre les balises d'ouverture et de fermeture du chapitre.

Si nous avions utilisé XPath pour lancer une requête pour tous les nœuds exemples contenus dans le nœud de section 2 d'un document XML DocBook, nous aurions utilisé l'expression XPath suivante //chapter/sect1/sect2/example. Si un nœud exemple est trouvé dans n'importe quel nœud de section 2, une liste des résultats sera retournée au panneau message. Pour chaque occurence du nœud de l'élément, un enregistrement sera créé dans la liste des résultats.

Dans notre exemple une requête XPath sur le fichier oxygen.xml :

- [oxygen.xml] /chapter[1]/sect1[3]/sect2[7]/example[1]

Ce qui signifie :

Dans le fichier oxygen.xml, premier chapitre, troisième section niveau 1, septième section niveau 2, le nœud exemple trouvé est le premier dans la section.

[Note]Note

Si votre projet est composé d'un fichier principal avec des références ENTITY vers d'autres fichiers, vous pouvez utiliser XPath pour retourner tous les éléments nom d'un certain type en faisant une requête sur le fichier principal. La liste des résultats va faire une requête sur tous les fichiers référencés.

Utiliser la vérification orthographique

L'option Vérifier l'orthographe permet d'exécuter la vérification orthographique sur le document actuel :

Figure 4.13. Dialogue vérifier l'orthographe

Dialogue vérifier l'orthographe

Compléter le dialogue comme suit:

Mot non-reconnu

Contient le mot qui n'a pu être trouvé dans le dictionnaire sélectionné. Le mot est aussi surligné dans le document XML.

Remplacer par

La chaîne de caractères qui est suggérée pour remplacer le mot non-reconnu.

Deviner

Affiche une liste de mots suggérés pour remplacer le mot inconnu. Double cliquer un mot dans cette liste l'insert automatiquement dans le document et continue le processus de vérification orthographique.

Dictionnaire

Affiche une liste des dictionnaires disponibles.

Remplacer

Remplace le mot actuellement surligné dans le document XML par le mot sélectionné dans la liste Deviner.

Tout remplacer

Remplace toutes les occurences du mot actuellement surligné dans le document XML par le mot sélectionné dans la liste Suggestions.

Ignorer

Permet de continuer de vérifier le document tout en ignorant la première occurence du mot inconnu. Le même mot sera remarqué à nouveau si il apparaît dans le document.

Tout ignorer

Ignore tous les exemplaires du mot inconnu dans le document entier.

Apprendre

Inclut le mot non-reconnu dans la liste des mots valides afin que le vérificateur orthographique ne s'arrête plus dessus pour la correction.

Options

Règle les options de configuration du vérificateur orthographique.

Débuter à la position du curseur

Si coché, le vérificateur orthographique va commencer son travail à la position du curseur.

OK

Ferme le dialogue vérificateur orthographique.

Figure 4.14. Dialogue Options

Dialogue Options

Le dialogue Options contient les options générales du vérificateur orthographique :

Sensible à la casse

Si coché, ignore les erreurs de capitales.

Ignorer les mots avec casse mélangée

Si coché, ne vérifie pas les mots contenant des mélanges de casse (par ex. "SpellChecker").

Ignorer les mots avec des chiffres

Si coché, le vérificateur orthographique ne vérifie pas les mots contenant des chiffres (par ex. "b2b").

Ignorer les doubles

Si coché, le vérificateur orthographique ne signale pas deux mots identiques successifs comme erreur.

Ignorer URL

Si coché, ignore les mots ressemblant à des URL ou des noms de fichier (par ex. "www.oxygenxml.com" ou "c:\boot.ini") .

Vérifier la ponctuation

Si coché, la vérification de la ponctuation est activée : des espaces mal placés et des mauvaises séquences, comme un point derrière une virgule, sont détectés.

Activer le remplacement automatique

Active la fonction "Remplacer toujours".

Permettre les mots composés

Si coché, tous les mots formés en concaténant deux mots légaux avec un trait d'union sont acceptés. Si la langue le permet, deux mots concaténés sans trait d'union sont aussi acceptés.

Permettre les préfixes généraux

Si coché, un mot formé en concaténant un préfixe enregistré et un mot légal est accepté. Par exemple si "micro-" est un préfixe enregistré, "micro-ordinateur" sera accepté.

Permettre les extensions de fichier

Si coché, accepte tous les mots se terminant avec une extension de fichier enregistrée (par ex. "monfichier.txt", "index.html" etc.).

Suggestion

Cette option indique la précision du vérificateur orthographique, qui peut être : "Favoriser la vitesse sur la qualité", "Normal" et "Favoriser la qualité sur la vitesse".

<oXygen/> propose des dictionnaires uniquement pour l'anglais (EN, GB, CA, US), le français (FR, BE, CA, CH) et l'allemand par le biais de fichiers .dar situés dans le répertoire [répertoire d'oXygen]/dicts. Un dictionnaire pré-construit peut être ajouté en copiant l'archive .dar corresopndante dans le même répertoire et en relançant <oXygen/>. Un dictionnaire peut être construit avec l'outil se trouvant ici : http://www.xmlmind.com/spellchecker/dictbuilder.shtml.

Les mots appris sont sauvegardés dans un dictionnaire persistant des mots appris avec l'extension .tdi qui se trouve dans le répertoire [dossier utilisateur]/spell ([dossier utilisateur]/.spell sous Mac OS X). Il y a un dictionnaire pour chaque variante pays d'une langue. Si le bouton Apprendre est appuyé par erreur, la seule façon d'effacer le mot appris du dictionnaire et d'éditer manuellement le dictionnaire et de relancer <oXygen/>. Cela car le composant de vérification orthographique ne permet pas l'édition via l'interface utilisateur.

[Note]Note

Le dictionnaire Czech peut être téléchargé ici : http://www.kosek.cz/sw/xxe/cs.dar

Utiliser Rechercher et remplacer

L'option Rechercher et remplacer permet d'exécuter les opérations suivantes sur le document :

  • trouver les occurrences d'un mot ou d'une chaîne de caractères, espaces blancs inclus, et surligner sa position dans l'éditeur.

  • remplacer les occurrences de la cible définie dans le champ "Rechercher" avec un mot ou une chaîne de caractères, espaces blancs inclus, défini dans le champ "Remplacer".

  • trouver toutes les occurences d'un mot ou d'une chaîne de caractères, espaces blancs inclus, et retourner une liste de résultats au panneau message.

  • remplacer toutes les occurences d'un mot ou d'une chaîne de caractères, espaces blancs inclus.

Figure 4.15. Dialogue Rechercher/Remplacer

Dialogue Rechercher/Remplacer

Compléter le dialogue comme suit:

Texte à rechercher

La chaîne de caractères à rechercher.

Remplacer par

La chaîne de caractères qui remplacera la cible. Elle peut contenir '{$NEWLINE}' qui insérera un caractère de nouvelle ligne au moment du remplacement.

Rechercher

Exécute une opération de recherche pour la prochaine occurence de la cible.

Remplacer

Exécute une opération de remplacement pour la cible.

Rechercher tout

Exécute une opération de recherche et retourne tous les résultats au panneau message.

Sensible à la casse

Si coché, les opérations sont sensibles à la casse.

Mots complets seulement

Si coché, seules les occurences entières d'un mot seront incluses dans l'opération.

Rechercher dans les balises

Si coché, l'opération va inclure le contenu des balises d'ouverture et de fermeture des éléments XML.

Expression régulière

Si coché, permet l'utilisation de n'importe quelle expression régulière dans la syntaxe PERL.

Rechercher depuis le début du fichier

Commence l'opération depuis le début du fichier, à la position 0:0.

Boucler

Continue la recherche depuis le début du document après avoir atteint la fin.

Utiliser le dialogue Rechercher et remplacer dans les fichiers

L'option Rechercher et remplacer dans les fichiers vous permet d'exécuter les mêmes opérations que l'option Rechercher/Remplacer sur n'importe quel nombre de fichiers situés dans un chemin donné.

Figure 4.16. Rechercher/Remplacer dans les fichiers

Rechercher/Remplacer dans les fichiers

Compléter le dialogue comme suit:

Texte à rechercher

La chaîne de caractères cible à rechercher.

Sensible à la casse

Si coché, les opérations sont sensibles à la casse.

Mots entiers uniquement

Si coché, seules les occurences entières d'un mot seront incluses dans l'opération.

Rechercher dans les balises

Si coché, l'opération va inclure le contenu des balises d'ouverture et de fermeture des éléments XML.

Expression régulière

Si coché, permet l'utilisation de n'importe quelle expression régulière dans la syntaxe PERL.

Remplacer par

La chaîne de caractères qui remplacera la cible. Elle peut contenir '{$NEWLINE}' qui insérera un caractère de nouvelle ligne au moment du remplacement.

Faire des fichiers de secours avec l'extension

Dans le processus de remplacement oXygen crée des fichiers de secours des fichiers modifiés. L'extension par défaut est *bak, mais vous pouvez changer l'extension selon vos souhaits.

Chemin spécifié

Choisir le chemin de recherche

Chemin du fichier actuel

Utilise le chemin du fichier actuel

Fichiers du projet (filtre fichier)

Recherche les fichiers du projet actuel en utilisant le filtre fichier spécifié.

Fichiers projet sélectionnés

Recherche seulement dans les fichiers sélectionnés du projet actuellement ouvert

[Note]Note

La recherche n'est exécutée que sur des fichiers locaux. Si vous avez ajouté au projet des fichiers distants d'un serveur FTP ou Webdav, ceux-ci seront éliminés de la recherche.

Rechercher tout

Exécute une opération de recherche et retourne la liste de résultats au panneau message.

Remplacer tout

Remplace toutes les occurences de la cible contenues dans les fichiers spécifiés.

[Avertissement]Utiliser cette option avec précaution.

La recherche et le remplacement global parmi tous les fichiers du projet n'ouvre pas les fichiers contenant les cibles, ni demande pour chaque document de confirmer une opération de remplacement. Comme l'opération fait simplement correspondre la chaîne définie dans le champ rechercher, il peut en résulter un remplacement de chaînes correspondantes qui ne devaient pas être remplacées à l'origine.

Utiliser le dialogue Aller à

L'option Aller à ... vous permet d'aller à un endroit précis du document édité en spécifiant une ligne et une colonne ou en utilisant l'offset relatif du début du fichier.

Figure 4.17. Aller à

Aller à

Compléter le dialogue comme suit:

Ligne

Ligne de destination dans le document actuel.

Colonne

La colonne de destination dans le document actuel.

Offset

L'offset de destination relatif au début du document.

Travailler avec de gros documents

Le problème

Considérons le cas de la documentation d'un gros projet. Il est fort probable que plusieurs personnes y participent. Le document en résultant peut faire plusieurs mégaoctets. Comment gérer cette masse de données sans affecter le parallélisme du travail ?

Heureusement, XML offre une solution pour cela. Un document maître peut être créé, avec des références vers les autres documents, contenant les sections du document. Les utilisateurs peuvent éditer individuellement les sections, puis appliquer FOP ou XSLT sur le document maître pour obtenir les fichiers résultat, par exemple PDF ou HTML.

  • Le document maître doit déclarer la DTD à utiliser et les entités externes - les sections. Un document échantillon est :

                                    <?xml version="1.0" encoding="UTF-8"?> 
                                    <!DOCTYPE book SYSTEM "../xml/docbookx.dtd" [ <!ENTITY testing SYSTEM "test.xml" > ]> 
                                    <book> 
                                    <chapter> ...                
                                

    On peut insérer à un certain point dans le document maître l'entité de section "test.xml" :

    ... &test; ...

  • Le document contenant la section ne doit pas définir à nouveau la DTD.

    <section> ... voici le contenu de la section ... </section>

    [Note]Note

    La DTD indiquée et les noms des éléments ( "section", "chapter" ) sont seulement utilisés ici pour illustrer le mécanisme d'inclusion. Vous pouvez utiliser n'importe quels noms de DTD et d'élément dont vous avez besoin.

Utiliser le panneau du projet

Quand vous avez un grand nombre de fichiers à éditer et à organiser, vous pouvez utiliser le panneau du projet.

[Note]Note

On peut accéder aux opérations en utilisant les boutons de la barre d'outils.

Créer un projet

Sélectionner Fichier / Nouveau projet pour créer un nouveau projet. Vérifiez que le panneau du projet est visible en cochant l'option Vue / Afficher (un signe de validation devrait être affiché dans le menu).

Créer des dossiers de projet

On peut organiser le projet comme une collection de dossiers. Ce sont des dossiers logiques, ils n'ont aucun lien avec les répertoires du disque. Faites un clic droit sur l'icône du projet, dans le panneau projet. Un menu popup s'affichera.

Figure 4.18. Menu popup du panneau du projet

Menu popup du panneau du projet

Sélectionner la première, "Nouveau dossier". Entrer un nom pour le dossier.

Figure 4.19. Dialogue nouveau dossier du panneau projet

Dialogue nouveau dossier du panneau projet
Ajouter des fichiers à un projet

Pour ajouter un ou plusieurs fichiers au dossier nouvellement créé, faites un clic droit dessus et choisissez "Ajouter fichier".

Un raccourci pour ajouter le fichier édité au dossier sélectionné est de presser le bouton droit de la souris depuis la barre d'outils du panneau projet.

Figure 4.20. Barre d'outils du panneau du projet

Barre d'outils du panneau du projet
Enlever des fichiers ou des dossiers du projet

Clic droit sur l'objet que vous souhaitez retirer. Sélectionner l'option Enlever.

Paramétrer un schéma pour Tag-Insight

Dans le cas où vous éditez des fragments d'un document, par exemple les chapitres d'un livre, chacun dans un fichier séparé, vous pouvez activer la Complétion de code pour ces fragments de deux façons :

Paramétrer une DTD par défaut

Comme expliqué ci-dessous, lors de la division d'un grand document, un seul fichier va contenir la DTD et inclure les autres. Les sections incluses ne peuvent définir à nouveau la DTD car, sinon, le document principal ne sera pas valide.

[Important]Important

L'éditeur crée les listes Tag-Insight en fonction de la DTD spécifiée et du contexte actuel (la position dans l'éditeur). Si vous changez la DTD, vous pourrez observer que la liste des balises à insérer change.

Figure 4.21. Tag-Insight piloté par une DTD Docbook

Tag-Insight piloté par une DTD Docbook

Pour proposer Tag-Insight sur les fichiers inclus, vous pouvez spécifier une DTD ou un schéma XML à utiliser quand les documents n'en spécifient pas un.

Changer la DTD par défaut

Depuis le menu Options, dialogue des Préférences, sélectionner Tag-Insight/Défaut.

Le panneau affiché a deux boutons radio : un pour la DTD et l'autre pour le schéma XML.

Si vous créez de la documentation avec DocBook, c'est un bon choix de définir le fichier docbookx.dtd.

Figure 4.22. Dialogue de configuration Tag-Insight

Dialogue de configuration Tag-Insight
Paramétrer une instruction de traitement

Le même effet est obtenu en configurant une instruction de traitement qui spécifie la DTD à utiliser. L'avantage de cette méthode est que vous pouvez configurer le TagInsight pour chaque fichier. L'instruction de traitement doit être ajoutée au début du document, juste après le prologue : <?oxygen DTDSystemID="system" DTDPublicID="public"?>

[Note]Note

Les valeurs système et publique doivent être les même que pour une déclaration DOCTYPE.

Créer un fichier inclus - une section.

Sélectionner Fichier / Nouveau. Choisir le type XML, mais sans DTD.

Vérifiez que vous avez choisi la bonne DTD dans l'option Tag-Insight. Vous pouvez maintenant taper dans le document édité l'élément racine de votre section. Par exemple, si vous utilisez DocBook ça peut être "<chapter></chapter>" or "<section></section>". Maintenant, si vous déplacez le curseur entre les balises et pressez "<", vous verrez la liste des noms d'éléments insérables.

Figure 4.23. Liste Tag-Insight sur un doucment sans DTD

Liste Tag-Insight sur un doucment sans DTD
[Note]Note

La validation ne va pas fonctionner sur un fichier inclus car aucune DTD n'est paramétrée. La validation ne peut être faite que sur le fichier maître. À ce point vous ne pouvez vérifier que la forme du document.

Navigation rapide dans le document avec les signets

Le concept du signet est le même que dans les autres : l'utilisateur peut marquer une position dans un document édité afin d'y retourner rapidement après l'édition et la navigation à travers un ou plusieurs documents ouverts en même temps. Jusqu'à neuf signets distincts peuvent être placés dans n'importe quel document ouvert. Des raccourcis claviers configurables sont disponibles pour placer des signets et pour retourner rapidement aux positions marquées.

Figure 4.24. Les signets de l'éditeur

Les signets de l'éditeur

Les raccourcis clavier peuvent être configurés depuis Options-> Préférences->Raccourcis clavier du menu.

Un signet peut être placé depuis Édition-> Signets->Créer, depuis Édition-> Signets->Création rapide de signets et en cliquant dans la marge de la zone d'édition, à gauche de la zone du numérotage des lignes, réservée aux signets.

On peut passer rapidement à une position marquée par un signet via Édition-> Signets->Aller à.

Pliage des éléments XML

Les documents XML sont organisés comme un arbre d'éléments. En travaillant sur un grand document vous pouvez réduire certains éléments en ne laissant dans le focus que ceux que vous voulez éditer. Augmenter et réduire fonctionne sur des éléments individuels : augmenter un élément ne change pas l'élément fils.

Figure 4.25. Pliage d'éléments XML

Pliage d'éléments XML

Une fonction unique de <oXygen/> est le fait que les pliages sont persistants : à la prochaine fois que vous ouvrirez le document, les pliages seront restaurés suivant le dernier étant dans lequel vous les aviez laissé. Vous n'avez donc pas besoin de replier à nouveau les parties qui ne vous intéressent pas.

Vous pouvez utiliser le pliage en cliquant sur les petits triangles dans le partie gauche de l'éditeur du document, depuis le menu contextuel ou depuis le menu DocumentPliage.