Documentation d’utilisation

MaX est régi par la licence open source CeCILL-B. Il est développé par le Certic et le pôle Document numérique.

Nota bene :
La présente documentation est rédigée pour la version 1.1.0-rc3 de MaX.

Avant-propos

Cette documentation a été rédigée à destination :

• d’ingénieurs en analyse de sources historiques et culturelles,
• d’éditeurs de corpus numériques

par :

• des développeurs,
• des ingénieurs en analyse de sources historiques et culturelles,
• des éditeurs de corpus numériques

qui travaillent :

• au CERTIC,
• au Pôle Document numérique.

Introduction

MaX, pour Moteur d’Affichage XML, est un moteur d’affichage qui permet la consultation, via un navigateur web, de fichiers XML stockés dans une base de données.

Cette documentation a pour objectif d’expliquer comment déployer une instance* de MaX, comment la configurer et comment y ajouter de nouvelles fonctionnalités. Attention, cet outil a été développé pour être installé uniquement sur les systèmes d’exploitation Linux et mac OS.

MaX repose sur les technologies et les services suivants :

• stockage : base de données XML BaseX,
• couche métier : RestXQ / XQuery / XSLT,
• couche présentation : HTML / CSS / Javascript.

Pour afficher une page d’une édition hébergée par MaX, le cœur applicatif de MaX se base sur l’URL interrogée. Celle-ci définit le contexte de configuration de base pour l’ensemble des traitements :

• requêtage,
• transformation XSL,
• génération de pages HTML,
• exécution des plugins éventuels.

Par exemple :

• une URL contenant /doc/, telle que http://[host]:[port]/[edition]/doc/demo_lorem.html, indique au cœur applicatif de max qu'il faut afficher le document demo_lorem.xml dans son ensemble et déclencher les traitements prévus pour les fichiers XML du corpus.
• une URL contenant /sommaire/, telle que http://[host]:[port]/[edition]/sommaire/demo_lorem.html, indique au cœur applicatif de max qu'il faut déclencher les traitements propres au sommaire d'un document donné et les appliquer à demo_lorem.xml.
• une URL contenant /index/, telle que http://[host]:[port]/[edition]/index/index_nominum.html, indique au cœur applicatif de max qu'il faut déclencher les traitements propres aux index et afficher l'index des noms, à savoir index_nominum.html