Commit 9e1aad0c authored by Marie Bisson's avatar Marie Bisson
Browse files

relecture plugins

parent 51dc8728

documentation/docs/plugins.md

+27 −21
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@ Un plugin est une brique logicielle proposant une fonctionnalité supplémentair 


MaX propose un ensemble de plugins placés dans le dossier <span class="dossier">plugins</span>. Le script *max.sh* permet l’activation/désactivation de ces plugins.



* Se placer dans le dossier **tools** : 

* Se placer dans le dossier <span class="dossier">tools</span> : 



``cd le/chemin/vers/le/projet/[projet-]MaX/tools``
@@ -21,8 +21,6 @@ MaX propose un ensemble de plugins placés dans le dossier <span class="dossier" 
``./tools/max.sh --disable-plugin [plugin_name] [mon-edition]``









Une fois activé, la configuration du plugin se fait dans les fichiers de configuration des différentes éditions (<span class="fichier">mon-edition\_config\_inc.xml</span>) dans lequel d’éventuels paramètres de configuration du plugin en question sont spécifiés. 



Cette configuration se fait au sein d'un élément `<plugin name='plugin_id'/>` de la section `<plugins/>` du fichier de configuration d’une édition.
@@ -187,14 +185,11 @@ Plugin rassemblant les plugins correction (balises `tei:sic` et `tei:corr`), abr 


### EAD basket



CSS et JS importés de base dans une édition EAD (depuis le template HTML). Ne doit donc pas être ajouté à la liste des plugins déclarés dans la configuration de l’édition.



|Nota Bene JR|

|---------|

| Je ne comprends pas de quoi il est question ici|

|pourtant moi (MB) je le déclare… sinon ça marche pô|



```xml

<plugin name="ead_basket"/>

```



Ce plugin permet d’utiliser le porte-document dans le cadre des éditions en EAD.



### EAD to PDF
@@ -241,10 +236,7 @@ afin de remplacer le paramètre d'appel à `MAX.plugins['img_viewer'].openImageI 




### Index

|Nota Bene JR|

|---------|

| À compléter|



à venir

### Normalisation



Afficher/masquer la normalisation de l’éditeur (balises `tei:reg` & `tei:orig`).
@@ -254,14 +246,24 @@ Afficher/masquer la normalisation de l’éditeur (balises `tei:reg` & `tei:orig 
```



### Notes

|Nota Bene JR|

|---------|

| À compléter|

à venir



### Pagination (Pager) ??

|Nota Bene JR|

|---------|

| À compléter|



```xml

<plugin name="pager">

      <!-- paramètres nécessaires au bon fonctionnement du plugin -->

      <parameters>

        <!-- XPaths des éléments à paginer-->

        <parameter key="itemsPath" value="//*:list/*:item"/>

        <!--Nombre de blocks par page -->

        <parameter key="nbBlocks" value="100"/>

        <!--Nombre de liens de pages visibles -->

        <parameter key="nbLinks" value="10"/>

      </parameters>

    </plugin>

```

Ce plugin est à activer pour les documents longs qui ne possèdent pas de divisions et sous-divisions pour la navigation.



### Recherche (search)
@@ -291,6 +293,10 @@ Voici un exemple de configuration du plugin de recherche : 


### Side toc



```xml

<plugin name="side_toc"/>

```



Ce plugin est déclaré par défait pour les éditions en EAD.

Il permet de générer un sommaire interactif et arborescent sur la partie gauche du site.
@@ -301,7 +307,7 @@ Permet de récupérer un dossier zippé contenant tous les fichiers XML. 
<plugin name="sources_export"/>

```



L’url permettant d'activer cette fonctionnalité :

L’url permettant d’activer cette fonctionnalité :



``http://[host]:[port]/[edition]/[edition].zip``