Appropriation oXygen : de la production en xml à la publication en html ou en epub

Éric Le Jan

CLEG Camille Saint Saëns


                        22 rue Saint Lô
                        Rouen
                        76000
                        tel: 02 35 07 83 50
                        Fax : 02 35 07 83 51
                    

<>

Carole Larose

Lycée Corneille Rouen
<>

Publié par

Éric Le Jan

Académie de Rouen
Résumé

Cet article correspond au fil conducteur de la formation à distance réalisée par Carole Larose et Eric Le Jan le 2 juillet 2013. Il a été utilisé pour montrer comment partir d'un article vierge au format ENS-DOA et parvenir çà une publication en ligne ou sous forme de livre électronique au format.epub


Table des matières

Préparation de la formation

Vous devez préparer vos machines en utilisant les instructions suivantes. Toutes les étapes sont nécessaires.

Vous pouvez toujours utiliser ce mode d'emploi pour travailler en local sur vos machines. Vous pouvez vous affranchir du "subset-ENS-DOA" pour utiliser les "article" docbook5 fournis dans oXygen.

Vous trouverez dans la collection Outils et méthodes les ouvrages "NoticeBook" et NoticeSSHetCloud" qui vous livrent les modalités 2015 de la production à l'iFé.

Les éléments à télécharger

Tous ces éléments sont utiles soit pour suivre la formation soit pour préparer votre machine d'un point de vue logiciel.

  1. ArchiveENSDOAJanvier2013.zip
  2. ConversionDOAOlivier.zip
  3. Docbook 1.78.1
  4. CSSDocBook
  5. FicheLOMmodele.zip
  6. Ressourcesbook.zip
  7. Formationjuillet.zip

Préparer des données personnelles

Pour que l'article que vous allez créer pendant la formation vous soit utile nous vous proposons de préparer une ressource personnelle.

  1. Choisir un travail existant qui contienne :

    1. Un texte structuré (fil conducteur de TP, cours .)
    2. Des illustrations (images, sons, vidéos …)
    3. Des liens ou des références liées au travail à réaliser par l'élève (Site, poly…)
  2. Préférer un travail qui pourrait être affiché sur internet

    1. Pas de problèmes de droits pour les médias
    2. Intérêt de l'affichage pour un public de collègues ou d'élèves
  3. Ranger dans un dossier l'ensemble des ressources

Préparer oXygen

La préparation tient en peu de choses. Il faut placer dans le logiciel les ressources qui lui permette de vous fournir l'accès aux éléments du modèle "ENS-DOA"

  1. Utiliser l'article en ligne du Pôle de diffusion des savoirs

    1. Il est ici
    2. Suivez les instructions du paragraphe «La préparation du poste de travail»
    3. Faites ce travail en ayant quitté oXygen.
  2. Vérifier avec l’aide du paragraphe «l’ouverture d’un nouveau fichier au format ENS-DOA» que cela a réussi

    1. Utiliser dans oXygen le menu "nouveau" du menu "fichier"
    2. Choisir "Article [ENS-DOA 1.0]
    3. L'ouverture doit livrer un fichier qui affiche "vert" en haut et à droite
  3. Sauvegarder le fichier en le nommant "article.xml"

Créer une archive pour travailler

Créer une archive zip permet de travailler en permanence de façon cohérente par rapport à notre objectif : déposer sur les serveurs de l'ENS des fichiers immédiatement accessibles.

Cela implique que tous les éléments soient transmis, avec les noms de fichiers cohérents, avec les liens justes.

Préparer l'archive sur le poste de travail

Suivez les étapes décrites ci-dessous.

  1. Créer un dossier «nomdelarticle»

    C'est lui qui vous permet de ranger éventuellement toutes vos données personnelles. Vous pouvez aussi y placer tous les fichiers téléchargés.

  2. Créer un fichier «article.xml» sauvegarder dans le dossier

    Cette création se fait dans oXygen et vous l'enregistrez dans le dossier à partir d'oXygen

  3. Coller la fiche «Lom_jardinet.xml» dans le dossier

    Elle est à glisser/déposer à partir du zip téléchargé

  4. Créer un sous dossier «média»

    Son rôle est de contenir tous les média. Ce dossier sur le serveur du PDS sera intégralement téléversé. Il sera alors renommé du nom de votre article. Ce point sera revu dans la partie "mise en ligne" de cette formation.

  5. Créer trois sous-dossiers «images», «vidéos», «fichiers»

    Leur rôle est aussi très important. L'article est illustré par les fichiers qu'ils contiennent. Les chemins des illustrations pointent vers ces dossiers.

  6. Zipper l’ensemble des deux fichiers .xml et du dossier media. Zipper l’ensemble des deux fichiers .xml et du dossier média.

    Ceci fait oXygen vous permettra d'ajouter dans l'archive tout ce que votre article contient. C'est vraiment une façon très simple d'éviter de mauvaises surprises lors de la publication.

  7. Ouvrir l’archive «article» dans oXygen et ouvrir «article.xml»

    oXygen vous affiche le contenu de votre archive.

Argumentaire en faveur de la méthode

Cette liste est le résultat de notre travail. Elle correspond à ce que nous ressentons. Nous comptons sur ces arguments pour vous convaincre d'appliquer les consignes que nous vous recommandons.

  1. Tous les fichiers attachés à l’article sont dans l’archive
  2. L’archive est sauvegardée dès la première modification

    On dispose du coup d'une "version" antérieure à chaque étape de la modification de l'article.

  3. L’archive peut être partagée par plusieurs enseignants, les modifications apportées sont transférées par copier coller dans les fichiers et par «ajouts» pour les médias
  4. L’archive fournie à l’iFé ENS contient obligatoirement tous les éléments nécessaires à la mise en ligne
  5. Le passage au format .epub se fait simplement par extraction du fichier «article.xml» et du dossier «media»

Utiliser un modèle pour accompagner la construction de l'article

Nous avons mis un moment à décider comment faire pour vous accompagner pendant le distanciel. Une vraie contrainte est le "contenu de l'article modèle". Plus ce contenu est proche de ce qu'on a conçu, mieux on comprend ce qu'on est en train de rédiger. Notre problème est que vous ne disposez pas d'article "personnels". Nous avons donc décidé de nous appuyer sur 3 articles.

L'article d'olivier Dequincey pour la diversité des "éléments" dont il illustre l'utilisation.

L'article Jardinet de notre formation Formaterre 2013 à Rouen car il ressemble à ce que vous produirez assez souvent pour l'iFé.

La version "Article" du fil conducteur de la formation car du coup vous voyez l'original (la présentation dans Centra) et sa transformation en fichier.xml (cet article)

Préparation du travail dans oXygen

Une fois franchies les étapes ci-dessous votre logiciel sera en situation de vous montrer ce que nous faisons à l'écran pendant le distanciel

  1. Lancer le logiciel et ouvrir l’archive «article» créée précédemment.
  2. Double cliquer sur le fichier «article.xml»

    On dispose du premier onglet

  3. Utiliser le bouton pour ouvrir l’archive «ressourcesbook»
  4. Double cliquer sur le fichier «Jardinet.xml»

    On dispose du second onglet

  5. Utiliser le bouton pour ouvrir l’archive «conversionDOAolivier.zip»
  6. Double cliquer sur le fichier «conversionDOAolivier.xml»

    On dispose du troisième onglet

  7. Utiliser le bouton pour ouvrir l’archive «formationjuillet.zip»
  8. Double cliquer sur le fichier «formationjuillet.xml»

    On dispose du quatrième onglet

  9. Utiliser le bouton pour ré-ouvrir l’archive de travail.
  10. Vous êtes près pour suivre la formation

Ouvrir l’onglet de «Jardinet.xml»

Nous allons ensemble découvrir les particularité de l'éditeur de texte oXygen. Vérifiez que vous avez bien à droite les onglets "éléments" et "Attributs" visibles. Dans la fenêtre "éléments" choisissez l'onglet "curseur". Si ce n'est pas le cas utiliser le menu "fenêtre" pour "réinitialiser la mise en page". Aux noms de fichier près votre écran doit ressembler à l'illustration ci-dessous.

La page et sa présentation

Cette illustration est mise à disposition selon les termes de la Licence Creative Commons Attribution - Pas d’Utilisation Commerciale - Partage dans les mêmes conditions 4.0 International

Figure 1. La page et sa présentation

La fenêtre de travail avec au centre l'éditeur et sur les colonnes latérales les accès au fichiers (gauche) et l'accès aux attributs et éléments (droite).


  1. Choisir le mode «auteur»
  2. L’article décrit une activité que nous avons utilisée en formation en 2011 pour formaterre
  3. Examiner la structure de l’article

    Il faut suivre en dessous des onglets le cheminement du curseur, et à droite noter les éléments qu'on peut ajouter ou les attributs qui caractérisent l'élément parcouru par le curseur.

  4. Constater que les éléments de la structure défilent dans les fenêtres de droite «éléments» et «attributs»
  5. Choisir le mode «texte»
  6. Constater cette fois que vous «lisez» les noms des éléments
  7. Constater que dans «éléments» le curseur permet encore de repérer ce qui est disponible à l’endroit où il se situe dans l’article

Ouvrir l’onglet de l’article vierge

Vous allez indépendamment les uns des autres commencer à rédiger un article. Dans un premier temps vous allez compléter l'article pour y définir ses auteurs et rédiger un "résumé".

  1. Cliquer sur l’onglet «article.xml»
  2. Passer dans l’onglet de l’article modèle regarder ce qu’on veut ajouter.
  3. Dans l’article vierge après le titre, sélectionner l’élément «authorgroup»
  4. Créer ensuite les mêmes éléments que dans l’article modèle
  5. Vous pouvez essayer en «copiant/collant» en mode texte, un des éléments de l’article modèle dans l’article vierge.
  6. Vous savez produire un document au format ENS-DOA.

    C'est le petit carré vert en haut et à droite de la fenêtre centrale qui vous confirme que ce que vous avez créé est conforme au format "ENS-DOA"

  7. Il reste à intégrer des sections, des figures, des tableaux ou tout autre éléments en respectant le format ENS-DOA

Compléter l’article vierge : images

Dans cet exercice il serait préférable que vous utilisiez une illustration qui figure dans votre dossier de données personnelles.

  1. Ajouter une figure

    Il faut commencer par titrer la figure. C'est une étape obligatoire.

  2. Intégrer un objet «image»

    1. Commencer par «ajouter» au dossier «media» et au sous dossier «images» le fichier .jpg

      Ce fichier est dans la mesure du possible un de vos fichiers.

    2. Sélectionner ensuite "mediaobject" puis "imageobject" puis "imagedata"
    3. Remplir les attributs «fileref» media/images/nomdufichier.jpg de l'élément "imagedata"
    4. Compléter les attributs «width», «align»

      Vous pouvez choisir 400 pour la largeur et "center" pour l'alignement

    5. Ajouter les éléments «info» puis «copyright» puis «year» puis «holder»

      Remplissez l'année, puis le prénom et le nom de l'auteur ou du propriétaire des droits.

  3. Vous savez produire un document illustré au format ENS-DOA.
  4. Il reste à intégrer des sections, des tableaux ou tout autre élément en respectant le format ENS-DOA

Compléter l’article vierge : vidéos

La vidéo présente une particularité. Il faut pour que le fichier soit lu quel que soit le navigateur intégrer trois vidéos, une au format .ogg une au format .mp4 et une au format .webm.

  1. Ajouter une figure

    Il faut de nouveau titrer.

  2. Intégrer un objet «videoobject»

    1. Commencer par ajouter au dossier "media" et au sous dossier "videos" le fichier .mp4, le fichier .ogg et le fichier .webm (logiciel sur PC pour faire les captures video)
    2. Choisir «mediaobject» puis «videoobject»
    3. Remplir les attributs «fileref» media/videos/nomdufichier.mp4
    4. Compléter les attributs «width», «align»
    5. Ajouter «info» puis «copyright» puis «year» puis «holder»
    6. Recommencer pour les «mediaobject» et intégrer les deux autres formats
  3. Vous venez d’intégrer une vidéo.
  4. Il reste à intégrer des sections, des tableaux ou tout autre élément en respectant le format ENS-DOA

Compléter la fiche LOM de l’article

Cette fiche est le support de l'affichage de l'article sur le site du Pôle de Diffusion des Savoirs

  1. La Fiche LOM est indispensable

    Il n'est donc pas possible d'y couper. On se sert d'un modèle pou créer la première fois une fiche LOM personnelle. Les autres articles réutilisent cette première fiche qu'il suffit d'adapter au nouvel article.

  2. Elle doit contenir une partie «descriptive de l’article» une partie «classification»

    La première partie se construit en remplaçant les éléments qui décrivent l'article initialement associé à la fiche.

    La seconde partie se construit sur le site UNIS de l'ENS Lyon.

  3. La partie descriptive :

    1. Remplacer les noms et prénoms, les dates, les url, pour que tout corresponde au nouvel article.
    2. Trouver des mots clefs pertinents, limiter à cinq ou six mots clefs
  4. La partie classification :

    1. Utiliser le site d’UNIS pour créer la classification en suivant ce lien
    2. Une fois la classification prête, la copier et aller la coller à la place de l’ancienne dans la fiche LOM dans oXygen

Argumentaire en faveur de la méthode

Cette liste est le résultat de notre travail. Elle correspond à ce que nous ressentons. Nous comptons sur ces arguments pour vous convaincre d'appliquer les consignes que nous vous recommandons.

  1. Le mode «auteur» dispose de boutons pour gérer quelques éléments de style ou quelques éléments comme les tableaux ou les figures.

    Il faut prendre l'habitude de cliquer sur les boutons en vérifiant que le curseur est au bon endroit.

  2. Le mode «texte» permet de s’y retrouver quand on est un peu perdu en mode «auteur»

    On peut s'aider du mode texte notamment si on souhaite copier/coller un "élément" depuis un autre article.

  3. Le fait de saisir directement l’article évite la transformation depuis le fichier contenu dans une archive .odt.

    Ceci nous est apparu évident après la rédaction du premier article. Aucune erreur ne peut se glisser dans l'article pendant la rédaction. Ce n'est pas le cas en partant d'OpenOffice.

  4. L’article produit et les documents qu’il contient rangés dans le dossier média permet de s'assurer que tout est en place.
  5. Le carré vert en haut et à droite témoigne de la conformité de l’article au format ENS-DOA

Passer au format Book en ajoutant les balises adhoc puis passer à .epub

Ces deux étapes conduisent à disposer d'un fichier au format epub qui sera lu par les tablettes Androïd comme les iPads ou encore par un logiciel comme "Readium" dans chrome ou "epubReader" dans firefox.

Dupliquer l’article et le compléter avec la balise "book"

Travailler dans l'archive d'origine permet de maintenir les liens avec les media. L'extraction du fichier articlebook.xml puis du dossier media seront ainsi cohérentes.

  1. Sélectionner l’article et le copier, puis le coller dans l’archive.

    Vous avez dupliqué votre fichier.

  2. Renommer l’article en nomdelarticlebook.xml

    Cela vous permettra de garder dans la version tous les liens vers les media.

  3. Ouvrir le fichier jardinetbook.xml fournit dans l’archive ressourcesbook.zip

    Cette étape vous permet de disposer d'un onglet supplémentaire qui affiche la balise "book" en place dans un article publié.

  4. Passer en mode «texte» et repérer la balise «book» puis les «éléments» ajoutés avant la balise «article»
  5. Repérer que les attributs de «book» sont ceux de «article» et que «article» est devenu la première partie du livre et que </book> termine l’article.

    Il faudra donc couper les attributs de l'élément "article" pour les coller dans l'élément "book"

  6. Regarder le document de couverture, repérez son nom, il est «conventionnel»

    Il est essentiel d'importer le fichier de la couverture dans vos media. Vous pouvez aussi importer une image et la renommer cover.jpg

  7. Transformer votre article en «book»

    Appliquez-vous à remplacer dans les balises copiées depuis "jardinetbook.xml" dans votre "articlebook.xml" ce qui rend votre article cohérent.

Transformer articlebook.xml et media en fichier epub

Ce travail impose que votre machine contienne le dossier "Docbook 1.78.1". Vous allez travailler avec la fenêtre de commande sous Windows et le Terminal sous Mac OS X. Pendant la formation vous aurez une démonstration de l'ensemble des étapes qui conduisent au fichier final.

  1. Créer dans le dossier Docbook 1.78.1 un dossier «ArticleBook»
  2. Depuis oXygen extraire, articlebook.xml et le dossier media dans ce dossier
  3. Créer dans le dossier «ArticleBook» un dossier «OEBPS» y coller le dossier «media»
  4. Lire les instructions de la procédure à suivre sur le site du PDS (authentification nécessaire)
  5. Lancer la première ligne de commande : production des fichiers en html5
  6. Remplacer dans OEBPS la css par celle de l’ENS, se placer dans le dossier «articlebook»

    Cette étape est importante, le fichier est dans le zip "docbook-epub.zip"

  7. Lancer la seconde ligne de commande : zipper les dossiers OEBPS, META-INF et le fichier mimetype ensemble en renommant le fichier «articlebook.epub»

    C'est fait vous disposez d'un livre électronique.

Corriger les «erreurs» dans les fichiers produits

Cette étape ne sera pas toujours nécessaire. En effet les erreurs proviennent de la transformation du fichier au format ENS-DOA. La correction de ces erreurs de transformation devrait apparaître dans un avenir proche.

  1. Ouvrir l’archive «articlebook.epub» dans oXygen
  2. Passer en revue l’ensemble des pages et corriger les petits défauts.
  3. Une fois les pages au vert il reste encore parfois :

    1. À ajouter les référence des fichiers vidéo ogg et webm
    2. À corriger la balise «video» en html5 pour quelle intègre les deux autres formats.
  4. Tester votre .epub dans Readium, epubReader (firefox) ou itunes (puis sur l’iPad)

    C'est l'étape la plus amusante et la plus satisfaisante.

Argumentaire en faveur de la méthode

Cette liste est le résultat de notre travail. Elle correspond à ce que nous ressentons. Nous comptons sur ces arguments pour vous convaincre d'appliquer les consignes que nous vous recommandons.

  1. Ce passage par Book permet d’accéder à une production contenant plusieurs articles
  2. Le format epub est compatible tablettes et lecteurs spécialisés sur les ordinateurs
  3. Les corrections sont fastidieuses mais routinières donc assez vite enchainées
  4. La mise à disposition sur un serveur déclenche la lecture du .epub dans un ENT c’est assez pertinent comme format
  5. Le téléchargement sur les ordinateurs reste possible avec un clic droit

Déposer l’article et de la fiche LOM ainsi que les média sur le site du PDS

Cette étape nous rend tous autonome par rapport au site qui affiche nos travaux. Nous sommes en mesure de déposer le fichier de l'article, la fiche LOM de l'article et le dossier des média de l'article.

Connecter sa machine à tomya

Cette étape est précise et vous sera communiquée individuellement. Le principe est exposé ci-dessous.

  1. Utiliser le Terminal sous Mac ou Putty sous Windows
  2. Sauvegarder la ligne de commande dans un fichier
  3. Saisir lors de la connexion son mot de passe sur la machine tomya.

Connecter le navigateur à la base exist de l’ENS

Cette étape exige que vous disposiez de l'URL et du port sur lequel vous connecter. Là encore ces informations vous seront communiquées individuellement.

  1. Entrer l’URL dans le navigateur.

    Il s'agit ici d'utiliser votre connexion sur Tomya via un port de votre machine (Tunnel SSH) pour atteindre le port cible de la machine qui héberge la base eXist.

  2. Se logger dans la base eXist.
  3. Ouvrir les collections
  4. Coller le fichier de l’article xml dans le dossier «data»
  5. Coller le fichier de la fiche LOM de l’article dans le dossier «metadata»

Déposer le dossier media sur le site du Pole de diffusion des Savoirs.

C'est l'ultime étape, vous pouvez agir en déposant vos données. Une fois cela fait il faut demander leur publication Web par le responsable du site. Pour l'instant la publication est réservée aux équipes ACCES.

  1. Utiliser celien pour rejoindre le lieu de dépôt
  2. Se logger avec son identifiant et son mot de passe sur ce site
  3. Déposer le dossier media et tout son contenu
  4. Renommer le dossier media du nom du fichier de l’article
  5. Retourner sur la base eXist et corriger grâce à «eXide» les chemins des illustrations
  6. Utiliser «rechercher/remplacer» pour faire la modification

Conclusion

Nous vous souhaitons de bons usages et nous vous invitons à revenir vers nous pendant vos expériences de création de documents au format ENS-DOA.