Création d’édition

Pour créer un site, il faut créer une nouvelle édition qui va être associée à une base de données XML (BaseX). Le nom de l’édition est le nom qui apparaîtra dans l’URL.

Deux éditions de démonstration sont proposées pour servir d’exemples de configuration :

  • une édition associée au vocabulaire TEI : max_tei_demo ;
  • l’autre associée au vocabulaire EAD : max_ead_demo .

Vous pouvez déployer une édition de démonstration ou directement déployer une nouvelle édition.

Déploiement de l’édition de démonstration

édition de démonstration

édition de démonstration

/!\ Il est nécessaire de lancer le serveur HTTP BaseX pour déployer une édition. Voir l'étape 8 de la procédure d'installation.

1) Se placer en ligne de commande dans le dossier tools de MaX :

cd [projet-]MaX/tools

(ou si l'on se trouve dans le dossier bin de BaseX : cd../../[projet-]MaX/tools)

=> Si le message suivant s’affiche Please install BaseX or set $BASEX_PATH environment variable, il faut alors indiquer le chemin vers le dossier contenant l’application BaseX au moyen de la commande suivante :
export BASEX_PATH=../../[projet-]basex

2) Lancer l’outil de création d’une édition de démonstration :

  • si utilisation du port par défaut de BaseX (1984)

Pour la version EAD démo : ./max.sh --d-ead

Pour la version TEI démo : ./max.sh --d-tei

Pour la version EAD démo : ./max.sh -p [numero-de-port-START] --d-ead

Pour la version TEI démo : ./max.sh -p [numero-de-port-START] --d-tei 

    Nota Bene
    Attention à ne pas confondre le port de la base de données (1984 par défaut) 
    avec le port du service HTTP (8984 par défaut).


3) Renseigner les identifiants et mots de passe de BaseX (par défaut admin / admin)

  • Please type your BaseX login/password : 
Username:admin    
Password:admin

=> Les éditions de démonstration sont consultables aux adresses suivantes :

Pour les ports par défaut :

Pour les ports modifiés, il faut renseigner dans l’adresse le numéro de port modifié dans le fichier jetty.xml (voir étape 12 de la procédure d’installation)

  • http://localhost:[numero-de-port]/max_tei_demo/accueil.html ;
  • http://localhost:[numero-de-port]/max_ead_demo/accueil.html.
    Nota Bene
    Lors du déploiement de l’édition de démonstration (et seulement pour la démonstration),
    les plugins sont automatiquement activés. Il est donc inutile de procéder à l’activation
    manuelle des plugins (voir la section plugins).

Déploiement d’une nouvelle édition

/!\ Il est nécessaire de lancer le serveur HTTP BaseX pour déployer une édition. Voir l'étape 8 de la procédure d'installation.

1) Se placer en ligne de commande dans le dossier tools de MaX :

cd [projet-]MaX/tools

(ou si l'on se trouve dans le dossier bin de BaseX : cd../../[projet-]MaX/tools)

=> Si le message suivant s’affiche Please install BaseX or set $BASEX_PATH environment variable, il faut alors indiquer le chemin vers le dossier contenant l’application BaseX au moyen de la commande suivante :

export BASEX_PATH=../../[projet-]BaseX

2) Création de la nouvelle édition :

  • si utilisation du port par défaut de BaseX (1984)

./max.sh -n

./max.sh -p [numero-de-port-START] -n

3) Plusieurs questions sont posées afin de renseigner le fichier de configuration mon-edition_config_inc.xml :

  • Project ID ?

Saisir le nom du site, sans espace ni caractères spéciaux. 

  Exemple : monedition
  • XML Project type (tei, ead, ...) ?

Saisir tei ou ead

  Exemple : tei
  • Database path ?

Renseigner le nom de la base de données XML (sans diacritique, sans espace)

  Exemple : monedition
  • XML sources path ?

Renseigner le chemin complet vers le dossier où se trouvent les sources XML : ce dossier ne doit contenir que des fichiers XML (aucun autre type de fichiers), et uniquement les fichiers XML qui doivent être versés dans la base.

  Exemple : /Users/nom/Documents/fichiersbasex/tei/sources/
  • Please type your BaseX login/password :

Nom d’utilisateur et mot de passe de la base de données XML BaseX ; par défaut admin / admin

     - Username: admin
     - Password: admin

=> Vous pouvez enfin vous connecter en local à l’adresse : http://localhost:[numero-de-port]/mon-edition

Exemple pour un port par défaut : http://localhost:8984/max_tei_demo

Si le port n’est pas celui par défaut, il faut renseigner dans l’adresse celui modifié dans le fichier jetty.xml (voir étape 12 de la procédure d’installation).

En cas d'erreur dans la création d'une édition :

  • Se rendre dans le dossier [projet-]MaX/configuration, et ouvrir le fichier configuration.xml avec un éditeur de texte.
  • Supprimer la ligne <xi:include> pointant vers l'édition que vous avez tenté de créer, et enregistrer. [Par exemple : <xi:include href="../editions/[projet]/[projet]_config_inc.xml"/>.
  • Vérifier que le dossier [projet-]MaX/editions ne contient pas de dossier [projet] avec l'édition que vous avez tenté de créer. Sinon, supprimer le dossier [projet] (mais pas le dossier editions !).
  • Recommencer depuis l'étape 1.

Organisation des éditions

Les éditions (max_tei_demo, max_ead_demo, mon-edition, etc.) sont créées dans un dossier editions de MaX.

Si vous suivez les recommandations d’organisation des dossiers décrites dans la partie Recommandations d’architecture :

  1. Dans votre dossier [projet], créer un dossier [projet-]editions.
  2. Déplacer chaque nouvelle édition créée, qui se trouve dans le dossier editions du dossier [projet-]MaX, vers le dossier [projet-]editions que vous venez de créer (le dossier ne doit pas être copié mais bien déplacé).
  3. En vous plaçant au moyen du terminal (ou de l’invite de commande) dans le dossier editions de [projet-]MaX créer un lien symbolique entre ce dossier et l’édition qui se trouve dans le dossier [projet-]editions.

cd [projet-]MaX/editions
ln -s ../../[projet-]editions/max_tei_demo .

ou

ln -s ../../[projet-]editions/mon-edition .

Les configurations des éditions sont faites dans les dossiers :

  • editions ;
  • plugins (quand ceux-ci sont activés).