Commit 4075d6c8 authored by Anne Goloubkoff-Duponchel's avatar Anne Goloubkoff-Duponchel
Browse files

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

parents a9a5ea09 804e0887

README.md

+9 −31
Original line number Diff line number Diff line
@@ -22,14 +22,12 @@ Vous pouvez nous contacter via [contact.certic@unicaen.fr](mailto:contact.certic 


- NodeJS (et npm) 10+



- xmllint



- BaseX 9.2+



## Installation



```bash

$ cd tools && ./max.sh -i

$ cd tools && ./max.sh -i # will init your max dev env, download and install saxon + fop jar dependencies

# change dir to your basex app folder

$ cd </path/to/basex>/webapp

# create a symlink on your MaX instance
@@ -37,29 +35,7 @@ $ sudo ln -s /path/to/max . 
# run basex http

$ cd </path/to/basex>/bin

$ ./basexhttp

# then check your install at: http://localhost:8984/max: 'MaX' should be displayed.

```



### Transformations XSL



Il est fortement recommandé d'utiliser saxon9 comme moteur de transformation XSLT. Il faut alors l'ajouter aux librairies chargées par BaseX :



```bash

$ cp </path/to/saxon/>saxon9.jar </path/to/basex>/lib

```



### Génération de PDF via FOP (xslfo)

Cette fonctionnalité nécessite de télécharger le [module fop](https://files.basex.org/modules/org/basex/modules/fop/FOP.jar) et de l'ajouter aux librairies :



```bash

$ cd </path/to/basex>/lib && wget https://files.basex.org/modules/org/basex/modules/fop/FOP.jar

```

### Initialisation



Installation des dépendances JS et désactivation des plugins



```bash

$ ./tools/max.sh -i

# then check your install at: http://localhost:8984/max.html

```



### Édition de démonstration
@@ -73,17 +49,19 @@ $ cd tools 
$ export BASEX_PATH=/path/to/basex

```



Modifier si nécessaire le numéro de port (*1984* par défaut) de votre serveur BaseX dans le script *max.sh* puis éxécuter la commande :



```bash

$ ./max.sh -d

$ ./max.sh --d-tei



or 



$ ./max.sh --d-ead

```



L'édition de démonstration est consultable à **http://localhost:8984/max_tei_demo/**

L'édition de démonstration est consultable à **http://localhost:8984/max_tei_demo/accueil.html**



## Paramétrage et customisation



Une documentation utilisateur est disponible dans le répertoire [documentation](./documentation)

Une documentation utilisateur est disponible dans le répertoire [ici](https://git.unicaen.fr/pdn-certic/max-documentation).

documentation/.gitignore

deleted100644 → 0
+0 −1
Original line number Diff line number Diff line 
site

documentation/README.md

deleted100644 → 0
+0 −20
Original line number Diff line number Diff line 
# Documentation Max





## Édition

* Nécessite d'installer [Mkdocs](https://www.mkdocs.org)

* Lancer la commande `mkdocs serve`



## Déploiement



Statification + mise en ligne :



```

$ mkdocs build

$ scp -r ./site user@host:/path/to/server

```





## Version en ligne



Documentation en cours de rédaction disponible [ici](https://www.certic.unicaen.fr/documentations/max/)
 
 No newline at end of file

documentation/docs/config.md

deleted100644 → 0
+0 −46
Original line number Diff line number Diff line 
# Configuration



## Configuration générale de MaX



Le fichier <span class="fichier">configuration.xml</span> (dans le dossier <span class="dossier">configuration</span>) 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 : 

    max-tei-demo et mon-edition -->



<?xml version="1.0"?>

<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/mon-edition/mon-edition_config_inc.xml"/>

    [...]

  </editions>

</configuration>

````



Chaque nouvelle édition implémentée avec l’outil *max.sh* ajoute un élément ``<xi:include>``.



Quand une édition déjà préparée est récupérée, cette ligne peut être ajoutée manuellement.



## Configuration d’une édition



L’édition **mon-edition** sera configurée dans le fichier <span class="dossier">editions</span> > <span class="dossier">mon-edition</span> > <span class="fichier">mon-edition_config_inc.xml</span>.



````

<!-- Exemple de fichier de configuration par défaut, sans option, ni surcharge, ni plugin-->



<edition xml:id="mon-edition" dbpath="moneditiondb" env="tei" prettyName="Mon Édition">

</edition>

````





* ``@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.





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

documentation/docs/css/mermaid.css

deleted100644 → 0
+0 −352
Original line number Diff line number Diff line 
/* Flowchart variables */





/* Sequence Diagram variables */





/* Gantt chart variables */



.mermaid .label {

    color: #274868;

    text-align: center;

}



.node rect,

.node circle,

.node ellipse,

.node polygon {

    color: #274868;

    fill: #FFF;

    stroke: #274868;

    stroke-width: 1px;

}



.edgePath .path {

    stroke: #333333;

}



.edgeLabel {

    background-color: #e8e8e8;

}



.cluster rect {

    fill: #ffffde !important;

    rx: 4 !important;

    stroke: #aaaa33 !important;

    stroke-width: 1px !important;

}



.cluster text {

    fill: #333;

}



.actor {

    stroke: #CCCCFF;

    fill: #ECECFF;

}



text.actor {

    fill: black;

    stroke: none;

}



.actor-line {

    stroke: grey;

}



.messageLine0 {

    stroke-width: 1.5;

    stroke-dasharray: "2 2";

    marker-end: "url(#arrowhead)";

    stroke: #333;

}



.messageLine1 {

    stroke-width: 1.5;

    stroke-dasharray: "2 2";

    stroke: #333;

}



#arrowhead {

    fill: #333;

}



#crosshead path {

    fill: #333 !important;

    stroke: #333 !important;

}



.messageText {

    fill: #333;

    stroke: none;

}



.labelBox {

    stroke: #CCCCFF;

    fill: #ECECFF;

}



.labelText {

    fill: black;

    stroke: none;

}



.loopText {

    fill: black;

    stroke: none;

}



.loopLine {

    stroke-width: 2;

    stroke-dasharray: "2 2";

    marker-end: "url(#arrowhead)";

    stroke: #CCCCFF;

}



.note {

    stroke: #aaaa33;

    fill: #fff5ad;

}



.noteText {

    fill: black;

    stroke: none;

    font-family: 'trebuchet ms', verdana, arial;

    font-size: 14px;

}





/** Section styling */



.section {

    stroke: none;

    /* below commented out because it conflicts with the readthedocs theme */

    /*  opacity: 0.2; */

}



.section0 {

    fill: rgba(102, 102, 255, 0.49);

}



.section2 {

    fill: #fff400;

}



.section1,

.section3 {

    fill: white;

    opacity: 0.2;

}



.sectionTitle0 {

    fill: #333;

}



.sectionTitle1 {

    fill: #333;

}



.sectionTitle2 {

    fill: #333;

}



.sectionTitle3 {

    fill: #333;

}



.sectionTitle {

    text-anchor: start;

    font-size: 11px;

    text-height: 14px;

}





/* Grid and axis */



.grid .tick {

    stroke: lightgrey;

    opacity: 0.3;

    shape-rendering: crispEdges;

}



.grid path {

    stroke-width: 0;

}





/* Today line */



.today {

    fill: none;

    stroke: red;

    stroke-width: 2px;

}





/* Task styling */





/* Default task */



.task {

    stroke-width: 2;

}



.taskText {

    text-anchor: middle;

    font-size: 11px;

}



.taskTextOutsideRight {

    fill: black;

    text-anchor: start;

    font-size: 11px;

}



.taskTextOutsideLeft {

    fill: black;

    text-anchor: end;

    font-size: 11px;

}





/* Specific task settings for the sections*/



.taskText0,

.taskText1,

.taskText2,

.taskText3 {

    fill: white;

}



.task0,

.task1,

.task2,

.task3 {

    fill: #8a90dd;

    stroke: #534fbc;

}



.taskTextOutside0,

.taskTextOutside2 {

    fill: black;

}



.taskTextOutside1,

.taskTextOutside3 {

    fill: black;

}





/* Active task */



.active0,

.active1,

.active2,

.active3 {

    fill: #bfc7ff;

    stroke: #534fbc;

}



.activeText0,

.activeText1,

.activeText2,

.activeText3 {

    fill: black !important;

}





/* Completed task */



.done0,

.done1,

.done2,

.done3 {

    stroke: grey;

    fill: lightgrey;

    stroke-width: 2;

}



.doneText0,

.doneText1,

.doneText2,

.doneText3 {

    fill: black !important;

}





/* Tasks on the critical line */



.crit0,

.crit1,

.crit2,

.crit3 {

    stroke: #ff8888;

    fill: red;

    stroke-width: 2;

}



.activeCrit0,

.activeCrit1,

.activeCrit2,

.activeCrit3 {

    stroke: #ff8888;

    fill: #bfc7ff;

    stroke-width: 2;

}



.doneCrit0,

.doneCrit1,

.doneCrit2,

.doneCrit3 {

    stroke: #ff8888;

    fill: lightgrey;

    stroke-width: 2;

    cursor: pointer;

    shape-rendering: crispEdges;

}



.doneCritText0,

.doneCritText1,

.doneCritText2,

.doneCritText3 {

    fill: black !important;

}



.activeCritText0,

.activeCritText1,

.activeCritText2,

.activeCritText3 {

    fill: black !important;

}



.titleText {

    text-anchor: middle;

    font-size: 18px;

    fill: black;

}





/*





*/



.node text {

    font-family: 'trebuchet ms', verdana, arial;

    font-size: 14px;

}



div.mermaidTooltip {

    position: absolute;

    text-align: center;

    max-width: 200px;

    padding: 2px;

    font-family: 'trebuchet ms', verdana, arial;

    font-size: 12px;

    background: #ffffde;

    border: 1px solid #aaaa33;

    border-radius: 2px;

    pointer-events: none;

    z-index: 100;

}
 
 No newline at end of file