Commit e0b072e9 authored by Jerome Chauveau's avatar Jerome Chauveau
Browse files

Merge branch 'jc/plugins-manager' into dev

parents 1bc0deb8 74ff142f

readme.md→README.md

+6 −1
Original line number Diff line number Diff line
@@ -71,7 +71,6 @@ L'édition de démonstration est consultable à **http://localhost:8984/demo_lor 


### Ajouter une édition





```

# Utilisation du port par défaut de BaseX : 1984

$ ./max.sh -n
@@ -111,6 +110,7 @@ Vous pouvez enfin vous connecter en local à l’adresse : 


Exemple : http://127.0.0.1:8984/pouille





### Fichiers de configuration



#### Configuration globale
@@ -283,6 +283,11 @@ Cette feuille de transformation recevra en entrée : 
 document courant.





### Affichage des titres



 todo: document_title.xsl





### Textes



La consultation des textes se fait aux URLs suivantes :

documentation/.gitignore

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

documentation/README.md

0 → 100644
+18 −0
Original line number Diff line number Diff line 
# Documentation Max



## Version en ligne



Documentation en cours de rédaction disponible [ici](https://pdndev.unicaen.fr/max_documentation/)



## É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

```

documentation/docs/alignment.md

0 → 100644
+1 −0
Original line number Diff line number Diff line 
# Alignement

documentation/docs/config.md

0 → 100644
+47 −0
Original line number Diff line number Diff line 
# Configuration





## Fichiers de configuration



### Configuration générale de MaX

Le fichier *configuration/configuration.xml* inclut les fichiers de configuration des différentes éditions

gérées par MaX.





````

<!-- Exemple de fichier de configuration de MaX incluant 2 éditions : demo_lorem et my_edition-->



<?xml version="1.0"?>

<configuration xmlns:xi="http://www.w3.org/2001/XInclude">

  <baseURI/>

  <editions>

    <xi:include href="../editions/demo_lorem/demo_lorem_config_inc.xml"/>

    <xi:include href="../editions/my_edition/my_edition_config_inc.xml"/>

    [...]

  </editions>

</configuration>



````



### Configuration d'une édition



L'édition *my_edition* sera configurée dans le fichier *editions/my_edition/my_edition_config_inc.xml*.



```

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



<edition xml:id="my_edition" dbpath="myeditiondb" env="tei">

</edition>

```



* @xml:id : identifiant de l'édition. Toutes les urls de consultation commencent par cet id

* @dbpath : Nom de la base de données contenant les sources consultables

* @env    : Grammaire XML de l'édition





Ce fichier contiendra si nécessaire, la [configuration des options de lecture](../reading_options), l'activation et le paramètrage de

[l'alignement](../alignment) et des [plugins](../plugins).



#### La variable baseURI



@todo !!