Utiliser un éditeur externe

1.Introduction
2. Recommandations générales
3. Utilisation de l’éditeur externe Notepad++
3.1 Installation
3.2 Principales fonctionnalités

1.       Introduction

Les instruments de recherche de PiXML sont encodés au format XML/EAD. Il est possible d’utiliser un logiciel d’édition compatible avec ce format pour préparer des portions de code EAD à copier-coller dans l’éditeur intégré Xeditor, ou même de modifier directement un instrument de recherche en passant par la fonctionnalité Éditer tout en externe de PiXML.

Cette fiche présente des recommandations générales avant l’utilisation d’un tel éditeur, ainsi que les principales fonctionnalités de Notepad++, l’éditeur externe gratuit proposé par la BnF.

2.       Recommandations générales

Il est vivement recommandé d’éditer les instruments de recherche de PiXML avec l’éditeur embarqué Xeditor (voir la rubrique Kitcat dédiée). Dans certains cas, l’utilisation de la fonction Editer tout en externe avec un logiciel d’édition XML peut constituer une alternative utile :

• pour l’édition de très gros instruments de recherche ;
• pour des copier-coller en masse depuis un tableur ;
• pour l’utilisation de fonctionnalités avancées telle que des transformations XSLT.

Elle présente cependant de nombreuses limites en n’offrant pas les fonctionnalités de saisie guidée de Xeditor (gestion des identifiants, prise en compte des bonnes pratiques de l’EAD en bibliothèque et des référentiels BnF, contrôles en cours de saisie, etc.). Elle est donc à réserver aux utilisateurs maîtrisant parfaitement XML et EAD.

Il est essentiel de ne pas modifier les identifiants attribués automatiquement par PiXML (voir la fiche Editer tout en externe). Le risque est de ne pas pouvoir enregistrer l’instrument de recherche, voire de le rendre inutilisable.

Remarque : comme l’ouverture de Xeditor en mode Éditer tout, l’édition externe est bloquée lorsque des sous-composants de la branche sont verrouillés pour édition ou pour envoi en numérisation. L’édition externe de branches contenant des composants Mandragore est réservée aux administrateurs Mandragore en raison du risque important de perte ou corruption des données Mandragore.

3.       Utilisation de l’éditeur externe Notepad++

3.1      Installation

L’éditeur gratuit Notepad++ est recommandé pour l’édition externe. Il peut être installé par le DSI sur demande avec son plugin XML Tools.

Si Notepad++ n’est pas installé en français par défaut, il est possible de modifier la langue de l’interface (sauf fonctionnalités propres au plugin XMLTools) en cliquant sur le menu Settings > Preferences > Localization.

Pour accéder aux outils XML, cliquez sur le menu Modules d’extension, puis XML Tools.

3.2      Principales fonctionnalités

Notepad ++ permet de :

• mettre en forme l’affichage d’un fichier XML ;
• manipuler un fichier XML ;
• valider un fichier XML.

3.2.1   Mettre en forme l’affichage d’un fichier XML

Pour ouvrir un IR téléchargé depuis le mode Édition externe, faire un clic droit sur le fichier et choisir Éditer avec Notepad ++.

Si le fichier en édition est bien enregistré avec l’extension .xml, alors la coloration syntaxique est automatique. Sinon, il faut la sélectionner dans langage> XML. Il est possible d’activer le retour automatique à la ligne (menu Affichage>retour automatique à la ligne).

Pour mettre en forme le code XML, le module d’extension XMLTools propose plusieurs options :

• l’indentation automatique : choisir Modules d’extension > XMLTools > Pretty Print ou bien le raccourci Ctrl+Alt+Shift+B. L’indentation permet de visualiser l’enchâssement des balises d’une manière semblable à la source XML dans Xeditor ;
• au contraire, la linéarisation (Linearize) supprime les espaces et les retours à la ligne inutiles à l’interprétation du code par le logiciel. Elle est à privilégier avant l’enregistrement dans PiXML ou le copier-coller dans XEditor (Modules d’extension > XMLTools > Linerarize).

3.2.2   Manipuler un fichier XML

Il est possible de saisir des balises et de modifier le code XML directement dans l’éditeur. La fermeture des balises saisies est automatique par défaut (Tag auto-close). Le code n’est pas contrôlé au moment de la saisie. Notepad++ propose un module rechercher/remplacer avec support avancé des expressions régulières (à partir du menu Recherche).

Des applications plus avancées, telles que la transformation XSLT sont possibles pour les utilisateurs avertis (Modules d’extension > XMLTools > XSL Transformation, limitée à la version 1.0 de XSLT).

Il est parfois nécessaire de vérifier que l’encodage est bien UTF-8 (Menu Encodage) avant toute transformation et avant d’enregistrer l’IR pour import dans PiXML. Si ce n’est pas le cas, une conversion est nécessaire pour garantir la prise en charge des caractères spéciaux (Encodage > Convertir en UTF-8).

3.2.3   Valider un fichier XML

Notepad++ est capable de vérifier la syntaxe XML (Modules d’extension > XMLTools > Check XML Syntax). Il est également possible de valider la conformité du code à la DTD EAD à condition d’avoir configuré celle-ci.

Pour valider la DTD EAD en cours d’édition cliquer sur Validate now (Modules d’extension > XMLTools > Validate now).

XMLTools propose par défaut de sélectionner un schéma EAD ; cette étape est à ignorer (cliquer sur OK sans choisir de fichier).

Attention : cette étape est vivement recommandée pour éviter les blocages lors de l’import de l’IR dans PiXML.

L’option Enable auto-validation (Modules d’extension > XMLTools > Enable auto-validation) permet de valider automatiquement la DTD à chaque enregistrement du fichier. La conformité du fichier XML est vérifiée à chaque enregistrement d’un fichier XML.

XMLTools ne permet pas de vérifier la conformité du fichier en cours d’édition aux Bonnes pratiques de l’EAD en Bibliothèque ni de parcourir les référentiels utilisés par la BnF pour certains attributs (par exemple les codes-fonction de l’INTERMARC). Ces vérifications sont à faire manuellement, ou après enregistrement dans PIXML, en utilisant la fonction Contrôler les bonnes pratiques.