Description de la hiérarchie des fichiers
Hiérarchie de fichiers de l'espace de travail
Une fois dézippé (ou après un svn export) le dossier de travail présente la hiérarchie de fichier ci-dessous.
les dossiers :
dbs : [nom et localisation par défaut] Le dossier où seront stockées toutes données manipulées par l'application : dossiers de formation, index pour le moteur de recherche, dépôt OAI, référentiel et description de l'établissement.
docs : Les éléments de documentation (parfois obsolètes mais complétés par ce wiki)
import : le dossier où sont stockés les fichiers au format cdmfr destinés à être importés
lib : la librairie des fichiers jars utiles au fonctionnement de l'application
log : le dossier où seront enregistrés les logs [dossier défini par défaut pouvant être déplacé par une configuration avancée]
source : l'ensemble des classes java qui seront compilées puis déployées sur le serveur tomcat
webpages : le dossier qui contient toutes les ressources qui seront déployées sur le serveur tomcat (les css, les fichiers xsl, ...)
Les fichiers :
build-*.sample.properties : Des exemples de configuration proposées
web-config.sample.properties : exemple de fichier utilisé comme base pour créer le fichier web-config.properties
build.sample.properties : modèle de fichier utilisé pour créer une nouvelle configuration
build.xml : les tâches ant utilisées pour le déploiement et l'administration de l'application
Après exécution de la tâche ant deploy, le dossier cdm est créé dans l'espace de travail esup-uniform et ce dernier est copié dans le dossier webapps du tomcat.
Hiérarchie de fichiers sur le serveur d'application
Voici la hiérarchie des dossiers du répertoire cdm :
Les dossiers :
errors : il contient les fichiers html renvoyés en cas d'erreur d’exécution ou de configuration de l'application. Il provient du dossier webpages
media : le dossier avec les fichiers javascript et les css utilisés par esup-uniform. Il provient du dossier webpages
WEB-INF/classes/fr et WEB-INF/classes/org : les classes java qui ont été compilées depuis le dossier source
WEB-INF/classes/properties : contient le fichier uniform-config.xml qui lui-même utilise les fichiers search-engine-config*.xml, uniform-config-rules.xml et variablesExt-*.xml
xsl : l'ensemble des feuilles xsl qui effectuent les transformations des documents du xml vers le xml ou vers le html
Les éléments de configuration
Qu'est-ce qu'une configuration ?
Une configuration est d'abord définie par un nom qui servira à relier tout un ensemble de fichiers ayant une même cohérence. Esup-uniform n'utilise qu'une seule configuration à un instant T. Par convnetion la configuration porte le nom définie par la valeur de la variable cdmfr-release. Par exemple cdmfr-release=cdmfr-2012-rof-2.50 ou cdmfr-release=cdmfr-2012-rof-2.50-lille1 pour une version spécifique à l'établissement "lille1"
Une configuration est aussi définie par l'ensemble de ces types de fichiers ou dossiers :
build.${cdmfr-release}.sample.properties : construit à partir de build.sample.properties et destiné à être renommé build.properties lors de son activation
properties/uniform-config.${cdmfr-release}.sample.xml : construit à partir de properties/uniform-config.sample.xml et destiné à être renommé properties/uniform-config.xml lors de son activation
properties/search-engine-config.${cdmfr-release}.sample.xml : construit à partir de properties/search-engine-config.sample.xml et destiné à être renommé properties/search-engine-config.${cdmfr-release}.xml lors de son activation
properties/urlrewrite.${cdmfr-release}.sample.xml : construit à partir de properties/urlrewrite.sample.xml et destiné à être renommé properties/urlrewrite.xml lors de son activation puis transféré dans cdm/WEB-INF/urlrewrite.xml
properties/variablesExt.${cdmfr-release}.sample.xml : construit à partir de properties/variablesExt.sample.xml et destiné à être renommé properties/variablesExt.xml lors de son activation
import/${cdmfr-release} : dans ce dossier devront être déposés les fichiers de formation au format cdmfr qui seront importés par la commande ant import_dir
initdb/orgunit-universite.${cdmfr-release}.sample.xml : ce fichier décrit l'établissement et sera d'abord transféré dans un dossier initdb/${cdmfr-release} sous le nom orgunit-universite.${cdmfr-release}.xml avant d'être copié dans dbs/uv-${cdmfr-release}/documents/orgUnit sous le même nom
initdb/constantes.${cdmfr-release}.sample.xml : ce fichier décrit le référentiel utilisé par l'établissement et sera d'abord transféré dans un dossier initdb/${cdmfr-release} sous le constantes.${cdmfr-release}.xml avant d'être copié dans dbs/uv-${cdmfr-release}/documents/constantes sous le même nom
webpages/xml2xml/${cdmfr-release} : ce dossier contient tous les fichiers qui sont référencés dans le fichier properties/uniform-config.${cdmfr-release}.sample.xml et servent à la transformation des données au sein de la couche métier d'esup-uniform
webpages/media/css/${cdmfr-release}.sample.css : ce fichier contient les classes css pour cette configuration et sera renommé webpages/media/css/main.css lors de son activation
Mettre en place une nouvelle configuration
Pour mettre en place une configuration il faut d'abord créer l'ensemble des fichiers et dossiers définis ci-dessus en exécutant la commande ant create_release -Dmy-cdmfr-release={nomdelaconfiguration}
Activer une configuration
Pour activer une configuration, il faut la définir dans la variable cdmfr-release.
Définissez également le nom du premier profil utilisé avec cette configuration (valeur à mettre dans la variable profil).
Puis exécuter la commande "ant init_release"
Qu'est-ce qu'un profil ?
Un profil est défini par un nom et par un ensemble de fichiers organisés sous le dossier webpages/stylesheets/${profil}.
rof-2.50 est un exemple de profil et ses fichiers sont localisés sous webpages/stylesheets/rof-2-50
Un profil est un ensemble de fichiers xslt qui prennent en charge la couche présentation d'esup-uniform
Mettre en place un profil
Pour mettre en place un profil, il est conseillé de cloner un profil déjà existant et dont le fonctionnement a été validé. Il suffit donc de recopier le dossier désignant le profil à cloner sous le nouveau du profil.
cp -r webpages/stylesheets/{profilSource} webpages/stylesheets/{nouveauprofil}
Activer un profil
Pour activer un profil il faut qu'il soit défini dans la variable profil du fichier build.properties. Il faut ensuite exécuter
ant clean initdb deploy
Personnalisation d'esup-uniform
Données propres à l'établissement
La description de l'établissement
Le référentiel utilisé dans l'établissement
La recherche
Régler l'indexation des dossiers
Les requêtes de recherche
Les écrans
Les pages par défaut
Les niveaux d'adaptation des écrans
le gabarit de la page
Les blocs de page
Dictionnaire des templates
templates adaptables par l'établissement
templates de type onglets
templates spécifiques aux objets CDMFR
templates CDMFR communs à tous les objets
Le package esup-uniform est organisé suivant cette hiérarchie de fichiers :