maj doc

### Page statique

### Mise en page

Le template de mise en page par défaut se trouve dans **ui/templates/[env].html**.

Il est possible de remplacer cette mise en page en créant son propre template et en le convoquant dans la configuration de l'édition concernée. Voici un exemple,

pour une mise en page avec un menu vertical à gauche sur l'édition de démonstration :

```

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

### Plugins

#### Abréviation

#### Ajout

#### Apparat critique

#### Fil d'ariane (Breadcrumb)

#### Correction

#### Équations

#### Images (img_viewer)

#### Notes

#### Pagination (Pager)

#### Recherche (search)

Son activation se fait par l'ajout d'une section **plugin** sous la section **plugins** du fichier de configuration d'une édition.

Voici un exemple de configuration du plugin de recherche :

```xml

<plugin name="search">

	<parameters>

		<!--Les recherches sont effectuées dans toutes les balises p (et leurs descendants)-->

        <parameter key="tag" value="p"/>

		<!--Pour chacun des résultats, le lien de retour au texte pointe

		vers la div ancêtre identifiée ayant un @ type-->

        <parameter key="backToTextID" value="(./ancestor::*:div[@*:type])[1]/@xml:id"/>

    </parameters>

</plugin>

```

 * **tag**: nom du tag xml dans lesquels les recherches sont effectuées

 * **backToTextId**: xpath à suivre pour les liens de retour au texte sur les éléments de résultat

#### 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'installation du plugin pour une édition à la lecture

du fichier *plugins/<plugin_name>/resources.json*.

Ex : l'édition de démo fonctionnant avec les plugins *img_viewer* et *equations*, les librairies *Mathjax* et *Openseadragon* sont

automatiquement copiées lors de l'installation de l'édition (lecture de *equations/dependencies.json* et *img_viewer/resources.json*).

## Métadonnées

Les métadonnées générées par défaut dans l'en-tête des documents HTML sont modifiables par l'ajout d'un fichier

**metadata.xq** dans **editions/[projectId]/xq/** :

```

declare variable $project external; (: id du projet :)

declare variable $requestPath external; (: path courant de l'url :)

declare variable $content external; (:contenu de la page = xml transformé = body:)

[...]

```

## Exécution d'une édition dans un container Docker

* L'image ne peut être créée que si une édition existe (la création d'une image à partir d'un MaX vide est impossible, et inutile !).

* Création de l'image de l'édition (exemple avec l'édition de démonstration) puis lancement du container accessible sur le port 9999 (base XML du projet stockée dans */opt/basex/data/max_demo_lorem* :

Création de l'édition de démonstration

```

$ ./tools/max.sh -i && ./tools/max.sh -d

```

Ajout des droits sur les données de la base pour le container :

```

$ sudo chown -R 1984 /opt/basex/data/max_demo_lorem

```

Création de l'image de l'édition puis lancement du container :

```

 $ sudo docker build -t unicaen/max_demo_lorem .

 $ sudo docker run -d -p 9999:8984 --volume /opt/basex/data/max_demo_lorem:/srv/basex/data/max_demo_lorem unicaen/max_demo_lorem

```

# Docker

* L'image ne peut être créée que si une édition existe (la création d'une image à partir d'un MaX vide est impossible, et inutile !).

* Création de l'image de l'édition (exemple avec l'édition de démonstration) puis lancement du container accessible sur le port 9999 (base XML du projet stockée dans */opt/basex/data/max_demo_lorem* :

Création de l'édition de démonstration

```

$ ./tools/max.sh -i && ./tools/max.sh -d

```

Ajout des droits sur les données de la base pour le container :

```

$ sudo chown -R 1984 /opt/basex/data/max_demo_lorem

```

Création de l'image de l'édition puis lancement du container :

```

 $ sudo docker build -t unicaen/max_demo_lorem .

 $ sudo docker run -d -p 9999:8984 --volume /opt/basex/data/max_demo_lorem:/srv/basex/data/max_demo_lorem unicaen/max_demo_lorem

```

    - Menu : menu.md

    - Table des matières : toc.md

    - Textes : text.md

    - Mise en page : layout.md

    - Pages statiques : static_pages.md

    - Métadonnées : metadata.md

    - Plugins : plugins.md