affichage dossier sous-dossier (c86773f2) · Commits · pdn-certic / MaX

documentation/docs/config.md

+2 −2

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

		## Configuration générale de MaX

		Le fichier configuration/configuration.xml inclut les fichiers de configuration des différentes éditions gérées par MaX.
		Le fichier <span class="fichier">configuration.xml</span> (dans le dossier <span class="dossier">configuration</span>) inclut les fichiers de configuration des différentes éditions gérées par MaX.

		````xml

		@@ -26,7 +26,7 @@ Quand une édition déjà préparée est récupérée, cette ligne peut être aj

		## Configuration d’une édition

		L’édition mon-edition sera configurée dans le fichier editions/mon-edition/mon-edition_config_inc.xml.
		L’édition mon-edition sera configurée dans le fichier <span class="dossier">editions</span> > <span class="dossier">mon-edition</span> > <span class="fichier">mon-edition_config_inc.xml</span>.

		````
		<!-- Exemple de fichier de configuration par défaut, sans option, ni surcharge, ni plugin-->

documentation/docs/css/test.css

+13 −0

Original line number	Diff line number	Diff line
		@@ -75,3 +75,16 @@
		color: #0096FF;
		overflow-x: auto;
		}

		.fichier {
		color: #5F9EA0;
		}

		.dossier {
		color: #5F9EA0;
		font-weight: bold;
		}

		.projet {
		font-style: italic;
		}
		No newline at end of file

documentation/docs/files.md

+4 −4

Original line number	Diff line number	Diff line
		@@ -73,15 +73,15 @@ 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 rxq, ui/css, ui/js, ui/templates, ui/xsl, l’utilisateur peut trouver des dossiers ou fichiers spécifiques pour ces deux vocabulaires.
		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 projet-MaX 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 projet-editions.
		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 :

		- [editions](../script),
		- [plugins](../plugins).
		- [<span class="dossier">editions</span>](../script),
		- [<span class="dossier">plugins</span>](../plugins).

		## Le dossier projet-editions

documentation/docs/home_page.md

+2 −2

Original line number	Diff line number	Diff line
		@@ -16,9 +16,9 @@ Par défaut, la page d'accueil affiche la liste des fichiers XML contenus dans B

		`http://[host]:[port]/[edition]/sommaire.html`

		Pour avoir une page d’accueil spécifique, il suffit d'ajouter dans le dossier fragments du dossier de l’édition, un fichier accueil.frag.html.
		Pour avoir une page d’accueil spécifique, il suffit d'ajouter dans le dossier <span class="dossier">fragments</span> du dossier de l’édition, un fichier <span class="fichier">accueil.frag.html</span>.

		`[projet-]editions/[edition]/fragments/accueil.frag.html`
		<span class="dossier">[projet-]editions</span>/<span class="dossier">[edition]</span>/<span class="dossier">fragments</span>/<span class="fichier">accueil.frag.html</span>

		<div class="mermaid">
		graph LR;

documentation/docs/install.md

+17 −17

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 projet va contenir :
		Un dossier <span class="projet">projet</span> va contenir :

		- un dossier BaseX : nommé projet-BaseX,
		- un dossier MaX : nommé projet-MaX,
		- un dossier pour les éditions : nommé projet-editions.
		- 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.


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


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

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

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

		``unzip basex[XX].zip``

		@@ -75,10 +75,10 @@ classDef default color:#274868, fill:#fff, stroke:#274868;

		``mv basex projet-BaseX``

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

		1. saxon[9he].jar pour utiliser les XSL,
		2. FOP.jar pour générer les PDF avec XSL-FO.
		1. <span class="fichier">saxon[9he].jar</span> pour utiliser les XSL,
		2. <span class="fichier">FOP.jar</span> pour générer les PDF avec XSL-FO.

		Pour les télécharger :

		@@ -94,7 +94,7 @@ Pour les télécharger :
		---

		<br />
		5) Récupérer le code source de MaX dans votre dossier projet-MaX.
		5) Récupérer le code source de MaX dans votre dossier <span class="dossier"><span class="projet">projet</span>-MaX</span>.

		`git clone https://git.unicaen.fr/pdn-certic/MaX.git`

		@@ -107,7 +107,7 @@ Si besoin de la version en développement, se placer sur la branche dev :
		`cd MaX`
		`git checkout dev`

		6) Renommer le dossier MaX
		6) Renommer le dossier <span class="dossier">MaX</span>

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

		@@ -124,9 +124,9 @@ Puis : ``mv MaX projet-MaX``
		`export BASEX_PATH=../../projet-BaseX`

		Ensuite refaire ``./max.sh -i``.
		Cela permet d’ajouter le dossier nodes_modules dans le dossier projet-MaX.
		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 (projet-basex) pointant vers MaX (projet-MaX)
		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``
		@@ -153,20 +153,20 @@ 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é .basex (qui se trouve à la racine du dossier projet-basex)
		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)

		12) Modifier le port dans le fichier jetty.xml (dossier webapp > WEB-INF > jetty.xml)
		1) Modifier le port dans le fichier <span class="fichier">jetty.xml</span> (dossier <span class="dossier">webapp</span> > <span class="dossier">WEB-INF</span> > <span class="fichier">jetty.xml</span>)

		* l. 13 : changer le contenu de l’élément `<Set name="port">8984</Set>` (par exemple 17002)

		13) Relancer le serveur http de BaseX
		1) Relancer le serveur http de BaseX

		`./basexhttp &`

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