1ère étape : choisir ou s'inspirer d'un skin existant

Dans ori-oai-search, plusieurs skins sont proposés par défaut :

Vous avez le choix entre :

Un skin personnalisé est représenté par un dossier dans [PATH_CUSTOM_CONFIG]/ori-oai-search/contribs-skin.
Pour définir votre propre skin, il est nécessaire de s'inspirer d'un skin existant ! Pour cela, il faut recopier un skin existant depuis les sources du modules ([ORI_HOME]/src/ori-oai-search-svn/src/main/resources/contribs-skin) vers le dossier de customisation ([PATH_CUSTOM_CONFIG]/ori-oai-search/contribs-skin).
Il en existe plusieurs par défaut (le nom du dossier commence par default). Certains proviennent aussi des membres de la communauté ORI-OAI (le nom commence par contrib).
Nous vous encourageons à contribuer et à nous fournir vos skins. Nous les proposerons alors aux utilisateurs afin de faciliter de travail de configuration. Reportez-vous pour cela à la page suivante de notre site.

2nde étape : adapter le skin

Dans ce chapitre, nous verrons comment paramétrer le skin en fonction des besoins.

Un dossier de skin est composé comme suit:

Dossier "css" : surcharge des CSS

Ce dossier contient toutes les CSS utilisées dans votre skin. Le fichier css/oos-custom.css est obligatoire. C'est dans ce fichier qu'il faut impérativement surcharger toutes les classes CSS définies par défaut. Cette CSS étant appelée en dernier dans l'ordre d'import, toutes les définitions qu'elle contient surchargeront celles par défaut.

Dossier "i18n" : personnalisation des messages et libellés

Tous les libellés propres au skin sont définis dans ce dossier. Il est possible de définir des nouveaux bundles, ou de surcharger également des bundles de message définis par défaut dans ORI-OAI. Pour cela, il faut les définir dans les fichiers custom_skin_XX.properties. Ces messages seront donc prioritaires sur ceux définis par défaut.

Mais pour les surcharger, il est nécessaire de savoir où ils sont stockés par défaut dans l'application :

Si vous avez besoin de modifier un message, il faut donc copier/coller sa clef depuis le fichier d'origine vers les fichiers custom_skin_XX.properties et modifier le libellé associé au message.

Dossier "js" : surcharge des fichiers javascript

Dossier à utiliser pour surcharger éventuellement des javascripts utilisés par défaut. Pour modifier un des fichiers javascript, il faut copier le fichier d'origine depuis le dossier [ORI_HOME]/src/ori-oai-search-svn/src/main/webapp/js vers le dossier js de la contribution et le modifier ensuite.

Dossier "media" : les images du skin

Ce dossier contient toutes les images utilisées dans le skin.

Dossier "jsp" : surcharge des pages HTML générées

Dans certains cas, il est nécessaire de modifier les JSP utilisées lors de la génération des pages HTML du moteur de recherche. Les JSP par défaut peuvent donc être surchargées en les copiant depuis le dossier [ORI_HOME]/src/ori-oai-search-svn/src/main/webapp/WEB-INF/jsp vers le dossier jsp de votre configuration. Attention l'arborescence des fichiers surchargés doit rester la même entre [ORI_HOME]/src/ori-oai-search-svn/src/main/webapp/WEB-INF/jsp et jsp.

Toutes les interfaces ont été conçues pour pouvoir être au maximum modifiées depuis la CSS. Chacun de ces thèmes contient donc une CSS qui se trouve dans le dossier css du skin utilisé.

Dans le cas où les configurations des CSS ne sont pas suffisantes pour personnaliser les pages, il faudra surcharger les JSP de génération des interfaces qui se trouvent dans le dossier jsp de chaque skin.

Dans le cas où vous souhaitez pousser la modification d'autres JSP il vous suffit de surcharger les JSP d'origine en les écrasant depuis le dossier jsp du skin sélectionné. Dans ces cas là, faites un copier/coller de la JSP en respectant bien la même structure de dossier dans le dossier skin.
Par exemple, pour surcharger le comportement de la JSP generic-results.jsp:

Dossier "xsl": transformation XSL des fiches de métadonnées