Lors de la consultation d'une page d'une édition, MaX se base sur l’URL interrogée. C’est cette URL qui va permettre de déclencher un ensemble de traitements (de l’affichage d’une page html simple, au requêtage de la base de données XML pour générer une nouvelle page html *via* une transformation xsl).
Lors de la consultation d’une page d’une édition, MaX se base sur l’URL interrogée. C’est cette URL qui va permettre de déclencher un ensemble de traitements (de l’affichage d’une page html simple, au requêtage de la base de données XML pour générer une nouvelle page html *via* une transformation xsl).
L’URL contient systématiquement l’identifiant de l'édition consultée. Cet identifiant, plus d’autres paramètres optionnels permettent de construire le document adéquat, en s'appuyant également sur le fichier de configuration de l'édition (pour les options d'affichage, ou l’utilisation des plugins par exemple).
L’URL contient systématiquement l’identifiant de l’édition consultée. Cet identifiant, plus d’autres paramètres optionnels permettent de construire le document adéquat, en s’appuyant également sur le fichier de configuration de l’édition (pour les options d’affichage, ou l’utilisation des plugins par exemple).
Les principales URL de consultation sont les suivantes :
***xsl** : feuilles de transformations XSL natives de MaX,
=> On retrouve la même organisation de ces sous-dossiers pour la configuration d'une édition particulière (cf. ci-dessous [Le dossier projet-editions](#le-dossier-projet-editions))
=> On retrouve la même organisation (dossier **ui**) de ces sous-dossiers pour la configuration d’une édition particulière (cf. ci-dessous [Le dossier projet-editions](#le-dossier-projet-editions))
***package.json**: fichiers des dépendances javascript ;
Le moteur d’affichage XML est construit pour permettre l’exposition de n’importe quel vocabulaire XML.
Néanmoins, deux vocabulaires ont fait l’objet de développements particuliers : ead et tei. Dans les dossiers **rxq**, **ui/css**, **ui/js**, **ui/templates**, **ui/xsl**, l’utilisateur peut trouver des dossiers ou fichiers spécifiques pour ces deux vocabulaires.
Le dossier *projet*-MaX constitue le "cœur applicatif" (*core*) de Max. La configuration spécifique de chaque édition se fera donc dans le dossier *projet*-editions.
Le dossier *projet*-MaX constitue le « cœur applicatif » (*core*) de Max. La configuration spécifique de chaque édition se fera donc dans le dossier *projet*-editions.
Il est ainsi fortement conseillé de ne modifier que ces deux dossiers. :
***mon_edition_config_inc.xml** : le fichier de configuration de l’édition qui permet de :
***mon-edition_config_inc.xml** : le fichier de configuration de l’édition qui permet de :
* préciser le nom de la base de données, le vocabulaire utilisé, le prettyName (titre de l’édition récupéré sous forme de variable et affiché à divers endroit du site).,
Cette documentation a pour objectif de vous expliquer comment déployer une instance de MaX, comment la configurer et y ajouter de nouvelles fonctionnalités.
MaX est un moteur d'affichage XML qui permet la consultation de fichiers XML stockés dans une base de données via un navigateur web. Il repose sur les technologies et les services suivants :
MaX est un moteur d'affichage XML qui permet la consultation de fichiers XML stockés dans une base de données *via* un navigateur web. Il repose sur les technologies et les services suivants :
***Stockage** : base de données XML BaseX
***Couche métier** : RestXQ / XQuery / XSLT
@@ -33,10 +33,10 @@ MaX est un moteur d'affichage XML qui permet la consultation de fichiers XML sto
À la consultation d'une page d'une édition hébergée par MaX, le cœur applicatif se base sur l'URL interrogée. Celle-ci définit le contexte de configuration de base pour l'ensemble des traitements :
À la consultation d’une page d’une édition hébergée par MaX, le cœur applicatif se base sur l’URL interrogée. Celle-ci définit le contexte de configuration de base pour l’ensemble des traitements :
@@ -119,7 +119,7 @@ Si besoin de la version en développement, se placer sur la branche dev :
``./max.sh -p 1234 -i``
=> Si le message suivant s'affiche ``Please install BaseX or set $BASEX_PATH environment variable``, indiquer le chemin vers le BaseX au moyen de la commande suivante :
=> Si le message suivant s’affiche ``Please install BaseX or set $BASEX_PATH environment variable``, indiquer le chemin vers le BaseX au moyen de la commande suivante :
`export BASEX_PATH=../../projet-basex`
@@ -141,7 +141,7 @@ Si besoin de la version en développement, se placer sur la branche dev :
Si besoin de configurer vos ports de manière spécifique pour votre projet, faire les étapes suivantes :
1) Arrêter le serveur HTTP de BaseX s'il est déjà lancé
9) Arrêter le serveur HTTP de BaseX s’il est déjà lancé
`./basexhttpstop`
@@ -164,4 +164,4 @@ Si besoin de configurer vos ports de manière spécifique pour votre projet, fai
|Rq SP |
|----------|
|J'ai testé l'installation, j'ai des messages d'erreur : 'configuration.xml' does not exist, à la place j'ai configuration.dist.xml. et erreur dans le rxq/config.xqm Line : 62 |
No newline at end of file
|J’ai testé l’installation, j’ai des messages d’erreur : ``configuration.xml`` does not exist, à la place j’ai configuration.dist.xml. et erreur dans le rxq/config.xqm Line : 62 |
