Oxygen - Manuel

Pour obtenir la version PDF imprimable de ce manuel, tapez Ctrl-P (ou Cmd-P pour les Mac).

Présentation du logiciel

Oxygen est un logiciel pensé pour travailler avec le format XML. Si ce n'est pas déjà le cas, vous pouvez consulter le manuel de TEI pour en savoir plus. Le format XML est un format de texte enrichis avec des balises, il est donc possible de faire du XML dans n'importe quel éditeur de texte brut (attention, pas OpenOffice ou Word, qui contiennent du texte mais également de la mise en forme). Cependant, un logiciel adapté permet de travailler beaucoup plus facilement, grâce à des fonctionnalités sur lesquels nous reviendrons dans ce manuel :

Oxygen est un logiciel spécialement conçu pour le XML, mais il est payant et propriétaire. Si vous souhaitez travailler avec un logiciel libre ou si vous ne disposez pas d'une licence grâce à une institution, il est également possible de travailler avec des logiciels d'édition de code plus généraliste, comme le logiciel libre VSCodium (voir l'article de blog de DAHU.

Installer le logiciel

Pour installer Oxygen, rendez-vous sur la page de téléchargement : https://www.oxygenxml.com/xml_editor/download_oxygenxml_editor.html en prenant garde à cliquer sur l'onglet qui correspond à votre système d'exploitation (Windows, MacOS ou Linux). Il faut ensuite cliquer sur "Download" pour télécharger le fichier puis double-cliquer sur le fichier téléchargé pour lancer l'installation. Une fois installé, vous pourrez lancer le logiciel en cliquant sur l'icône Oxygen.

(Note : il est nécessaire d'avoir les droits d'installation sur son ordinateur)

Enregistrer sa licence

Pour utiliser Oxygen, il est nécessaire de disposer d'une licence. L'IR* Huma-Num propose des licences, gratuites pour nous les utilisateur·ices. Une fois la demande envoyée, vous recevrez par mail une clé de licence. Voici comment procéder pour enregistrer la clé de licence fournie par Huma-Num :

  • Ouvrir Oxygen
  • Cliquer sur "utiliser un serveur de licences"
  • Saisir l'url correspondant au serveur de licences Huma-Num : https://xml.lic.huma-num.fr/xmllic/license-servlet/
  • Saisir le nom d'utilisateur·ice et le mot de passe envoyés par Huma-Num

image

Cette étape n'est à réaliser qu'une seule fois, la licence est enregistrée jusqu'à ce qu'elle expire. Vous êtes maintenant prêt·es à travailler

L'espace de travail dans Oxygen

Lorsque vous ouvrez Oxygen pour la première fois, l'interface se présente ainsi :

  • au centre, une zone de saisie
  • à gauche des blocs "projet, sommaire"
  • à droite "attributs, association scénario, éléments et entités"

image

Je vous conseille pour le moment de fermer toutes ses fenêtres pour ne garder que "sommaire" à gauche et éventuellement "éléments" et "attributs" à droite. Dans le cas d'un petit écran, il peut même être plus agréable de ne laisser que la zone de saisie.

Pour réinitialiser la mise en forme des fenêtres allez dans le menu "fenêtre", puis "réinitialiser la mise en page". À l'inverse, pour remettre une fenêtre fermée, allez dans le menu "fenêtre" puis "afficher la vue..." et sélectionner la vue que vous souhaitez (par exemple le sommaire, pour naviguer dans un long document) .

Travailler sur un fichier XML

  • Ouvrir un fichier existant : Allez dans "fichier", "ouvrir" et sélectionnez le fichier sur lequel vous souhaitez travailler.
  • Créer un nouveau fichier : Allez dans "fichier", "nouveau" puis taper "TEI" dans la barre "saisir le texte du filtre". Sélectionnez "TEI All" puis "créer" et enfin cliquez sur la disquette pour enregistrer.
    image
  • Indenter le texte : pour rendre le texte et la hiérarchie des balises plus lisible, il est possible de l'indenter. Pour cela, cliquez sur l'icône "Formater et indenter" ou faites le raccourci clavier ctrl-shift-P

Ajouter une <balise> (ou élément)

La solution la plus évidente est de commencer à taper à la main votre balise ouvrante, votre texte, puis votre balise fermante.

ex: <persName>Madame de Sevigné</persName>

Dans les fait, Oxygen propose les noms de balises disponibles dans l'élément où l'on se situe, dès que vous commencez à écrire le nom d'une balise, il est donc possible de naviguer avec les flèches puis de cliquer sur entrée. La balise ouvrant et la balise fermantes sont alors automatiquement crées. C'est une bonne pratique car cela évite de risquer de laisser des balises non fermées, mais ce n'est pas très pratique lorsque l'on travaille sur un texte déjà rédigé (ex : lorsque l'on veut ajouter des balises sur un texte préalablement transcrit)
image

Dans le cas d'un texte déjà transcrit, il est possible d'ajouter la balise ouvrant et la balise fermante d'un seul coup, autour d'un bloc de texte, toujours pour gagner du temps mais aussi pour éviter les erreurs.

Première solution :

  • Sélectionnez avec votre souris le texte à encoder.
  • Appuyez sur ctrl-E sur PC ou cmd-Esur mac
  • Une fenêtre s'ouvre, sélectionnez le nom de la balise (il est possible de taper les première lettres du nom de la balise pour filtrer)

Deuxième solution :

  • Sélectionner avec votre souris le texte à encoder.
  • Double-cliquer sur l’élément de votre choix dans la liste des éléments (qui se trouve à priori en bas à droite, dans la fenêtre "éléments"). Vous pouvez rouvrir la fenêtre "éléments" si vous l'avez fermée (menu "Fenêtre" - "afficher la vue".

Ajouter un @attribut

De la même façon, il est possible de passer par un raccourci clavier ou par la fenêtre "attribut", à droite. Première solution :

  • Placez votre curseur à la fin du nom de la balise ouvrante, avant le chevron fermant.
  • Insérer une espace.
  • Une fenêtre s’ouvre. Sélectionnez l'attribut à ajouter (il est possible de taper les première lettres du nom de la balise pour filtrer).
  • Cliquez sur "entrée" et choisir le contenu de l'attribut dans la liste proposée le cas échéant.
  • Pour ajouter un deuxième attribut, insérer une espace après le premier.

Deuxième solution :

  • Cliquer sur l’élément sur lequel ajouter un attribut.
  • Dans la fenêtre, "Attributs", se trouve les attributs autorisés pour l’élément en question. (il est possible de remettre cette fenêtre si elle a été fermée, voir plus haut)
  • Remplir la colonne "Valeur" soit par du texte libre, soit en sélectionnant un élément dans la liste fermée proposée.

image

S'assurer qu'un fichier est conforme

Oxygen permet de s'assurer qu'un fichier est conforme à la TEI (ou au schéma spécifique que vous avez choisis d'appliquer : dans le cas des projets ELAN, il y a la plupart du temps un fichier ODD qui permet de restreindre la TEI afin de ne pas autoriser tous les éléments disponibles pour chaque projets et préciser certaines définitions en fonction du cadre). Cela est visible grace au fameux "carré vert" en haut à droite la fenêtre de saisie, qui devient un "carré rouge" lorsqu'il y a une erreur. Ce carré rouge s'accompagne de petites lignes au niveau de l'erreur, il est possible de cliquer dessus pour aller directement au passage fautif. Attention, lorsqu'il s'agit d'erreur d'imbrication, celles-ci ne sont pas toujours bien localisée, il faut alors remonter dans le fichier pour les trouver. Le manuel de TEI propose une liste des erreurs les plus fréquentes.

Les raccourcis clavier

Pour faciliter l'encodage, il est parfois plus rapide d'utiliser le clavier plutôt que d'aller chercher des fonctionnalités dans les sous-menus. Les raccourcis sont rangés dans un ordre très subjectif d'"indispensabilité". (si vous travaillez avec un mac, remplacez tous les ctrl par des cmd).

  • Entourer ce qui est surligné d'un tag : ctrl-E
  • Indenter le texte : ctrl-shift-P
  • Diviser un élément en deux : alt-shift-X
  • Dupliquer la ligne : ctrl-shift-flèche du haut (la ligne est copiée à l'identique au dessus)

D'autres raccourcis sont utilisables dans Oxygen, mais également dans la plupart des autres logiciels, en voici quelques uns qui pourraient servir dans le cadre d'un travail en TEI : (si vous travaillez avec un mac, remplacez tous les ctrl par des cmd).

  • Créer un nouveau document : ctrl-N
  • Copier du texte : ctrl-C (ou cmd-shit-P
  • Couper du texte : ctrl-X
  • Coller le texte préalablement copié ou coupé : ctrl-V
  • Sauvegarder le fichier en cours d'édition : ctrl-S
  • Annuler la dernière action : ctrl-Z
Pour plus de raccourcis, vous pouvez vous référez à l'article du blog de DAHU : Raccourcis clavier

Aller plus loin : effectuer des transformations

Si nous gardons Oxygen à Elan pour certains opérations, c'est aussi qu'il propose des services que l'on ne retrouve pas sur d'autres outils, dont la possibilité de lancer des transformations XSLT sans utiliser la ligne de commande. Même si vous ne rédigez pas vous-même de scripts XSLT, vous pouvez être amené·es à en utiliser, par exemple en récupérant le script d'Anne Garcia-Fernandez pour numéroter les vers de 5 en 5 🙂 .

Pour lancer un script XSL, ouvrez le fichier XML que vous souhaitez transformer et le scirpt XSL à appliquer. Passez l'affichage d'Oxygen en mode XSLT (1), puis sélectionnez dans les menus déroulant le fichier XML à transformer, le fichier XSL à utiliser et l'emplacement où la sortie sera enregistrée (2, 3, 4). Enfin, cliquez sur la flèche bleue (5) pour lancer la transformation.
image


Remarques générales sur le modèle TEI et son manuel