Copyright © 2014-12-14 Ce livret numérique 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
Un ensemble d'étapes qui permettent l'installation de la base de donnée libre Jlodb (Javascript Learning Object Data Base). Seront mise en place dans chaque chapitre les recomandations pour installer et utiliser cette base d'exercice. Merci à l'auteur pour l'aide et le soutien apporté pendant le déploiement de son outil.
L'iFé ENS de Lyon au sein de l'équipe @CCES continue le développement de la chaine éditoriale Tremplin. Une possibilité d'intégration de documents de type "exercices d'appropriation" de divers format est offerte par la démarche de l'auteur qui a mis au point un système d'édition d'exercices fondés sur le javascript et le html5.
Ce chapitre s'adresse aux usagers qui disposent d'un Mac et qui souhaitent déployer l'outil dessus. Ce déploiement nécessite quelques installations ou quelques paramétrages différents de ceux livrés avec la machine.
Pour aborder cette installation vous n'avez pas besoin de beaucoup de connaissances, mais les opérations qui touchent au paramétrage du Mac se réalisant en ligne de commande il faut tout de même être soignuex dans l'apprication des consignes.
L'installation doit comprendre :
un système Apache fonctionnel
une installation de la base de donnée Mysql
une mise en place de php5
l'installation d'un logiciel permettant d'interagir avec la base Mysql
Une fois l'installation des prérequis menée à bien il reste à poser jolb dans le dossier redu accessible par le serveur Apache.
Le serveur Apache du Mac n'est pas lancé par défaut. Cet aspect est un héritage de la version 10.7 de l'OS d'Apple. Le service Apache est livré par défaut dans les versions "Server" du système.
Suivez les étapes décrites ci-dessous.
Ouvrez le terminal en utilisant spotlight
Il suffit de faire apparaître le champ SpotLight (cmd + space sous Yosemite) puis de saisir le nom de l'application.
Dans la fenêtre du terminal vous allez lancer votre serveur Apache.
La commande exige que vous soyez administrateur de la machine.
:~ sudo apachectl start
le début de la ligne ci-dessus signale que vous êtes à la racine de votre session il ne faut donc pas ressasir ( :~ ).
Pour les modifications du fichier de configuration apache pensez à stopper le serveur
Quand on change des paramètres comme plus loin dans ce livret on édite le fichier httpd.conf. Il est alors prudent d'arreter le serveur avant de faire les modifications.
:~ sudo apachectl stop
Naturellement une fois les changements effectués vous aurez à relancer le serveur avec la commande vue plus haut dans ce livret.
En cas d'absence de l'expression it works vérifiez l'intégrité de la configuration
C'est encore une ligne de commande du terminal qui permet cela.
:~ apachectl configtest
Plutôt que de faire des copier / coller pensez à essayer de recopier la ligne en vous servant de l'autocomplétion du système, après les première lettre utilisez la touche de tabulation pour compléter la fonction recherchée.
Conserver le dossier d'hébergement des sites commun à toutes les session
La configuration sera ici maintenue pour "tous les utilisateurs de la machine". Si vous n'etes pas sur votre machine il se peut que vous souhaitiez activer un dossier "Sites" accessible seulement sur votre compte.
Ce tutoriel vous livre une méthode fonctionelle pour y parvenir.
i vous vous lancez dans cette opération pensez à sauvegarder une version non modifiée de votre fichier httpd.conf
:~ cd /etc/apache2/ <!– pour changer de répertoire :~ sudo cp httpd.conf httpdoriginal.conf <!– pour garder un fichier propre
Passons maintenant à l'étape 2.
Cette étape implique de retourner dans le fichier httpd.conf. Vous devez décommenter la ligne
#LoadModule php5_module libexec/apache2/libphp5.so
On décommente en enlevant le # devant la ligne.
Une fois cela fait on vérifie que PHP est en place en lançant un fichier test.php dans leque vous aurez pris soin de placer l'expression :
<?php phpinfo(); ?>
Commencez par créer un fichier avec un editeur de texte comme Xcode ou Subethaedit. Collez l'expression dans le fichier et sauvegardez le dans le répertoire parrtagé de Apache (/Library/WebServer/Documents/) . Ensuite avec votre navigateur accedez à l'adresse localhost/test.php.
Vous devriez alors voir un document qui ressemble à l'illustration ci-dessous.
à Venir
Vous êtes prêts pour créer votre article.
Quelques aides à la navigation dans oXygen:
Les touches de direction sont essentielles à la navigation.
Les différentes fenêtres dans oXygen : au centre, votre fenêtre de travail avec en haut une aide essentielle à la navigation qui vous précise la position de votre curseur.
Sur un côté, la fenêtre navigateur d'Archives dans laquelle vous avez ouvert votre zip avec les media, votre article, votre fiche LOM, votre connection aux bases de données.
Sur l'autre côté, deux fenêtre indispensables: la fenêtre Eléments avec tous les éléments dont vous disposerez pour la construction de votre article et la fenêtre Attributs dont vous aurez besoin dans les cas où vous insérez un media ou un lien. Si ces fenêtres n'apparaissent pas il est possible de les afficher en allant les activer dans le menu "fenêtre".
Dans un premier temps, vous allez commencer l'article en remplissant les champs qui définissent le ou les auteurs de l'article puis présenter l'article en rédigeant un résumé.
Il reste à intégrer des sections, des figures, des tableaux ou tout autre éléments en respectant le format DocBook 5
Lorsque l'on écrit un article, il est important et utile de pouvoir le structurer. Pour cela, il faut utiliser l'élement section: sect 1 pour les grands titres et sect 2 pour les sous-titres...
Pour écrire du texte, il suffit de se situer à un niveau du curseur qui donne dans les éléments possibles celui de "para". Si vous souhaitez faire un copier/coller de texte, c'est à cet élément que ce sera possible. Il est dans ce cas plus facile de passer par le mode texte pour un meilleur repérage des balises.
La série de boutons illustrée ci-dessous vous permettra comme dans un traitement de texte classique de pouvoir appliquer du gras, de souligner ou de mettre votre texte en italique, suivant la configuration choisie vous pouvez avoir des icônes ou du texte pour les styles..
Dans la liste des éléments, fenêtre de droite se trouve l'élement figure comme sur l'image ci-dessous:
Ajouter une figure
Il faut commencer par titrer la figure. C'est une étape obligatoire.
Intégrer un objet «image»
Soit votre dossier média contient déjà l'image soit vous pouvez ajouter un fichier image.jpg au dossier «media» et au sous dossier «images» (local ou en ligne).
Pour cela, dans le navigateur d'archives, fenêtre de gauche, cliquer droit sur images et ajouter des fichiers:
Compléter les attributs «width», «align», «alt»
Vous pouvez choisir 400 pour la largeur et "center" pour l'alignement
Votre image s'affichera en mode auteur. Si cela n'est pas le cas, c'est que le chemin que vous avez attribué à l'image dans l'attribut fileref n'est pas correct.
Vous devez disposer d'un article au format DocBook 5 pour continuer. La production d'un article vous est proposée dans l'epub que vous pouvez télécharger en suivant ce lien. Vous pouvez aussi visualiser l'article en ligne en suivant cet autre lien.
Ouvrir l'article dans Oxygen puis l'enregistrer sous son nom de livre (différent du nom de l'article).
Vérifier que l'en-tête du fichier xml est bien une en-tête DocBook et pas l'en-tête DOA qui entraine l'utilisation d'une transformation non standard incompatible avec epub3, il faut avoir le texte ci-dessous qui peut se présenter sous la forme de trois longues lignes (sans les retours à la ligne après la définition de chaque élément) :
<?xml version="1.0" encoding="UTF-8"?>
<?xml-model href="http://docbook.org/xml/5.0/rng/docbook.rng" schematypens="http://relaxng.org/ns/structure/1.0"?>
<?xml-model href="http://docbook.org/xml/5.0/rng/docbook.rng" type="application/xml" schematypens="http://purl.oclc.org/dsdl/schematron"?>
Ou bien rajoutez les deux lignes manquantes si vous n'avez que :
<?xml version="1.0" encoding="UTF-8"?>
Vérifiez que la balise article ne contient plus d'attribut de type DOA. Si c'était le cas supprimez la référence pour n'obtenir que :
<article version="5.0" xml:lang="fr">
Placer le curseur sur la balise article, choisir avec un clic sur le bouton de droite le menu « Refactoring », choisir « entourer par », choisir la balise <book>.
Votre article est alors inséré au sein d'un livre.
Ce changement de contexte induit des anomalies temporaires qu'on va corriger simplement par étapes. La situation est la suivante :
<book> <article xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:mml="http://www.w3.org/1998/Math/MathML" version="5.0" xml:lang="fr">
Il faut donc couper tous les attributs de la balise <article> pour les coller dans la balise <book>.
Vous avez maintenant un livre valide mais incomplet car il ne possède ni page de garde ni informations propres au livre.
Il faut impérativement fournir ces informations sinon le livre n'apparait pas convenablement dans les outils de lecture. Deux cas sont possibles à ce stade :
Soit le livre doit contenir plusieurs articles/parties et dans ce cas la solution la plus simple est de copier /coller la balise <info> et son contenu depuis article vers <book> (au dessus de <article> et sous <book>) puis de compléter les informations pour décrire le livre comme indiqué ci-dessous.
Soit le livre ne va contenir qu'un seul article et dans ce cas les informations de l'article doivent être transférées au livre il faut alors couper /coller la balise <info> avec tout son contenu (important) et la placer après la balise <book> et avant la balise <article>. Ce déplacement a pour effet d'introduire une anomalie, en effet l'article n'a plus de titre ! Il suffit soit de copier coller la balise <title> et son contenu après la balise <article> et avant la balise <sect1>, soit d'ajouter une nouvelle balise <title> sous la balise <article> et la remplir le texte désiré.
En copiant ou déplaçant <info> on vient d'attribuer au livre le titre de l'article, vous pouvez bien sûr modifier le titre du livre et de l'article en fonction de vos besoins.
Il est possible de transformer la balise <article> en <chapter> ou de l'entourer avec une balise <part> en utilisant le menu « refactoring » vu plus haut mais nous n'avons pas testé les effets (toutes informations sont les bienvenues), probablement le passage d'un livre de type actes de colloque à un « vrai » livre et très certainement un traitement différent du formattage lors du rendu.
Votre livre n'a toujours pas de couverture, il vous faut rajouter l’image qui servira de couverture à votre livre dans dans le dossier images du dossier media rattaché à votre article. Donnez-lui un nom qui vous permette de l'identifier facilement.
Ajouter ensuite la balise <cover> dans la balise <info> de <book> avec les éléments ci-dessous :
<cover> <mediaobject> <imageobject> <imagedata fileref="https://media.tremplin.ens-lyon.fr/ressources/users/EricLeJan/NoticeBook/images/imageDeCouv.jpg"></imagedata> </imageobject> </mediaobject> </cover>
L'image doit apparaître en mode auteur dans Oxygen.
Vérifier que l'en-tête du fichier XML du livre est bien une en-tête DocBook et pas l'en-tête DOA qui entraine l'utilisation d'une transformation non standard incompatible avec epub3, il faut avoir les trois lignes d'en-tête signalées au premier paragraphe de ce chapître.
<?xml version="1.0" encoding="UTF-8"?> <?xml-model href="http://docbook.org/xml/5.0/rng/docbook.rng" schematypens="http://relaxng.org/ns/structure/1.0"?> <?xml-model href="http://docbook.org/xml/5.0/rng/docbook.rng" type="application/xml" schematypens="http://purl.oclc.org/dsdl/schematron"?>
La balise <book> doit avoir les attributs standards (le mathML est facultatif, vous en avez besoin seulement si vous avec des formules en mathML). Cela donne :
<book xmlns="http://docbook.org/ns/docbook" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:xlink="http://www.w3.org/1999/xlink" version= "5.0" xml:lang="fr">
Vérifiez la présence et le contenu de la balise <info> avec au moins les balises suivantes renseignées :
<cover>
<authorgroup> (auteurs et éditeur)
<pubdate>
<keywordset>
<abstract>
<copyright>
avec au moins les informations décrites plus haut.
Une fois le livre mis en place au format DocBook et tous ses médias associés, il est possible de lui appliquer les transformations de la familles docbook-xsl 1.78.1 intégrées à Oxygen.
Une première transformation, "Docbook pdf", permet de proposer un fichier pdf imprimable ou lisible avec un lecteur pdf sur une tablette ou un ordinateur.
Une deuxième, "Docbook XHTML5", permet de proposer un format purement web du livre en HTML5 qui permet de l'intégrer de différentes façons à d'autres structures web. Les livres produits diffèrent selon qu'on utilise une sortie "paginée" (Chunk) ou pas.
La troisième, "Docbook epub3 (expérimentale)" assure une production de livre numérique standard de 3ème génération, lisible sur toutes les tablettes quelque soit leur OS (pour les tablettes Androïd, Gitden Reader est le plus performant) et lisible sur vos ordinateurs avec un navigateur muni de l'extension adéquate : Lucifox ou epub-reader pour Firefox, Readium pour Chrome, .. ou encore un logiciel dédié comme ibooks (Apple).
Si le livre a été édité en ligne il est nécessaire d'en faire une copie locale dans ce que l'on pourrait considérer comme un atelier de fabrication qui prenne en compte toutes les options choisies pour le projet. Les transformations xhtml et epub3 imposent pour le moment que les fichiers au format pivot docbook soient accessibles localement. Pour la transformation epub3 tous les documents nécessaires pour produire le format epub3 doivent être sur le support local car ils sont empaquetés dans un objet utilisable complètement (sans connexion externe) dans un outil mobile : smartphone tablette, liseuse compatible.
Ce chapitre concerne seulement les situations dans lesquelles le livre a été rédigé ou co-rédigé en ligne, si l'ensemble des documents sont sur le disque local passer au chapitre suivant.
Pour réaliser une copie locale du livre en ligne il est nécessaire de télécharger le fichier DocBook tel qu'il est sauvegardé sur la base de données. D'un point de vue formel lorsqu'on travaille dans le "cloud" l'original se trouve dans le "cloud" et autant de copies que nécessaires sont déployées dans les postes de travail des usagers. Si des modifications sont faites hors ligne il est impératif de les téléverser dès qu'une connexion est possible. Pour réaliser cette opération plusieurs stratégies sont possibles la plus simple consiste a ouvrir avec oXygen le livre dans la base en ligne et de l'enregistrer localement avec oXygen.
Dans le fichier DocBook qui vient d'être téléchargé les liens vers les media pointent tous vers le serveur de medias en ligne or pour transformer un fichier docbook.xml en .epub il faut absolument que les liens vers les media pointent vers des fichiers locaux sur la machine de travail. Faire une copie du fichier original en ajoutant "local" dans son nom afin de ne pas interférer avec la copie originale du fichier qui servira pour la transformation xhtml et pdf.
Une fois la copie réalisée ouvrir le fichier et faire une modification systématique des adresses des fichiers images et liés en modifiant l'adresse http :
https://media.tremplin.ens-lyon.fr/ressources/users/nomuser/nomfichier/
en une adresse interne :
media/
Cette opération est réalisée grâce au menu "rechercher/replacer" appliqué en mode "texte" au fichier à modifier.
Pour terminer il est nécessaire de recopier à côté du fichier DocBook le dossier portant le nom du document et la totalité des sous-dossiers et des fichiers qu'il contient depuis le serveur où il est déposé. Dans le cadre du projet "Tremplin" ce serveur est mediaserv.climatetmeteo.fr. Il n'est malheureusement pas possible d'exporter directement un répertoire entier en l'ouvrant dans oXygen, utiliser votre outil de ftp securisé (cyberduck par exemple) pour réaliser cette opération, pour les plus aguerris il est toutefois possible d'utiliser l'ordinateur local comme source de données (voir "Production de ressources dans un espace collaboratif sécurisé". On renomme ce dossier local "media". Cette opération est nécessaire pour pouvoir produire le livre au format epub3.
La copie à l'identique de l'original se trouvant dans la base va permettre de produire le fichier XHTML unique ou une série de fichiers XHTML qui pourront être affichés dans les sites web en utilisant les outils du projets connectés aux bases de données. Pour éviter des problèmes de pertes de données le fichier local doit porter le même nom que le fichier de la base de données. une autre sauvegarde doit être effectuée en ajoutant "Local" à la fin de la partie principale du nom avant l'extension ".xml".
La version actuelle d'oxygen ne propose par défaut que les transformations xhtml-1 mais les transformations xhtml-5 sont disponibles, il suffit de les activer.
C'est ce que nous allons faire pour les transformations docbook XHTML et docbook XHTML-chunk.
Avant de les activer il est nécessaire de remplacer un fichier de l'installation par défaut (à l'endroit où le logiciel oXygen a été installé); le fichier /frameworks/docbook/xsl/xhtml5/html5-element-mods.xsl doit être remplacé par celui qui se trouve sur le site des sources et au bout de ce lien la version fournie lors de l'installation standard provoque une anomalie bénigne mais bloquante qui a été soumise aux développeurs de docbook-xsl et qui sera traitée dans la prochaine version.
Une fois que le remplacement est fait, par prudence redémarrez oXygen, puis ouvrez avec oXygen le fichier DocBooklocal.xml.
Cliquer sur le bouton permettant de créer une nouvelle transformation choisir le groupe DocBook5 et cliquer sur la ligne DocBook XHTML (respectivement DocBook XHTML - Chunk), cliquer sur dupliquer (ou reproduire).
Une nouvelle fenêtre popup apparait, changer le nom en "DocBok XHTML5" (respectivement "DocBok XHTML5 - Chunk") modifier la fin de l'URL de la XSL en remplaçant à partir de "/xhtml" par "/xhtml5/docbook.xsl" (respectivement par "/xhtml5/chunk.xsl"). Cela doit conduire au paramétrage illustré dans la figure ci-dessous. Veiller à bien préparer les deux transformations "DocBok XHTML5" et "DocBok XHTML5 - Chunk".
Lors de la production des livres et des fichiers xhtml5, il reste a modifier encore quelques éléments pour respecter les choix éditoriaux qui dépassent le formattage "standard". Le projet dispose pour ce faire de transformations qu'on appelle par convention "Cleaner".
Chacune s'applique à un format de production :
epub3 : utilisation du fichier "epub3Cleaner.xsl"
xhtml5 : utilisation du fichier "xhtmlCleaner.xsl"
xhtml5-chunk : utilisation du fichier "xhtmlChunksCleaner.xsl"
Télécharger depuis le site des sources les trois fichiers de transformation associés au projet tremplin : "xhtmlCleaner.xsl", "xhtmlChunksCleaner.xsl" et "epub3Cleaner.xsl" et les déposer à côté du fichier DocBook.
Vous pouvez aussi les télécharger en suivant ce lien et ce lien ci et ce dernier ce lien (versions pas forcément à jour). Le répertoire contenant les copies doit se présenter comme celui de la figure ci-dessous.
Pour installer les trois transformations commencez par cliquer sur le bouton permettant de créer une nouvelle transformation puis utilisez le bouton .
Ensuite choisissez l'option "XML transformation with XSLT"
La fenêtre de popup qui apparait va vous permettre de créer la transformation et de régler les paramètres de transformation si nécessaire.
Nommez la transformation "xhtmlCleaner".
Il faut utiliser l'icone " " de la ligne "xsl URL" et aller jusqu'au dossier illustré ici. La sélection du fichier permet la mise en place du lien dans le champ.
Choisissez ensuite dans le champ "transformer" l'option Saxon-EE 9.6.0.3
Il faut maintenant choisir les paramètres dont un essentiel, celui qui relie la transformation au fichier .xml qui sert de source à cette transformation.
Cochez les paramètres dont vous voulez qu'ils s'appliquent lors de la transformation.
Dans les champs valeur il faut, lorsque vous voulez utiliser les options audio et video sélectioner le champ l'éditer et lui ajouter un 1 (laisser le champ vide pour ne pas effectuer le rajout de table des matières dédiées).
Pour le paramètre db-file il faut inscrire le nom du fichier qui a subi la transformation (nomdubook.xml) et qui est dans le même répertoire que la xsl.
Cliquez sur "accepter" puis enregistrer pour quitter la fenêtre de création de transformation.
Veiller à préparer les deux autres types de transformation "xhtmlChunksCleaner" et "epub3Cleaner", pour cela il suffit de reprendre pour chacune les étapes que vous venez de franchir en utilisant les fichiers téléchargés plus haut, les paramètres sont identiques dans les trois transformations.
Nous pouvons maintenant passer à la production Cross Media.
La transformation pdf pour le moment ne propose aucun paramètre particulier et c'est donc la plus simple à réaliser. Le fichier pdf est produit directement depuis oXygen, cliquer sur le bouton permettant de créer une nouvelle transformation choisir le groupe DocBook5 et cocher la case à gauche de la ligne DocBook PDF. Sauvegarder puis lancer la transformation en cliquant sur le bouton . Un dossier "out" est créé s'il n'existe pas déjà, dans ce dossier est créé un dossier pdf qui contient le fichier résultant de la transformation au format pdf.
Deux transformations sont possibles, l'une conduit à un fichier xhtml unique l'autre fournit un ensemble de fichiers liés proposant une structuration en "pages par chapitre". Dans le premier cas on obtient un seul fichier avec l'extension xhtml qui porte le nom du fichier DocBook, dans le second cas on obtient une série de fichiers comprenant au moins un fichier "index.html" et une série de fichiers avec une extension xhtml dont les noms sont générés automatiquement à partir du numéro d'ordre de la partie, du chapitre, de la section par exemple la section 1 du chapitre 2 s'appellera ch02s01.xhtml.
Ouvrir le fichier DocBook, cliquer sur le bouton permettant de créer une nouvelle transformation , décocher tout autre transformation qui serait enclenchée pour éviter qu'elle se reproduise, choisir le groupe Global et cocher la case à gauche de la ligne "DocBook XHTML5" qui a été créé au chapitre précédent. Sauvegarder puis lancer la transformation en cliquant sur le bouton . Un dossier "out" est créé s'il n'existe pas déjà, dans ce dossier est créé un dossier "xhtml" qui contient le fichier résultant de la transformation au format xhtml, et un fichier docbook.css qui propose une CSS sommaire pour l'affichage du fichier produit.
Par défaut une fenêtre de navigateur s'ouvre aussi pour afficher le résultat ce qui confirme que la transformation s'est bien passée. Une vérification vous permet de voir qu'une partie des informations a probablement disparu en particulier pour ce qui concerne les droits sur les média. Cette situation s'explique par un certain nombre de choix effectués par l'équipe proposant les transformations docbbok-xsl, une demande de modification a été faite mais pour le moment est sans suite.
Afin de récupérer les informations non affichées nous allons appliquer une nouvelle transformation qui prend en compte un certain nombre de règles fixées par le projet et qui affiche les informations sur les droits. S'il est besoin de modifier les choix éditoriaux faits pour tremplin il suffit de modifier le fichier xhtmlCleaner qui a été installé dans le chapitre précédent .
Ouvrir le fichier xhtml du dossier out/xhtml, ce fichier apparait sous une forme peu lisible, ne vous en préoccupez pas nous allons le reformatter.
Cliquer sur le bouton permettant de régler une nouvelle transformation , décocher tout autre transformation qui serait enclenchée pour éviter qu'elle se reproduise, choisir le groupe Global et cocher la case à gauche de la ligne de la transformation "xhtmlCleaner" qui a été créé au chapitre précédent. Sauvegarder puis lancer la transformation en cliquant sur le bouton .
La transformation s'effectue au sein d'oXygen et le résultat apparait dans la fenêtre inférieure d'oXygen. Cliquer dans cette fenêtre sélectionner la totalité de son contenu en appuyant simultanément sur les touches <Ctl><A> puis copier le contenu en appuyant simultanément sur les touches <Ctl><C>, cliquer dans la fenêtre contenant le fichier xhtml, sélectionner la totalité de son contenu en appuyant simultanément sur les touches <Ctl><A> et enfin coller le contenu en appuyant simultanément sur les touches <Ctl><V>.
Sur MacOS remplacer les <ctrl> par <cmd>
Il est possible maintenant de changer la CSS utilisée en remplaçant le nom du fichier utilisé dans l'en-tête (<head>) par exemple une des propositions disponible sur le serveur de media:
<link rel="stylesheet" type="text/css" href="https://media.tremplin.ens-lyon.fr/ressources/css/eric/docbook.css"/>
Pour être totalement compatible avec la version la plus stricte on peut rajouter sous la première ligne une ligne contenant simplement :
<!DOCTYPE html>
Vous pouvez maintenant sauvegarder le fichier xhtml et le déposer en ligne dans la collection db/data-xhtml/acces à l'intérieur d'un répertoire portant le nom de votre livre.
Ouvrir le fichier DocBook, cliquer sur le bouton permettant de créer une nouvelle transformation , décocher tout autre transformation qui serait enclenchée pour éviter qu'elle se reproduise, choisir le groupe Global et cocher la case à gauche de la ligne "DocBook XHTML5 - Chunk" qui a été créé au chapitre précédent. Sauvegarder puis lancer la transformation en cliquant sur le bouton .
Un dossier "out" est créé s'il n'existe pas déjà, dans ce dossier est créé un dossier "xhtml-chunks" qui contient une famille de fichiers résultant de la transformation au format xhtml, et un fichier docbook.css qui propose une CSS sommaire pour l'affichage du fichier produit. Il y a au moins un fichier index.xhtml qui correspond à la première page du livre et ensuite une suite de fichiers correspondant chacun à une "page" du livre.
Il ne s'agit pas de pages au sens livre imprimé mais de "pages web" contenant chacune seulement un chapitre ou un sous-chapitre. Par défaut une fenêtre de navigateur s'ouvre aussi pour afficher le résultat ce qui confirme que la transformation s'est bien passée. Une vérification vous permet de voir d'une part qu'une structure complexe en pages a été produite et d'autre part que comme pour le chapitre précédent qu'une partie des informations a probablement disparu en particulier pour ce qui concerne les droits sur les média pour les raisons déjà citées.
Afin de récupérer les informations non affichées nous allons appliquer à chaque fichier xhtml la transformation spécifique, "xhtmlChunkCleaner" crée au chapitre précédent qui prend en compte les mêmes règles fixées par le projet.
Ouvrir tous les fichiers xhtml du dossier out/xhtml-chunk correspondant à cette transformation (ne pas retoucher le fichier précédent qui est correct), chaque fichier apparait sous une forme plus ou moins lisible, ne vous en préoccupez pas nous allons les reformatter.
Pour chaque fichier xhtml , cliquer sur le bouton permettant de sélectionner une nouvelle transformation , décocher tout autre transformation qui serait enclenchée pour éviter qu'elle se reproduise, choisir le groupe Global et cocher la case à gauche de la ligne de la transformation "xhtmlCleaner" qui a été créée au chapitre précédent. Sauvegarder puis lancer la transformation en cliquant sur le bouton .
La transformation s'effectue au sein d'oXygen et le résultat apparait dans la fenêtre inférieure d'oXygen. Cliquer dans cette fenêtre sélectionner la totalité de son contenu en appuyant simultanément sur les touches <Ctl><A> puis copier le contenu en appuyant simultanément sur les touches <Ctl><C>, cliquer dans la fenêtre contenant le fichier xhtml, sélectionner la totalité de son contenu en appuyant simultanément sur les touches <Ctl><A> et enfin coller le contenu en appuyant simultanément sur les touches <Ctl><V>.
Sur MacOS remplacer les <ctrl> par <cmd>
Il est possible maintenant de changer la CSS utilisée en remplaçant le nom du fichier utilisé dans l'en-tête (<head>) par exemple une des propositions disponible sur le serveur de media:
<link rel="stylesheet" type="text/css" href="https://media.tremplin.ens-lyon.fr/ressources/css/eric/docbook.css"/>
Pour être totalement compatible avec la version la plus stricte on peut rajouter sous la première ligne une ligne contenant simplement :
<!DOCTYPE html>
Vous pouvez maintenant sauvegarder les fichier xhtml et les déposer en ligne dans la collection db/data-xhtml/acces à l'intérieur d'un répertoire portant le nom de votre livre. Ces fichiers se placent à coté du fichier issu de la transformation xhtmlCleaner.
Ouvrir le fichier DccBookLocal et vérifier en mode auteur que tous les médias sont liés localement au répertoire media.
ATTENTION, comme indiqué au chapitre 2.2, la transformation en epub est extrêmement stricte et IMPOSE que tous les media soient disponibles localement. Si besoin il sera possible de modifier cela une fois que la transformation sera effectuée.
Pour des raisons pratiques nous recommandons de travailler dans un dossier spécial qui contienne le fichier XML du livre chargé dans oXygen et le dossier media qui lui correspond.
Cliquer sur la clé avec triangle rouge, on obtient un popup dont l'illustration ci-dessous révèle le contenu :
Cocher la case configurer les scénarios de transformation DocBook epub 3 (expérimental). Veiller à bien choisir la transformation du groupe DocBook 5 si plusieurs groupes de transformation vous sont proposés.
Cliquer sur le bouton « enregistrer et fermer » puis cliquer sur le triangle rouge à côté de la clé pour exécuter la transformation.
Oxygen crée dans le dossier où se trouve le xml du livre un dossier « out » contenant :
un dossier epub3
un dossier temp
un fichier mimetype
La transformation standard est terminée on va maintenant pouvoir utiliser le fichier avec l'extension .epub qui vient d'être créé.
Dans le dossier "epub" on retrouve le fichier au format .epub, tous les fichiers temporaires qui ont servi à le construire ainsi qu'un dossier media qui ne contient que les images ou les videos. Il faudra donc compléter/remplacer ce dossier par l'original afin de conserver tous les medias reliés aux pages du livre produit.
On peut vérifier à ce stade que l'ensemble des fichiers XHTML nécessaires à la bonne présentation du livre sont présents. S'il manque le fichier de couverture, le fichier d'index ou le fichier de la table des matières c'est qu'une anomalie s'est produite lors de la transformation et la cause est fort probablement une anomalie du fichier DocBook initial :
s'il existe des messages d'erreur affichés par Oxygen les consulter et les transmettre à l'assistance,
si aucun message d'erreur n'est affiché c'est que le format du document bien que valide et transformable n'est pas conforme aux exigences d'un livre vérifier les prérequis listés dans les chapitres précédents.
Ce travail est à réaliser sur l'ensemble de fichiers produits par la transformation epub et sur le fichier DocBook original. Il peut s'avérer prudent de travailler sur une copie de ce fichier pour conserver un original ce qui évite de refaire la transformation DocBook - epub3 qui peut s'avérer longue pour des livres abondamment illustrés.
La transformation ne traite que les images, les videos de type mp4 et les audio de type mp3. La conséquence est que le dossier media inclus dans le livre au format epub ne contient pas tous les media. Il faut donc dans Oxygen glisser/déposer ou utiliser l'outil ajouter pour déposer dans le dossier media du livre tout ce qui manque en respectant l'arborescence du dossier media original.
XSL est le format des feuilles de style pour transformer les documents XML. On utilise donc une transformation xsl pour mettre en forme les éléments non traités par la transformation. On va utiliser pour faire ce travail le fichier "epubCleaner.xsl" que nous avons installé dans le chapitre précédent.
Attention ce fichier est susceptible d'être modifié au fur et à mesure de l'enrichisssement des livrets que nous produisons il faut vérifier que c'est toujours le dernier produit qui est utilisé. Il est déposé sur le site des sources.
Télechargez le fichier epub3Cleaner.xsl le plus récent et placez - le dans le répertoire qui contient le fichier DocBook qui a subi la transformation epub dans oXygen.
Il faut que ce fichier soit impérativement dans ce même répertoire pour que son exécution produise l'effet attendu sur les fichiers contenus dans le .epub.
Si le fichier est plus récent que celui que vous avez intallé lors d'un autre traitement, faites une nouvelle transformation "epu3Cleaner" l'illustration ci-dessous vous rappelle les réglages XSL URL.
Vous pouvez choisir "global" lors de la création de la transformation "epub3Cleaner" pour la conserver dans oXygen.
N'oubliez pas le réglage des paramètres l'illustration suivante vous rappelle leurs valeurs.
Dans certains livrets .epub nous intégrons du son et des vidéos. Il est possible de disposer dans la table des matières d'un accès direct aux figures contenant ce types de fichier.
Les paramètres permettent cela. Cliquez sur le bouton "paramètres" pour faire aparaître les choix possibles.
Cochez les paramètres dont vous voulez qu'ils s'appliquent lors de la transformation.
Dans les champs valeur il faut, lorsque vous voulez utiliser les options audio et video sélectioner le champ l'éditer et lui ajouter un 1 (laisser le champ vide pour ne pas effectuer le rajout de table des matières dédiées).
Pour le paramètre db-file il faut inscrire le nom du fichier qui a subi la transformation (nomdubook.xml) et qui est dans le même répertoire que la xsl.
L'illustration Figure 3.8, « Le popup de sélection des paramètres »ci-dessus montre le résultat de ces trois actions.
Pour tous les fichiers xhtml du epub ansi que pour le fichier opf lancer la transformation en cliquant sur le bouton . La transformation s'effectue au sein d'oXygen et le résultat apparait dans la fenêtre inférieure d'oXygen.
Cliquer dans cette fenêtre sélectionner la totalité de son contenu en appuyant simultanément sur les touches <Ctl><A> puis copier le contenu en appuyant simultanément sur les touches <Ctl><C>, cliquer dans la fenêtre contenant le fichier xhtml, sélectionner la totalité de son contenu en appuyant simultanément sur les touches <Ctl><A> et enfin coller le contenu en appuyant simultanément sur les touches <Ctl><V>.
Sur MacOS remplacer les <ctrl> par <cmd>
Sauvegarder les fichiers ce qui modifie automatiquement leur version dans le fichier epub.
Une fois l'installation réalisée vous pouvez commencer à utiliser la base des exercices. Il est aussi possible de développer ses prorpes exercices.
L'auteur continue à développement cet outil.