relecture jusquà menu (194e501f) · Commits · pdn-certic / MaX

documentation/docs/config.md

+3 −9

Original line number	Diff line number	Diff line
		@@ -5,21 +5,15 @@
		Le fichier configuration/configuration.xml inclut les fichiers de configuration des différentes éditions gérées par MaX.

		````xml
		<<<<<<< HEAD
		<!--
		Exemple de fichier de configuration de MaX incluant 2 éditions :
		demo_lorem et mon-edition
		-->
		=======

		<!-- Exemple de fichier de configuration de MaX incluant 2 éditions :
		demo_lorem et mon-edition -->
		>>>>>>> pdn/doc
		max-tei-demo et mon-edition -->

		<?xml version="1.0"?>
		<configuration xmlns:xi="http://www.w3.org/2001/XInclude">
		<baseURI/>
		<editions>
		<xi:include href="../editions/demo_lorem/demo_lorem_config_inc.xml"/>
		<xi:include href="../editions/max-tei-demo/max-tei-demo_config_inc.xml"/>
		<xi:include href="../editions/mon-edition/mon-edition_config_inc.xml"/>
		[...]
		</editions>

documentation/docs/features.md

+1 −1

Original line number	Diff line number	Diff line
		@@ -27,7 +27,7 @@ Les principales URLs de consultation sont les suivantes :

		`http://[host]:[port]/[edition]/[document].xml/[id].html`

		* Consultation d’un contenu html statique* ([plus d’info](../static_pages)) :
		* Consultation d’un [contenu html statique*](../glossary/#c) ([plus d’info](../static_pages)) :

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

documentation/docs/files.md

+4 −4

Original line number	Diff line number	Diff line
		@@ -52,18 +52,18 @@ classDef default color:#274868, fill:#fff, stroke:#274868;

		* configuration : contient le/les fichiers de configuration,
		* documentation : contient la documentation de MaX,
		* editions : contient les éditions hébergées par l’instance de MaX. Chaque édition a son propre dossier dans lequel sont stockées ses ressources propres : HTML, XSLT, CSS, Javascript, XQuery, etc. Voir [Creation d’une edition](../script/#creation),
		* editions : contient les éditions hébergées par l’instance de MaX. Chaque édition a son propre dossier dans lequel sont stockées ses ressources propres : HTML, XSLT, CSS, Javascript, XQuery, etc. Voir [Création d’une edition](../script/#creation),
		* node_modules : contient les dépendances node.js installées. Ce dossier n’est créé qu’à l’initialisation de MaX (voir étape 6 de la [procédures d’installation](../install/#procedure)) ou lors d’un `npm install`,
		* plugins : contient les plugins. Chaque plugin dispose de son propre dossier de ressources : fichiers Javascript, XQuery, XSL, ... Voir la partie [Plugins](../plugins),
		* rxq : contient l’ensemble des modules RestXQ,
		* tools : contient les outils de déploiement : édition de démonstration, nouvelle édition, activation et désactivation de plugins,
		* ui :
		* css : contient les feuilles de style natives de MaX,
		* css : feuilles de style natives de MaX,
		* i18n : ressources d’internationalisation,
		* images : images de MaX : logo et icônes de navigation,
		* js : sources Javascript de MaX,
		* lib : librairies externes,
		* templates : templates HTML*,
		* 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))
		@@ -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 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 à l'extérieur du core 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 à l’extérieur du core dans le dossier projet-editions.


		Il est ainsi fortement conseillé de ne modifier que ces deux dossiers :

documentation/docs/glossary.md

+14 −12

Original line number	Diff line number	Diff line
		@@ -2,31 +2,33 @@

		## B

		baseURI (ou variable baseURI) : partie de l'URL d'un site qui est avant tous les chemins (routes, voir infra.) qui sont dans MaX, propres à une édition particulière. Exemple dans https://www.unicaen.fr/puc/sources//castel/accueil, il s'agit de https://www.unicaen.fr/puc/sources/
		baseURI (ou variable baseURI) : partie de l’URL d’un site qui est avant tous les chemins (routes, voir infra.) qui sont dans MaX, propres à une édition particulière. Exemple dans https://www.unicaen.fr/puc/sources//castel/accueil, il s’agit de https://www.unicaen.fr/puc/sources/

		Breadcrumb (Fil d’Ariane) : dans l'interface de MaX, aide à la navigation sous forme de menu arborescent. Le breadcrumb permet au lecteur de localiser les documents (les pages web du site) et de se situer par rapport à ces documents.
		Breadcrumb (Fil d’Ariane) : dans l’interface de MaX, aide à la navigation sous forme de menu arborescent. Le breadcrumb permet au lecteur de localiser les documents (les pages web du site) et de se situer par rapport à ces documents.

		## C

		container (ou conteneur) : un conteneur permet de distribuer une ou plusieurs application(s) avec tous les éléments dont elle(s) a/ont besoin pour fonctionner : fichiers source, environnement d'exécution, librairies, outils et fichiers. Ces éléments sont prêts à être déployé sur un serveur et son système d'exploitation.
		container (ou conteneur) : un conteneur permet de distribuer une ou plusieurs application(s) avec tous les éléments dont elle(s) a/ont besoin pour fonctionner : fichiers source, environnement d’exécution, librairies, outils et fichiers. Ces éléments sont prêts à être déployé sur un serveur et son système d’exploitation.

		contenu html statique (ou page statique) : page web dont le contenu n'est pas généré dynamiquement. Dans Max, cela signifie que ce contenu n'est pas reconstitué depuis pas de la base BaseX.
		contenu html statique (ou page statique) : page web dont le contenu n’est pas généré dynamiquement. Dans Max, cela signifie que ce contenu n’est pas reconstitué depuis pas de la base BaseX.

		contrôleur RestXQ : fait la correspondance entre l'URL demandée et le code exécuté.
		contrôleur RestXQ : fait la correspondance entre l’URL demandée et le code exécuté.

		## D

		Dépendances : certains plugins de MaX ont des dépendances vers des librairies Javascript. On utilise indépendamment les termes de "dépendances" ou de "librairies" pour renvoyer à des logiciels externes MaX et dont il a besoin pour faire fonctionner certaines fonctionnalités.

		Docker : conteneur d'applications (voir supra container).
		Docker : conteneur d’applications (voir supra container).

		## I

		instance : exécution d'un programme. Une "instance de MaX" est déployée pour chaque projet.
		i18n = 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.

		instance : exécution d’un programme. Une "instance de MaX" est déployée pour chaque projet.

		## L

		lien symbolique : fichier qui pointe vers un autre fichier dans un système de fichier. Cela permet de faire référence à un autre fichier pour éviter d'éditer les mêmes fichiers à plusieurs endroits ou pour éviter d'avoir à déplacer des fichiers. Dans l'organisation des dossiers et fichiers proposés, on retrouve par exemple un lien symbolique qui pointe vers dans le sous-dossier éditions du dossier projet-MaX. Voir [Organisation des dossiers et des fichiers](../files/)).
		lien symbolique : fichier qui pointe vers un autre fichier dans un système de fichier. Cela permet de faire référence à un autre fichier pour éviter d’éditer les mêmes fichiers à plusieurs endroits ou pour éviter d’avoir à déplacer des fichiers. Dans l’organisation des dossiers et fichiers proposés, on retrouve par exemple un lien symbolique qui pointe vers dans le sous-dossier éditions du dossier projet-MaX. Voir [Organisation des dossiers et des fichiers](../files/)).

		## P

		@@ -37,15 +39,15 @@ BaseX a besoin de plusieurs ports pour fonctionner.

		## R

		racine de l’hôte : La racine de l'hôte c'est le "/" de fin dans une URL. Exemple : "http://xxx.net/".
		racine de l’hôte : La racine de l’hôte c’est le "/" de fin dans une URL. Exemple : "http://xxx.net/".

		reverse-proxy : machine qui se fait passer pour une autre et qui transmet des requêtes entre le serveur et le client. Dans le cas de MaX, en production, il s'agit d'Apache.
		reverse-proxy : machine qui se fait passer pour une autre et qui transmet des requêtes entre le serveur et le client. Dans le cas de MaX, en production, il s’agit d’Apache.

		[route] : partie de l'URL. Chemin que l'on met au niveau du contrôleur RestXQ.
		[route] : partie de l’URL. Chemin que l’on met au niveau du contrôleur RestXQ.

		## S

		serveur http (de BaseX) : Logiciel qui prend des requêtes HTTP et qui renvoient des réponses HTTP. Dans le cas de MaX, c'est Jetty.
		serveur http (de BaseX) : Logiciel qui prend des requêtes HTTP et qui renvoient des réponses HTTP. Dans le cas de MaX, c’est Jetty.

		## T
		template : gabarit ou patron. On parle de templates HTML, XSLT ou encore CSS pour modéliser des documents indépendamment de la valeur des données.
		No newline at end of file

documentation/docs/images/biblissima.png

0 → 100644

+2.26 KiB

Loading image diff...

Original line number	Diff line number	Diff line
		@@ -52,18 +52,18 @@ classDef default color:#274868, fill:#fff, stroke:#274868;

		* configuration : contient le/les fichiers de configuration,
		* documentation : contient la documentation de MaX,
		* editions : contient les éditions hébergées par l’instance de MaX. Chaque édition a son propre dossier dans lequel sont stockées ses ressources propres : HTML, XSLT, CSS, Javascript, XQuery, etc. Voir [Creation d’une edition](../script/#creation),
		* editions : contient les éditions hébergées par l’instance de MaX. Chaque édition a son propre dossier dans lequel sont stockées ses ressources propres : HTML, XSLT, CSS, Javascript, XQuery, etc. Voir [Création d’une edition](../script/#creation),
		* node_modules : contient les dépendances node.js installées. Ce dossier n’est créé qu’à l’initialisation de MaX (voir étape 6 de la [procédures d’installation](../install/#procedure)) ou lors d’un `npm install`,
		* plugins : contient les plugins. Chaque plugin dispose de son propre dossier de ressources : fichiers Javascript, XQuery, XSL, ... Voir la partie [Plugins](../plugins),
		* rxq : contient l’ensemble des modules RestXQ,
		* tools : contient les outils de déploiement : édition de démonstration, nouvelle édition, activation et désactivation de plugins,
		* ui :
		* css : contient les feuilles de style natives de MaX,
		* css : feuilles de style natives de MaX,
		* i18n : ressources d’internationalisation,
		* images : images de MaX : logo et icônes de navigation,
		* js : sources Javascript de MaX,
		* lib : librairies externes,
		* templates : templates HTML*,
		* 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))
		@@ -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 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 à l'extérieur du core 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 à l’extérieur du core dans le dossier projet-editions.


		Il est ainsi fortement conseillé de ne modifier que ces deux dossiers :

Original line number	Diff line number	Diff line
		@@ -2,31 +2,33 @@

		## B

		baseURI (ou variable baseURI) : partie de l'URL d'un site qui est avant tous les chemins (routes, voir infra.) qui sont dans MaX, propres à une édition particulière. Exemple dans https://www.unicaen.fr/puc/sources//castel/accueil, il s'agit de https://www.unicaen.fr/puc/sources/
		baseURI (ou variable baseURI) : partie de l’URL d’un site qui est avant tous les chemins (routes, voir infra.) qui sont dans MaX, propres à une édition particulière. Exemple dans https://www.unicaen.fr/puc/sources//castel/accueil, il s’agit de https://www.unicaen.fr/puc/sources/

		Breadcrumb (Fil d’Ariane) : dans l'interface de MaX, aide à la navigation sous forme de menu arborescent. Le breadcrumb permet au lecteur de localiser les documents (les pages web du site) et de se situer par rapport à ces documents.
		Breadcrumb (Fil d’Ariane) : dans l’interface de MaX, aide à la navigation sous forme de menu arborescent. Le breadcrumb permet au lecteur de localiser les documents (les pages web du site) et de se situer par rapport à ces documents.

		## C

		container (ou conteneur) : un conteneur permet de distribuer une ou plusieurs application(s) avec tous les éléments dont elle(s) a/ont besoin pour fonctionner : fichiers source, environnement d'exécution, librairies, outils et fichiers. Ces éléments sont prêts à être déployé sur un serveur et son système d'exploitation.
		container (ou conteneur) : un conteneur permet de distribuer une ou plusieurs application(s) avec tous les éléments dont elle(s) a/ont besoin pour fonctionner : fichiers source, environnement d’exécution, librairies, outils et fichiers. Ces éléments sont prêts à être déployé sur un serveur et son système d’exploitation.

		contenu html statique (ou page statique) : page web dont le contenu n'est pas généré dynamiquement. Dans Max, cela signifie que ce contenu n'est pas reconstitué depuis pas de la base BaseX.
		contenu html statique (ou page statique) : page web dont le contenu n’est pas généré dynamiquement. Dans Max, cela signifie que ce contenu n’est pas reconstitué depuis pas de la base BaseX.

		contrôleur RestXQ : fait la correspondance entre l'URL demandée et le code exécuté.
		contrôleur RestXQ : fait la correspondance entre l’URL demandée et le code exécuté.

		## D

		Dépendances : certains plugins de MaX ont des dépendances vers des librairies Javascript. On utilise indépendamment les termes de "dépendances" ou de "librairies" pour renvoyer à des logiciels externes MaX et dont il a besoin pour faire fonctionner certaines fonctionnalités.

		Docker : conteneur d'applications (voir supra container).
		Docker : conteneur d’applications (voir supra container).

		## I

		instance : exécution d'un programme. Une "instance de MaX" est déployée pour chaque projet.
		i18n = 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.

		instance : exécution d’un programme. Une "instance de MaX" est déployée pour chaque projet.

		## L

		lien symbolique : fichier qui pointe vers un autre fichier dans un système de fichier. Cela permet de faire référence à un autre fichier pour éviter d'éditer les mêmes fichiers à plusieurs endroits ou pour éviter d'avoir à déplacer des fichiers. Dans l'organisation des dossiers et fichiers proposés, on retrouve par exemple un lien symbolique qui pointe vers dans le sous-dossier éditions du dossier projet-MaX. Voir [Organisation des dossiers et des fichiers](../files/)).
		lien symbolique : fichier qui pointe vers un autre fichier dans un système de fichier. Cela permet de faire référence à un autre fichier pour éviter d’éditer les mêmes fichiers à plusieurs endroits ou pour éviter d’avoir à déplacer des fichiers. Dans l’organisation des dossiers et fichiers proposés, on retrouve par exemple un lien symbolique qui pointe vers dans le sous-dossier éditions du dossier projet-MaX. Voir [Organisation des dossiers et des fichiers](../files/)).

		## P

		@@ -37,15 +39,15 @@ BaseX a besoin de plusieurs ports pour fonctionner.

		## R

		racine de l’hôte : La racine de l'hôte c'est le "/" de fin dans une URL. Exemple : "http://xxx.net/".
		racine de l’hôte : La racine de l’hôte c’est le "/" de fin dans une URL. Exemple : "http://xxx.net/".

		reverse-proxy : machine qui se fait passer pour une autre et qui transmet des requêtes entre le serveur et le client. Dans le cas de MaX, en production, il s'agit d'Apache.
		reverse-proxy : machine qui se fait passer pour une autre et qui transmet des requêtes entre le serveur et le client. Dans le cas de MaX, en production, il s’agit d’Apache.

		[route] : partie de l'URL. Chemin que l'on met au niveau du contrôleur RestXQ.
		[route] : partie de l’URL. Chemin que l’on met au niveau du contrôleur RestXQ.

		## S

		serveur http (de BaseX) : Logiciel qui prend des requêtes HTTP et qui renvoient des réponses HTTP. Dans le cas de MaX, c'est Jetty.
		serveur http (de BaseX) : Logiciel qui prend des requêtes HTTP et qui renvoient des réponses HTTP. Dans le cas de MaX, c’est Jetty.

		## T
		template : gabarit ou patron. On parle de templates HTML, XSLT ou encore CSS pour modéliser des documents indépendamment de la valeur des données.
		No newline at end of file