Commit d2faca1b authored by Jerome Chauveau's avatar Jerome Chauveau
Browse files

lien depuis le readme principal vers la doc

parent 8a5a8624
......@@ -67,199 +67,12 @@ $ ./max.sh -d
L'édition de démonstration est consultable à **http://localhost:8984/demo_lorem**
## Paramétrages
## Paramétrage et customisation
### Ajouter une édition
Une documentation est disponible dans le répertoire [documentation](./documentation)
```
# Utilisation du port par défaut de BaseX : 1984
$ ./max.sh -n
ou
./max.sh -p 1234 -n
```
Plusieurs questions sont posées :
1. Identifiant du projet ?
Saisissez le nom de site, sans espace ni caractères spéciaux. Exemple : pouille
2. Nom de la base de données ?
Renseignez le nom de la base de données XML
3. Vocabulaire XML du projet (tei, ead, ...)?
Saisissez tei ou ead
4. Dossier des sources XML à charger ?
Resneigner le chemin complet vers le dossier où se trouvent les sources XML. Exemple : /Users/johndoe/Documents/fichiersBaseX/pouille
5. Please type your BaseX login/password :
Par défaut admin / admin
- Username: admin
- Password: admin
Vous pouvez enfin vous connecter en local à l’adresse :
`http://localhost:[numero_de_port]/NOM_PROJET`
Exemple : http://127.0.0.1:8984/pouille
### Fichiers de configuration
#### Configuration globale
Le fichier *configuration/configuration.xml* se contente d'inclure les fichiers de configuration des différentes éditions hébergées par l'instance de MaX.
Chaque édition *myedition* existe de par la présence d'un dossier *editions/myedition*.
*Exemple d'inclusion de configuration de l'édition demo dans configuration/configuration.xml :*
```
<!--inclusion de la configuration de l'édition demo au sein de la configuration de MaX-->
<xi:include href="../editions/demo/demo_config_inc.xml"/>
```
Ces opérations de création et d'inclusion de fichier sont effectuées automatiquement par le script d'ajout d'édition *max.sh --new-edition*.
### Page d'accueil
* **URL** : http://[host]:[port]/[project]/accueil
* **Fonctionnalité** : Affiche le fragment HTML stocké dans **editions/[project]/fragments/accueil.frag.html**
### Menu
Le menu d'une édition **myedition** se configure dans un fichier **editions/myedition/menu.xml** décrivant au maximum deux niveaux de menu . Pour une entrée de menu (<entry>), il est nécessaire de renseigner son identifiant(<id>) ainsi que sa cible (<target>). Dans l'exemple ci-contre, le menu généré contiendra deux entrées principales (attribut type='main'): home et parcours.
L'entrée home pointera vers l'URL **http://{...}/myedition/accueil** et contiendra deux sous-entrées presentation et contacts pointants respectivement vers **http://{...}/myedition/presentation** et **http://{...}/myedition/contact**.
```xml
<menu>
<entry type="main" default="true">
<id>home</id>
<target>accueil</target>
<!--home sub entries-->
<entry>
<id>presentation</id>
<target>presentation</target>
</entry>
<entry>
<id>contacts</id>
<target>contacts</target>
</entry>
</entry>
<entry type="main">
<id>sommaire</id>
<target>sommaire</target>
</entry>
</menu>
```
#### Modification de la mise en forme du menu
Le menu HTML est le résultat de la transformation du fichiers **myedition/menu.xml** par la feuille XSL par défaut placée dans **MAX/ui/xsl/menu.xsl**.
Une feuille de transformation placée dans **myedition/ui/xsl/menu.xsl** remplacera celle par défaut. 3 paramètres sont disponibles dans cette XSL :
* **projectId** : identifiant du projet
* **baseURI** : baseURI du projet
* **selectedTarget**: entrée de menu courante (valeur d'un des attributs @target)
### Table des matières d'une édition
La table des matières d'une édition est disponible à l'URL **http://[host]:[port]/[project]/sommaire**
#### Fonctionnement par défaut
Par défaut, la page de sommaire liste les documents présents dans la collection:
* Pour la TEI, les élements **TEI/tei:teiHeader/tei:fileDesc//tei:title//text()**
* Pour l'EAD, les éléments **ead/ead:archdesc/ead:did/ead:unittitle//text()**
#### Surchage du comportement
La modification du comportement par défaut se fait par l'ajout d'un fichier XQUERY **toc.xq**, dans le répertoire **editions/[projectId]/xq/**.
Ce fichier doit à minima déclarer les variables qui lui sont automatiquement passées en paramètres par MAX :
```
declare variable $baseURI external;
declare variable $dbPath external;
declare variable $project external;
declare variable $doc external;
<div>
[ ... ]
</div>
```
Pour être compatible avec la XSL par défaut, cette XQUERY devra générer une balise *ul* composée de *li* et *ul*.
Les items de lien devront renseigner ces liens dans l'attribut **data-href**.
Exemple de listing (comportement par défaut):
```
<ul>
<li data-depth="0" data-href="/demo_lorem/sommaire/demo_lorem.xml">
<title xmlns="http://www.tei-c.org/ns/1.0">Lorem Ipsum <lb></lb>In <hi rend="small-caps">MaX</hi> - Corrections, notes &amp; sauts de page</title>
</li>
<li data-depth="0" data-href="/demo_lorem/sommaire/demo_align_lat.xml">
<title xmlns="http://www.tei-c.org/ns/1.0">Lipsum - Version Latine.</title>
</li>
<li data-depth="0" data-href="/demo_lorem/sommaire/demo_lorem_3.xml">
<title xmlns="http://www.tei-c.org/ns/1.0">Lorem Ipsum in MaX - Tome 3. Images et Équations</title>
</li>
<li data-depth="0" data-href="/demo_lorem/sommaire/demo_lorem_2.xml">
<title xmlns="http://www.tei-c.org/ns/1.0">Lorem Ipsum In MaX - Tome 2. Apparat critique</title>
</li>
<li data-depth="0" data-href="/demo_lorem/sommaire/demo_align_fr.xml">
<title xmlns="http://www.tei-c.org/ns/1.0">Lipsum aligné - Version française / traduction latine.</title>
</li>
</ul>
```
Il est aussi possible d'intervenir sur le HTML généré par l'ajout d'une XSL **toc.xsl**, dans le répertoire **editions/[projectId]/xsl/**.
Cette feuille de transformation reçoit en entrée :
* le listing des documents XML stockés dans la collection propre à l'édition (comportement par défaut) **ou** le XML généré par la surcharge XQUERY **editions/[projectId]/xq/toc.xq**.
* les paramètres $baseuri et $project contenant respectivement la variable base_uri et l'identifiant de l'édition
La feuille de transformation par défaut se trouve dans **max/ui/xsl/toc.xsl**
### Sommaire d'un document
Le sommaire d'un document est accessible à l'URL **http://[host]:[port]/[project]/sommaire/[document_path].xml**
#### Fonctionnement par défaut
Actuellement, seule la TEI est dotée d'un comportement par défaut : le sommaire d'un document liste les balises *head* des *div* identifiée (avec un attribut @xml:id) contenant un attribut *@type*.
### Barre de navigation
Lors de l'affichage du texte d'un fragment, la barre de navigation (liste déroulante) permet de naviguer de fragment en fragment.
Les entrées de cette liste déroulante sont par défaut identiques aux entrées de la table des matières du document en cours
de consultation.
Il est possible de modifier l'affichage des ces entrées en ajoutant une feuille de transformation dans **editions/[projectId]/xsl/nav_bar.xsl**.
Celle-ci recevra en entrée le même arbre XML que **editions/[projectId]/xsl/document-toc.xsl** ainsi que les paramètres **baseuri**, **project** accompagnés de :
* **selectedId** : identifiant du fragment en cours de consultation
* **nextArrow** : 'true' s'il existe des fragments suivants le fragment courant
* **prevArrow** : 'true' s'il existe des fragments précédents le fragment courant
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment