Installation

Il est recommandé d'utiliser l'outil climax pour l'installation et l'utilisation de MaX.

Démarrage rapide

climax new mon_projet
cd mon_projet
climax demo
climax start

Pour afficher l'aide de climax :

climax --help

Fonctionnement général

L'application est scindée en 2 blocs :

• le cœur : déclaration des routes/fonctionnalités de base, accès aux sources xml et à la configuration, système de templating, traduction etc.
• les bundles : fonctionnalités additionnelles.

Les sources XML à afficher sont stockées dans une base nommée max d'une instance de BaseX.

Les bundles

Un bundle ajoute une (ou des) fonctionnalité(s) à MaX (xquery, xsl, js, etc.). On distingue les bundles de vocabulaire des autres bundles. Pour fonctionner, un (et un seul) bundle de vocabulaire doit être activé. Sans bundle de vocabulaire, aucun rendu HTML n'est opéré par le cœur de MaX.

MaX propose de base les bundles :

• max-dumb-xml : Bundle de vocabulaire d'exemple. Affiche un listing des sources, n'opère aucune transformation sur les documents.
• max-export : Export des sources XML stockées dans MaX (accessible depuis la route /sources.zip).
• max-dev : Fonctionnalités d'assitance au développement, actives uniquement en environnement 'dev'.

Bundle de vocabulaire

Un bundle de vocabulaire est spécialisé dans le rendu d'un vocabulaire XML (TEI, EAD, etc.).

Code source

Le code source est disponible ici.