La version 2 de Pleade n'est plus officiellement développée par Anaphore et AJLSM. Si des bogues bloquants sont constatés, ils pourront toutefois être corrigés.

Nous encourageons tous les utilisateurs de Pleade 2 à songer à une migration vers la version 3.

La version 3.1 est disponible depuis le 24 février 2009 sur SourceForge : > > Télécharger...

Voir le site de démonstration de Pleade 3 : > > Démonstration de Pleade 3

Plus d'information sur Pleade 3 : http://pleade.com/

Organisation des sources

PLEADE est une application livrée avec son code source. Les lecteurs ou les éditeurs de contenus d'un site PLEADE ne devraient pas avoir à connaître ou modifier ces sources. Toutefois, il peut être intéressant pour les administrateurs et développeurs, ou tout simplement les curieux, de bien comprendre leur organisation. Dans ce document, nous allons présenter tous les dossiers que l'on trouve dans les sources de PLEADE, avec leur contenu et leur rôle.

1) Dossier racine

Le dossier racine contient les scripts qui permettent d'installer PLEADE depuis les sources, ainsi que certaines autres opérations utiles aux développeurs. Ces scripts utilisent l'utilitaire Ant ru projet Apache. Le fichier pleade.properties contient les valeurs par défaut des propriétés d'installation de PLEADE.

1.1) Dossier bin

Ce dossier contient les scripts génériques de pilotage de Ant.

1.2) Dossier legal

Ce dossier contient les licences de PLEADE et des différents outils livrés avec.

1.3) Dossier lib

Ce dossier contient les librairies Java qui sont nécessaires pour faire fonctionner les outils de compilation et d'installation de PLEADE. On y retrouve essentiellement Ant, Saxon (processeur XSLT) et Xerces (parseur XML).

1.4) Dossier src

Les sources de l'application PLEADE et de sa documentation.

1.4.1) Dossier documentation

La documentation de PLEADE, incluant le fichier source que vous consultez actuellement. Cette documentation est structurée en XML, DTD Docbook, avec un outil de publication réalisé par AJLSM. Cette documentation peut être consultée sur Internet à l'adresse http://www.pleade.org.

1.4.2) Dossier examples

Ce dossier contient des documents EAD qui peuvent vous servir d'exemples pour tester PLEADE.

1.4.3) Dossier tools

Ce dossier contient quelques outils nécessaires pour PLEADE, sans être au coeur de son fonctionnement. Pour l'instant, on y trouve la XSLT qui pilote la transformation de la documentation depuis le format XML vers HTML.

1.4.4) Dossier webapp

L'application Web elle-même, soit le code informatique qui sera exécuté par le serveur pour réaliser les fonctionnalités de PLEADE. La structure de ce dossier est très semblable à la structure finale de l'application qui sera installée sur le serveur SDX. Elle respecte notamment les contraintes imposées par SDX, en particulier la présence d'un dossier conf.

1.4.4.1) Dossier conf

Ce dosser est obligatoire pour une application SDX. Il contient une configuration d'application SDX par défaut pour PLEADE. Cette configuration contient essentiellement des liens vers les parties de configuration que l'on trouve dans le dossier ../pleade-system/sdx-config. Lors de l'installation, le fichier pleade.xconf sera renommé en application.xconf (standard SDX) si un fichier de ce nom n'est pas déja présent.

1.4.4.2) Dossier pleade-local

Ce dossier contient des configurations et autres informations qui sont susceptibles d'être modifiées par les gestionnaires d'installations PLEADE. C'est pourquoi elles sont dans un dossier local. La plupart des fichiers qu'on y trouve sont soit des documents de configuration ou d'information, soit des programmes qui vont importer les programmes systèmes de PLEADE dans le but de surcharger, si nécessaire, les fonctionnalités de base.

De façon générale, l'installation de PLEADE ne va copier ces fichiers que si un fichier d'un nom équivalent n'existe pas sur le serveur.

1.4.4.2.1) Dossier ead-display-formats

Ce dossier contient des informations relatives aux différents formats d'affichage des documents des documents EAD. En particulier, le fichier ead-display-formats.xml qu'on y trouve fournit la liste des formats disponibles, avec un pointeur sur les XSLT qui les implémentent.

1.4.4.2.2) Dossier ead-fragmentation

Dans ce dossier sont présents les fichiers qui décrivent les diverses méthodes de fragmentation des documents (ead-fragmentation.xml) et de la table des matières (ead-toc.xml).

1.4.4.2.3) Dossier sdx-index

Ce dossier contient les transformations XSLT en charge de l'indexation des documents dans SDX. Par défaut, ces transformations ne font qu'importer celles fournies dans ../pleade-system/sdx-index et elles permettent donc de surcharger les méthodes prévues par ces dernières.

1.4.4.2.4) Dossier search-forms

Ce dossier contient les descriptions des fomulaires de recherche avancée livrés avec PLEADE. Il y a un document XML pour chaque formulaire de recherche.

1.4.4.2.5) Dossier subsets

Ce dossier contient les informations à propos des différents systèmes de regroupement qui seront proposés dans un site PLEADE, par exemple les collections, les types de documents, etc. Il y a un fichier par système de regroupement.

1.4.4.3) Dossier pleade-system

Ce dossier contient les fichiers système de PLEADE, c'est-à-dire ceux qui contiennent le coeur du code et qui, logiquement, ne devraient pas être modifiés par les gestionnaires d'un site PLEADE. Ces fichiers sont organisés de manière à bien distinguer leur rôle, mais aussi de manière à pouvoir isoler certains regroupements afin de pouvoir les utiliser dans d'autres contextes que SDX.

Si jamais vous devez modifier l'un de ces fichiers pour réaliser une adaptation de PLEADE, veuillez le signaler aux développeurs.

1.4.4.3.1) Dossier ead

Ce dossier rassemble tous les fichiers relatifs au traitement de documents EAD, en particulier leur affichage. L'idée est de ne rien mettre dans ce dossier qui soit propre à PLEADE ou SDX, afin de faciliter leur réutilisation.

1.4.4.3.1.1) Dossier css

Des CSS pour l'affichage de documents EAD, soit directement en XML, soit transformés en HTML.

1.4.4.3.1.2) Dossier dtd

Les DTD des versions 1 et 2002 de l'EAD. Le dossier contient également un fichier catalog qui permet de référencer les DTD par leur identifiant public.

1.4.4.3.1.3) Dossier html

Des transformations XSLT qui permettent de produire du HTML pour la consultation avec un navigateur Web. Nous ne détaillons pas ici les sous-répertoires que l'on trouve, mais l'idée générale est d'avoir un sous-répertoire par type d'affichage souhaité, le dossier _common étant réservé pour les parties communes réutilisables par différents affichages.

1.4.4.3.1.4) Dossier utils

Des programmes utiliataires concernant l'EAD, qui peuvent être utilisés dans différents contextes : HTML, FO, SDX, etc.

1.4.4.3.2) Dossier forms

Les programmes de traitement des formulaires de recherche avancée.

1.4.4.3.3) Dossier oai-repository/

Les transformations XSLT qui permettent d'extraire les métadonnées pour constituer les enregistrements OAI en 4 étapes (récupération des paramètres propres à OAI, récupération des métadonnées issues d'autres unités documentaires, extraction vers le format Dublin Core qualifié puis vers le Dublin Core simple) ainsi que les schémas XML régissant les formats OAI.

1.4.4.3.4) Dossier sdx-config

Les fichiers de configuration pour une application SDX. Ces fichiers sont en fait des entités externes (au sens XML) et elles sont incluses par le document ../../conf/application-original.xconf.

1.4.4.3.5) Dossier sdx-index

Les transformations XSLT qui permettent d'indexer les documents EAD dans PLEADE, et ce en deux étapes.

1.4.4.3.6) Dossier sitemap

La sitemap Cocoon pour PLEADE, avec la définition des pipelines système de l'outil. Pour ajouter de nouveaux pipelines propres à une installation locale, modifier ../../sitemap-original.xmap.

1.4.4.3.7) Dossier web

Des ressources utilisées pour l'interface Web, en particulier des CSS, Javascript et images. Les sous-dossiers ne seront pas détaillés ici.

1.4.4.3.8) Dossier xsl

Les transformations XSLT utilisées pour générer l'interface Web de PLEADE. Ces XSLT ont généralement pour mandat de transformer la sortie des pages XSP (du XML virtuel) vers un format HTML pour affichage dans le navigateur de l'utilisateur. Le sous-dossier _common contient les XSLT communes importées par la plupart des autres.

1.4.4.3.9) Dossier xsp

Les pages XSP qui implantent la logique applicative de PLEADE, comme les fonctions de recherche ou d'importation. Le sous-dossier logichseets contient les bibliothèques de balises (concept Cocoon) utilisées par PLEADE.

1.4.4.4) Dossier skins

Ce dossier contient les habillages livrés dans la distribution standard de PLEADE. Pour l'instant, un seul habillage est fourni, soit celui nommé default, qui peut servir de base pour un gestionnaire d'une installation locale de PLEADE afin qu'il mette en place un habillage personnalisé.

1.4.4.4.1) Dossier default

L'habillage par défaut de PLEADE.

1.4.4.4.1.1) Dossier css

Les CSS associées à cet habillage. Il doit y avoir au moins une CSS nommée website.css qui sera toujours appelée par les pages HTML. Celle-ci peut importée d'autres CSS si souhaité.

1.4.4.4.1.2) Dossier menubars

Les barres de menus de l'interface souhaitée. PLEADE s'attend à trouver une barre de menus dans le fichier main.xml.

1.4.4.4.1.3) Dossier static

Les pages statiques de l'interface souhaitée. Ces pages sont à organiser dans des dossiers par langue, en utilisant le code ISO de la langue concernée. PLEADE est livré avec un jeu de pages statiques fictives en français et en anglais.

1.4.4.4.1.4) Dossier ui-strings

Les messages d'interface, c'est-à-dire les chaînes de caractères affichées à l'écran par PLEADE, et qui ne proviennent ni des documents EAD gérés ni des pages statiques. Ces messages sont dans des documents XML qui regroupent une certaine thématique qui correspond, de manière générale, à une XSLT qui produit l'interface.

PLEADE est livré avec des messages en anglais et en français.

1.4.4.4.1.5) Dossier xsl

Les XSLT qui permettent de produire l'interface utilisateur. Ces XSLT ne font qu'importer les XSLT systèmes de PLEADE, mais le gestionnaire local à tout le loisir de les modifier pour créer des adaptations de PLEADE pour son site, adaptations qui peuvent aller beaucoup plus loin que les simples couleurs ou polices.


© 2003, 2004, 2005 PLEADE / AJLSM / Anaphore
Des questions ? Des remarques ? Utilisez les listes de discussions ! Vous voulez l'utiliser ? Vous pouvez le télécharger !