Changes for documentation/docs/config.md: 22 added lines, 32 removed lines.
Original line number
Diff line number
Diff line
# Configuration
## Configuration générale de MaX
## Fichiers de configuration
Le fichier<spanclass="fichier">configuration.xml</span> (dans le dossier <spanclass="dossier">configuration</span>) inclut les fichiers de configuration des différentes éditions gérées par MaX.
### 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.
````xml
````
<!-- 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 :
L’édition **mon-edition** sera configurée dans le fichier <spanclass="dossier">editions</span> > <spanclass="dossier">mon-edition</span> > <spanclass="fichier">mon-edition_config_inc.xml</span>.
````
<!-- Exemple de fichier de configuration par défaut, sans option, ni surcharge, ni plugin-->
* @xml:id : identifiant de l'édition. Toutes les urls de consultation commencent par cet id
* @dbpath : Nom de la base de données contenant les sources consultables
Ce fichier contiendra si nécessaire, la [configuration des options de lecture](../reading_options), l'activation et le paramètrage de
[l'alignement](../alignment) et des [plugins](../plugins).
*``@xml:id`` : identifiant de l’édition. Toutes les URLs de consultation commencent par cet identifiant,
*``@dbpath`` : nom de la base de données contenant les sources XML consultables,
*``@env`` : grammaire XML de l’édition (tei ou ead),
*``@prettyName`` : titre de l’édition qui pourra être récupéré sous forme de variable et affiché à divers endroits du site.
#### La variable baseURI
Pour un site déployé sur une URL autre que la racine de l'hôte, la variable *baseURI* doit être renseignée dans le fichier
*configuration/configuration.xml*. Par exemple, pour un site publié à l'adresse https://site.domain.ext/app/ :
Ce fichier contiendra si nécessaire, la [configuration des options de lecture](../text/#options-de-lecture), l’activation et le paramètrage de [l’alignement](../text/#alignement) et des [plugins](../plugins).
font-family:Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace;
Changes for documentation/docs/docker.md: 10 added lines, 11 removed lines.
Original line number
Diff line number
Diff line
# Docker
# [Docker*](../glossary/#d)
* L'image ne peut être créée que si une édition existe (la création d'une image à partir d'un MaX vide est impossible, et inutile !).
L’image ne peut être créée que si une édition existe (la création d’une image à partir d’un MaX vide est impossible, et inutile !).
* Création de l'image de l'édition (exemple avec l'édition de démonstration) puis lancement du container accessible sur le port 9999 (base XML du projet stockée dans */opt/basex/data/max_demo_lorem* :
Voici la procédure pour la création de l’image d’une édition (exemple avec l’édition de démonstration TEI) et le lancement du [container*](../glossary/#c) accessible sur le port 9999 (base XML du projet stockée dans /<spanclass="dossier">opt</class>/<spanclass="dossier">basex</class>/<spanclass="dossier">data</class>/<spanclass="dossier">max_TEI_demo</span> :
Création de l'édition de démonstration
*Création de l’édition de démonstration
```
$ ./tools/max.sh -i && ./tools/max.sh -d
./tools/max.sh -i && ./tools/max.sh -d
```
Ajout des droits sur les données de la base pour le container :
*Ajout des droits sur les données de la base pour le container :
Changes for documentation/docs/features.md: 48 added lines, 14 removed lines.
Original line number
Diff line number
Diff line
# Fonctionnalités et URLs associées
# Fonctionnement
## Fonctionnalités et adresses URL associées
*`/[edition]/accueil.html` Page d'accueil d'une édition
*`/[edition]/sommaire.html` Sommaire d'une édition (liste des documents XML consultables)
*`/[edition]/sommaire/[document].html` Sommaire d'un document d'une édition
*`/[edition]/[document].xml/[id].html` Consultation d'un fragment identifié, d'un document d'une édition
*`/[edition]/doc/[document].xml/[id].html` Consultation d'un document d'une édition
*`/[edition]/[page].html` Consultation d'un contenu html statique
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).
# Chaîne de traitement
L’URL contient systématiquement l’identifiant de l’édition consultée. Cet identifiant, en 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).
Lors de la consultation d'un sommaire, d'un document ou d'un fragment, MaX effectue les opérations suivantes :
Les principales URLs de consultation sont les suivantes :
1. requêtage XQUERY pour récupération des données (liste de document, document complet, fragment identifié, etc.)
2. Transformation de ces données en un contenu HTML par application de templates XSLT
3. Création d'une page HTML complète (à partir d'un template) contenant les données transformées, les blocs de navigation, menu, etc. ainsi que les imports CSS et Javascript
nécessaires.
4. Exécution des éventuels plugins Javascript au sein du navigateur
* Page d’accueil d’une édition ([plus d’info](../home_page)) :
`http://[host]:[port]/[edition]/accueil.html`
* Sommaire d’une édition (liste des documents XML consultables) ([plus d’info](../toc/#sommaire-dune-edition)) :
`http://[host]:[port]/[edition]/sommaire.html`
* Sommaire d’un document d’une édition ([plus d’info](../toc/#sommaire-dun-document)) :
* Consultation d’un [contenu html statique*](../glossary/#c) ([plus d’info](../static_pages)) :
`http://[host]:[port]/[edition]/[page].html`
## Chaîne de traitement
Lors de la consultation d’un sommaire, d’un document ou d’un fragment, MaX effectue les opérations suivantes :
1. Requêtage XQUERY pour la récupération des données (liste de documents, document complet, fragment identifié, etc.).
2. Transformation de ces données en un contenu HTML par application de templates XSLT.
3. Création d’une page HTML complète (à partir d’un template HTML) contenant les données transformées, les blocs de navigation, menu, etc. ainsi que les imports CSS et Javascript nécessaires.
4. Exécution des éventuels plugins au sein du navigateur.