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

maj doc plugins à compléter sur les xqueries spécifiques

parent e6c50e56

documentation/docs/plugins.md

+20 −14
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@ 
MaX propose un ensemble de plugins placés dans le répertoire *plugins-enabled/default*.

Tout autre plugin devra être placé dans *plugins-enabled/custom*.



Le script *tool/max.sh* permet l'activation/désaction de ces plugins.

Le script *tool/max.sh* permet l'activation/désactivation de ces plugins.



````

# lister les plugins disponibles
@@ -20,18 +20,20 @@ $ ./tools/max.sh --list-plugins 
Une fois activé, un plugin doit être déclaré (et configuré si nécessaire) dans les fichiers de configuration des éditions l'utilisant.

Déclaration et configuration se font au sein d'un élément `<plugin/>` de la section `<plugins/>` du fichier de configuration d'une édition.



## Abréviations

## Les plugins disponibles



## Ajouts

### Abréviations



## Apparat critique

### Ajouts



### Apparat critique

Gestion de l'affichage de l'apparat critique :



```xml

<plugin name="apparat_critique"/>

```



## Fil d’Ariane (Breadcrumb)

### Fil d’Ariane (Breadcrumb)



Affichage d'un fil d'Ariane lors de la consultation du texte. Le paramètre `topLabel` permet de configuré

le label de la racine du fil d'Ariane.
@@ -44,7 +46,7 @@ le label de la racine du fil d'Ariane. 
 </plugin>

```



## Corrections

### Corrections



Affichage/masquage des erreurs et de leurs corrections (balises `tei:sic` & `tei:corr`).
@@ -52,7 +54,7 @@ Affichage/masquage des erreurs et de leurs corrections (balises `tei:sic` & `tei 
<plugin name="correction"/>

```



## Équations

### Équations



Permet l'affichage HTML des équations mathématiques (encodage `tei:formula[@notation='TeX']`)
@@ -60,7 +62,7 @@ Permet l'affichage HTML des équations mathématiques (encodage `tei:formula[@no 
<plugin name="equations"/>

```



## Images (img_viewer)

### Visionneuse d'images (img_viewer)



Permet la consultation des images au sein d'une visionneuse ([Openseadragon](https://openseadragon.github.io/)).
@@ -78,12 +80,10 @@ Ce plugin requiert le chemin (relatif à l'édition) de stockage des images (`im 
Pour consulter des images tuilées (dzi, iiif, etc.), il fat surcharger le template `tei:graphic` (dans la `text_hook` de l'édition)

afin de remplacer le paramètre d'appel à `MAX.plugins['img_viewer'].openImageInDialog` par l'URL du `.dzi` ou `.json`.



## Index





## Pagination (Pager)

### Pagination (Pager)



## Recherche (search)

### Recherche (search)



Voici un exemple de configuration du plugin de recherche :
@@ -103,7 +103,7 @@ Voici un exemple de configuration du plugin de recherche : 
 * **backToTextId**: xpath à suivre pour les liens de retour au texte sur les éléments de résultat

 

 

### Plugins et dépendances Javascript

## Plugins et dépendances Javascript

 

Certains plugins ont des dépendances vers des librairies js (ex : *img_viewer* requiert *OpenSeadragon*).

Ces librairies sont automatiquement copiées à l'activation du plugin à la lecture
@@ -114,3 +114,9 @@ automatiquement copiées lors de l'installation de l'édition (lecture de *equat 


Note : ces dépendances ne sont pas supprimées lors de la désactivation d'un plugin (à venir ?) afin d'éviter la suppresion d'une lib

utilisée par un autre plugin.



## Récupération d'éléments hors contexte



documentation todo :

  - xquery propre à un plugin <nom_plugin>.xq (cas de la visionneuse d'images)

  - ou plugin headerPicker -> todo (qui prend un xpath en paramètre. Voir https://git.unicaen.fr/pdn-certic/MaX/-/issues/75)
 
 No newline at end of file