maj (51dc8728) · Commits · pdn-certic / MaX

documentation/docs/files.md

+3 −3

Original line number	Diff line number	Diff line
		@@ -66,7 +66,7 @@ classDef default color:#274868, fill:#fff, stroke:#274868;
		* templates : [templates HTML*](../glossary/#t),
		* xsl : feuilles de transformations XSL natives de MaX.

		=> 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))
		=> 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 ]editions](#le-dossier-projet-editions))

		* package.json : fichiers des dépendances Javascript,
		* max.xq : [« contrôleur » RestXQ*](../glossary/#c) de MaX.
		@@ -75,7 +75,7 @@ classDef default color:#274868, fill:#fff, stroke:#274868;
		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 <span class="dossier">rxq</span>, <span class="dossier">ui/css</span>, <span class="dossier">ui/js</span>, <span class="dossier">ui/templates</span>, <span class="dossier">ui/xsl</span>, l’utilisateur peut trouver des dossiers ou fichiers spécifiques pour ces deux vocabulaires.

		Le dossier <span class="dossier">projet-MaX</span> constitue le cœur applicatif (core) de MaX. La configuration spécifique de chaque édition se fera donc à l’extérieur du core dans le dossier <span class="dossier">projet-editions</span>.
		Le dossier <span class="dossier">[projet-]MaX</span> constitue le cœur applicatif (core) de MaX. La configuration spécifique de chaque édition se fera donc à l’extérieur du core dans le dossier <span class="dossier">[projet-]editions</span>.


		Il est ainsi fortement conseillé de ne modifier que ces deux dossiers :
		@@ -83,7 +83,7 @@ Il est ainsi fortement conseillé de ne modifier que ces deux dossiers :
		- [<span class="dossier">editions</span>](../script),
		- [<span class="dossier">plugins</span>](../plugins).

		## Le dossier projet-editions
		## Le dossier [projet-]editions

		<div class="mermaid">
		graph LR;

documentation/docs/glossary.md

+1 −1

Original line number	Diff line number	Diff line
		@@ -24,7 +24,7 @@

		<span class="voc">i18n</span> = internationalisation : mise en place du système permettant à un logiciel de s’adapter à des langues différentes. L’objectif est de pouvoir inclure plusieurs langues dans l’interface.

		<span class="voc">instance</span> : exécution d’un programme. Une « instance de MaX » est déployée pour chaque projet.
		<span class="voc">instance</span> : exécution d’un programme. Une « instance de MaX » est déployée pour chaque [projet].

		## L

documentation/docs/install.md

+16 −18

Original line number	Diff line number	Diff line
		@@ -20,11 +20,11 @@ Pour chaque projet, l’éditeur aura besoin :

		L’organisation recommandée est donc la suivante :

		Un dossier <span class="projet">projet</span> va contenir :
		Un dossier <span class="dossier">[projet]</span> va contenir :

		- un dossier BaseX : nommé <span class="projet">projet</span>-BaseX,
		- un dossier MaX : nommé <span class="projet">projet</span>-MaX,
		- un dossier pour les éditions : nommé <span class="projet">projet</span>-editions.
		- un dossier BaseX : nommé <span class="dossier">[projet-]</span>BaseX,
		- un dossier MaX : nommé <span class="dossier">[projet-]</span>MaX,
		- un dossier pour les éditions : nommé <span class="dossier">[projet-]</span>editions.


		### Exemple
		@@ -63,17 +63,17 @@ classDef default color:#274868, fill:#fff, stroke:#274868;
		## Procédure


		1) En ligne de commande, se placer dans le dossier <span class="dossier"><span class="projet">projet</span></span>
		1) En ligne de commande, se placer dans le dossier <span class="dossier">[projet]</span>

		``cd le/chemin/vers/mon/projet``

		2) Dézipper l’application BaseX dans le dossier <span class="dossier"><span class="projet">projet</span></span>
		2) Dézipper l’application BaseX dans le dossier <span class="dossier">[projet]</span>

		``unzip basex[XX].zip``

		3) Renommer l’application BaseX

		``mv basex projet-BaseX``
		``mv basex [projet]-BaseX``

		4) Ajouter les deux bibliothèques suivantes dans le dossier <span class="dossier">lib</span> de basex :

		@@ -110,26 +110,26 @@ Si besoin de la version en développement, se placer sur la branche dev :

		Se placer au niveau du dessus en faisant ``cd ..``

		Puis : ``mv MaX projet-MaX``
		Puis : ``mv MaX [projet-]MaX``

		7) Initialiser MaX et installer des [dépendances*](../glossary/#i)

		`cd projet-MaX/tools`
		`cd [projet-]MaX/tools`
		``./max.sh -i``


		=> 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`
		`export BASEX_PATH=../../[projet-]BaseX`

		Ensuite refaire ``./max.sh -i``.
		Cela permet d’ajouter le dossier <span class="dossier">nodes_modules</span> dans le dossier <span class="dossier">projet-MaX</span>.
		Cela permet d’ajouter le dossier <span class="dossier">nodes_modules</span> dans le dossier <span class="dossier">[projet-]MaX</span>.

		8) Créer un lien symbolique depuis BaseX (<span class="dossier">projet-BaseX</span>) pointant vers MaX (<span class="dossier">projet-MaX</span>)
		8) Créer un lien symbolique depuis BaseX (<span class="dossier">[projet-]BaseX</span>) pointant vers MaX (<span class="dossier">[projet-]MaX</span>)


		``cd ../../projet-BaseX/webapp``
		`ln -s ../../projet-MaX MaX`
		``cd ../../[projet-]BaseX/webapp``
		`ln -s ../../[projet-]MaX MaX`


		En faisant un ``ls -l`` vous pouvez vérifier que votre lien symbolique a bien été créé :
		@@ -152,7 +152,7 @@ S’il est nécessaire de configurer les ports de manière spécifique pour le p

		`./basexhttpstop`

		11) Modifier des ports START et STOP dans le fichier caché <span class="fichier">.basex</span> (qui se trouve à la racine du dossier <span class="dossier">projet-BaseX<span class="dossier">)
		11) Modifier des ports START et STOP dans le fichier caché <span class="fichier">.basex</span> (qui se trouve à la racine du dossier <span class="dossier">[projet-]BaseX<span class="dossier">)

		* l. 13 et 14 : changer le port START (par défaut 1984 ; par exemple 17000),
		* l. 38 : changer le port STOP (par défaut 8985 ; par exemple 17001)
		@@ -165,7 +165,5 @@ S’il est nécessaire de configurer les ports de manière spécifique pour le p

		`./basexhttp &`

		=> Pour vérifier l’installation, consulter
		``http://localhost:17002/max.html``
		[17002 étant le numéro du port déclaré dans le fichier <span class="fichier">jetty.xml</span>]
		=> Pour vérifier l’installation, consulter ``http://localhost:17002/max.html`` [17002 étant le numéro du port déclaré dans le fichier <span class="fichier">jetty.xml</span>]

documentation/docs/menu.md

+2 −2

Original line number	Diff line number	Diff line
		@@ -80,11 +80,11 @@ L’entrée sommaire pointe vers l'URL `http://[host]:[port]/[edition]/sommair

		L’affichage du texte du menu est géré par un fichier de ressources d'internationalisation (appelé en développement logiciel i18n), qui permettra à termes de gérer l’adaptation de l’interface à des langues différentes.

		Ce fichier par défaut se trouve dans <span class="dossier">projet-MaX</span>/<span class="dossier">ui</span>/<span class="dossier">i18n</span>/<span class="fichier">I18n.xml</span>. Il peut être surchargé (cf. infra).
		Ce fichier par défaut se trouve dans <span class="dossier">[projet-]MaX</span>/<span class="dossier">ui</span>/<span class="dossier">i18n</span>/<span class="fichier">I18n.xml</span>. Il peut être surchargé (cf. infra).

		## Modification de la mise en forme du menu

		Le menu HTML est le résultat de la transformation du fichier <span class="dossier">mon-edition</span>/<span class="fichier">menu.xml</span> par la feuille XSL par défaut placée dans <span class="dossier">projet-MaX</span>/<span class="dossier">ui</span>/<span class="dossier">xsl</span>/<span class="fichier">menu.xsl</span>.
		Le menu HTML est le résultat de la transformation du fichier <span class="dossier">mon-edition</span>/<span class="fichier">menu.xml</span> par la feuille XSL par défaut placée dans <span class="dossier">[projet-]MaX</span>/<span class="dossier">ui</span>/<span class="dossier">xsl</span>/<span class="fichier">menu.xsl</span>.
		Une feuille de transformation placée dans <span class="dossier">mon-edition</span>/<span class="dossier">ui</span>/<span class="dossier">xsl</span>/<span class="fichier">menu.xsl</span> peut remplacer celle disponible par défaut.

		Trois paramètres sont disponibles dans cette XSL :

documentation/docs/script.md

+8 −8

Original line number	Diff line number	Diff line
		@@ -17,11 +17,11 @@ Deux éditions de démonstration sont proposées pour servir d’exemples de con

		1) Se placer en ligne de commande dans le dossier <span class="dossier">tools</span> :

		`cd projet-MaX/tools`
		`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`
		`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)
		@@ -60,11 +60,11 @@ Password:admin

		1) Se placer en ligne de commande dans le dossier <span class="dossier">tools</span> :

		`cd projet-MaX/tools`
		`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`
		`export BASEX_PATH=../../[projet-]BaseX`

		2) Création de la nouvelle édition si utilisation du port par défaut de BaseX (1984)

		@@ -116,15 +116,15 @@ Exemple : [http://localhost:8984/max_tei_demo](http://127.0.0.1:8984/max_tei_dem

		Les éditions (max_tei_demo, max_ead_demo, mon-edition, etc.) sont créées dans le dossier <span class="dossier">editions</span> de MaX.

		Si vous suivez les recommandations d’organisation des dossiers décrites dans la partie [Recommandations d’architecture](../install#recommandations_architecture), vous pouvez déplacer chaque nouvelle édition créée dans le dossier <span class="dossier">projet-editions</span>. Puis en vous plaçant au moyen du terminal (ou de l’invite de commande) dans le dossier <span class="dossier">editions</span> de <span class="dossier">projet-MaX</span> créer un lien symbolique entre ce dossier et l’édition qui se trouve dans le dossier <span class="dossier">projet-editions</span>.
		Si vous suivez les recommandations d’organisation des dossiers décrites dans la partie [Recommandations d’architecture](../install#recommandations_architecture), vous pouvez déplacer chaque nouvelle édition créée dans le dossier <span class="dossier">[projet-]editions</span>. Puis en vous plaçant au moyen du terminal (ou de l’invite de commande) dans le dossier <span class="dossier">editions</span> de <span class="dossier">[projet-]MaX</span> créer un lien symbolique entre ce dossier et l’édition qui se trouve dans le dossier <span class="dossier">[projet-]editions</span>.


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

		ou

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

		Les configurations des éditions sont faites dans les dossiers :