Commit 32ead2ee authored by dje's avatar dje
Browse files

maj README + namespace TEI

parent 95f37853
Loading
Loading
Loading
Loading
+38 −4
Changes for readme.md: 38 added lines, 4 removed lines.
Original line number Diff line number Diff line
@@ -93,8 +93,13 @@ Ces opérations de création et d'inclusion de fichier sont effectuées automati

### Page d'accueil

Affiche le fragment HTML stocké dans **editions/[project]/fragments/accueil.frag.html** à l'url 
**http://[host]:[port]/[project]/accueil**

### Table des matières d'une édition

La table des matières d'une édition est disponible à l'URL **http://[host]:[port]/[project]/sommaire**

#### Fonctionnement par défaut

Par défaut, la page de sommaire liste les documents présents dans la collection: 
@@ -103,7 +108,7 @@ Par défaut, la page de sommaire liste les documents présents dans la collectio
 * Pour l'EAD, les éléments **ead/ead:archdesc/ead:did/ead:unittitle//text()**

## Surchage du comportement
La modification du comportement par défaut  ce fait par l'ajout d'un fichier XQUERY **toc.xq**, dans le répertoire **editions/<projectId>/xq/**.
La modification du comportement par défaut se fait par l'ajout d'un fichier XQUERY **toc.xq**, dans le répertoire **editions/<projectId>/xq/**.
Ce fichier doit à minima déclarer les variables qui lui sont automatiquement passées en paramètres par MAX : 

```
@@ -118,6 +123,8 @@ declare variable $project external;

### Sommaire d'un document

Le sommaire d'un document est accessible à l'URL **http://[host]:[port]/[project]/sommaire/[document_path].xml**

#### Fonctionnement par défaut

Actuellement, seule la TEI est dotée d'un comportement par défaut : le sommaire d'un document liste le contenu des balises
@@ -146,15 +153,42 @@ declare variable $doc external;

### Textes

#### Options de lecture

#### Alignement

### Page statique

### Plugins

#### Abréviation

#### Ajout

#### Apparat critique

#### Fil d'ariane (Breadcrumb)

#### Correction

#### Équations

#### Images (img_viewer)

#### Index

#### Notes

#### Pagination (Pager)

#### Recherche (search)


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>/dependencies.json*.
Ex : l'édition de démo fonctionnant avec les plugins *img_viewer* et *equations*, les librairies *Mathjax* et *Openseadragon* sont
automatiquement copiés lors de l'installation de l'édition (lecture de *equations/dependencies.json* et *img_viewer/dependencies.json*).
automatiquement copiées lors de l'installation de l'édition (lecture de *equations/dependencies.json* et *img_viewer/dependencies.json*).



@@ -175,14 +209,14 @@ $ ./tools/max.sh --init && ./tools/max.sh --install-demo
Ajout des droits sur les données de la base pour le container :

```
$ sudo chown -R 1984 /opt/basex/data
$ 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 -ti -p 9999:8984 --volume /opt/basex/data/max_demo_lorem:/srv/basex/data/max_demo_lorem 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
```


+6 −6
Changes for rxq/toc.xqm: 6 added lines, 6 removed lines.
Original line number Diff line number Diff line
(: For conditions of distribution and use, see the accompanying legal.txt file. :)

module namespace max.toc = 'pddn/max/toc';

declare namespace tei="http://www.tei-c.org/ns/1.0";
import module namespace max.cons = 'pddn/max/cons' at 'cons.xqm';
import module namespace max.config = 'pddn/max/config' at 'config.xqm';
import module namespace max.html = 'pddn/max/html' at 'html.xqm';
@@ -60,11 +60,11 @@ declare function max.toc:buildDefaultDocumentTOC($project, $docPath){
  let $doc := doc(concat($dbPath,'/', $docPath))
  return 
  <div>
    <h2>Sommaire de <span class='document-title'>{$doc//*:teiHeader//*:title/text()}</span></h2>
    <h2>Sommaire de <span class='document-title'>{$doc//tei:teiHeader//tei:title/text()}</span></h2>
    <ul id="routeEntries">
    {
      for $chapter in $doc//*:div[@type='chapitre']
        let $title := $chapter/*:head//text()
      for $chapter in $doc//tei:div[@type='chapitre']
        let $title := $chapter/tei:head//text()
        let $idPointer :=  $chapter/@xml:id
        return 
        <li id="{$idPointer}">
@@ -78,9 +78,9 @@ declare function max.toc:buildDefaultDocumentTOC($project, $docPath){

declare %private function max.toc:subTOC($chapter, $project, $docPath){
  <ul>{
  for $subChapter in $chapter/*:div[@*:id]
  for $subChapter in $chapter/tei:div[@*:id]
    return 
      let $title := $subChapter/*:head//text()
      let $title := $subChapter/tei:haad//text()
      let $idPointer :=  $subChapter/@xml:id
      return
      <li id="{$idPointer}">