Chapitre 1. Produire un article docbook [db:article] | ||
---|---|---|
Précédent | Suivant |
Ce chapitre s'adresse aux usagers qui n'ont jamais utilisé oXygen pour écrire un articles, les autres peuvent passer directement au chapitre 2.
oXygen est un logiciel qui permet d'écrire des documents en langage xml. Plusieurs formats sont disponibles dans le logiciel mais nous ne nous intéresserons ici qu'au format DocBook version 5. Ce logiciel est un éditeur XML qui associé à des feuilles de style ressemble fortement à un logiciel de traitement de texte mais son usage requiert une plus grande rigueur du fait de la syntaxe assez stricte de XML. Ce tutoriel introductif présente seulement quelques principes de base.La production d'un article vous est proposée dans l'epub que vous pouvez télécharger en suivant ce lien.
Il est possible de façon transparente de travailler en local ou en ligne (à condition de disposer des autorisations d'accès nécessaires).
Créer un dossier par article permet de travailler de façon sûre avec oXygen en ayant réuni au même endroit l'ensemble des éléments de l'article : le texte, les fichiers son, les images, les vidéos, les fichiers externes.
Suivez les étapes décrites ci-dessous.
Créer un dossier «nomdelarticle»
Ce dossier vous permet de ranger tous les fichiers utiles à votre article. Vous pouvez aussi y placer tous les fichiers externes téléchargés.
Créer un fichier «nomdelarticle.xml» sauvegarder dans le dossier
La création se fait dans oXygen (voir plus bas) et l'enregistrement impérativement dans le dossier crée en 1.
Placer la fiche «LOM modèle» dans le dossier
Dézipper la fiche "LOM conversion.xml" qui est une fiche modèle
Créer un sous dossier «media»
Son rôle est de contenir tous les média, par convention pour éviter tout problème de codage des caractères on n'utilise que des caractères non accentués.
Créer les sous-dossiers «images», «video», «fichiers», «audio»
Créer seulement les sous-dossiers qui contiendront effectivement les illustrations que vous utiliserez dans votre article, il est inutile de créer un sous-dossier audio s'il n'y a pas d'illustrations sonores dans l'article.
Si vous êtes amenés à changer d'ordinateur pour éditer le même fichier oXygen présente une facilité de travail qui est la manipulation d'archives. Cela permet de déplacer un seul fichier zippé au lieu de l'ensemble complet de la hiérarchie de fichiers. Même si elle est très pratique cette fonctionnalité présente certaines limites, elle ne permet pas de faire au sein de l'archive les transformations présentées au chapitre 3.
Suivez les étapes décrites ci-dessous pour constituer et utiliser une archive :
Zipper le conteneur du fichier .xml et du dossier media.
Ceci fait oXygen vous permettra d'ajouter dans l'archive tout ce dont vous aurez besoin en écrivant votre article, à la sauvegarde l'archive contiendra toutes les modifications et tous les ajouts.
Ouvrir l’archive dans oXygen.
On retrouve la structure "article.xml" media lorsque oXygen affiche le contenu de votre archive dans la vue "Navigateur d'archives" du menu "Fenêtre" élément "Afficher la vue".
Cette étape suppose que vous disposiez des accès aux serveurs :
xml.climatetmeteo.fr : accès à la base exist.
mediaserv.climatetmeteo.fr : accès au serveur de média.
Ces accès vous sont fournis par l'équipe coordinatrice de Tremplin. Cette étape suppose aussi que vous ayez paramétré oXygen pour qu'il travaille dans le Cloud. Ces étapes sont détaillées dans la production NoticeSSHEtCLoud .
Créer dans votre répertoire "PrénomNom" sur mediaserv le répertoire au nom du fichier xml
Vous devez reproduire en ligne la hiérarchie de dossiers qui a été proposée en local pour garder la cohérence de la méthode de production. Comme sur votre disque dur ce dossier vous permet de ranger toutes les medias et fichiers utiles à votre article. On retrouve :
video
images
audio
fichiers
scripts
Créer un fichier «nomarticle.xml» au format DocBook5 article dans le sous répertoire "data" du répertoire "acces"
Pour créer un nouveau fichier dans la base il est nécessaire de le sauvegarder localement puis de l'importer dans la base depuis le menu "explorateur de sources de données" d'oXygen. Il s'affiche depuis l'onglet "Fenêtre"/"Afficher la vue"/"Explorateur de sources de données". Une fois qu'il est déposé fermer le fichier local et ouvrir le fichier directement dans la base.
Ce fichier peut être un article.xml en cours d'écriture ou déjà achevé ou un ancien document au format DocBook. On peut parfaitement un fichier modèle pour éviter de démarrer sur une page vide et avoir des exemples simples de construction.
Créer une nouvelle fiche LOM_nomarticle.xml dans le répertoire "acces" et le sous répertoire "metadata"
Ouvrez une fiche LOM valide avec oXygen puis sauvegardez-la avec le nouveau nom LOM_nomarticle.xml.
Glisser/Déposer ou importer la fiche la fiche sauvegardée sur le serveur distant dans la collection "metadata" de la collection "acces".
Il y a trois façons d’afficher un document écrit en xml dans oXygen, le mode «auteur» le mode «texte» et le mode «grille» :
le mode auteur utilise une feuille de style et propose un affichage voisin de ce qui est fourni par un logiciel de traitement de texte, il permet de mieux visualiser l'organisation de votre article
le mode texte affiche l'article en langage xml en utilisant explicitement les <balises> servant à structurer le texte il permet de mieux comprendre la structure et avec un peu de savoir faire de rédiger directement en xml en choisissant les <balises> dans le menu éléments qui apparait dans ce mode d'affichage
Le mode grille affiche une vue synoptique de l'article qui permet de vérifier que la construction est conforme à ce qui est souhaité, cette vue est plus compliquée à utiliser et déconseillée aux utilisateurs débutants
oXygen propose une fonctionnalité supplémentaire qui teste si ce qui a été écrit est "valide et bien formé" c'est à dire acceptable ou pas par une base de données reconnaissant le format xml. Il indique par un petit carré rouge en haut à droite de la fenêtre d'édition si le document est correct (carré vert) ou contient des erreurs de structure (carré rouge). Lorsque le carré est rouge une ouplusieurs barettes rouges apparaissent dans l'ascenseur pour indiquer le(s) lieu(x) en erreur. L'erreur est soulignée en rouge par une ligne ondulée et en positionnant le texte sur l'erreur une explication sommaire est fournie pour favoriser la correction.
Corrigez les erreurs pour remettre le petit carré au vert.
Il existe dans la base de données un "article modèle" qui peut servir de base pour construire un nouvel article.
Télécharger puis ouvrir le zip appelé template_article.zip dans oXygen ou directement ouvrir l'article Loremipsum dans la base xml
Regardez la construction de cet article en mode auteur et en mode texte. Il vous présente les éléments les plus courants utilisés dans un article: le texte , la création de section et sous-section, l'insertion d'images, de sons, de vidéos.