Commit 5ca97b3a authored by Jerome Chauveau's avatar Jerome Chauveau
Browse files

maj doc + corrections coquilles

parent 9de0ba3b

documentation/docs/config.md

+14 −5
Original line number Diff line number Diff line
@@ -9,14 +9,14 @@ gérées par MaX. 




````

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

<!-- Exemple de fichier de configuration de MaX incluant 2 éditions : demo_lorem et mon_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"/>

    <xi:include href="../editions/mon_edition/mon_edition_config_inc.xml"/>

    [...]

  </editions>

</configuration>
@@ -25,12 +25,12 @@ gérées par MaX. 


### Configuration d'une édition



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

L'édition *my_edition* sera configurée dans le fichier *editions/mon_edition/mon_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="mon_edition" dbpath="moneditiondb" env="tei">

</edition>

```
@@ -44,4 +44,13 @@ Ce fichier contiendra si nécessaire, la [configuration des options de lecture]( 


#### La variable baseURI



@todo !!
 
Pour un site déployé sur une URL autre que la racine de l'hôte, la variable *baseURI* doit être renseignée dans le fichier

*configuration/configuration.xml*. Par exemple, pour un site publié à l'adresse https://site.domain.ext/app/ :



```

<?xml version="1.0"?>

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

  <baseURI>/app/</baseURI>

  [...]  

</configuration>

```
 
 No newline at end of file

documentation/docs/files.md

+5 −5
Original line number Diff line number Diff line
@@ -2,12 +2,12 @@ 






* **configuration**: dossier contenant le/les fichiers de configuration

* **documentation**: dossier documentation de MaX

* **editions**: dossier des éditions hébergées par l'instance de MaX. Chaque éditions à son propre dossier dans lequel sont stockés ses ressources HTML, XSLT, CSS, Javascript, XQuery, etc.

* **node_modules**: dossier des dépendances node.js installées. Ce dossier n'est créé qu'a l'initialisation de MaX (ou avec un ```npm install```)

* **configuration**: contient le/les fichiers de configuration

* **documentation**: contient la documentation de MaX

* **editions**: dossier des *éditions* (ou *projets*) hébergées par l'instance de MaX. Chaque édition à son propre dossier dans lequel sont stockés ses ressources HTML, XSLT, CSS, Javascript, XQuery, etc.

* **node_modules**: dossier des dépendances node.js installées. Ce dossier n'est créé qu'a l'initialisation de MaX (ou lors d'un ```npm install```)

* **plugins-available**: dossier des plugins disponibles. Chaque plugin dispose de son propre dossier de ressources: fichiers Javascript, XQuery, XSL, ...

* **plugins-enabled**: dossier des plugins activés (liens symboliques vers *plugins-available*).

* **plugins-enabled**: dossier des plugins activés (liens symboliques vers *plugins-available*)

* **rxq**: ensemble des modules RestXQ

* **tools**: outils de déploiement de l'édition de démonstration et d'une nouvelle édition

* **ui**

documentation/docs/home_page.md

+3 −0
Original line number Diff line number Diff line
@@ -12,3 +12,6 @@ http://localhost:1234/pouille/accueil 
```



Éditer le fichier **editions/[project]/fragments/accueil.frag.html** pour la modifier.





Par défaut, l'URL *http://[host]:[port]/[project]/* redirige automatiquement vers *http://[host]:[port]/[project]/accueil*
 
 No newline at end of file

documentation/docs/layout.md

+1 −1
Original line number Diff line number Diff line
@@ -8,5 +8,5 @@ pour une mise en page avec un menu vertical à gauche sur l'édition de démonst 
<layout template="editions/demo_lorem/ui/layout/template.html"/>

```



Il est nécessaire d'activer la surcharge de transformation du menu en renommant le fichier **editions/demo_lorem/ui/xsl/menu_left.xsl** en **editions/demo_lorem/ui/xsl/menu.xsl**.

Il est nécessaire d'activer la surcharge de transformation du menu en renommant le fichier **editions/demo_lorem/ui/xsl/_menu_left.xsl** en **editions/demo_lorem/ui/xsl/menu.xsl**.

documentation/docs/menu.md

+3 −3
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@ 


Le menu d'une édition **mon_edition** se configure dans un fichier **editions/mon_edition/menu.xml** décrivant au maximum deux niveaux de menu . 

Pour une entrée de menu, il est nécessaire de renseigner son identifiant ainsi que sa cible. Dans l'exemple ci-contre, 

le menu généré contiendra deux entrées principales (attribut type='main') : home et parcours.

le menu généré contiendra deux entrées principales (attribut type='main') : *home* et *toc*.



```

<menu>
@@ -24,7 +24,7 @@ le menu généré contiendra deux entrées principales (attribut type='main') : 
  </entry>



  <entry type="main">

    <id>sommaire</id>

    <id>toc</id>

    <target>sommaire</target>

  </entry>
@@ -35,7 +35,7 @@ L'entrée home pointera vers l'URL **/mon_edition/accueil** et contiendra deux s 


## Modification de la mise en forme du menu



Le menu HTML est le résultat de la transformation du fichiers **mon_edition/menu.xml** par la feuille XSL par défaut placée dans **MAX/ui/menu.xsl**.

Le menu HTML est le résultat de la transformation du fichier **mon_edition/menu.xml** par la feuille XSL par défaut placée dans **{MAX-dir}/ui/menu.xsl**.

Une feuille de transformation placée dans **mon_edition/ui/xsl/menu.xsl** remplacera celle par défaut. 3 paramètres sont disponibles dans cette XSL :



* *projectId* : identifiant du projet