Commit 59354b98 authored by Marie Bisson's avatar Marie Bisson
Browse files

Merge branch 'ag/doc' into mb/doc

on récupère les modif dAnne
parents a91d2e33 e05c243c
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -13,7 +13,7 @@ Le fichier *configuration/configuration.xml* inclut les fichiers de configuratio
<configuration xmlns:xi="http://www.w3.org/2001/XInclude">
  <baseURI/>
  <editions>
    <xi:include href="../editions/max-tei-demo/max-tei-demo_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>
+6 −6
Original line number Diff line number Diff line
@@ -52,9 +52,9 @@ Pour afficher une page d’une édition hébergée par MaX, le cœur applicatif
* exécution des plugins éventuels.

<br/>
<img src="/images/logopdnMrshCarre.jpg" alt="logo MRSH" style="width:70px;float:left;margin:7px 30px 0px 10px" />
<img src="/images/logo-certic.png" alt="logo CERTIC" style="width:100px;float:left;margin:0px 30px 60px 0px" />
<img src="/images/UNICAEN-logo-NOIR-horizontal.png" alt="logo Unicaen" style="width:90px;float:left;margin-right:30px" />
<img src="/images/CNRSfilaire-grand.jpg" alt="logo CNRS" style="width:45px;float:left;margin-right:15px;margin-top:7px" />
<img src="/images/biblissima.png" alt="logo Biblissima" style="width:70px;float:left;margin:7px 30px 0px 10px" />
<img src="/images/investissement-davenir.png" alt="logo IA" style="width:45px;float:left;margin-right:15px;margin-top:7px" />
<img src="images/logopdnMrshCarre.jpg" alt="logo MRSH" style="width:70px;float:left;margin:7px 30px 0px 10px" />
<img src="images/logo-certic.png" alt="logo CERTIC" style="width:100px;float:left;margin:0px 30px 60px 0px" />
<img src="images/UNICAEN-logo-NOIR-horizontal.png" alt="logo Unicaen" style="width:90px;float:left;margin-right:30px" />
<img src="images/CNRSfilaire-grand.jpg" alt="logo CNRS" style="width:45px;float:left;margin-right:15px;margin-top:7px" />
<img src="images/biblissima.png" alt="logo Biblissima" style="width:70px;float:left;margin:7px 30px 0px 10px" />
<img src="images/investissement-davenir.png" alt="logo IA" style="width:45px;float:left;margin-right:15px;margin-top:7px" />
+4 −4
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@
## Prérequis

* Java 8+
* NodeJS (et npm) 10+
* NodeJS (et npm) 10+ (pour installer npm : https://www.npmjs.com/get-npm)
* xmllint
* BaseX 9.2+

@@ -67,7 +67,7 @@ classDef default color:#274868, fill:#fff, stroke:#274868;

2) Dézipper l’application BaseX dans le dossier *projet*

``unzip basex.zip``
``unzip basex[XX].zip``

3) Renommer l’application BaseX

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

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

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

@@ -152,7 +152,7 @@ S’il est nécessaire de configurer les ports de manière spécifique pour le p

12)  Modifier le port dans le fichier **jetty.xml** (dossier **webapp** > **WEB-INF** > **jetty.xml**)

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

13) Relancer le serveur http de BaseX

+12 −12
Original line number Diff line number Diff line
@@ -19,7 +19,7 @@ graph LR;
    D("menu.xml")
</div>

Ce fichier **menu.xml** permet d’ajouter autant d’onglets et sous-onglets quil est nécessaire. 
Ce fichier *menu.xml* permet d’ajouter autant d’onglets et sous-onglets qu'il est nécessaire. 

Ce fichier dont l’élément racine est `<menu>` contient un ou plusieurs éléments `<entry>`. L’élément ``<entry>`` contient un élément `<id>` pour indiquer l’identifiant et un élément `<target>` pour mentionner la cible, à savoir la fin de l’URL `nom.html`. L’élément `<target>` permet tout aussi bien de pointer vers :

@@ -32,8 +32,8 @@ L’attribut ``@type`` avec la valeur ``main`` est employé pour chaque entrée

Dans l’exemple ci-dessous, le menu contient deux entrées principales (attribut ``@type="main"``) : *accueil* et *sommaire*.

* ``accueil.html`` pointe (généralement) vers le fragment HTML statique accueil.frag.html (cf. [supra](../home_page)); 
* ``sommaire.html`` pointe vers la route qui permet de générer le sommaire d’un document (cf. [supra](../toc/#sommaire-dune-edition)).
* *accueil.html* pointe (généralement) vers le fragment HTML statique accueil.frag.html (cf. [supra](../home_page)) ; 
* *sommaire.html* pointe vers la route qui permet de générer le sommaire d’un document (cf. [supra](../toc/#sommaire-dune-edition)).

```
<menu>
@@ -50,12 +50,12 @@ Dans l’exemple ci-dessous, le menu contient deux entrées principales (attribu

Pour les sous-entrées, au sein de l’élément `<entry type="main">`, un ou plusieurs éléments `<entry>` sont ajoutés : chacun possède un identifiant `<id>` ainsi qu’une cible `<target>`.

Dans lexemple ci-contre, le menu contient deux entrées principales *accueil* et *sommaire*. L’entrée *accueil* pointe vers l’URL `http://[host]:[port]/[edition]/accueil.html` et contient deux sous-entrées *introduction_oeuvre* et *presentation_oeuvre* dont les URL sont respectivement  :
Dans l'exemple ci-contre, le menu contient deux entrées principales *accueil* et *sommaire*. L’entrée *accueil* pointe vers l’URL `http://[host]:[port]/[edition]/accueil.html` et contient deux sous-entrées *introduction_oeuvre* et *presentation_oeuvre* dont les URL sont respectivement  :

- `http://[host]:[port]/[edition]/introduction_oeuvre.html`, 
- `http://[host]:[port]/[edition]/presentation_oeuvre.html`.

L’entrée *sommaire* pointe vers lURL `http://[host]:[port]/[edition]/sommaire.html`.
L’entrée *sommaire* pointe vers l'URL `http://[host]:[port]/[edition]/sommaire.html`.


```
@@ -82,7 +82,7 @@ L’entrée *sommaire* pointe vers l’URL `http://[host]:[port]/[edition]/somma
```


Laffichage du texte du menu est géré par un fichier de ressources dinternationalisation (appelé en développement logiciel [i18n*]()../glossary/#i)), qui permettra à termes de gérer ladaptation de linterface à des langues différentes.
L'affichage du texte du menu est géré par un fichier de ressources d'internationalisation (appelé en développement logiciel i18n **[AG : à reformuler et à mettre dans le glossaire ?]**), qui permettra à termes de gérer l'adaptation de l'interface à des langues différentes.

Ce fichier par défaut se trouve dans `[projet-]MaX/ui/i18n/I18n.xml`. Il peut être surchargé.

@@ -95,11 +95,11 @@ Trois paramètres sont disponibles dans cette XSL :

* *projectId* : identifiant du projet,
* *baseURI* : baseURI du projet,
* *selectedTarget* : entrée de menu courante (valeur dun des attributs @target).
* *selectedTarget* : entrée de menu courante (valeur d'un des attributs @target).

###Fichier i18n

Pour surcharger le fichier i18n, il faut créer un dossier **ui** dans le dossier de lédition, puis un dossier **i18n**, dans lequel est ajouté un fichier **I18n.xml**
Pour surcharger le fichier i18n, il faut créer un dossier **ui** dans le dossier de l'édition, puis un dossier **i18n**, dans lequel est ajouté un fichier **I18n.xml**

<div class="mermaid">
graph LR;
@@ -112,10 +112,10 @@ graph LR;
    D("I18n.xml")
</div>

Ce fichier est construit à partir des identifiants que lon a choisi dans le fichier menu.xml. 
Ce fichier est construit à partir des identifiants que l'on a choisi dans le fichier menu.xml. 

```xml
<!-- Exemple dun fichier I18n.xml -->
<!-- Exemple d'un fichier I18n.xml -->

<?xml version="1.0" encoding="UTF-8"?>

@@ -127,9 +127,9 @@ Ce fichier est construit à partir des identifiants que l’on a choisi dans le
```

###Menu à gauche
Pour configurer un menu à gauche dans la version de démonstration max_tei_demo, il est nécessaire dactiver la surcharge de transformation du menu en renommant le fichier **editions/demo_lorem/ui/xsl/menu_left.xsl** en **editions/demo_lorem/ui/xsl/menu.xsl**. 
Pour configurer un menu à gauche dans la version de démonstration max_tei_demo, il est nécessaire d'activer la surcharge de transformation du menu en renommant le fichier **editions/max_tei_demo/ui/xsl/menu_left.xsl** en **editions/max_tei_demo/ui/xsl/menu.xsl**. 

Faire de même avec le template HTML, en renommant le fichier **editions/demo_lorem/ui/templates/_template.html** en **editions/demo_lorem/ui/templates/template.html**. 
Faire de même avec le template HTML, en renommant le fichier **editions/max_tei_demo/ui/templates/_template.html** en **editions/max_tei_demo/ui/templates/template.html**. 



+1 −1
Original line number Diff line number Diff line
@@ -16,7 +16,7 @@ Deux éditions de démonstration sont proposées pour servir d'exemples de confi

## Déploiement de l’édition de démonstration

<img src="/images/demotei.png" alt="édition de démonstration"/ style="border:1px solid #bbb; padding:0px;width:60%;margin-top:10px">
<img src="../images/demotei.png" alt="édition de démonstration"/ style="border:1px solid #bbb; padding:0px;width:60%;margin-top:10px">

1) Se placer en ligne de commande dans le dossier *tools* :