Commit 5ef32162 authored by Marie Bisson's avatar Marie Bisson
Browse files

maj avec anne

parent 222a11b1

documentation/docs/docker.md

+1 −1
Original line number Diff line number Diff line
@@ -16,7 +16,7 @@ Voici la procédure pour la création de l’image d’une édition (exemple ave 
$ sudo chown -R 1984 /opt/basex/data/max_TEI_demo

```



Création de l’image de l’édition puis lancement du container :

* Création de l’image de l’édition puis lancement du container :



```

 $ sudo docker build -t unicaen/max_TEI_demo .

documentation/docs/install.md

+2 −3
Original line number Diff line number Diff line
@@ -94,12 +94,11 @@ Pour les télécharger : 
---



<br />

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` 

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



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



> *Je (MB) trouve que ce point 5 n’est pas très clair. On a l'impression qu'il faut se placer en ligne de commande dans un dossier projet-MaX… alors qu'il faut faire le git clone dans le dossier projet…*





Si besoin de la version en développement, se placer sur la branche dev :

documentation/docs/layout.md

+13 −13
Original line number Diff line number Diff line
@@ -13,19 +13,19 @@ Le template de mise en page par défaut se trouve dans : 


Il est possible de remplacer cette mise en page en créant son propre template dans <span class="dossier">[projet-]editions</span>/<span class="dossier">[edition]</span>/<span class="dossier">ui</span>/<span class="dossier">templates</span>/<span class="fichier">template.html</span>.



Le template contient des références à des variables qui seront remplacées par le contenu correspondant à l’affichage. Les paramètres disponibles sont : 



* ``$projectId`` : identifiant de l’édition,

* ``$prettyName`` : le titre de l’édition (tel qu’il doit s'afficher)

* ``$baseURI`` : valeur de la variable de configuration [baseURI](../config#la-variable-baseuri),

* ``$home`` : le lien vers la page d’accueil du site

* ``$menu`` : le [menu](../menu) de l’édition

* ``$navigationSelect`` : la [barre de navigation](../text/#barre-de-navigation) de l’édition

* ``$textOptions`` : le [sélectionneur d’options de lecture](../text/#options-de-lecture)

* ``$head`` : les déclarations d’import de css et les métadonnées à placer dans le header html

* `$content` : le contenu de la page à afficher (document, fragment, sommaire…)

* ``$footer`` : le pied de page de l’édition `[lien à faire quand cette partie sera rédiger]`

* ``$jsImports`` : les déclarations des variables et des imports de script js

Le template contient des références à des variables qui seront remplacées par le contenu correspondant à l’affichage. Les variables disponibles sont : 



* **$projectId** : identifiant de l’édition,

* **$prettyName** : le titre de l’édition (tel qu’il doit s'afficher),

* **$baseURI** : valeur de la variable de configuration [baseURI](../config#la-variable-baseuri),

* **$home** : le lien vers la page d’accueil du site,

* **$menu** : le [menu](../menu) de l’édition,

* **$navigationSelect** : la [barre de navigation](../text/#barre-de-navigation) de l’édition,

* **$textOptions** : le [sélectionneur d’options de lecture](../text/#options-de-lecture),

* **$head** : les déclarations d’import de css et les métadonnées à placer dans le header html,

* **$content** : le contenu de la page à afficher (document, fragment, sommaire…),

* **$footer** : le pied de page de l’édition `[lien à faire quand cette partie sera rédiger]`,

* **$jsImports** : les déclarations des variables et des imports de script js.

documentation/docs/menu.md

+4 −4
Original line number Diff line number Diff line
@@ -78,7 +78,7 @@ L’entrée *sommaire* pointe vers l'URL `http://[host]:[port]/[edition]/sommair 
```





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.

L’affichage du texte du menu est géré par un fichier de ressources d'internationalisation (appelé en développement logiciel i18n), qui permettra à termes de gérer l’adaptation de l’interface à des langues différentes.



Ce fichier par défaut se trouve dans <span class="dossier">*projet*-MaX</span>/<span class="dossier">ui</span>/<span class="dossier">i18n</span>/<span class="fichier">I18n.xml</span>. Il peut être surchargé (cf. *infra*).
@@ -89,9 +89,9 @@ Une feuille de transformation placée dans <span class="dossier">mon-edition</sp 


Trois 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).

* **projectId** : identifiant de l’édition,

* **baseURI** : baseURI du projet,

* **selectedTarget** : entrée de menu courante (valeur d’un des attributs @target).



### Fichier i18n

documentation/docs/overriding.md

+4 −4
Original line number Diff line number Diff line
@@ -11,9 +11,9 @@ Le menu HTML est le résultat de la transformation du fichier <span class="dossi 
Une feuille de transformation placée dans <span class="dossier">[projet-]editions</span>/<span class="dossier">[edition]</span>/<span class="dossier">ui</span>/<span class="dossier">xsl</span>/<span class="fichier">menu.xsl</span> peut remplacer celle par défaut.    

Trois 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).

* **projectId** : identifiant du projet,

* **baseURI** : baseURI du projet,

* **selectedTarget** : entrée de menu courante (valeur d’un des attributs @target).



## Sommaires
@@ -77,7 +77,7 @@ Exemple de listing (généré par la XQuery par défaut de MaX) compatible avec 




Pour modifier la XSL par défaut, il faut créer un fichier <span class="fichier">toc.xsl</span>.    

 <span class="dossier">[projet-]editions</span>/<span class="dossier">[edition]</span>/<span class="dossier">ui</span>/<span class="dossier">xsl</span>/<span class="dossier">[tei ou ead]</span>/<span class="fichier">toc.xsl</span>

 <span class="dossier">[projet-]editions</span>/<span class="dossier">[edition]</span>/<span class="dossier">ui</span>/<span class="dossier">xsl</span>/<span class="dossier">[tei ou ead]</span>/<span class="fichier">toc.xsl</span>.    

 Cette XSL permet detransformer le résultat de la XQuery par défaut ou celle qui la surcharge (<span class="dossier">[projet-]editions</span>/<span class="dossier">[edition]</span>/<span class="dossier">xq</span>/<span class="fichier">toc.xq</span>) en HTML.



En l’absence d'un tel fichier, MaX exécutera <span class="dossier">[projet-]MaX</span>/<span class="dossier">ui</span>/<span class="dossier">xsl</span>/<span class="dossier">[tei ou ead]</span>/<span class="fichier">toc.xsl</span>.