Commit b4369763 authored by Marie Bisson's avatar Marie Bisson
Browse files

Merge branch 'pdn/doc' of git.unicaen.fr:pdn-certic/MaX into pdn/doc 

on merge
parents 0b68e39c 5e031bf1

documentation/docs/files.md

+7 −5
Original line number Diff line number Diff line
@@ -105,8 +105,8 @@ classDef default color:#274868, fill:#fff, stroke:#274868; 
    B-->B7

    B-->B8

    A-->C

    

    A1["mon-edition_config_inc.xml"]

    B1-->D3

    A1("mon-edition_config_inc.xml")

    B["ui"]

    B1["css"]

    B2["fonts"]
@@ -117,9 +117,11 @@ classDef default color:#274868, fill:#fff, stroke:#274868; 
    B8["xsl"]

    D["fragments"]

    C["xq"]

    E["menu.xml"]

    D1["accueil.frag.html"]

    D2["footer.frag.html"]

    E("menu.xml")

    D1("accueil.frag.html")

    D2("footer.frag.html")

    D3("mon-edition.css")

    

</div>



* **mon-edition_config_inc.xml** : le fichier de configuration de l’édition qui permet de :

documentation/docs/home_page.md

+2 −6
Original line number Diff line number Diff line
@@ -16,13 +16,9 @@ Par défaut, la page d'accueil affiche la liste des fichiers XML contenus dans B 


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



Pour avoir une page d’accueil spécifique, il faut créer un dossier **fragments** dans le dossier de l’édition, dans lequel est ajouté un fichier **accueil.frag.html**.

Pour avoir une page d’accueil spécifique, il suffit d'ajouter dans le dossier **fragments** du dossier de l’édition,  un fichier **accueil.frag.html**.



```

<!-- chemin du fichier accueil.frag.html-->



 [projet-]editions/[edition]/fragments/accueil.frag.html

```

`[projet-]editions/[edition]/fragments/accueil.frag.html`



<div class="mermaid">

graph LR;

documentation/docs/images/liensSymboliques.png

0 → 100644
+105 KiB
Loading image diff...

documentation/docs/install.md

+13 −8
Original line number Diff line number Diff line
@@ -58,6 +58,8 @@ classDef default color:#274868, fill:#fff, stroke:#274868; 
    C["projet-editions"] 

</div>



<img src="../images/liensSymboliques.png" alt="liens symboliques" style="width:80%;" />



## Procédure
@@ -75,7 +77,7 @@ classDef default color:#274868, fill:#fff, stroke:#274868; 


4) Ajouter les deux bibliothèques suivantes dans le dossier lib de basex :



1. saxon9he.jar pour utiliser les XSL, 

1. saxon*[9he]*.jar pour utiliser les XSL, 

2. FOP.jar pour générer les PDF avec XSL-FO. 



Pour les télécharger :
@@ -104,8 +106,9 @@ Si besoin de la version en développement, se placer sur la branche dev : 


6) Renommer le dossier MaX



(``cd ../``)    

``mv MaX projet-MaX``

Se placer au niveau du dessus en faisant ``cd ..`` 



Puis : ``mv MaX projet-MaX``



7) Initialiser MaX et installer des [dépendances*](../glossary/#i)
@@ -124,15 +127,17 @@ Cela permet d’ajouter le dossier nodes_modules dans le dossier *projet*-MaX. 


 

 ``cd ../../projet-BaseX/webapp``     

 `sudo ln -s ../../projet-MaX MaX` 

 `ln -s ../../projet-MaX MaX` 

 



En faisant un ``ls -l`` vous pouvez vérifier que votre lien symbolique a bien été créé :



    lrwxr-xr-x   1 anne  staff     9 11 mar 15:57 max -> ../../MaX



|Nota Bene |

|----------|

|Le sudo est-il obligatoire ?|



9) Lancer le serveur HTTP de BaseX



`cd ../../projet-BaseX/bin`    

`cd ../bin`    

`./basexhttp &`



=> Pour vérifier l’installation, consulter [http://localhost:8984/max.html](http://localhost:8984/max.html)

documentation/docs/layout.md

+11 −4
Original line number Diff line number Diff line
@@ -3,11 +3,9 @@ 
## Mise en page



Le template de mise en page par défaut se trouve dans **ui/templates/[tei ou ead].html**.

Il est possible de remplacer cette mise en page en créant son propre template dans `editions/[projectId]/ui/templates/template.html`.



|Nota Bene OVP|

|---------|

|Il y a aussi la méthode en ajoutant dans mon-edition\_config\_inc.xml un élément \<layout template="chemin-vers-mon-template"/> mais est-elle encore pertinente ?|

Il est possible de remplacer cette mise en page en créant son propre template dans `editions/[edition]/ui/templates/template.html`.





Le template contient des références à des variables qui seront remplacées par le contenu correspondant à l’affichage. Les paramètres disponibles sont :
@@ -28,6 +26,15 @@ Le template contient des références à des variables qui seront remplacées pa 
|---------|

|Je ne sais pas quel cas d’usage on a pour ce dernier paramètre.|



<br/>





Il peut être également pratique, dans certains cas, de faire référence à un template autrement nommé ou qui se trouve dans une autre édition. Dans ce cas, il est possible d’ajouter dans mon-edition\_config\_inc.xml un élément :



```

<template file="le/chemin/vers/le/templateCustomisé.html"/>

```



````xml

<!-- Exemple de template -->