Commit 5122436a authored by Marie Bisson's avatar Marie Bisson
Browse files

Merge branch 'mb/doc' into pdn/doc 

maj des ajouts mb
parents e0a2e6a4 da57f645

documentation/docs/config.md

+2 −2
Original line number Diff line number Diff line
@@ -2,7 +2,7 @@ 


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

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
@@ -26,7 +26,7 @@ Quand une édition déjà préparée est récupérée, cette ligne peut être aj 


## Configuration d’une édition



L’édition *mon-edition* sera configurée dans le fichier *editions/mon-edition/mon-edition_config_inc.xml*.

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

documentation/docs/css/test.css

+13 −0
Original line number Diff line number Diff line
@@ -75,3 +75,16 @@ 
            color: #0096FF;

            overflow-x: auto;

        }

        

        .fichier {

            color: #5F9EA0;

        }

        

        .dossier {

            color: #5F9EA0;

            font-weight: bold;

        }

        

        .projet {

            font-style: italic;

        }
 
 No newline at end of file

documentation/docs/files.md

+6 −6
Original line number Diff line number Diff line
@@ -66,22 +66,22 @@ classDef default color:#274868, fill:#fff, stroke:#274868; 
    * **templates** : [templates HTML*](../glossary/#t),

    * **xsl** : feuilles de transformations XSL natives de MaX.

    

        => On retrouve la même organisation (dossier **ui**) de ces sous-dossiers pour la configuration d’une édition particulière (cf. ci-dessous [Le dossier projet-editions](#le-dossier-projet-editions))

        => On retrouve la même organisation (dossier **ui**) de ces sous-dossiers pour la configuration d’une édition particulière (cf. ci-dessous [Le dossier *projet*-editions](#le-dossier-projet-editions))



* **package.json** : fichiers des dépendances Javascript,

* **max.xq** : « contrôleur »* RestXQ de MaX.

* **max.xq** : [« contrôleur » RestXQ*](../glossary/#c) de MaX.





Le moteur d’affichage XML est construit pour permettre l’exposition de n’importe quel vocabulaire XML.

Néanmoins, deux vocabulaires ont fait l’objet de développements particuliers : ead et tei. Dans les dossiers **rxq**, **ui/css**, **ui/js**, **ui/templates**, **ui/xsl**, l’utilisateur peut trouver des dossiers ou fichiers spécifiques pour ces deux vocabulaires.

Néanmoins, deux vocabulaires ont fait l’objet de développements particuliers : EAD et TEI. Dans les dossiers <span class="dossier">rxq</span>, <span class="dossier">ui/css</span>, <span class="dossier">ui/js</span>, <span class="dossier">ui/templates</span>, <span class="dossier">ui/xsl</span>, l’utilisateur peut trouver des dossiers ou fichiers spécifiques pour ces deux vocabulaires.



Le dossier *projet*-MaX constitue le cœur applicatif (*core*) de MaX. La configuration spécifique de chaque édition se fera donc à l’extérieur du *core* dans le dossier *projet*-editions.

Le dossier <span class="dossier">*projet*-MaX</span> constitue le cœur applicatif (*core*) de MaX. La configuration spécifique de chaque édition se fera donc à l’extérieur du *core* dans le dossier <span class="dossier">*projet*-editions</span>.





Il est ainsi fortement conseillé de ne modifier que ces deux dossiers :



- [editions](../script),

- [plugins](../plugins).

- [<span class="dossier">editions</span>](../script),

- [<span class="dossier">plugins</span>](../plugins).



## Le dossier *projet*-editions

documentation/docs/home_page.md

+2 −2
Original line number Diff line number Diff line
@@ -16,9 +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 suffit d'ajouter dans le dossier **fragments** du dossier de l’édition,  un fichier **accueil.frag.html**.

Pour avoir une page d’accueil spécifique, il suffit d'ajouter dans le dossier <span class="dossier">fragments</span> du dossier de l’édition,  un fichier <span class="fichier">accueil.frag.html</span>.



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

<span class="dossier">[projet-]editions</span>/<span class="dossier">[edition]</span>/<span class="dossier">fragments</span>/<span class="fichier">accueil.frag.html</span>



<div class="mermaid">

graph LR;

documentation/docs/images/demoead.png

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