Cyber Docs

Cyberdocs Documentation
Universit Lyon 2 - 2009
Table des matires

1. Introduction.....................................................................................................................................3 2. Communaut...................................................................................................................................4 3. Documentation................................................................................................................................4
3.1. Aide linstallation..............................................................................................................................4
3.1.1. Les pr-requis matriels................................................................................................................................4 3.1.2. Les pr-requis logiciels..................................................................................................................................5 3.1.3. Les composants sous-jacents.........................................................................................................................6 3.1.4. Tlcharger Cyberdocs..................................................................................................................................7 3.1.5. Installation tape par tape............................................................................................................................7 3.1.5.1. Le fichier de proprits pcd.properties....................................................................................................8 3.1.5.2. Compilation..........................................................................................................................................11 3.1.5.3. Installation des modules........................................................................................................................12 3.1.5.3.1. Installation du module de conversion.............................................................................................12 3.1.5.3.2. Installation du module de gestion...................................................................................................12 3.1.5.3.3. Installation du module de publication.............................................................................................14 3.1.6. Personnaliser cyberdocs..............................................................................................................................15 3.1.6.1. Crer une nouvelle institution...............................................................................................................15 3.1.6.2. Ajout d'un nouveau code de styles........................................................................................................16 3.1.6.3. Conversion dans une autre langue.........................................................................................................17 3.1.6.4. Les feuilles de styles CSS.....................................................................................................................17 3.1.6.5. Publier d'autres documents...................................................................................................................17 3.1.6.6. Modifier les pages statiques..................................................................................................................18 3.1.6.7. Modifier l'application Web...................................................................................................................18 3.1.6.8. Personnaliser le module de gestion.......................................................................................................19 3.1.6.9. Lier Apache et Tomcat : installer le module JK.....................................................................................19 3.1.6.10. Utiliser une base MySQL....................................................................................................................21 3.1.6.11. Intgrer le module de publication votre site web...............................................................................23 3.1.7. Outils..........................................................................................................................................................23 3.1.7.1. Rindexer tous vos documents..............................................................................................................23 3.1.7.2. Modifier vos mtadonnes en masse.....................................................................................................25
3.2. Aide aux utilisateurs...........................................................................................................................25

3.2.1. Approche technologique..............................................................................................................................25 3.2.2. Convertir un document via le module de gestion.........................................................................................26 3.2.2.1. Sidentifier sur Cyberdocs....................................................................................................................27 3.2.2.2. Crer un espace pour une thse............................................................................................................27 3.2.2.3. Procdure de conversion......................................................................................................................28 3.2.2.3.1. Transfert des fichiers styls et des fichiers associs (onglet Gestion de fichiers)............................28 3.2.2.3.2. Saisie des mtadonnes (onglet Mtadonnes)..............................................................................30 3.2.2.3.3. Conversion (onglet Traitements)...................................................................................................32 3.2.2.3.4. Vrification du rsultat de la conversion........................................................................................36 3.2.3. Convertir un document sans le module de gestion : en ligne de commandes................................................39 3.2.3.1. Oprations et tapes de conversion.......................................................................................................39 3.2.3.2. Prparer un espace de travail.................................................................................................................41 3.2.3.3. Prparer un document...........................................................................................................................42 3.2.3.4. Effectuer une conversion......................................................................................................................44 3.2.3.5. Rsultats de la conversion.....................................................................................................................46 3.2.4. Module de publication.................................................................................................................................46 3.2.4.1. La gestion et l'identification des utilisateurs..........................................................................................47
3.2.4.2. La gestion des documents.....................................................................................................................47 3.2.4.3. L'utilisation des mtadonnes du document..........................................................................................49 3.2.4.4. La consultation des documents.............................................................................................................51 3.2.4.5. La recherche.........................................................................................................................................53 3.2.4.6. Les rsultats de recherche.....................................................................................................................53 3.2.4.7. Les versions pour impression................................................................................................................54
3.3. Aide aux dveloppeurs.......................................................................................................................54

3.3.1. Signaler des bogues.....................................................................................................................................54 3.3.2. Contribuer Cyberdocs...............................................................................................................................54
3.4. Tlchargements de Cyberdocs.........................................................................................................54
4. Tlchargement.............................................................................................................................54
4.1. Distributions de Cyberdocs...............................................................................................................55 4.2. Rcuprer les sources avec Subversion.............................................................................................55
5. Listes..............................................................................................................................................56 6. FAQ................................................................................................................................................58 7. Contacts.........................................................................................................................................58
1. Introduction
La plate-forme Cyberdocs offre des outils, mais galement un modle, permettant une institution de publier de la documentation scientifique, par exemple des thses, des rapports, des revues, etc. Deux principes essentiels sont associs la plate-forme : 1. Les logiciels libres : Cyberdocs est une plate-forme libre (licence GPL ) et utilise elle-mme des logiciels libres. Cette approche permet tous de l'utiliser sans contrainte, de l'amliorer, de contribuer son rayonnement, de partager son exprience, de la traduire, de la documenter, etc. Il s'agit donc d'un vritable projet de coopration entre diffrents partenaires, financeurs, dveloppeurs, utilisateurs. 2. Les documents structurs : le modle de publication de Cyberdocs est bas sur des documents structurs avec la norme XML, ce qui comporte plusieurs avantages, notamment d'intressantes possibilits de consultation, un archivage prenne, des changes facilits, etc. Le modle de publication Le modle de publication de Cyberdocs consiste produire un document structur en format XML (DTD TEILite), document qui devient ainsi le document de rfrence qui servira l'archivage et la publication. L'objectif est d'obtenir ce document de rfrence avec le moins d'efforts possibles, en partant des documents tels qu'ils sont produits par les auteurs, soit le plus souvent avec un traitement de texte. Le processus de publication Le processus de publication de la chane Cyberdocs est constitu de ces tapes : 1. Prparation des documents Un oprateur (a pourrait tre l'auteur, un documentaliste, etc.) va prendre un document traitement de texte et le prparer adquatement. Cette prparation consiste utiliser certains styles pour identifier des parties du contenu, s'assurer que les styles Titre 1, Titre 2 sont utiliss pour la table des matires, prparer les dessins vectoriels pour les pixelliser, etc. Mais de plus en plus souvent, ce travail est ralis directement par l'auteur qui utilise les modles de documents proposs par le logiciel de traitement de texte ou par l'institution scientifique au sein de laquelle il travaille. Exemple : le modle de documents Cyberthses. 2. Prparation des mtadonnes Les mtadonnes associes au document doivent tre prpares, ce qui consiste en la cration d'un document XML contenant ces mtadonnes. 3. Conversion vers XML Le module de conversion de la plate-forme Cyberdocs permet de convertir le document traitement de texte pralablement prpar en un document XML respectant la DTD TEILite. Le module de gestion de la plate-forme Cyberdocs permet de piloter la plupart de ces oprations l'aide d'une interface Web trs facile utiliser. 4. Production des fichiers pour la publication statique Si ncessaire, des versions HTML, XHTML et PDF sont produites (depuis le format XML) afin de permettre une diffusion statique des documents, sur un rseau ou sur un cdrom par exemple. 5. Publication Le module de publication permet de rendre disponible les documents, avec une consultation aise et exploitant la structure des documents, de mme que des recherches
3 Service Gnral de la Recherche et des coles Doctorales - Universit Lumire Lyon 2 Fvrier 2009
documentaires prcises l'intrieur d'un document ou dans une collection de documents publis.
2. Communaut
Cyberdocs a pu voir le jour grce au soutien de lAgence Intergouvernementale de la Francophonie et son programme Cyberthses, par lintermdiaire du Fonds Francophone des Inforoutes. Cette plate forme de conversion, place sous licence GPL, a t ralise avec laide de la socit AJLSM, et est diffuse en Afrique, dans lAmrique du Sud, en Suisse et en France. Aujourd'hui, la plateforme est principalement maintenue travers le projet Cyberthses, dont les acteurs majeurs sont notamment l'unversit Lumire Lyon 2, l'universit de Santiago du Chili, les universits du Prou et la socit Silecs.
3. Documentation
3.1. Aide linstallation
La plate-forme Cyberdocs permet de diffuser des documents numriques dans un environnement Internet. Elle offre des services de conversion et de publication de ces documents numriques. Diffrents publics sont concerns par la plate-forme et donc par cette documentation. On distingue notamment : les utilisateurs, pour qui le module de publication, avec ses fonctionnalits d'affichage et de recherche constitue l'lment le plus important les responsables de la prparation et de la publication des documents, qui piloteront la conversion puis la publication des documents numriques les implmenteurs, c'est--dire les personnes qui seront amenes installer, dployer, exploiter une plate-forme Cyberdocs, mais galement la personnaliser, voire l'adapter les dveloppeurs, qui ajouteront de nouvelles fonctionnalits la plate-forme ou qui corrigeront les erreurs
La plate-forme Cyberdocs se dcoupe en trois grands modules : le module de conversion : il permet de transformer des documents traitement de texte en format XML selon la DTD TEILite. le module de gestion : il permet de piloter, via une interface web, les conversions et la publication des documents. le module de publication : il permet de diffuser, dans une architecture Web dynamique, des documents, avec des fonctions de recherche et de consultation.
Linstallation du module de gestion require au moins linstallation du module de conversion. Mais vous ntes pas oblig dutiliser le module de gestion pour faire fonctionner le module de conversion en ligne de commande. En ce qui concerne les modules de publication et de conversion, ils sont indpendants.
3.1.1. Les pr-requis matriels

Les informations donnes dans cette page concernent d'abord et avant tout les outils serveurs de la plate-forme, c'est--dire ce qui est ncessaire pour excuter les conversions, installer l'outil de recherche, etc. Les postes clients n'ont besoin que d'un navigateur Web rcent, qui supporte les normes HTML, CSS et Javascript, tel Internet Explorer, Mozilla, Opera, etc.
Le matriel informatique peut tre trs vari, ses caractristiques prcises dpendent en grande partie de la charge de travail que vous prvoyez ainsi que des modules que vous souhaitez installer. L'espace disque requis sera d'environ 200 Mo pour une installation complte, incluant PHP, SDX et Java. Les outils Cyberdocs eux-mmes prennent relativement peu de place, environ 20 Mo. Bien entendu, l'espace disque pour stocker les documents convertis n'est pas compt ici, et ce sujet il faut prvoir environ 10 fois la taille du document original, mme si ce chiffre peut varier en fonction du nombre de ressources externes telles que les images. Cet espace disque est ncessaire parce que les outils de conversion produisent beaucoup de documents : Une version XML / TEI Lite du document Deux versions XHTML statiques du document : une pour la consultation statique hors de tout contexte, et une autre pour la fonction d'impression dans l'application Web dynamique Deux versions HTML statiques du document : une pour la consultation statique hors de tout contexte, et une autre pour la fonction d'impression dans l'application Web dynamique, ces versions HTML tant destines principalement au navigateur Web Internet Explorer. Une version PDF du document, avec un fichier PDF pour le document au complet et un fichier par partie de document Trois versions XML intermdiaires du document, produites lors de l'excution des outils de conversion
Seul le document XML de rfrence en format TEI Lite est rellement ncessaire, tous les autres sont des produits drivs qui peuvent tre conservs ou non ; noter qu'il est mme possible de ne pas les faire gnrer par les outils. Si vous ne conservez pas tous les documents, l'espace disque requis diminue galement. On doit galement mentionner que si vous utilisez l'environnement Web dynamique bas sur SDX pour diffuser les documents, vous devez compter environ 2,5 fois la taille des documents dans leur version TEI Lite en terme d'espace disque. En effet, SDX doit conserver une copie du document en entier, ainsi que chacune des parties. La taille des index pour la recherche est variable, mais on peut l'estimer environ 50% de la taille des documents en format XML TEI Lite. La quantit de mmoire vive (RAM) sur le serveur est un facteur critique. Le module de conversion utilise de la mmoire de manire proportionnelle la taille des documents qu'il doit traiter, de mme qu'au nombre d'images comprises dans ces documents. Une rgle simple pour valuer le besoin en mmoire est de prvoir 50Mo au dpart, et ajouter 1,25Mo par page du document. Ainsi, pour un document de 500 pages, il peut tre ncessaire d'avoir prs de 700Mo de mmoire pour le traiter, mme si trs souvent une quantit moins grande sera suffisante. De son ct, la mmoire utilise par le module de publication dpend largement du nombre d'utilisateurs simultans que l'on souhaite servir. Pour une application telle Cyberdocs, une mmoire de 2Go 4Go sera en gnral confortable. La puissance de l'unit de traitement (CPU) n'est pas un facteur critique, sachant que plus le processeur est rapide, plus rapides seront les conversions, mais galement les recherches et l'affichage dans le module de publication.
3.1.2. Les pr-requis logiciels

Les diffrents modules de la plate-forme Cyberdocs ont t conus de manire tre le plus portables possibles. Toutefois, ils font appel des technologies diffrentes, d'o une certaine variation dans les spcifications des systmes o on peut installer chaque module. Il est important de mentionner que dans cette page et toute la documentation en gnral, le nom Windows fait rfrence aux versions Serveur, XP ou Vista de Windows. En particulier, cela exclut les versions 95, 98 ou Millenium ; certains outils pourront y tre installs, mais ces
systmes d'exploitation ne sont pas conus pour ce genre d'oprations et il peut tre difficile de s'en sortir. Une chose est certaine, les procdures ne sont pas documentes ici. 1) Le module de conversion Le module de conversion fait appel diffrentes technologies : Java pour piloter les conversions qui sont pour la plupart effectues l'aide du langage XSLT
2) Le module de gestion Le module de gestion est une interface Web dveloppe avec le langage PHP 5. On peut donc l'installer sur toute plate-forme supportant un tel environnement, ce qui ouvre beaucoup de possibilits. A noter un excellent support PHP sur les systmes Linux et UNIX, mais aussi sous Windows. 3) Le module de publication Le module de publication est une application Web dynamique dveloppe l'aide de la plateforme SDX, elle-mme conue sur l'infrastructure Cocoon. Il s'agit en quelque sorte d'une application Web dynamique selon l'API des Java Servlets. Pour l'hberger, il faut donc un systme qui peut accueillir une machine virtuelle Java, et une telle machine virtuelle existe pour tous les systmes d'exploitation rcents, de Mac OSX Windows en passant par Linux et de nombreux UNIX.
3.1.3. Les composants sous-jacents

En fonction des modules Cyberdocs installer, vous devrez d'abord prvoir l'installation de composantes sous-jacentes, ncessaires pour utiliser les fonctions Cyberdocs. Ces composantes sont : Java, un serveur Web, PHP, un moteur de servlets et SDX. 1) Java Une machine virtuelle Java est ncessaire pour les modules de conversion et de publication. Elle est mme ncessaire pour procder l'installation de ces modules, c'est pourquoi il s'agit en gnral de la premire installation faire. Les modules Cyberdocs fonctionnent avec Java 1.4, mais si vous procdez une nouvelle installation, nous vous conseillons fortement d'utiliser la dernire version de Java, la 1.6. Ci-dessous, vous trouverez des liens vers les distributions Java pour les plates-formes les plus populaires. A noter que vous devriez utiliser un Java Development Kit (JDK), et non un Java Runtime Environment (JRE). Distribution de rfrence de Sun (pour Windows, Linux et Solaris) HP-UX (UNIX pour les stations Hewlett-Packard) IBM (pour AIX, Windows, Linux, OS/2, z/OS) Apple (pour Mac OS X) Ces distributions sont en gnral trs faciles installer, vous n'avez qu' suivre les instructions fournies ou consulter leur documentation. L'installation de Java devrait prendre environ 40Mo. Important Une fois Java install, vous devez manuellement dfinir une variable d'environnement nomme JAVA_HOME, et lui donner comme valeur le chemin o vous avez install Java. Sur UNIX ou Linux, vous pouvez dfinir cette valeur dans l'un des scripts de dmarrage situs dans le rpertoire maison de l'utilisateur utilis par Java (par exemple dans le fichier .bashrc). Sur Windows, vous pouvez le faire en ouvrant le panneau de contrle Systme et en choisissant l'onglet Avance, o vous trouverez un bouton qui vous permet de dfinir des variables d'environnement.
2) Serveur Web Un serveur Web est ncessaire pour utiliser les modules de publication et de gestion de Cyberdocs. A noter que si vous souhaitez seulement utiliser le module de publication pour des dmonstrations ou des tests, vous pouvez viter cette installation et passer directement l'installation du moteur de servlets. Mais pour un site de production, ou encore pour installer le module de gestion, nous vous encourageons fortement installer le serveur Web Apache. Sur certains systmes (Linux, UNIX) ce serveur est probablement dj install ; sinon aller au site de tlchargement et prendre la version qui convient votre environnement. La documentation d'Apache est trs complte, incluant une section sur la compilation et l'installation, mais aussi sur la configuration. Si vous souhaitez utiliser le module de gestion, le module Rewrite (ou quivalent) doit tre install et activ pour votre serveur web. 3) PHP L'environnement de script PHP doit tre install pour utiliser le module de gestion de Cyberdocs. PHP s'appuie sur un serveur Web, le plus souvent Apache, qui doit donc aussi tre install. A noter que trs souvent le support PHP est dj prvu par Apache, et que la version 5.x de PHP est requise. Le site principal de PHP vous fournira toute l'information ncessaire sur cet outil. Il existe une page spcifique pour les tlchargements. Important : Pour une question de gestion de processus, le module de gestion ncessite que PHP soit install en tant que module du serveur web et non en CGI (Common Gateway Interface). Reportez-vous la documentation dinstallation de php. 4) Moteur de servlets Le moteur de servlets est un environnement d'excution de sites Web dynamiques crits en langage Java. Le module de publication a besoin d'un tel environnement pour fonctionner. Tomcat de la fondation Apache est le moteur de servlets le plus utilis. Vous pouvez le tlcharger et l'installer aisment, si vous avez pralablement install une machine virtuelle Java. Tomcat inclut son propre serveur Web, qui est en gnral suffisant pour des tests ou des dmonstrations, ce qui vite l'installation du serveur Web. Si toutefois vous souhaitez utiliser Tomcat avec le serveur Web Apache, vous devrez installer et configurer le module JK pour faire le lien entre les deux outils. Afin de simplifier son installation, nous vous proposons un rapide guide dinstallation pour Linux. 5) SDX La plate-forme SDX est un outil de recherche et de consultation de documents XML. Elle est utilise comme outil de base pour le module de publication Cyberdocs. La version 2.3 ou suprieure est ncessaire. Vous pouvez tlcharger SDX et ses sources, mais si vous cherchez simplement l'installer rapidement nous vous conseillons d'utiliser le fichier sdx.war et de le placer dans le dossier webapps du moteur de servlets. Une fois votre moteur redmarr, le fichier WAR sera dcompress et SDX sera disponible.
3.1.4. Tlcharger Cyberdocs

Retrouvez toutes les instructions la page Tlchargements .
3.1.5. Installation tape par tape

Lorsqu'on tlcharge la plate-forme Cyberdocs, il est ncessaire de faire un certain nombre d'oprations avant de pouvoir l'utiliser ; dans cette documentation, nous allons appeler ces oprations le processus d'installation de la plate-forme.
Il est important de raliser que ce processus d'installation ne concerne que les oprations spcifiques la plate-forme Cyberdocs. Pour l'installation des composantes sous-jacentes (serveur Web, PHP, moteur de servlets, SDX, Java), vous devez suivre les instructions fournies avec ces outils. Dans la page sur le tlchargement des composantes, vous trouverez des liens vers les sites Web des outils qui vous permettront de raliser votre installation. Le processus d'installation comporte essentiellement deux types d'opration : la modification de fichiers de proprits et l'excution de diffrents scripts, en fonctions des modules installer. Afin de ne rien oublier, veuillez respecter lordre suivant : Modification du fichier pcd-properties Compilation Installation des modules
3.1.5.1. pcd.properties
Le
fichier
de
proprits
Dans le dossier racine des sources Cyberdocs se trouve un fichier nomm pcd.properties. Ce fichier contient quelques informations qui permettent de dterminer les paramtres d'installation de la plate-forme. Il est essentiel de comprendre ces paramtres et de leur donner des valeurs appropries pour votre environnement. Le format de ce fichier est le format de proprits standard de l'environnement Java. Il s'agit d'un fichier texte, et pour tre certain qu'il soit correctement interprt dans tous les environnements Java, il ne contient que des caractres de l'ASCII. Les lignes qui commencent par le caractre # sont des commentaires, elles sont donc ignores ; vous pouvez en ajouter si vous le jugez ncessaire. Idem pour les lignes blanches, elles n'ont aucune signification sinon que de rendre le fichier plus lisible. Enfin, les lignes significatives sont celles o l'on retrouve le nom d'une proprit, suivi d'un caractre =, suivi de sa valeur. Il est important de prciser que vous pouvez dfinir ces proprits ailleurs que dans le fichier pcd.properites. En effet, afin de faciliter les mises jour, il est conseill de ne pas toucher ce fichier, mais plutt placer les proprits dans l'un ou l'autre de ces fichiers :
Un fichier nomm pcd.properties situ dans le rpertoire maison de l'utilisateur qui effectue l'installation. Un fichier nomm .ant.properties situ dans le rpertoire maison de l'utilisateur qui effectue l'installation. Un fichier nomm .ant.properties situ dans le rpertoire racine des sources Cyberdocs qui serviront l'installation.
Ces diffrents fichiers de proprits sont lus dans cet ordre, et la premire fois qu'une proprit est dfinie, elle conserve sa valeur jusqu' la fin du processus. Le dernier fichier lu est le fichier pcd.properties situ la racine du rpertoire des sources Cyberdocs, et les valeurs proprits qu'on y trouve constituent donc des valeurs par dfaut. Aprs installation, le fichier outils/bin/pcd.properties pcd.properties se trouve lemplacement suivant :
1. Le dossier d'installation des outils de conversion La proprit dossier.installation.up permet de dfinir l'emplacement du rpertoire d'installation du module de conversion. A noter que ce rpertoire devient galement le rpertoire de travail o les documents sont convertis. La valeur de cette proprit est un chemin qui peut tre soit absolu (par exemple /usr/local/ cyberdocs/pcd-install ou C:/programmes/cyberdocs/pcd-install) ou relatif (par exemple
../../pcd-install). S'il est relatif, la rsolution du chemin se fait par rapport la racine des sources Cyberdocs. Prcisons galement que mme sous Windows, il est conseill d'utiliser le caractre / pour sparer les rpertoires dans un chemin ; sinon, vous devez doubler les sparateurs : \\. La valeur par dfaut est ../pcd-install, le rpertoire de travail sera donc le dossier pcdinstall situ dans la hirarchie de votre poste de travail au mme niveau que le rpertoire contenant l'ensemble des sources de la plate-forme. Si vous ne prvoyez pas d'utiliser ni le module de conversion ni le module de gestion de Cyberdocs, cette proprit est bien entendue inutile. 2. Le dossier d'installation et la version d'OpenOffice Note importante : contrairement aux anciennes versions de Cyberdocs, OpenOffice nest plus utilis par dfaut pour convertir les fichiers DOC et ceci pour des raisons de stabilit. Vous pouvez ignorer ce paramtre. 3. Le style utilise par dfaut lors la conversion Il sagit de lidentifiant des styles utiliss par dfaut lors de la conversion. La liste des styles et des codes se trouvent dans le fichier : src/oo-vers-tei/xslt/utiles/styles.xml. Au moment de linstallation, ce fichier est disponible ici : outils/xslt/utiles/styles.xml. Reportez-vous la partie liste des styles supports par Cyberdocs pour plus dinformation. La valeur par dfaut lyon2 est fonctionnelle pour effectuer des tests. 4. Le chemin du module de publication sous SDX Le module de publication de Cyberdocs utilise SDX comme infrastructure de site Web dynamique ; une fois install, ce module devient donc une application SDX. Chaque application SDX doit tre installe dans un dossier situ immdiatement dans le dossier d'installation de SDX lui-mme. La proprit sdx.application.path indique le nom de ce dossier. Par dfaut, c'est la valeur pcd qui est utilise. Cette proprit ne concerne que les installations o il est prvu d'utiliser le module de publication. 5. Informations complmentaires pour SDX Pour les proprits sdx.logicsheet.path, cocoon.class.cinclude et cocoon.class.wildcard, reportez-vous aux commentaires du fichier pcd.properties fourni par dfaut, car ces proprits sont amenes voluer trs rapidement. 6. L'habillage de l'interface de consultation Le module de publication peut avoir diffrents habillages pour la consultation des documents sur le Web. La proprit habillage permet de spcifier lequel choisir. La valeur donne cette proprit doit correspondre au nom d'un dossier qui se trouve dans le dossier src/web/habillages partir de la racine des sources servant l'installation. Dans la distribution normale de Cyberdocs, seul l'habillage pcd est propos. Si vous tlchargez les sources, vous aurez galement l'occasion d'utiliser l'habillage cybertheses, mais celui-ci devrait tre rserv un usage spcifique au projet Cyberthses. Cette proprit ne concerne que les installations o il est prvu d'utiliser le module de publication.
7. L'identifiant du module de publication sous SDX La plate-forme SDX offre un ventail de fonctionnalits dont certaines peuvent tre distribues sur diffrents serveurs ou diffrentes applications. C'est pourquoi toutes les applications sous SDX doivent avoir un identifiant, et les responsables des applications doivent faire en sorte que cet identifiant soit unique parmi toutes les applications SDX existantes. Un bon moyen d'y arriver est d'utiliser le principe des noms de domaines inverss. Par exemple, si vous pensez installer le module de publication une adresse de type http://www.monsite.org/sdx/pcd/, vous tes normalement responsable du nom de domaine monsite.org. Dans ce cas, vous devriez choisir un identifiant qui commence org.monsite et qui est complt de diffrentes parties spares par un . , et vous tes responsables de faire en sorte que ce complment soit unique parmi les applications SDX qui sont sous la responsabilit de monsite.org. La proprit application.sdx.identifiant contient cette valeur, et il est ncessaire de la modifier afin d'vite que tous utilisent la mme valeur. Cette proprit ne concerne que les installations o il est prvu d'utiliser le module de publication. 8. Le dossier d'installation de SDX Pour installer le module de publication, il est ncessaire de connatre le dossier o la plateforme SDX est installe. La proprit dossier.installation.consultation doit contenir le nom de ce dossier. Cette proprit ne concerne que les installations o il est prvu d'utiliser le module de publication. 9. Ladresse du serveur SDX Spcifiez ici lURL pour accder SDX. Par exemple : http://www.monserveur.fr:8080/sdx. Le port 8080 est ncessaire seulement si vous utilisez Tomcat dans sa configuration par dfaut. Pour une utilisation de Cyberdocs en production, nous vous conseillons dutiliser module JK permettant de lier Apache Tomcat. Cette proprit servira de base au URL des documents disponibles via le module de publication. Modifiez cette valeur par ladresse externe de votre serveur, ne laissez pas localhost sauf pour une utilisation dans le cadre dun test. Cette proprit ne concerne que les installations o il est prvu d'utiliser le module de publication. 10.L'ouverture de l'application de consultation Dans une installation SDX, on peut retrouver un dossier contenant les sources d'une application sans que celle-ci soit rellement visible publiquement. Pour qu'elle le soit, elle doit tre ouverte dans SDX, c'est--dire apte tre utilise. L'installation de la plate-forme Cyberdocs peut effectuer automatiquement cette ouverture, si la proprit sdx.application.open a une valeur 1, ce qui est la valeur par dfaut que nous vous conseillons de garder. Cette proprit ne concerne que les installations o il est prvu d'utiliser le module de publication. 11.Identification des erreurs de conversion Lorsque le module de conversion traite un document traitement de texte, il peut signaler certaines erreurs (style manquant, etc.) propre un certain contexte d'utilisation. Pour l'instant, le seul contexte o de telles erreurs sont dfinies est le projet CyberThses. Ces
erreurs sont signales par des attributs spcifiques dans le document XML en format TEILite, qui ne seront donc pas valide et devra tre modifi. Pour activer l'identification des erreurs, il faut donner la valeur 1 erreurs.cyberdocs. Cette fonctionnalit est dsactive pour toute autre valeur. 12.Les paramtres OAI La plate-forme Cyberdocs permet de rendre disponibles des mtadonnes associes aux documents via le protocole OAI-PMH. Pour que cette fonctionnalit fonctionne, vous devez utiliser la version 2.2 ou plus rcente de SDX. Pour activer cette fonctionnalit, vous devez modifier trois proprits dans le fichier pcd.properties : entrepot.oai : donner la valeur true pour activer la fonctionnalit OAI. entrepot.oai.nom : le nom de votre entrept OAI, requis par le protocole. admin.oai.email : l'adresse de courrier lectronique de l'administrateur de cet entrept OAI, requis par le protocole. au paramtre
13.Location du binaire php Cette proprit ne concerne que les installations o il est prvu dutiliser le module de gestion. Il sagit du rpertoire o se trouve le binaire de php (l'interface en ligne de commande). Le chemin doit tre absolu. Par exemple : /usr/local/bin. Si vous ne savez pas o trouver le fichier, aidez-vous de la commande : which php Si PHP est actif et que vous ne trouvez pas lexcutable php, essayez dinstaller php-cli ( cli pour Command Line Interface ) avec votre gestionnaire dinstallation habituel. Par exemple pour une Debian ou une Ubuntu : apt-get install php-cli. Avertissement Vrifiez que le binaire porte bien le nom php ou php.exe l'intrieur du rpertoire spcifi. Crez un lien symbolique dans le cas contraire. Votre version de php doit tre suprieure ou gale 4.3 (version 5 conseille). Vous pouvez vrifier l'aide la commande : php --version. 14.Et en suite ? Vrifiez une dernire fois vos proprits, notamment quil ny a pas despace dans les chemins daccs, etc Votre fichier de configuration est maintenant prt : vous pouvez passer aux tapes suivantes (la compilation et linstallation des modules).
3.1.5.2.
Avertissement
Compilation
Cette opration est ncessaire seulement si vous installez depuis les sources obtenues depuis l'entrept CVS de Cyberdocs. Si vous installez depuis la distribution, cette opration a dj t effectue pour vous. Elle peut cependant s'avrer ncessaire si vous utilisez une version de Java antrieur 1.6 (dans ce cas supprimez le rpertoire build la racine des sources). Plusieurs classes Java ont t crites pour le module de conversion, et elles sont ncessaires ds l'installation des outils. Ainsi leur complilation est-elle la premire chose effectuer lors de l'installation de Cyberdocs.
Pour cela, il suffit simplement d'excuter le script build-ant.bat ou build-ant.sh en fonction du systme d'exploitation que vous utilisez. Si la compilation vous renvoie une erreur que vous ne comprenez pas, vrifiez votre fichier pcd.properties et consultez la FAQ. Si la compilation se termine correctement, vous pouvez maintenant passer linstallation des modules.
3.1.5.3.
Installation des modules
Important : avant dinstaller les modules, nous vous rappelons quil est ncessaire davoir lu et respect les pr-requis matriels et logiciels, ainsi que les trois tapes prcdentes de ce manuel dinstallation : tlchargement, configuration du fichier pcd.properties et compilation. Linstallation complte de Cyberdocs se droule en trois tapes : Installation du module de conversion Installation du module de gestion Installation du module de publication Linstallation du module de gestion require au moins linstallation du module de conversion. Mais vous ntes pas oblig dutiliser le module de gestion pour faire fonctionner le module de conversion en ligne de commande. En ce qui concerne les modules de publication et de conversion, ils sont indpendants.
3.1.5.3.1. module de conversion
Installation
du
Cette tape va crer le dossier de production du module de conversion, contenant toutes les sources ncessaires la conversion des documents ainsi que des exemples. Vous pouvez effectuer cette installation en excutant simplement le script installation-oo2xml.bat ou installation-oo2xml.sh. Par la mme occasion, les outils de conversion, de mme que les fichiers du module de gestion, seront copis. Ce script aura pour effet de crer un dossier qui sera le dossier de base des modules de conversion et de gestion. La localisation de ce dossier est prcise dans le fichier pcd.properties. Dans ce dossier, on trouvera trois sous-dossiers : outils : contient les outils du module de conversion, soit les processeurs XSLT ou XSLFO, transformations XSLT, l'environnement ANT et son fichier de directives, etc. php : contient les scripts PHP du module de gestion ainsi que certains binaires pour l'appel au module de conversion. production : constitue le rpertoire de base pour la production des documents l'aide du module de conversion.
3.1.5.3.2. module de gestion
Installation
du
Avertissement : Cette partie ne concerne que les utilisateurs dsirant utiliser le module de gestion en php. Si vous souhaitez utiliser la plate-forme Cyberdocs en ligne de commande, passez cette tape.
Les fichiers du module de gestion sont copis automatiquement lors de linstallation du module de conversion. Si vous ne dsirez pas utiliser le module de gestion, vous pouvez supprimer lintgralit du rpertoire gestion . Avant dutiliser le module de gestion, procder aux vrifications et modifications suivantes : 1. Droits daccs aux fichiers Le module de gestion est un site web en php pilotant le module de conversion. Pour raliser cela, les scripts php doivent pouvoir executer certaines commandes l'intrieur des rpertoires d'installation de la plate-forme Cyberdocs. Il vous faut donc autoriser votre serveur web accder aux commandes de conversion de la plate-forme. Le plus simple est d'effectuer les actions suivantes : Sous Linux et Unix-like : placez-vous dans le rpertoire contenant le dossier pcd-install et attribuez tous les fichiers de la plateforme au compte et groupe utilisateur utilis par le serveur web. Par exemple : chown -Rh apache:apache pcd-install. Pour connaitre le nom du compte utilisateur et son groupe, vous pouvez diter votre fichier httpd.conf et regarder les paramtres User et Group. Sous Windows : vrifiez que les fichiers sont accessibles en lecture, criture et excution au compte utilisateur servant votre serveur web. C'est normalement le cas par dfaut. 2. Paramtres de PHP/Apache Editez le fichier php.ini prsent dans /etc sous Linux, c:/windows ou le rpertoire d'installation de Apache sous Windows et vrifier les paramtres suivants (ces valeurs sont donnes titre indicatif, adaptez-les selon vos besoins) : Maximum execution time of each script, in seconds : (possibilit de modifier uniquement pour php-cli cf doc de php-cli et son fichier php.ini propre.) max_execution_time = 300000 Maximum amount of time each script may spend parsing request data : max_input_time = 6000 Maximum amount of memory a script may consume memory_limit = 1600M Maximum size of POST data that PHP will accept. post_max_size = 1500M Show all errors, except coding standards warnings (vous pouvez aussi dsactiver les erreurs !) error_reporting=E_ALL & ~E_NOTICE Whether to allow HTTP file uploads. file_uploads = On Maximum allowed size for uploaded files. upload_max_filesize = 1400M
Note : pour les utilisateurs de Redhat Linux 8.0/9.0 avec Apache 2.x.x, il peut tre ncessaire de modifier le fichier /etc/httpd/conf.d/php.conf et de changer la valeur de LimitRequestBody. Ajouter la variable d'environnement suivante dans httpd.conf :
SetEnv JAVA_HOME rpertoire_installation_java. Par exemple : SetEnv JAVA_HOME /usr/java/j2sdk1.4.2_01 Relancer Apache aprs modification des fichiers. 3. Accs HTTP au module de gestion Crer un accs web la plateforme dans la configuration de votre serveur web (il s'agit du fichier httpd.conf pour Apache), pointant dans le dossier pcd-install/gestion/. Pour des raisons de scurits, ne PAS donner d'accs HTTP au rpertoire production . Si certains documents sont confidentiels, nous vous recommandons d'utiliser des connexions scurises (HTTPS) pour accder au module de gestion. Si ncessaire, modifier galement le fichier .htaccess la racine du dossier pcdinstall/gestion/ afin de configurer les redirections automatiques permettant de tlcharger les fichiers du rpertoire production : par exemple, dcommentez et modifier RewriteBase avec le chemin de base de l'URL vers le module de gestion - notamment si vous utilisez un alias dans votre configuration d'Apache. Aller sur la page d'accueil (http://nom_host/php/) du module de gestion, et s'identifier avec le nom d'utilisateur root, sans mot de passe. La premire action raliser sera donc de mettre un mot de passe en allant dans la rubrique utilisateurs. Voir la documentation du module de gestion pour en savoir plus. 4. Configuration avance du module de gestion Le module de gestion peut utiliser un serveur LDAP pour l'authentification, tre traduit aisment dans la langue de votre choix et tre paramtr diffremment. Pour cela, consultez la partie intitule : #3.1.6.8.Personnaliser le module de gestion 5. Avertissement Il est fortement recommander de limiter l'accs au module de gestion votre intranet. Vous pouvez galement opter pour un accs en https.
3.1.5.3.3. module de publication
Installation
du
Pour installer le module de publication, quelques tapes peuvent tre ncessaires. Tout d'abord, on doit excuter le script installation-web.bat ou installation-web.sh. Cela aura pour effet de copier les fichiers sources dans le dossier appropri sous SDX, tout en filtrant certains paramtres pour contextualiser votre installation. Ensuite, il est galement prfrable de copier les fichiers de configuration des institutions pour lesquelles vous souhaitez publier des documents. Le script copie-institutions.{bat | sh} effectue cette opration. En particulier, il copie le fichier exemple fourni avec la plate-forme Cyberdocs, pour l'universit Lyon 2. Si vous souhaitez publier des documents provenant d'autres institutions, il faut crer des fichiers semblables ceux qu'on retrouve dans le dossier exemples/configurations/web/lyon2 dans les sources Cyberdocs. Une fois toutes les sources de Linux 8.0/9.0 avec Apache 2.x.x : modifier le ouvrir lapplication dans SDX. Cela signifie qu'il faut indiquer au serveur SDX qu'il existe une nouvelle application installe, et qu'on veut rendre cette application visible et utilisable.
Pour cela, il suffit de se rendre ladresse de la page d'administration du serveur SDX (par exemple http://localhost:8080/sdx/sdx/admin/loginsu.xsp), au formulaire d'identification tel que prsent cidessous, et sidentifier en tant que super-utilisateur :
Cette dmarche effectue, il suffit ensuite de cliquer sur le bouton applications en haut de l'cran :
Sur cette page, une liste droulante propose lensemble des applications prsentes sur le serveur :
En slectionnant lidentifiant de votre application (valeur sdx.application.path dans le fichier pcd.properties), un lien vers lapplication apparat alors. Elle est dsormais ouverte, il ne reste plus qu cliquer sur ce lien. Cette opration d'ouverture de l'application nest effectuer quune seule fois.
3.1.6. Personnaliser cyberdocs
3.1.6.1. institution
15
Crer
une
nouvelle
L'interface Web du module de publication suppose que chaque document est publi par une institution. Des informations sur cette institution doivent tre fournies afin de rendre l'interface
Service Gnral de la Recherche et des coles Doctorales - Universit Lumire Lyon 2 Fvrier 2009
claire et efficace. Si un document d'une nouvelle institution doit tre ajout, il est donc ncessaire de configurer le module pour inclure cette institution. Le plus simple est de partir de l'exemple fourni avec l'institution lyon2. Les informations sur les institutions sont places dans le dossier institutions dans l'application Web. Dans ce dossier, chaque institution possde son propre dossier, et le nom de ce dossier doit tre le code donn l'institution. Dans ce dossier, on retrouve trois lments d'information importants : 1. Un fichier de configuration pour l'institution, absolument essentiel. 2. Une feuille de style CSS pour les documents publis par l'institution, essentielle mais peut tre vide. 3. Un logo, affich dans le cadre suprieur de la fentre de consultation, lorsqu'on consulte un document publi par cette institution. C'est le document de configuration, qui doit tre nomm config.xml, qui contient les informations importantes. L'exemple ci-dessous permet de documenter ce fichier. Exemple 1. Exemple de fichier de configuration d'une institution  <ins:institution id="lyon2" xmlns:ins="http://cyberdocs.org/institutions" > <ins:informations>  <ins:nom>Universit Lumire Lyon 2</ins:nom> <ins:logos>  <ins:logo role="consultation" height="20" width="10" src="logos/logo.png"/ </ins:logos> <ins:description/>  <ins:intranet> <ins:masque ip="192.168.123.*"/> <ins:masque ip="127.0.0.*"/> </ins:intranet> </ins:informations>  <ins:metadonnees> <ins:champ nom="dc:creator"> <ins:libelle xml:lang="fr">Auteur</ins:libelle> </ins:champ> <ins:champ nom="dc:title"> <ins:libelle xml:lang="fr">Titre</ins:libelle> </ins:champ> ... </ins:metadonnees> <ins:messages>  <ins:intitule code="dedicace" xml:lang="fr">Dedicace</ins:intitule> </ins:messages> </ins:institution>
>
3.1.6.2. styles
Ajout d'un nouveau code de
Soit le style auteur-nouveau qui permet de styler les auteurs dans le code de styles 'nouveaucode'.
1. Il faut tout d'abord faire passer 'nouveau-code' en paramtre dans le script de conversion. (cf : informations de conversion) 2. Dans le fichier dossier_de_production/outils/xslt/utiles/styles.xml, il est ncessaire de rajouter un lment : <institutions> <institution code="nouveau-code"/> </institutions> (comme celui existant pour lyon2) 3. Pour chacun des styles , il est ncessaire de dclarer un lment nom, indiquant le nom du style dans le code de styles 'nouveau-code', par exemple : <style code="auteur"> <nom code="lyon2" xml:lang="fr">1|Auteur</nom> <nom code="nouveau-code" xml:lang="fr">auteur-nouveau</nom> </style> ou encore : <style code="text"> <nom code="lyon2" xml:lang="fr">Text</nom> code="nouveau-code" xml:lang="fr">Text</nom> </style> <nom
3.1.6.3. langue
Conversion dans une autre
1. Pour utiliser l'anglais, il faut tout d'abord faire passer le parametre 'en' dans le script de converison 2. Dans chaque fichier xml de dossier_de_production/outils/xslt/utiles les lments du type : <element xml :lang= fr>----</element> doivent avoir leur quivalent dans la langue souhaite : <element xml :lang= en>----</element> 3. Il en va de mme pour dossier_de_production/outils/xslt/metadonnees/metadonnees.xml le fichier
3.1.6.4.
Les feuilles de styles CSS
La consultation des documents, dans le module de publication ou en statique, passe par le format HTML ou XHTML, et celui-ci permet de prciser l'affichage l'aide de feuilles de styles CSS. Dans Cyberdocs, nous utilisons beaucoup ces feuilles de styles, permettant notamment d'en utiliser plusieurs : 1. Une feuille de styles gnrale, applique tous les documents. 2. Une feuille de styles par institution, applique tous les documents publis par cette institution. 3. Une feuille de styles spcifique un document. Ces trois CSS sont prsentes dans l'ordre inverse de priorit ; en effet, si deux slecteurs CSS s'appliquent, c'est celui que l'on trouve dans la feuille de styles spcifique, puis la feuille de styles pour l'institution, et enfin la gnrale. Pour ajouter une feuille de styles CSS spcifique un document, il suffit de nommer le fichier [code du document].css et de le placer dans le dossier sources du document si on utilise le module de conversion, ou de le placer directement la racine du dossier du document. Pour ajouter une CSS propre une institution, on doit crer un fichier [code de l'institution].css, et le placer dans le dossier de l'institution du module de conversionou du module de publication.
3.1.6.5.
Publier d'autres documents
Il est possible d'utiliser le module de publication sans que le document soit au format XML TEILite. Par exemple, il pourrait s'agir d'un document PDF. Ces documents doivent aussi avoir un code unique et tre organiss par institution et par anne de publication. Pour les traiter, il suffit de placer le fichier source dans le dossier [code du document]/sources et de nommer le fichier avec le code de document et une extension reprsentative de son format.
On doit ensuite absolument avoir un fichier de mtadonnes, toujours nomm [code du document]-md.xml. L'lment dc:identifier doit ce moment contenir l'URL complte du document.
3.1.6.6. statiques
Modifier
les
pages
L'application Web dynamique offre l'utilisateur une interface ergonomique qu'il est souhaitable de prsenter dans sa langue. Les contenus gnrs par cette application sont associs un habillage spcifique, ce qui permet d'offrir plusieurs langues pour une mme apparrence et un mme contenu statique. Ces contenus gnrs sont stocks dans les documents XML suivants : src/web/habillages/pcd/messages/global.xml: messages communs la plupart des pages de l'application src/web/habillages/pcd/messages/menu-general.xml: navigation gnrale dfinition du menu de
src/web/habillages/pcd/messages/messages-avancee.xml: messages du formulaire de recherche avance src/web/habillages/pcd/messages/messages-cadre.xml: suprieur de consultation dans un document messages du cadre
src/web/habillages/pcd/messages/messages-chargement.xml: messages relis au formulaire d'indexation d'un document src/web/habillages/pcd/messages/messages-contenu.xml: messages relis au cadre principal de consultation d'un document src/web/habillages/pcd/messages/messages-fiche.xml: fentre de mtadonnes d'un document messages relis la
src/web/habillages/pcd/messages/messages-id.xml: messages relis au formulaire d'identification src/web/habillages/pcd/messages/messages-imprimer.xml: messages relis la fentre de choix du format pour l'impression src/web/habillages/pcd/messages/messages-rchargement.xml: concernant la page de rsultat de l'indexation messages
src/web/habillages/pcd/messages/messages-resultats.xml: messages relis aux rsultats de recherche src/web/habillages/pcd/messages/messages-termes.xml: messages relis aux listes de termes d'index Afin de modifier le contenu statique (notament la page index), ditez et crez des fichiers dans le rpertoire src/web/habillages/pcd/statique. Vous noterez que l'habillage par dfaut est pcd : il vous est bien sr possible de crer un nouvel habillage totalement diffrent en vous basant le modle de base. Pour cela, dans les sources, crez un nouveau rpertoire dans le rpertoire habillage, placez-y vos fichiers personnaliss et modifiez le paramtre habillage du fichier pcd.properties afin d'y spcifier le nom de votre nouvel habillage. Puis relancer le script installation-web pour que vos nouveaux fichiers soient copis dans le rpertoire de travaille de SDX.
3.1.6.7.
Modifier l'application Web
Afin de modifier l'application Web, il est possible de distinguer quatre niveaux de modifications :
Modifier la feuille de styles src/web/css/structure.css : il s'agit de la solution la plus simple qui vous permet de changer la mise en page des documents. La feuille de styles contient des sections pour les diffrentes parties du site, pensez lire les commentaires du fichier pour plus d'information. Modifier les pages statiques du site : consulter la partie de cette documentation traitant spcialement de ces modifications. Modifier les fichiers XSL du rpertoire src/web/xsl : ne modifiez ces fichiers que si vous ne pouvez pas obtenir ce que vous souhaitez avec les feuilles de styles et les pages statiques. Il s'agit de modifications en profondeur, notamment pour changer le HTML gnr dynamiquement. Modifier les fichiers XSP du rpertoire src/web : cris en JAVA, ces pages sont l'articulation de l'application Web. Editez ces pages si vous souhaitez modifier le comportement du site (recherches, filtrage, nouvelles fonctionnalits... etc.). A noter : il vous faudra relancer le script d'installation installation-web aprs chaque modification des sources. Sinon les fichiers modifis ne seront pas copis dans le rpertoire de de SDX.
3.1.6.8. gestion
Personnaliser le module de
Le module de gestion est une application Web dynamique crite en PHP (http://www.php.net). Vous pouvez modifier aisment son comportement en ditant les fichiers PHP. Cependant, certains fichiers de configuration ont t prvus afin d'viter des modifications en profondeur. Voici un rapide descriptif de l'architecture du module de gestion : Le fichier de configuration gnral : il s'agit de fichier pcd.properties global cyberdocs. Consultez la documention d'installation pour plus d'information. Le fichier de configuration src/gestion/gestion/config.inc.php : les langues disponibles, configuration facultative d'un serveur LDAP. Le fichier de constantes src/gestion/gestion/inc/const.php : retrouvez dans ce fichier tous les constantes du module de gestion (rpertoire de document, langues, tapes de conversion... etc.) Les fichiers d'affichage dans le rpertoire src/gestion/gestion/inc : il s'agit de l'habillage pour le module de gestion. C'est ici que vous pouvez personnaliser les pages ou les traduire dans une autre langue. Les fichiers applicatifs la racine du rpertoire src/gestion/gestion : il s'agit des fichiers de traitement pour la gestion des conversions et le stockage des donnes. A ne modifier que si vous souhaitez changer le comportement du module de gestion. A noter : il vous faudra relancer le script d'installation installation-oo2xml aprs chaque modification des sources. Sinon les fichiers modifis ne seront pas copis dans le rpertoire d'installation. Traduction : il est possible de traduire le module gestion sans modifier le code PHP. Pour cela : Dans l'onglet configuration du module de gestion, cliquez sur Extraire le fichier de traduction vierge . Le fichier extrait est un fichier .po , ditable avec un logiciel de gestion de traduction, tel que poEdit Lokalize , KBabel ... Une fois traduit, renommez le fichier avec le suffixe de la langue (par exemple en.po pour l'anglais) Placez le fichier dans le rpertoire pcd-install/gestion/po/ Ajouter la langue au tableau php $GLOBALS["TRANSLATIONS"] du fichier de configuration : pcd-install/gestion/config.inc.php
3.1.6.9. Lier installer le module JK
Apache
et
Tomcat :
Le module JK permet de faire communiquer Apache et Tomcat : le principal avantage se trouve dans la possibilit d'utiliser les deux serveurs en mme temps comme s'ils taient tous les
deux sur le port 80. En effet, le port 8080 (par dfaut pour Tomcat) n'est pas recommand pour un serveur Web et certains administrateurs rseaux en bloquent l'accs pour des raisons de scurit. De plus, les URL de vos documents seront moins compliques retenir et surtout plus conformes ce que les utilisateurs d'internet connaissent. Enfin, vos statistiques de consultations d'Apache contiendront galement les appels aux documents et les recherches via SDX. Avertissement : cette page d'aide ne se veut pas exhaustive sur la dmarche suivre afin d'installer le module JK. Nous vous conseillons de lire la documentation officielle disponible sur le site du module JK. Cette page est un exemple d'installation : nous nous baserons sur l'utilisation d'une distribution Linux Fedora 7. Vous devez avoir install et configur vos serveurs Apache et Tomcat. Nous vous conseillons d'installer pralablement SDX afin de pouvoir tester plus facilement votre nouvelle configuration. 1) Dpendances Vrifiez que vous avez install les packages suivants : http-devel (yum install http-devel) 2) Tlcharger les sources du module JK Vous trouverez les sources du dernier http://tomcat.apache.org/connectors-doc/ module JK sur le site officiel :
Ou, par exemple, directement en ligne de commandes : wget http://www.apache.org/dist/tomcat/tomcat-connectors/jk/source/jk1.2.25/tomcat-connectors-1.2.25-src.tar.gz Dcompressez l'archive dans /usr/loca/src/ 3) Compilation et installation Trouvez le rpertoire d'installation de APX : # which apxs /usr/sbin/apxs Compilation :
cd /usr/local/src/tomcat-connectors-1.2.25-src/native/ ./configure --with-apxs=/usr/sbin/apxs make su -c 'make install'
4) Configuration dApache Crez le fichier de configuration /etc/httpd/conf/workers.properties avec le contenu suivant, en adaptant selon vos chemins d'installation de tomcat et de java. # tomcat home workers.tomcat_home=/data/tomcat #localisation de la jvm workers.java_home=/data/jdk1.6.0 # Define 1 real worker using ajp13 worker.list=worker1 # Set properties for worker1 (ajp13) worker.worker1.type=ajp13
worker.worker1.host=127.0.0.1 worker.worker1.port=8009 Ajoutez la configuration du module JK votre fichier httpd.conf : # ################### MOD JK #################### # Load mod_jk module # Update this path to match your modules location LoadModule jk_module modules/mod_jk.so # Where to find workers.properties # Update this path to match your conf directory location (put workers.properties next to httpd.conf) JkWorkersFile "/etc/httpd/conf/workers.properties" # Where to put jk shared memory # Update this path to match your local state directory or logs directory JkShmFile "/etc/httpd/logs/mod_jk.shm" # Where to put jk logs # Update this path to match your logs directory location (put mod_jk.log next to access_log) JkLogFile "/etc/httpd/logs/mod_jk.log" # Set the jk log level [debug/error/info] JkLogLevel info # Select the timestamp log format JkLogStampFormat "[%a %b %d %H:%M:%S %Y] " # Send everything for context /examples to worker named worker1 (ajp13) JkMount /sdx/* worker1 Ici, nous voyons sur la dernire ligne que toutes les requtes commenant par sdx seront rediriges vers tomcat. Rechargez votre serveur web : /etc/init.d/httpd reload Testez : http://votre_serveur/sdx/ Vous devez voir s'afficher la page d'administration de SDX.
3.1.6.10.
Utiliser une base MySQL
Par dfaut, SDX travaille avec une base de documents stocke dans une arborescence de rpertoires situe dans son espace de travail. Ce systme est acceptable pour une petite base de documents, mais il devient vite trs peu performant pour une base volumineuse et une monte en charge importante. Il est donc prfrable, une fois l'installation de Cyberdocs termine et teste, de changer de systme de stockage pour un moteur de bases de donnes plus performant. Si vous souhaitez faire ce changement sur une base en production, notez qu'il vous faudra r-indexer tous vos documents. Nous verrons ici l'exemple d'utilisation de MySQL, disponible en licence GPL et propos avec la plupart des distributions Linux. Bien videmment, l'utilisation d'un autre systme de base de donnes est tout a fait possible. Voici les modifications de configuration apporter pour utiliser MySQL : 1. Arrtez votre Tomcat (cd tomcat/bin, ./shutdown.sh)
2. Tlchargez le connecteur java pour MySQL l'adresse suivante : http://dev.mysql.com/downloads/connector/j/3.1.html. Copiez le fichier .jar dans le rpertoire webapps/sdx/WEB-INF/lib. Le fichier .jar se trouve nomalement la racine de l'archive tlcharge. Par exemple : mysqlconnector-java-3.1.7-bin.jar. 3. Crez une nouvelle base de donnes MySQL. Pour l'exemple, nous l'appellerons pcd . Nous vous conseillons galement de crer un utilisateur MySQL pcd ayant uniquement des droits complets sur cette nouvelle base. 4. Modifiez votre configuration de MySQL pour autoriser des requtes de taille importante. Pour cela, ajoutez les lignes suivantes au fichier /etc/my.cnf : # Taille maximun des paquets max_allowed_packet=1024M Relancez votre serveur MySQL (/etc/init.d/mysqld restart). 5. Editez le fichier webapps\sdx\WEB-INF\web.xml, pour ajouter ou modifier les lignes suviantes : <init-param> <param-name>load-class</param-name> <param-value>com.mysql.jdbc.Driver</param-value> </init-param> 6. Editez le fichier webapps\sdx\WEB-INF\cocoon.xconf pour ajouter ou modifier les lignes suivantes - en y modifiant l'url, le login et le password mysql comme il convient : <datasources> <jdbc name="id_mysql" logger="sdx.rdbms.id_mysql"> <pool-controller min="5" max="10"/> <dburl>jdbc:mysql://localhost:3306/pcd?autoReconnect=true</dburl> <user>myuser</user> <password>mypassword</password> </jdbc> </datasources> 7. Modifiez le fichier src/web/conf/application.xconf :
Au dbut du noeud <sdx:userDocumentBase> , ajoutez : <sdx:database type="MYSQL" dsi="id_mysql"/>
Remplacez (ou commentez) dans <sdx:repositories> du noeud <sdx:userDocumentBase> : <sdx:repository id="users" type="FS" baseDirectory="users/xml" depth="0" extent="1000"/> Par : <sdx:repository id="users" type="MYSQL" dsi="id_mysql"/>

Au dbut du noeud <sdx:documentBase id="documents" type="lucene" default="true" maxFieldLength="100000"> situ dans <sdx:documentBases> , ajoutez : <sdx:database type="MYSQL" dsi="id_mysql"/> .
Remplacez (ou commentez) dans <sdx:repositories> du noeud <sdx:documentBases> : <sdx:repository type="FS" id="rdocuments" baseDirectory="documents" default="true"/> Par : <sdx:repository type="MYSQL" id="rdocuments" dsi="id_mysql" default="true"/> Pour vous aider, vous pouvez tlcharger un exemple de fichier application.xconf aprs modifications.
8. Relancez le script installation-web pour copier le fichier application.xconf dans le rpertoire de SDX. 9. Relancez Tomcat (cd tomcat/bin, ./startup.sh) Vous devez voir apparatre 4 tables dans votre base MySQL : documents, rdocuments, sdxuserdb, users. De plus, les noms des tables seront prfixs par l'identifiant de l'application spcifi dans votre fichier pcd.properties . A noter : La base de donnes peut tre d'une taille consquente (plusieurs Go) : prvoyez donc un espace disque suffisant. Vous pouvez supprimer le rpertoire webapps\sdx\pcd\conf\document.
3.1.6.11. Intgrer publication votre site web
le
module
de
Il n'existe pour le moment aucune solution prtablie pour intgrer le module de publication un site dj existant. Cependant, des projets bases sur XML-RPC/SOAP sont l'tude. Pou le moment, dans le cadre du programme Cybertheses, l'universit Lyon 2 a modifi les fichiers XSL du module de publication pour l'utiliser avec le CMS Drupal. Cependant, il est tout a fait possible d'utiliser ces sources modifies avec d'autres sites dynamiques, en apportant quelques modifications aux scripts PHP. Nous tenons prciser qu'il s'agit d'une solution temporaire en attendant des dveloppements plus pousss. Le principe est le suivant : Ne plus utilisez directement les interfaces de SDX pour les pages statiques et pour rechercher dans les documents. Intgrer le moteur de recherche un site dj existant.
Voici les conditions pour utiliser ces sources remodifies :

Vous possdez dj une installation de Cyberdocs fonctionnelles. Votre configuration serveur accepte PHP. Vous possder des connaissances en PHP Vous disposer de temps pour tester et modifier les scripts fournis. Votre institution dispose dj d'un site dynamique auquel vous souhaitez intgrer le module de publication de Cyberdocs (notamment pour plus de visibilit et pour conserver un accs unique).
Installation et utilisation : Devant la complexit de l'installation et les risques de trou de scurit en cas de mauvaise utilisation des sources, nous avons choisi de ne pas diffuser directement ces modifications : contactez-nous via la rubrique contact pour plus d'information.
3.1.7. Outils
Vous trouverez sur le site Cyberdocs.org o tlcharger les outils documents ci-dessous.
3.1.7.1. documents
Rindexer
tous
vos
En cas de problme ou suite une modification de configuration, il peut tre ncessaire de rindexer tous les documents de la base.
La mthode propose n'est sans doute pas la meilleure, mais elle possde l'avantage d'tre relativement simple, pour un coup de dveloppement presque nul. Pr-requis : le script de r-indexation utilise wget et awk . Rindexer vos documents, tape par tape :
Tlchargez cette archive et dcompressez-la : vous y trouverez un rpertoire reindex contenant les outils de r-indexation. Dans le rpertoire reindex/web , vous trouverez trois fichiers permettant d'ajouter votre application SDX une page XSP de r-indexation simplifie. Copiez les trois fichiers dans l'arborescence des sources Cyberdocs comme indiqu ci-dessous : reindex/web/rsimplechargement.xsp : placez ce fichier dans votre rpertoire src/ web/ reindex/web/xsl/rsimplechargement.xsl : placez ce fichier dans votre rpertoire src/web/xsl/ reindex/web/habillages/pcd/xsl/rsimplechargement.xsl : placez ce fichier dans le rpertoire xsl de votre habillage. Excutez nouveau le script installation-web afin d'installer les nouveaux fichiers dans votre application SDX. Relancez Tomcat. Si vous utilisez le module de gestion, copiez le fichier index.dat de votre institution (par exemple production/lyon2/index.dat) dans le rpertoire reindex Si vous n'utilisez pas le module de gestion, il vous faut crer un fichier texte index.dat contenant la liste de tous les espaces de document r-indexer, ayant pour chaque ligne le format suivant : nom_repertoire_doc:annee_sur_4_chiffre: . Par exemple : grosjean_mf:2003: . Placez-vous dans le rpertoire rindex et executez la commande reindex.sh comme indiqu ci-dessous, afin de fabriquer le fichier de commandes de r-indexation globale : ./reindex.sh URL_APPLICATION_PCD CHEMIN_REPERTOIRE_PRODUCTION LANGUE ID_INSTUTION REPERTOIRE_TOMCAT REPERTOIRE_GESTION|all FICHIER_INDEX_DAT > reindex_all.sh Par exemple, pour rindexer toute l'institution lyon2 : ./reindex.sh http://mon_server/sdx/pcd /data/pcd-install/produdction lyon2 /data/tomcat all index.dat > reindex_all.sh fr
Par exemple, pour rindexer uniquement les documents de l'institution lyon2 classs dans le rpertoire archive du module de gestion : ./reindex.sh http://mon_server/sdx/pcd /data/pcd-install/produdction lyon2 /data/tomcat arch index.dat > reindex_all.sh Vrifiez le fichier reindex_all.sh : il doit contenir des appels wget . Attribuez les droits en excution tous les fichiers sh du rpertoire reindex et lancez reindexall.sh : ./reindexall.sh > resultat.txt & Vous pouvez surveiller la r-indexation en consultant le fichier resultat.txt (tail resultat.txt). Si des erreurs apparaissent, notez les espaces de document en question et traitez ces cas manuellement. Important : Tous les 50 chargements de documents, le server Tomcat est arrt et relanc automatiquement.
fr
Une fois les documents rindexs, pensez supprimer rsimplechargement.xsl/xsp : ils ne sont plus utiles.
les
fichiers
3.1.7.2. en masse
Modifier vos mtadonnes
Il peut tre utile de modifier certaines mtadonnes de faon globale. Cependant, il n'existe pas d'outil intgr Cyberdocs pour effectuer ce genre d'opration. Le plus simple est sans doute d'utiliser les expressions rgulires et les outils de remplacements automatiques. Nous prendrons ici l'exemple de la suppression du port 8080 dans les URL de rfrence des documents, suite une installation du module JK. Tout ceci est bien sr titre d'exemple. 1) Cration d'un script de remplacement Crer un fichier remplace.sh : cp $1 $1.orig sed 's/mon_serveur.fr:8080/mon_serveur.fr/g' $1.orig > $1 Une copie de sauvegarde du fichier sera cre avant le remplacement. 2) Trouver les fichiers modifier Un exemple pour trouver les fichiers modifier. find pcd-install/production/ -name "*.xml" -exec grep "mon_serveur.fr:8080" -l '{}' \; > list_fichier.txt find pcd-install/production/ -name "*.dat" -exec grep "mon_serveur.fr:8080" -l '{}' \; >> list_fichier.txt 3) Effectuer le remplacement awk '{ print "./remplace.sh "$0 }' list_fichier.txt > changeall.sh chmod +x changeall.sh ./changeall.sh Une fois les vrifications effectues, vous pouvez supprimer les fichiers de sauvegarde. find pcd-install/production/ -name "*.xml.orig" -exec rm -f '{}' \; find pcd-install/production/ -name "*.dat.orig" -exec rm -f '{}' \;
3.2.
Aide aux utilisateurs
3.2.1. Approche technologique

Le module de conversion de la plate-forme Cyberdocs vise automatiser un processus de conversion depuis un format traitement de texte vers un document structur en format XML, selon la DTD TEILite. Une telle opration consiste donc identifier le plus de structure possible dans le document original pour rendre le document XML le plus riche possible. Les lments de structure prsents dans un document traitement de texte peuvent tre : De l'enrichissement typographique : caractres gras ou italiques, couleurs, polices particulires, etc. Des structures dj gres par les traitements de texte : tableaux, illustrations, liens hypertexte, notes de bas de page, etc.
Des styles (de paragraphes ou de caractres) ayant une smantique commune tous les documents : Titre 1, Titre 2, etc. Des styles ayant une smantique particulire pour la plate-forme Cyberdocs : auteur, titre du document, anne de publication, etc.
Le module de conversion de la plate-forme Cyberdocs ne se contente pas de produire ce document XML de rfrence. En effet, une fois celui-ci obtenu, le module peut produire des versions du document prt une publication statique, en format HTML, XHTML ou PDF. De plus, le module va prparer un ensembe de documents qui alimenteront le module de publication pour rendre l'interface de consultation encore plus riche. Une srie de traitements seront effectus, en squence, dans le but de tirer le meilleur parti de ces informations. Ces traitements font intervenir essentiellement cinq technologies : XSLT (eXtensible Stylesheet Language Transformations) : ce langage de programmation a t conu spcialement pour traiter de l'information en format XML. Il s'avre parfaitement appropri pour les traitements effectus par le module de conversion, et part l'tape initiale qui fait appel OpenOffice.org, tous les autres dveloppements ont t effectus l'aide de ce langage normalis. Le module de conversion inclut un processeur XSLT : Saxon version 6.5.2, ralis par Michael Kay et disponible librement. XSL-FO (eXtensible Stylesheet Language Formatting Objects) : il s'agit de l'autre volet de la norme XSL, qui consiste en un format (XML) de mise en page, permettant ainsi de prparer des documents adapts l'impression. La production des documents PDF dans le module de conversion passe pralablement par la production d'une version en format XSL-FO, qui ensuite sera traite l'aide d'un processeur XSL-FO, inclut dans la distribution Cyberdocs. Ce processeur est FOP du projet Apache XML. SVG (Scalable Vector Graphics) : ce format de graphique vectoriel est utilis lors de la conversion vers le format XSL-FO, afin de permettre une reprsentation plus fine et plus prcise des images incluses dans les documents traits. Le processeur XSL-FO FOP, lorsqu'il traite des documents, donne un meilleur rendu lorsque les images sont incluses dans des documents SVG. ANT : ce projet Apache fournit un environnement souple et puissant pour excuter diffrentes oprations. Il inclut dj une srie de tches, dont le pilotage des transformations XSLT ou XSL-FO, la copie de fichiers, etc. C'est pourquoi ANT est utilis pour piloter les diffrentes oprations de conversion proposes par le module de conversion Cyberdocs. Java : l'environnement ANT tant une application Java, une machine virtuelle Java est utilise pour supporter toutes les oprations effectues par le module de conversion, l'exception du traitement inital effectu par OpenOffice.org.
Un oprateur de conversion de documents l'aide de Cyberdocs n'a pas ncessairement besoin de connatre tous ces dtails techniques. Toutefois, en cas de problmes, ou lorsqu'une installation doit tre correctement effectue, il peut tre important de comprendre le rle jou par les diffrentes technologies et leur implmentation. Lutilisation du module de gestion dispense de connaitre prcisment les noms des tapes de conversion et notamment dutiliser le module de conversion en ligne de commande. Nous avons donc spar la documentation en deux parties distinctes : une documentation plus visuelle pour les utilisateurs du module de gestion et une documentation trs dtaille pour les utilisateurs en ligne de commande.
3.2.2. Convertir un document via le module de gestion

Loutil Cyberdocs permet de convertir des documents texte en un format XML garantissant un archivage prenne des documents (qui ainsi ne dpendent plus dun logiciel particulier), et partir duquel sont gnrs des formats de consultation (HTML, XHTML) et dimpression (PDF).
3.2.2.1.
Sidentifier sur Cyberdocs
Pour utiliser Cyberdocs, il faut que ladministrateur vous ait attribu un nom dutilisateur et un mot de passe qui vous donnent accs votre institution. Pour exemple ici, nous prendrons lUniversit Lumire Lyon 2.
Vous pouvez alors slectionner linstitution dont vous allez traiter les documents :
Lcran suivant vous permet daccder aux documents qui ont dj t traits sur le serveur, ou de crer de nouveaux documents.
3.2.2.2. thse
Crer un espace pour une
Si vous souhaitez convertir un document que vous venez de prparer, il faut dabord crer un espace pour ce nouveau document :
Lidentifiant correspond au nom de lauteur suivi de linitiale du prnom dont il est spar par un tiret bas, le tout en minuscules ; par exemple, pour la thse dEdith Jaillardon, on aura lidentifiant suivant : jaillardon_e. Cet identifiant peut tre modifi, mais en rgle gnrale ce nest pas ncessaire. Le nouvel espace que vous venez de crer dans Cyberdocs a lapparence suivante :
3.2.2.3.
Procdure de conversion
La navigation lintrieur de lespace se fait laide des onglets Gestion de fichiers, Mtadonnes et Traitements. Procdez dans cet ordre :
3.2.2.3.1. Transfert des fichiers styls et des fichiers associs (onglet Gestion de fichiers)
Chargez les fichiers qui doivent tre traits par la chane dans les champs appropris. Le fichier principal doit tre un document texte ayant une extension .odt ou .sxw, cr laide dOpenOffice. Les fichiers associs au document principal peuvent tre des fichiers image (possdant une extension .jpg, .gif ou .png, qui peuvent tre regroups dans une archive .zip) ou des fichiers .pdf (quil nest pas possible de regrouper dans une archive .zip).
3.2.2.3.2. Saisie mtadonnes (onglet Mtadonnes)
des
Il est indispensable de saisir et valider les mtadonnes avant la conversion pour que celles-ci soient associes au document.
Lorsquune thse possde 2 auteurs, les noms et prnoms des deux auteurs doivent tre indiqus dans le mme champ Auteur :
Lorsquune thse a t rdige dans une langue autre que le franais (cas de certaines thses en co-tutelle crites en anglais, italien, portugais, ), on indique, dans le mme champ Titre franais , le titre en franais et dans la langue trangre :
Pour les thses au format PDF (mais pas celles contenant uniquement certaines parties en PDF), on indique, dans la rubrique Commentaires de diffusion , la mention suivante : Thse diffuse au format PDF .
Afin de valider ces mtadonnes, il faut imprativement cliquer une premire fois, en bas du premier cran, sur Modifier, puis au bas du second cran sur Continuer.
Les mtadonnes sont prsent enregistres et lon peut lancer la conversion des documents.
3.2.2.3.3.
Conversion (onglet Traitements)
Lorsquon travaille sur un nouveau document, on lance un Traitement complet qui va gnrer un document XML et des produits drivs (HTML, PDF).
Service Gnral de la Recherche et des coles Doctorales - Universit Lumire Lyon 2 Fvrier 2009 3 2
Le temps ncessaire la conversion dun document dpend de sa taille et de la complexit de son contenu (prsence dillustrations par exemple) ; pour une thse, il faut compter en gnral quelques minutes (moins dun quart dheure) mais certains documents peuvent prendre jusqu une heure de traitement et plus. La rubrique Rsultat de la conversion : Voir permet de suivre les tapes de la conversion, de sinformer des problmes rencontrs et de vrifier son rsultat :
Service Gnral de la Recherche et des coles Doctorales - Universit Lumire Lyon 2 Fvrier 2009 3 3
Si la conversion aboutit, le message BUILD SUCCESSFUL est affich en bas de la page ; avant de passer ltape de vrification, il faut sassurer que, dans le haut de la page, sous la rubrique Premire tape XSLT de conversion, depuis OpenOffice.org dclars : vers un format XML intermdiaire napparaisse aucun message annonant que le document trait contient un ou plusieurs styles non
La prsence de styles non dclars dans le document ne bloque pas la conversion, mais tout paragraphe auquel est associ un style non dclar est supprim lors de la conversion. Si vous voyez apparatre des messages vous signalant la prsence de styles non dclars, il faut considrer que la conversion nest pas correcte. Il vous faut retourner au document OpenOffice, remplacer ces styles incorrects par des styles appartenant au modle Thse Lyon2, et recommencer la conversion en suivant la procdure dcrite plus bas pour une conversion qui a chou. Il savre quelquefois impossible de remplacer un style dans Word. Dans ce cas, plusieurs solutions soffrent vous : - appliquer le style Police par dfaut au paragraphe concern ; - le couper et de le recoller en tant que texte sans mise en forme (menu dition/ collage spcial) ; - supprimer totalement le style. Sans oublier dans tous les cas de reprendre manuellement les enrichissements de texte qui auront t supprims.
Si aucun style non dclar napparat, vous pouvez passer ltape suivante : la vrification.
Si la conversion naboutit pas, le message BUILD FAILED est affich en bas de la page ; les informations figurant sur la page vont alors vous permettre didentifier le problme qui a empch la conversion.
Si lerreur sest produite plus tt dans la conversion, cest quil existe un problme dans les documents soumis la conversion, qui empche le bon droulement de celle-ci (liste des problmes de conversion courants tablir). Dans ce second cas, la conversion est refaire. Procdez comme suit :
Retournez dans vos documents source et corrigez les problmes qui ont bloqu la conversion.
Dans Cyberdocs, effacez tous les fichiers produits par la conversion partir de la page Traitements :
Supprimez les documents source que vous avez chargs, partir de longlet Gestion de fichiers :
Chargez les fichiers corrigs partir de longlet Gestion des fichiers. Lancez un nouveau traitement complet partir de longlet Traitements.
En cas de nouvel chec de la conversion, cette procdure est rpter autant de fois que ncessaire, jusqu lobtention dun message BUILD SUCCESSFUL . N.B. La chane Cyberdocs peut traiter plusieurs documents en parallle.
3.2.2.3.4. rsultat de la conversion
Vrification
du
Lorsque la conversion a t mene terme, il faut encore vrifier que les documents produits ne comportent pas de problmes rsiduels, avant de les diffuser sur le site des thses en ligne. Pour cela, on effectue une vrification partir des fichiers HTML produits par la conversion, qui donnent un aperu des documents lorsquils seront mis en ligne et accessibles par les internautes. Pour cela, dans longlet Traitements, rubrique Liste des fichiers produits par loutil de conversion : activez le lien HTML et choisissez le document index-frames.html :
Vous accdez alors au document tel quil apparatra sur le site des thses en ligne (hormis certaines diffrences de mise en forme) ; la table des matires active, dans le cadre de gauche, permet de naviguer lintrieur du document ; des onglets permettent daccder directement la liste des tableaux et des figures contenus dans le document :
Les points vrifier en particulier sont les suivants :
o o
La page de titre comporte toutes les informations requises ; ces informations sont conformes celles du bordereau de mtadonnes ; Les parties et sous-parties saffichent correctement et ne comportent pas derreur de hirarchisation ; les titres sont placs en minuscules accentues, avec une capitale linitiale ; Tableaux et illustrations : Tester tous les liens accessibles depuis les onglets et sassurer que les tableaux et illustrations saffichent correctement ; Lorsque les listes sont incrmentes (ex. Figure 1, Tableau 1), sassurer quaucun numro ne manque ; Si diffrentes figures ou diffrents tableaux sont reprs par le mme intitul, il faut les distinguer en prcisant la lgende (par ex. Tableau 1 dans le corps de texte et Annexe Tableau 1 ). Les caractres spciaux saffichent correctement ; Les illustrations sont visibles et ne dpassent pas du cadre (sauf dans le cas dillustrations de grande taille comportant beaucoup de dtails, quon ne peut pas rduire sans nuire la lisibilit) ; Les fichiers lis (PDF, sons, vidos) souvrent sans problme.
o o o o
o o
Si le document est correct, on signale que la vrification a t faite en ajoutant un commentaire dans longlet Traitements, rubrique Commentaire du document :
On peut alors procder la diffusion du document. Cette diffusion seffectue laide de la plate-forme SDX (pour installer le module de publication, reportez-vous au site www.cyberdocs.org/)
3.2.3. Convertir un document sans le module de gestion : en ligne de commandes

Le module de conversion Cyberdocs effectue globalement une tche de conversion finalement assez complexe, car la variabilit des documents en entre suppose une grande souplesse dans les traitements effectuer, d'o une certaine complexit. C'est pourquoi cette tche de globale de conversion a t divise en plusieurs oprations ou tapes qui sont expliques ici. Bien comprendre ces oprations est essentiel pour l'oprateur de conversion, car mme si on cherche l'viter, il peut lui tre ncessaire d'intervenir manuellement sur un document produit l'une ou l'autre des tapes.
3.2.3.1. conversion
Oprations
et
tapes
de
Chapeau : Toutes les oprations effectues par le module de conversion, expliques tape par tape. Une manire un peu plus dtaille de prsenter la conversion est de prciser les tapes effectues. Dans la liste ci-dessous, le nom de code qui figure correspond la tche ANT qui permet d'excuter cette tape seulement. Les dossiers mentionns sont toujours crs l'intrieur du dossier de travail d'un document. etape_oo Cette tape va permettre de convertir le fichier source en un fichier XML grce l'outil OpenOffice.org. Le dossier oo est cr et contient le rsultat de ce traitement. etape_01 Cette tape va rcuprer la sortie de l'tape prcdente et faire un premier traitement qui permet de bien identifier ce qui sera trait ou exclu. Ainsi, on va donner les bons noms de style aux lments, vrifier que les styles obligatoires sont bien prsents, exclure les lments OpenOffice.org non traits. Le rsultat est envoy dans le dossier prod/01 .
etape_02 Cette tape va rcuprer la sortie de l'tape prcdente et transformer chaque lment en lment TEILite, en fonction de son nom ou du style qui lui est associ. Le produit de cette opration, prod/02, est ensuite trait par l'tape etape_02-bis qui va simplement numroter chaque lment afin de pouvoir les regrouper ultrieurement. Le rpertoire rsultat est plac dans le dossier prod/02-bis. etape_03 Cette tape va rcuprer la sortie de l'tape prcdente et hirarchiser les lments en fonction des niveaux de titre. Le dossier prod/03 contient le rsultat de cette tape. etape_04 Enfin, cette tape va transformer la sortie de l'tape prcdente en un document TEI, et gnrer le docment XML final dans le rpertoire xml. Une fois l'tape etape_04 effectue, nous avons un document XML TEILite qui servira de rfrence ; il s'agit en quelque sorte du vritable produire de ce module de conversion. Toutefois, les traitements peuvent se poursuivre, afin de valider ce document ou d'obtenir des produits drivs. Les tapes dcrites ci-dessous effectuent ces traitements. metadonnees Cette tche permet de crer le fichier de mtadonnes en format texte, qui pourra tre rcupr par le module de gestion. Le fichier produit est dans le dossier xml. html Cette tche permet de gnrer deux versions HTML statiques du document. Une premire, situe dans le dossier html, est une version qui peut tre utilise dans n'importe quel contexte, pour une publication statique. La seconde, semblable mais sans la table des matires dynamique, est une version destine l'impression, et elle sera utilise par le module de publication. Elle se trouve dans le dossier html/sdx. Toute cette opration est effectue une seconde fois, pour produire deux versions en format XHTML. Ces versions sont parfaitement en phase avec les standards du W3C, avec notamment des quations mathmatiques incluses en format MathML, et le navigateur Mozilla permet de les consulter aisment. Ces versions sont dans le dossier xhtml. pdf Cette tche permet de gnrer une version PDF du document, qui sera place dans le dossier pdf. web Cette tche permet de crer l'ensemble des documents qui seront utiliss par le module de publication (version XML TELite, version HTML pour impression, version PDF). Les principales oprations connatre La section prcdente dcrit toutes les tapes de conversion, mais les outils prvoient galement des oprations, qui sont des squences de tches permettant d'effectuer un traitement, depuis un point de dpart (par exemple le document source) vers un point d'arrive (le document de rfrence par exemple). Le fichier bin/taches.xml dans le dossier d'installation du module de conversion (ou le fichier src/oo-vers-tei/bin/taches.xml dans les sources Cyberdocs) constitue la rfrence ultime des oprations de conversion (et des tapes galement), mais nous reprenons les principales informations ici. En dbut d'item, en caractre gras, se trouve le nom de la tche ANT qui effectue l'opration. tout : Traitement complet, depuis la source vers le document de rfrence, ainsi que les produits drivs. Prodution du document de rfrence : document-reference : depuis le document de traitement de texte
depuis-oo : depuis le document OpenOffice.org depuis-xslt-01 : depuis la fin de la premire tape de transformation XSLT depuis-xslt-02 : depuis la fin de la seconde tape de transformation XSLT depuis-xslt-03 : depuis la fin de la troisime tape de transformation XSLT depuis-xslt-04 : depuis la fin de la quatrime tape de transformation XSLT validation : validation du document de rfrence
A partir du document de rfrence : produits-derives : gnration de tous les produits drivs metadonnees : gnration d'un fichier de mtadonnes minimal en format texte html : gnration des versions HTML et XHTML statiques pdf : gnration des versions PDF web : production de tous les fichiers ncessaires pour le module de publication
3.2.3.2. travail
Prparer
un
espace
de
Chapeau : Les dossiers et documents prparer avant d'utiliser d'appliquer les oprations du module de conversion sur un document. Afin de simplifier le nombre de paramtres lors d'une opration de conversion, le module de conversion a t programm en fonction d'une structure de rpertoires prcise. De plus, les documents qu'il va produire seront toujours situs dans les mmes rpertoires par rapport au rpertoire de travail d'un document. Nous allons explorer ici l'organisation gnrale du dossier de production puis l'organisation spcifique du dossier d'un document. 1. Organisation du dossier de production Le dossier de production est un dossier nomm production dans le dossier d'installation du module de conversion. Ce dossier contiendra tous les documents convertir, de mme que tous les documents issus du processus de conversion. L'organisation de ce dossier de conversion suit une logique immuable : les documents sont organiss sur trois niveaux, le premier tant une institution, le second une anne d'dition, et enfin le troisime un document traiter. Cette organisation relativement rigide pourrait voluer dans le futur. Exemple 1. Contenu simplifi d'un dossier de production production up.bat up.sh lyon2 lyon2.css 2000 dieng_sa.bat dieng_sa.sh dieng_sa sources dieng_sa-md.xml dieng_sa.css dieng_sa.doc images images-dieng_sa.zip L'exemple ci-dessus nous montre une partie du dossier de production tel qu'il est lorsqu'on installe le module de production. Nous montrons dans cet exemple les fichiers et dossiers relatifs un seul document. Directement dans le dossier de production se trouve un script up. {bat|sh} qui va appeler le script de dmarrage du module de conversion. On voit tout d'abord un premier niveau, le dossier lyon2, qui correspond au code d'institution de l'diteur du document. Ce dossier contient une feuille de style CSS qui lui est spcifique ; cette feuille de style doit tre prsente, quitte copier celle qui est fournie avec la plate-forme. Le nom du fichier doit tre le code de l'institution avec l'extension .css. Au second niveau, on retrouve un dossier 2000 qui correspond cette anne de production. S'y retrouve galement un script dieng_sa.{bat|sh} qui permet de dmarrer la conversion du document dont le code est le mme que le nom du script.
Au troisime niveau se trouve un dossier dieng_sa qui correspond au code du document traiter. Dans ce dossier se trouve un dossier sources ou doit ncessairement se trouver la source traitement de texte convertir. Si ce document possde des illustrations externes, elles doivent tre dans le sous-dossier images, soit regroupes dans un ou des fichiers ZIP ou directement dans ce dossier. Lorsque l'un ou l'autre des tapes de conversion aura t excute, d'autres dossiers et fichiers seront ajouts, mais ils seront tous situs l'intrieur du dossier du document, soit le dossier dieng_sa dans l'exemple ci-dessus. 2. A faire avant de traiter un nouveau document Lorsque l'on souhait traiter un nouveau document, les oprations suivantes doivent tre effectues : S'il s'agit d'un document provenant d'une nouvelle institution, crer un dossier pour cette institution dans le dossier production, et l'intrieur de celui-ci ajouter un feuille de style CSS qui porte le mme nom que le dossier mais avec une extension .css. S'il s'agit d'une nouvelle anne de publication, crer un dossier pour cette anne l'intrieur du dossier de l'institution qui dite le document.
Dans le dossier de l'anne de publication, crer un dossier dont le nom sera l'identifiant du document tout au long de son parcours dans la plate-forme Cyberdocs. Cet identifiant est trs important, et il ne devrait pas contenir de caractres spciaux (accents, ponctuation, etc.). Dans le dossier du document, crer un dossier sources et dposer cet endroit le document traitement de texte qui sera converti. Si vous avez des mtadonnes pour la publication, placer un fichier [identifiant du document]-md.xml dans le dossier sources. S'il y a des illustrations externes au document, crer un dossier images l'intrieur du dossier sources et placer les illustrations cet endroit.
Dans le dossier de l'anne d'dition, copier des scripts d'excution fournis avec les exemples (par exemple essai.{bat|sh} et modifier ces scripts pour y passer les bons paramtres, en particulier l'identifiant du document qui soit tre le second paramtre. Pour cet aspect, une section ultrieure donne plus d'indications. Nous rappelons que si vous avez install le module de gestion, ces manipulations sont grandement simplifies, puisque vous avez seulement demander la cration d'un espace pour un document et ensuite d'y tlcharger les fichiers sources.
3.2.3.3.
Prparer un document
Chapeau : Description et rle des diffrents styles utiliss dans les documents. La plate-forme Cyberdocs est en mesure de traiter tout document traitement de texte. Toutefois, afin de rendre les outils encore plus intressants, une phase de prparation des documents peut tre envisage. Cette phase consiste essentiellement appliquer des styles aux diffrents paragraphes du document, et nettoyer quelque peu leur contenu. Pour Cyberdocs, un style est identifi par un code et non par un nom. C'est pourquoi il est possible d'utiliser des feuilles de styles diffrentes dans le traitement de texte, tout en obtenant un traitement adquat avec le module de conversion. Pour utiliser votre propre feuille de styles, vous devez tout simplement modifier le fichier outils/xslt/utiles/styles.xml pour y inclure les noms de vos styles pour chaque style support par Cyberdocs (voir liste ci-dessous). Liste des styles supports par Cyberdocs
Cette liste donne le code (dfini dans le fichier outils/xslt/utiles/styles.xml), la structure XML produite par la prsence de ce style, ainsi que le nom du style correspondant dans la feuille de styles lyon2. Tableau 1. Liste des styles Code de feuille de Nom correspondant pour la Elment xml correspondant style feuille de style lyon2 auteur <docAuthor> 1|Auteur copyright <titlePart type="copyright"> 1|Copyright dedicace <div type="dedicace"> 1|Dedicace depot <docDate> 1|Depot dept <titlePart type="dept"> 1|Dept directeur <titlePart type="directeur"> 1|Directeur discipline <titlePart type="discipline"> 1|Discipline ecole-doct <titlePart type="ED"> 1|EcoleDoct epigraphe <epigraph> 1|Epigraphe faculte <titlePart type="faculte"> 1|Faculte grade <titlePart type="grade"> 1|Grade jury <titlePart type="jury"> 1|Jury no-officiel <titlePart type="Reference"> 1|NoOfficiel <docTitle>/<titlePart type="sub" sous-titre 1|Sous-titre lang="fr"> titre-front <div type="***"> 1|TitreFront <docTitle>/<titlePart type="main" titre-these 1|TitreThese lang="fr"> universite <titlePart type="univ"> 1|Universite ------------------------------------------------------ann-titre 3|Ann_titre -------ann-titre1**9 <div type="appendix"> 3|Ann_titre1**9 bibli-item <bibl> 3|Bibli_item ------------------------------------------------------bibli-tit 3|Bibli_tit -------bibli-tit1**4 <div type="bibl"> 3|Bibli_tit1**4 citation <q rend="block"> Citation citation-bloc1**2 <q rend="block"> CitatioBloc1**2 closer <closer> closer conclu <div type="conclusion"> Conclu entree <list type="gloss">/<item> Entree figure <figure> Figure intro <div type="***"> Intro legende-fig <* id="fig">/<head> LegendeFig legende-tab <* id="tab">/<head> LegendeTab ------------------------------------------------------liste-num ListeNum ----------liste-num1 <list type="ordered">/<item> ListeNum1 liste-num2 <list type="ordered">/<item> ListeNum2 ------------------------------------------------------liste-puce ListePuce ----------liste-puce1**8 <list type="bulleted">/<item> ListePuce1**8
Code de feuille de Elment xml correspondant style liste-simple <list type="simple">/<item> liste-titre <list>/<head> partie <div type="part"> source <note place="interlinear"> caption <head> heading1**9 <div>/<head> image-ligne <figure> image-tab <figure>
Nom correspondant pour la feuille de style lyon2 ListeSimple ListeTitre Partie Source Caption heading 1**9 ImageLigne ImageTab
3.2.3.4.
Effectuer une conversion
Chapeau : Les scripts excuter pour convertir un document, ainsi que leurs paramtres potentiels. Le module de conversion peut tre utilis l'aide d'une cascade de scripts qui s'appellent les uns les autres. Le plus simple est de copier un exemple existant, mais nous allons prsenter ici les dtails en rfrence. La cascade peut tre schmatise ainsi : Un script spcifique un document appelle un script gnral de conversion en lui passant des paramtres qui dterminent o se trouvent les documents convertir. Le script gnral de conversion appelle le script de dmarrage de ANT en spcifiant la tche excuter ainsi que des variables d'environnement qui correspondent aux paramtres du script prcdent contextualiss. Le script de dmarrage de ANT va prparer l'environnement Java en dfinissant un CLASSPATH appropri, puis va dmarrer une machine virtuelle Java en lui demandant d'excuter ANT.
Comme on peut le constater, seul le premier script doit tre modifi lorsqu'on traite un nouveau document ; les deux autres sont gnriques et n'ont pas tre modifis d'un document l'autre. C'est pourquoi, lors de la prparation d'un document, il est seulement ncessaire de copier un script spcifique un document et de le modifier pour passer les bons paramtres. 1. Le script de dmarrage de ANT Ce script est correspond au fichier outils/bin/oo-vers-tei.{bat|sh} dans le dossier d'installation du module de conversion. Ce script va lui-mme appeler le script ant.{bat|sh} qui est fourni avec ANT. Si on regarde la ligne de commande principale de ce script, on remarque qu'elle est trs simple : call ant -logger org.cyberdocs.ant.HTMLLogger -buildfile oo-vers-tei.xml %1 %2 %3 %4 %5 %6 %7 %8 %9 Essentiellement, le script dfinit deux paramtres importants et passe les autres paramtres qu'il reoit. Ces deux paramtres sont : -logger Il s'agit du type de journalisation (logging) que l'on souhaite obtenir. En effet, afin de rendre le module de gestion trs intuitif et auto-document, un type de journalisation spcifique la plate-forme Cyberdocs, en format HTML, a t dfini. C'est d'ailleurs celui qui est utilis par dfaut, tel qu'on le voit dans l'exemple ci-dessus. Si on souhaite utiliser le type de journalisation
par dfaut (qui consiste sortir des messages standards en format texte), on peut supprimer la partie -logger org.cyberdocs.ant.HTMLLogger dans cette commande. -buildfile ANT fonctionne partir d'un document XML o se trouvent toutes les tches possibles et leurs dpendances. Ce paramtre permet de le spcifier, et dans le cas de Cyberdocs il n'y aucune raison de le modifier. Sauf pour modifier le type de journalisation, il n'y a donc aucune raison de modifier ce script. 2. Le script gnrique de conversion Ce script est le fichier production/up.{bat|sh} situ dans le dossier d'installation du module de conversion. Ce script va appeler le script de dmarrage de ANT avec une commande telle que celle-ci : call oo-vers-tei.bat "-Ddossier.production=..\..\production" "-Dnom.fichier=%2" "-Dcode.institution=%3" "-Dcode.doc=%4" "-Dcode.styles=%5" "-Dlangue.doc=%6" "-Dannee.soutenance=%7" %1 Dans cet exemple, la ligne de commande a t scinde en plusieurs lignes pour faciliter la lecture. Comme on peut le constater, ce script va envoyer essentiellement des paramtres de la forme -D[nom du paramtre]=[valeur du paramtre]. Cette syntaxe est importante, car elle est exploite lors du dmarrage de Java et permet de spcifier des variables d'environnement. Ces variables peuvent ensuite tre exploites dans un script ANT, ce qui est effectivement le cas dans outils/bin/oo-vers-tei.xml. Ainsi, si vous voulez envoyer d'autres paramtres au script ANT, ou mme si vous voulez redfinir des proprits utilises dans ce script, vous pouvez le faire la ligne de commande comme dans l'exemple ci-dessus, sans modifier le fichier outils/bin/oo-vers-tei.xml. Pour en savoir plus, consulter la documentation de ANT. La signification de ces variables d'environnement sera indirectement explique dans la section suivante. 3. Le script spcifique un document Ce script est par exemple le fichier production/lyon2/2002/essai.{bat|sh}. La principale ligne de commande est semblable celle-ci : call up.bat tout essai.doc lyon2 essai lyon2 fr 2002 On voit donc que ce script ne fait qu'appeler le script gnrique, en lui passant sept paramtres qui sont : tout est lune des tches du module de conversion, tel qu'expliqu dans une autre section ou dtaill dans le fichier outils/bin/taches.xml dans les sources Cyberdocs. essai.doc est le nom de fichier du document convertir, fichier qui doit se trouver dans le dossier sources. lyon2 est le code de linstitution qui dite le document, et doit donc correspondre au nom d'un dossier parent. essai est l'identifiant du document, ce qui doit correspondre au nom du dossier propre ce document. lyon2 (le second) reprsente le code de feuille de styles utilise, et ce code doit tre dfini dans le fichier outils/xslt/utiles/styles.xml. fr est le code ISO de la langue principale du document.
2002 correspond lanne de publication du document, ce qui doit correspondre au nom du dossier o se trouve le dossier du document.
Afin que le script fonctionne correctement, il faut veiller ce que l'ordre de ces arguments ne soit pas modifi.
3.2.3.5.
Rsultats de la conversion
Chapeau : Description des diffrents documents et fichiers produits lors de la conversion d'un document. A la suite d'une opration de conversion, un certain de nombre de fichiers et de dossiers seront ajouts ; ces fichiers et dossiers se retrouvent tous l'intrieur du dossier du document, et toujours l'extrieur du dossier contenant les sources (dossier sources. Voici quelques informations propos de ces dossiers et de leur contenu. Le rpertoire oo contient le rsultat de la conversion du document traitement de texte par OpenOffice.org. Le rpertoire prod lui mme dcoup en 4 sous-rpertoires : 01, 02, 02-bis, 03, contenant respectivement le rsultat de la conversion aprs les premire (01), deuxime (02 et 02-bis) et troisime (03) tapes de conversion. Un rpertoire xml contenant : o le document final, rsultat de la conversion, au format xml (dans notre exemple dieng_sa.xml) o la DTD TEILite associe o un fichier texte contenant quelques mtadonnes (dans notre exemple dieng_sa-meta-auto.txt) o un fichier notes.xml contenant les notes de bas de page du document, ce document tant utilis par le module de publication pour optimiser l'affichage. o un fichier config.xml indiquant des informations de configuration pour ce document, essentiellement pour l'instant le nombre de niveaux de la table des matires o le fichier de mtadonnes XML situ au dpart dans le rpertoire sources (dans notre exemple dieng_sa-md.xml) o un fichier Javascript tocTab.js contenant la table des matires du document o un rpertoire ressources dans lequel sont stockes les images du document o un rpertoire formules contenant les formules prsentes dans le document au format MathML. Le rpertoire html contient une version HTML statique du document, la page de dpart tant index-frames.html, et des versions HTML imprimables - du document et de ses parties - dans le sous-rpertoire sdx. Le rpertoire xhtml contient une version XHTML statique du document, avec les mmes remarques que pour la version HTML. Le rpertoire pdf contient une version PDF du document et de ses parties, en plus des fichiers XSL-FO qui ont servi les produire.
Parmi tous ces fichiers, un certain nombre peuvent tre supprim aprs conversion, soit : Le dossier prod car il contient des fichiers de travail pour les tapes intermdiaires de conversion. Les fichiers .fo dans le dossier pdf car ils ont seulement servi produire le PDF.
3.2.4. Module de publication
Le module de publication de la chane Cyberdocs est une application Web dynamique btie avec la plate-forme SDX. Les principales fonctionnalits sont la recherche et la consultation des documents publis. Dans cette documentation, nous allons dcrire brivement les fonctionnalits prsentes et leurs principales caractristiques.
3.2.4.1. des utilisateurs
La gestion et l'identification
Chapeau : La gestion et l'identification des utilisateurs dans SDX et dans le module de publication Cyberdocs en particulier. Le module de publication ncessite une authentification des utilisateurs pour permettre d'ajouter (ou indexer) un document. Dans cette partie, nous prsentons comment crer des utilisateurs et comment s'identifier. Dans la configuration initiale de l'application, il existe un utilisateur qui fait partie du groupe admins : son code est admin et il n'a pas de mot de passe. Comme tous les utilisateurs de ce groupe, il a le droit d'ajouter ou supprimer des documents dans le module de publication. 1) Gestion des utilisateurs Le module de publication ne prsente pas de fonctionnalits propres la gestion des utilisateurs. Pour ce faire, il faut plutt utiliser l'interface d'administration de SDX, qui possde de telles fonctionnalits. Pour y accder, allez l'URL sdx/admin/index.xsp de votre installation SDX (attention, cela peut donner une URL avec deux fois sdx, c'est normal!), puis cliquez sur le bouton Administrer ct de l'application Cyberdocs. Vous pouvez ce moment saisir le code et le mot de passer d'un administrateur (groupe admins) , puis cliquer sur le bouton Identification pour grer les comptes utilisateurs. 2) Identification Pour s'identifier dans l'application Cyberdocs et avoir des privilges administrateurs, il faut aller l'URL identification.xsp de l'application.
3.2.4.2.
La gestion des documents
Chapeau : La dmarche suivre pour indexer et supprimer des documents dans le module de publication. Le module de publication de Cyberdocs est une application SDX. Pour cet outil de recherche, les documents publis n'ont une signification que s'ils sont indexs, c'est pourquoi nous allons parler de l'indexation et de la suppression des documents. Ces fonctions sont bien entendu rserves aux administrateurs de l'application. Pour mettre en place cette restriction, le module de publication utilise les fonctionnalits de gestion des utilisateurs disponibles avec la plate-forme SDX. Pour indexer ou supprimer des documents, vous devez pralablement vous identifier comme un administrateur de l'application. 1) Indexer des documents Ladministrateur de lapplication, une fois identifi, la possibilit de charger (dindexer) les documents, afin qu'ils soient cherchables et consultables via l'application SDX. Pour ce, deux formulaires sont sa disposition, ces deux formulaires tant situs dans la mme page accessible depuis l'URL chargement.xsp : Pour indexer des documents qui sont stocks sur un disque directement accessible par le serveur
Dans ce cas, une zone de texte pr-remplie indique lemplacement du dossier de production du module de conversion. Vous pouvez conserver cette valeur ou la modifie si vos documents sont ailleurs. Il ny a plus qu renseigner le code de l'institution, l'anne de publication et l'identifiant du document. Ces informations doivent correspondre des sous-dossiers dans le dossier de production. Si le document n'est pas disponible en format XML (par exemple s'il est en format PDF), il faut cocher le bouton document non-xml. Pour indexer des documents situs sur un serveur distant:
Dans ce cas, il faut saisir compltement ladresse URL complte du document XML, par exemple http://monserveur.org/mes-documents/essai/xml/essai.xml. Sil sagit d'un document non disponible en format XML, il faut fournir l'URL de son fichier de mtadonnes, par exemple : http://monserveur.org/mes-documents/essai/xml/essai-md.xml. Il est noter qu'il est ncessaire que le document soit situ dans un dossier qui respecte la strucure du dossier xml produit par le module de conversion. 2) Supprimer des documents Un administrateur peut supprimer un document index, cela ayant pour consquence qu'il ne peut plus tre trouv par une recherche ni afficher. Pour supprimer, il suffit de cliquer sur la petite croix qui apparat ct d'un document dans un rsultat de recherche ; vous devez donc
pralablement effectuer une recherche, par la mthode qui semble la plus opportune, pour trouver le document supprimer.
A noter que ce bouton de suppression n'est disponible que pour les documents complets, par pour les parties de documents (les chapitres par exemple). Par contre, si on supprime un document, toutes ses parties sont galement supprimes, pour conserver ainsi toute la cohrence souhaite.
3.2.4.3. L'utilisation mtadonnes du document
des
Chapeau : Le format de mtadonnes attendu par le module de publication et les traitements effectus avec ces informations. Les mtadonnes associes au document sont exploites par le module de publication, et elles lui sont mme essentielles. Peu importe comment elles sont produites (le module de gestion inclut une interface Web pour les saisir), elles doivent tre sous la forme d'un document XML et ce document doit tre dans un fichier situ dans le mme dossier que le document XML principal, et ce fichier doit avoir le mme nom que le document principal, mais avec un -md avant le .xml. Les lments de mtadonnes font partie du Dublin Core Metadata Element Set ou du Metadata Standard for Electronic Theses and Dissertations (ETDMS). D'autres formats pourraient ventuellement tre supports. 1) Utilisation des mtadonnes Les mtadonnes sont exploites de diffrentes manires par le module de publication :
La fiche sommaire du document, que l'on peut afficher dans sa propre fentre, est cre partir des mtadonnes.
Les rsultats de recherche sont constitus partir des mtadonnes. La plupart des champs de recherche du formulaire de recherche avance exploitent
l'une ou l'autre des mtadonnes.

La fourniture d'information par un entrept OAI se fait partir des mtadonnes.
2) Format des mtadonnes L'exemple ci-dessous constitue une rfrence pour les mtadonnes traites par Cyberdocs. Exemple 1. Mtadonnes supportes par Cyberdocs <doc  xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:dcterms="http://purl.org/dc/terms/" xmlns:md-cyb="http://cyberdocs.org/md/1.0"
xmlns:etdms="http://www.ndltd.org/standards/metadata/etdms/1.0/" >  <md-cyb:identifiant>lyon2.2002.essai</md-cyb:identifiant>  <md-cyb:identifiant-doc>essai</md-cyb:identifiant-doc> <md-cyb:annee>2002</md-cyb:annee> <md-cyb:code-institution>lyon2</md-cyb:code-institution>  <md-cyb:plate-forme>Plate-forme [http://sourcesup.cru.fr/cybertheses/]</md-cyb:plate-forme>  <md-cyb:version-plate-forme>1.0</md-cyb:version-plate-forme>  <dc:creator>Kim Danire, Viviane Boultreau</dc:creator>  <dc:title xml:lang="fr">Test de la nouvelle chaine</dc:title>  <dcterms:alternative xml:lang="en">Test</dcterms:alternative>  <dc:contributor etdms:role="directeur">Sous direction</dc:contributor> notre propre / diffuser le
CybertThses
 <dc:contributor etdms:role="jury">Martin Svigny</dc:contributor> <dc:contributor etdms:role="jury">Jean-Paul Ducasse</dc:contributor>  <etdms:degree>  <etdms:level>Thse pour obteniur le grade de CyberThseur</etdms:level>  <etdms:discipline>Discipline : Edition Electronique</etdms:discipline>  <etdms:grantor md-cyb:role="universite">Universit Lumire Lyon 2</etdms:grantor> <etdms:grantor md-cyb:role="ecole-doctorale">Ecole Doctorale tagada</etdms:grantor> <etdms:grantor md-cyb:role="faculte">Division ERAD</etdms:grantor> <etdms:grantor md-cyb:role="departement">Cellule Edition Electronique</etdms:grantor> </etdms:degree>  <dcterms:dateAccepted>2002-11-27</dcterms:dateAccepted>  <dcterms:abstract xml:lang="fr">Un rsum en franais</dcterms:abstract> <dcterms:abstract xml:lang="en">An English abstract</dcterms:abstract>
 <dc:subject xml:lang="fr">[Test ; conversion ; cyberthses]</dc:subject>  <dc:publisher>CyberThses</dc:publisher>  <dc:format>text/xml</dc:format>  <dc:language>fr</dc:language>  <dc:right md-cyb:role="copyright">[Copyright Lumire Lyon 2</dc:right> 2002 CyberThses Universit
< !--valeurs possibles pour la diffusion : rien ou [intranet]--> <dc:right md-cyb:role="diffusion"></dc:right> <dc:right md-cyb:role="commentaires-diffusion"> [Cette thse est en accs restreint pour protger la vie prive des personnes qui sont mentionnes]</dc:right>  <dc:identifier>http://localhost:8080/sdx/pcd/lyon2/2002/essai</dc:identifier>  <dcterms:temporal xml:lang="fr"/>  <dcterms:spatial xml:lang="fr"/>  <dcterms:extent>[13416]</dcterms:extent> </doc>
3.2.4.4. documents
La
consultation
des
Chapeau : Informations sur la fentre de consultation des documents et ses diffrentes options. Le module de publication de Cyberdocs inclut une fonction de consultation relativement sophistique, particulirement adapte la consultation de documents longs et structurs, par exemple des thses de doctorat. Nous allons expliquer les principes derrire cette mthode de consultation, de mme que les diffrentes fonctionnalits associes la consultation. 1) Les modes de reprsentation des documents Dans le module de publication Cyberdocs, ces diffrents modes de consultation des documents sont disponibles :
Un format bref, utilis dans les rsultats de recherche, qui contient les principales
coordonnes bibliographiques du document (titre, auteur, date de publication, etc.).

Les mtadonnes du document, affiche dans une fentre spcifique sous la forme d'un
tableau.
Des versions pour impression des documents. La fentre de consultation structure du document et de ses parties.
Dans cette partie de la documentation, c'est seulement ce dernier mode qui nous intresse ; pour les autres aspects vous tes invits suivre les liens respectifs pour consulter d'autres parties de la documentation. 2) La fentre de consultation de structure La fentre de consultation structure est divise en trois cadres. Le cadre suprieur prsente les informations bibliographiques principales du document, des informations sur la recherche effectue pour arriver ce document, de mme qu'un formulaire de recherche simple. A noter qu'il s'agit d'une fentre spcifique cette fonctionnalit dans le module de consultation. Ainsi, lorsqu'une recherche est effectue et que l'on souhaite consulter un document, celui-ci s'affiche dans une fentre diffrente de celle des rsultats. Toutefois, tous les documents sont consults dans la mme fentre, pour viter une multiplicit des fentres ouvertes. 2.1) Le cadre des informations bibliographiques Les informations fournies dans ce cadre proviennent des mtadonnes associes au document. Ce cadre offre galement des fonctionnalits de recherche et de navigation dans le document prsent. Premirement, les mots recherchs sont mis en vidence dans le document prsent. Si on veut passer d'une occurrence d'un mot recherch une autre, il suffit d'utiliser les deux boutons prvus cet effet :
Ensuite, vous pouvez galement effectuer une recherche dans le document ou l'une des ses parties en utilisant le formulaire de recherche simple que l'on retrouve dans ce cadre :
Cela aura pour effet de prsenter une liste de rsultats dans le cadre du document, rsultats qui ne contiendront que des parties du document que vous consultez. 2.2) Le cadre de table des matires Le cadre de table des matires se situe dans la partie gauche de la fentre de consultation. Il offre une table des matires interactives qui permet de slectionner rapidement, en pliant ou dpliant des parties, la section du document que l'on souhaite consulter. Normalement, trois tables des matires diffrentes sont prsentes : 1. Une table des matires construite partir des titres du document. 2. Une table des illustrations, construite partir des titres d'illustrations. 3. Une liste des tableaux, construite partir des titres de tableaux. 2.3) Le cadre du document Le cadre principal, situ dans la partie droite de la fentre, permet de lire le document. A noter que si vous cliquez sur l'icne situ au dbut d'un titre, la table des matires sera synchronise, c'est--dire que le titre en question sera affich dans le cadre de table des matires.
3.2.4.5.
La recherche
Chapeau : Les diffrents modes de recherche, la manire de les utiliser, le type de rsultats attendus. La recherche constitue une fonctionnalit centrale dans le module de publication. Il existes essentiellement quatre faons d'effectuer des recherches, que nous prsentons ci-dessous. Peu importe la manire de les effectuer, les rsultats de recherche se prsentent toujours sous la mme forme. 1) Recherche simple La recherche simple est celle qui consiste utiliser la zone de texte prsente en haut de chaque page pour y exprimer une requte de recherche. La plupart du temps, cette requte sera constitue d'un ou plusieurs mots, mais un langage de recherche plus volu est en fait disponible. Par exemple, si vous effectuez la recherche afrique agriculture, les deux mots ne seront pas obligatoires (OU boolen implicite) mais si vous effectuez la recherche afrique +agriculture, le mot agriculture sera obligatoire. Lorsqu'on effectue de telles recherches, la zone de recherche est le texte intgral des documents. 2) Recherche avance On accde la recherche avance en cliquant sur le lien Recherche avance situ dans le bandeau suprieur de chaque page. On obtient alors un formulaire qui permet de saisir plusieurs critres de recherche et de les relier par les oprateurs boolens ET ou OU. Les premires zones du formulaire permettent de saisir des mots et de les rechercher dans les principales mtadonnes des documents. Ensuite, les zones suivantes permettent de recherche dans des index prcis. 3) Recherche par listes La recherche par listes consiste rechercher des documents en obtenant une liste en fonction de certains critres. Pour l'instant, le seul critre disponible est Universits et facults, particulirement bien adapt pour les thses. Pour activer cette liste, il s'agit de choisir cette entre dans le menu droulant intitul Choisir un index, prsent dans le haut de toutes les pages. Le rsultat sera une liste d'universits et de facults, et pour chacune les documents qui y sont publis. 4) Recherche dans un document Lorsqu'on consulte un document, on a la possibilit d'effectuer une recherche l'intrieur de ce document seulement. Pour ce faire, il suffit d'utiliser la zone de texte dans le cadre suprieur de la fentre de consultation des documents. On peut y effectuer des recherches de la mme manire que pour la recherche simple prsente ci-dessus. Les rsultats seront prsents dans le cadre principal de consultation du document.
3.2.4.6.
Les rsultats de recherche
Chapeau : Informations au sujet de la page de prsentation des rsultats de recherche, de la navigation dans ces rsultats, etc. Les rsultats de recherche sont toujours prsents de la mme manire, que l'on arrive de la recherche simple, la recherche avance, les listes ou la recherche dans un document. Pour chaque rsultat de recherche, une reprsentation sommaire du document incluant les informations suivantes :
L'auteur du document Le titre du document, et ses ventuels sous-titres
L'anne de publication L'diteur (par exemple l'universit de soutenance pour les thses) L'adresse du document
Cette dernire information, l'adresse, est cliquable pour accder la fentre de consultation. Ensuite, gauche de cette prsentation sommaire, on retrouve le numro de ce rsultat dans la liste, de mme qu'un lien pour consulter la fiche (mtadonnes) et un autre pour consulter le document.
3.2.4.7. impression
Les
versions
pour
Chapeau : Comment identifier des versions pour impression des documents, et aussi comment les obtenir l'cran. On peut obtenir, depuis le module de publication, des versions pour impression des documents que l'on consulte. Pour ce faire, on doit aller dans la fentre de consultation du document, puis cliquer sur l'icne en forme d'imprimante en haut droit de la fentre. On obtient alors une fentre qui nous permet de choisir le document entier ou la partie du document envoyer, de mme que le format (HTML ou PDF). Il ne reste plus qu' utiliser les possibilits d'impression de votre navigateur et de votre poste de travail.
3.3.
Aide aux dveloppeurs
3.3.1. Signaler des bogues

Tout signalement d'erreurs est bien videmment le bienvenu ! Pour cela, nous souhaitons que les discussions se fassent par l'intermdiaires des listes de discussions. Vous n'avez pas besoin d'tre un dveloppeur confirm pour signaler des erreurs : des problmes dans la documentation, des soucis d'installation ou de conversion de document, des liens errons sur notre site... les amliorations de Cyberdocs ne peuvent se faire sans ses utilisateurs.
3.3.2. Contribuer Cyberdocs

Pour contribuer au dveloppement de la plate-forme, vous devriez d'abord vous faire connatre auprs de la communaut des dveloppeurs en vous abonnant la liste de discussions cybertheses-dev. Un formulaire en ligne vous permet de le faire aisment.
3.4.
Tlchargements de Cyberdocs
4. Tlchargement
Cyberdocs est un logiciel libre qui peut tre tlcharg sur Internet. Pour les impatients, voici les deux liens essentiels pour rcuprer la plate-forme, que ce soit une version distribue ou les dernires sources : Tlcharger une distribution officielle de Cyberdocs Rcuprer les dernires sources avec Subversion
4.1.
Distributions de Cyberdocs
Le site de dveloppement collaboratif Sourcesup hberge le projet Cyberdocs et propose par le fait mme une page o l'on peut tlcharger les diffrentes distributions de la plate-forme. Cette page est disponible depuis l'onglet Fichier sur le site Sourcesup. Cette page de tlchargement propose les diffrentes versions qui sont encore disponibles au tlchargement. Pour chaque version, diffrents formats pourront tre accessibles, ou diffrents paquets. Dans tous les cas, il est recommand dinstaller la dernire version disponible : le support et la documentation des anciennes versions ne sont plus assurs.
4.2.
Rcuprer les sources avec Subversion
Subversion est un logiciel de gestion de versionnement de sources. Les dveloppeurs du projet Cyberdocs utilisent cet outil pour faciliter leur collaboration et la saine volution des diffrentes versions de la plate-forme. Au-del de cette utilisation en dveloppement, tout utilisateur intress par les dernires sources de Cyberdocs peut le faire en utilisant un logiciel client Subversion. Dans cette page, nous fournissons quelques informations sur Subversion, de mme que les paramtres utiliser pour rcuprer les sources Cyberdocs, et enfin un exemple avec le logiciel TortoireSVN sous Windows. A propos de Subversion Pour en savoir plus sur cet outil, nous vous proposons de lire l'articile correspondant dans l'encyclopdie Wikipedia. Vous y trouverez des explications sur l'origine de l'outil, sur les principales commandes disponibles, ainsi que des liens vers diffrents logiciels qui permettent de travailler avec Subversion. Nous vous suggrons galement de lire une page d'aide sur Subversion maintenue par le Comit Rseau des Universits (CRU, France), l o sont hberges les sources Cyberdocs. Si vous ne souhaitez que rcuprer les sources de Cyberdocs, vous pouvez passer aux sections suivantes qui fournissent toutes les informations ncessaires. Paramtres Subversion de Cyberdocs Sur le site Sourcesup o sont hberges les sources de Cyberdocs, l'onglet Subversion fournit les informations ncessaires pour accder aux sources Cyberdocs via Subversion. Pour un accs en mode anonyme, qui permet uniquement de rcuprer les sources, et non de les modifier, vous devez utiliser l'adresse suivante avec votre logiciel clien Subversion : checkout http://subversion.cru.fr/cyberdocs Selon l'outil que vous utilisez, la procdure exacte sera diffrente. Par exemple, si vous travaillez en mode ligne de commande, la commande sera : svn checkout http://subversion.cru.fr/cyberdocs [dossier_local] O [dossier_local] est le chemin du dossier o vous souhaitez copier les sources sur votre ordinateur. Utiliser TortoiseSVN avec Windows
Le logiciel TortoiseSVN est un outil qui s'intgre l'explorateur Windows et qui vous permet d'utiliser trs facilement toutes les fonctionnalits de Subversion en mode graphique. Voici la procdure suivre pour installer TortoiseSVN puis pour rcuprer les sources Cyberdocs. Tlcharger et installer TortoiseSVN Une page de tlchargement vous permet de rcuprer la dernire version. Vous devez tlcharger l'installateur, et ensuite le language pack en franais pour obtenir une interface en franais. L'installation est simple partir de l'installateur. A noter que vous devrez redmarrer votre ordinateur pour bnficier des icnes spcifiques installes par TortoiseSVN. Rcuprer Cyberdocs avec TortoiseSVN Nous allons considrer que vous rcuprez les sources pour la premire fois. D'abord, vous devez crer un nouveau dossier sur votre ordinateur, qui contiendra les sources Cyberdocs. Une fois cela fait, avec votre explorateur Windows, cliquez sur le dossier avec le bouton droit de la souris et vous obtiendrez un menu contextuel semblable celui-ci : Dans le menu contextuel, cliquer sur l'entre SVN Extraire... et vous obtiendrez une fentre telle que celle-ci : (Image) Dans la zone URL du rfrentiel, vous devez saisir la valeur suivante : http://subversion.cru.fr/cyberdocs/trunk Dans la zone Extraction du rpertoire, le chemin du dossier o vous avez cliqu sera inscrit et vous pouvez le conserver. Pour les autres paramtres, les valeurs par dfaut sont correctes, et sont celles illustres dans l'image prcdente. Une fois ces informations fournies, vous n'avez qu' cliquer sur le bouton OK et la rcupration des sources va dbuter. Une fentre vous indiquer en permanence o vous en tes. Mettre jour les sources avec TortoiseSVN Si jamais vous avez dj rcupr les sources Cyberdocs et que vous voulez les mettre jour (par exemple si les dveloppeurs ont apport des changements), vous pouvez utiliser l'explorateur Windows pour dmarrer TortoiseSVN, un peu comme lors de la rcupration initiale des sources. Avec l'explorateur, ouvrez le dossier racine o se trouve les sources Cyberdocs. Puis vous cliquez avec le bouton droit de la souris, et vous obtiendrez un menu contextuel tel que celuici : (Images) Cette fois, dans le menu contextuel, choisissez l'entre SVN Mettre jour et TortoiseSVN se chargera de vrifier sur le serveur si des nouvelles sources sont disponibles (ajouts ou modifications) et il les rcuprera.
5. Listes
La collaboration entre les diffrents participants Cyberdocs ou Cyberthses se fait travers plusieurs listes de discussion. Toutes ces listes sont hberges par le CRU, elles fonctionnent avec le logiciel multilingue Sympa, leur archivage est ralis par le logiciel MhOnArc. Les listes de discussions constituent le moyen privilgi d'entrer en contact avec les
communauts Cyberdocs ou Cyberthses, et toutes les questions ou remarques devraient d'abord passer par l'une ou l'autre de ces listes. Toutes les listes relies Cyberdocs et Cyberthses sont accessibles depuis une mme page gre par Sympa. En accdant la page d'accueil d'une liste, vous pourrez effectuer diffrentes oprations, en particulier vous abonner, vous dsabonner et consulter les archives de la liste. Veillez noter qu'il est fortement conseill de consulter les archives d'une liste avant d'y poser des questions. Le reste de cette page vous expliquera le rle et les modalits propres chaque liste de discussions associe au projet. Nous vous invitons bien lire les objectifs de chaque liste avant d'envoyer un message, pour tre certain de choisir la bonne liste, la plus pertinente pour la question poser ou la remarque effectuer. 1) cybertheses-users Cette liste est destine aux utilisateurs de la plateforme. Y sont abordes toutes les questions relatives au traitement des documents par la plateforme Cyberdocs : stylage, traitement, comprhension des messages d'erreur, etc. Page d'accueil de la liste S'abonner la liste Arrter son abonnement la liste Consulter les archives de la liste Envoyer un message sur la liste : cybertheses-users@cru.fr 2) cybertheses-tech Cette liste de discussion technique est destine aux personnes qui doivent installer, grer et maintenir une plateforme Cyberdocs, et qui donc sont susceptibles d'tre intresss par ses aspects techniques : comment a marche, comment l'adapter ou la personnaliser, comment rgler les problmes d'installation ou de paramtrage, etc. Page d'accueil de la liste S'abonner la liste Arrter son abonnement la liste Consulter les archives de la liste Envoyer un message sur la liste : cybertheses-tech@cru.fr 3) cybertheses-dev Cette liste est accessible en consultation tout un chacun, son contenu est essentiellement technique puisque c'est l que les personnes participant activement aux dveloppements de Cyberdocs s'entre-aident, changent leurs informations, trucs et astuces, bouts de programmes, etc. L'abonnement est possible, mais il doit auparavant tre autoris par un des gestionnaires du projet. Page d'accueil de la liste S'abonner la liste Arrter son abonnement la liste Consulter les archives de la liste Envoyer un message sur la liste : cybertheses-dev@cru.fr 4) cybertheses-latex Ce groupe a pour objet lintgration de loutil LXir qui permet une entre LaTeX la chane de conversion de la plateforme Cyberdocs, en particulier pour le projet Cyberthses.
Page d'accueil de la liste S'abonner la liste Arrter son abonnement la liste Consulter les archives de la liste Envoyer un message sur la liste : cybertheses-latex@cru.fr 5) cybertheses-multilingue Ce groupe de travail anim par Gabriela Ortzar de l'Universidad de Chile, va aborder le thme de l'amlioration de l'accs aux ressources CyberThses travers l'intgration de bases de donnes d'autorits multilingues. Page d'accueil de la liste S'abonner la liste Arrter son abonnement la liste Consulter les archives de la liste Envoyer un message sur la liste : cybertheses-multilingue@cru.fr
6. FAQ
Voir : http://www.cyberdocs.org/fr/faq
7. Contacts
Service Gnral de la Recherche et des Ecoles doctorales - ERAD 86 rue Pasteur 69007 Lyon FRANCE For any information, please write to: cybertheses@univ-lyon2.fr

Cyber Docs

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Cyber Docs

Uploaded by

Copyright:

Available Formats

Cyberdocs Documentation

Universit Lyon 2 - 2009

Table des matires

3.2. Aide aux utilisateurs...........................................................................................................................25

3.3. Aide aux dveloppeurs.......................................................................................................................54

3.4. Tlchargements de Cyberdocs.........................................................................................................54

3.1.1. Les pr-requis matriels

3.1.2. Les pr-requis logiciels

3.1.3. Les composants sous-jacents

3.1.4. Tlcharger Cyberdocs

3.1.5. Installation tape par tape

Installation des modules

3.1.5.3.1. module de conversion

3.1.5.3.2. module de gestion

3.1.5.3.3. module de publication

3.1.6. Personnaliser cyberdocs

Ajout d'un nouveau code de

Conversion dans une autre

Les feuilles de styles CSS

Publier d'autres documents

Modifier l'application Web

3.1.6.9. Lier installer le module JK

Utiliser une base MySQL

Au dbut du noeud <sdx:userDocumentBase> , ajoutez : <sdx:database type="MYSQL" dsi="id_mysql"/>

3.1.6.11. Intgrer publication votre site web

Voici les conditions pour utiliser ces sources remodifies :

Modifier vos mtadonnes

Aide aux utilisateurs

3.2.1. Approche technologique

3.2.2. Convertir un document via le module de gestion

Sidentifier sur Cyberdocs

Crer un espace pour une

3.2.2.3.2. Saisie mtadonnes (onglet Mtadonnes)

Conversion (onglet Traitements)

3.2.2.3.4. rsultat de la conversion

Les points vrifier en particulier sont les suivants :

3.2.3. Convertir un document sans le module de gestion : en ligne de commandes

Effectuer une conversion

3.2.4. Module de publication

3.2.4.1. des utilisateurs

La gestion des documents

3.2.4.3. L'utilisation mtadonnes du document

l'une ou l'autre des mtadonnes.

coordonnes bibliographiques du document (titre, auteur, date de publication, etc.).

Les rsultats de recherche

Aide aux dveloppeurs

3.3.1. Signaler des bogues

3.3.2. Contribuer Cyberdocs

Rcuprer les sources avec Subversion

You might also like