README.md 2.24 KB
Newer Older
dje's avatar
dje committed
1
# MaX
dje's avatar
dje committed
2

Arnaud Daret's avatar
Arnaud Daret committed
3
4
Le Moteur d'Affichage XML est une interface de lecture de sources XML développé par l'[Université de Caen Normandie](http://www.unicaen.fr) ([Pôle Document Numérique](http://www.unicaen.fr/recherche/mrsh/document_numerique) / [CERTIC](https://www.certic.unicaen.fr)) notamment dans le cadre de l'Equipex [Biblissima](http://www.biblissima-condorcet.fr/)

dje's avatar
dje committed
5
6
## Licence

Jerome Chauveau's avatar
Jerome Chauveau committed
7
voir [legal.txt](legal.txt)
dje's avatar
dje committed
8

Pierre-Yves Buard's avatar
Pierre-Yves Buard committed
9
10
11
12
## Participer au développement

Demander à rejoindre [MaX-Community](https://git.unicaen.fr/MaX-Community).

dje's avatar
dje committed
13
## Contacts
dje's avatar
dje committed
14

Arnaud Daret's avatar
Arnaud Daret committed
15
Vous pouvez nous contacter via [contact.certic@unicaen.fr](mailto:contact.certic@unicaen.fr?subject=[MaX])
dje's avatar
dje committed
16

dje's avatar
dje committed
17
---
18

dje's avatar
dje committed
19
20
21
22
## Prérequis

- Java 8+

Jerome Chauveau's avatar
Jerome Chauveau committed
23
- NodeJS (et npm) 10+
dje's avatar
dje committed
24
25

- xmllint
Jerome Chauveau's avatar
Jerome Chauveau committed
26

Jerome Chauveau's avatar
Jerome Chauveau committed
27
- BaseX 9.2+
dje's avatar
dje committed
28
29
30
31

## Installation

```bash
Arnaud Daret's avatar
Arnaud Daret committed
32
$ cd tools && ./max.sh -i
dje's avatar
dje committed
33
# change dir to your basex app folder
34
$ cd </path/to/basex>/webapp
dje's avatar
dje committed
35
36
# create a symlink on your MaX instance
$ sudo ln -s /path/to/max .
37
38
39
# run basex http
$ cd </path/to/basex>/bin
$ ./basexhttp
Jerome Chauveau's avatar
Jerome Chauveau committed
40
# then check your install at: http://localhost:8984/max: 'MaX' should be displayed.
dje's avatar
dje committed
41
42
43
44
45
46
```

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
Jerome Chauveau's avatar
Jerome Chauveau committed
47
```
dje's avatar
dje committed
48

49
50


dje's avatar
dje committed
51
52
53
54
55
56
57
58
### Édition de démonstration

```bash
$ cd tools

# set the env var $BASEX_PATH only if the basexclient command is not in your PATH. Useless
# if basex was install with your system package manager
# The basex dir must contains the bin subfolder
59
$ export BASEX_PATH=/path/to/basex
60
61
62
```

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 :
dje's avatar
dje committed
63

64
```bash
Jerome Chauveau's avatar
Jerome Chauveau committed
65
$ ./max.sh -d
Jerome Chauveau's avatar
Jerome Chauveau committed
66
```
Arnaud Daret's avatar
Arnaud Daret committed
67

Jerome Chauveau's avatar
Jerome Chauveau committed
68
L'édition de démonstration est consultable à **http://localhost:8984/demo_lorem**
dje's avatar
dje committed
69

70
## Paramétrage et customisation
dje's avatar
dje committed
71

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

74
75


Jerome Chauveau's avatar
Jerome Chauveau committed
76
77


78

dje's avatar
dje committed
79

Arnaud Daret's avatar
Arnaud Daret committed
80
81
82
![UNICAEN-PDN-CERTIC](https://www.certic.unicaen.fr/ui/images/UNICAEN_PDN_CERTIC.png)

[![IA](http://medites.fr/partenaires/investissement-avenir/@@images/d94128c2-f712-4712-9659-a86f6f8f36c5.jpeg)](http://www.agence-nationale-recherche.fr/investissements-d-avenir/)
dje's avatar
dje committed
83
![Biblissima](http://asynchrone.fr/sites/default/files/projet/logo/biblissima-logo.png)