Commit cb268904 authored by Orderic-Vital Pain's avatar Orderic-Vital Pain
Browse files

Maj

parent bd1d16d4

documentation/docs/layout.md

+60 −0
Original line number Diff line number Diff line 
# Gabarits, mise en page



## Mise en page



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

Il est possible de remplacer cette mise en page en créant son propre template dans `editions/[projectId]/ui/templates/template.html`.



|Nota Bene OVP|

|---------|

|Il y a aussi la méthode en ajoutant dans mon-edition\_config\_inc.xml un élément \<layout template="chemin-vers-mon-template"/> mais est-elle encore pertinente ?|



Le template contient des références à des variables qui seront remplacées par le contenu correspondant à l’affichage. Les paramètres disponibles sont : 



* $projectId : identifiant de l'édition,

* $prettyName : `[je ne sais pas le terme que l’on utilise]`

* $baseURI : valeur de la variable de configuration [baseURI](../config#la-variable-baseuri),

* $home : le lien vers la page d’accueil du site

* $menu : le [menu](../menu) de l’édition

* $navigationSelect : la [barre de navigation](../text/#barre-de-navigation) de l’édition

* $textOptions : le [sélectionneur d’options de lecture](../text/#options-de-lecture)

* $head : les déclarations d’import de css et les métadonnées à placer dans le header html

* $content : le contenu de la page à afficher (document, fragment, sommaire…)

* $footer : le pied de page de l’édition `[lien à faire quand cette partie sera rédiger]`

* $jsImports : les déclarations des variables et des imports de script js

* $data : ? `max.config:getProjectData($projectId)`



|Nota Bene OVP|

|---------|

|Je ne sais pas quel cas d’usage on a pour ce dernier paramètre.|



````xml

<!-- Exemple de template -->



<!DOCTYPE html>

 <html>

  <head>

       <meta charset="UTF-8"/>

       <link rel="stylesheet" href="{$baseURI}core/ui/lib/bootstrap.min.css"/>

       <link rel="stylesheet" type="text/css" href="{$baseURI}core/ui/css/tei.css"/>

      {$head}

  </head>

    <body>

    <header>

      <div id="top_bar">

        <div id="header_left"><h1>PDDN MaX / {$projectId}</h1></div>

      </div>

      <div id="menu_and_logo">

        {$menu}

      </div>

    </header> 

    <div id="main_content">{$content}</div>

    {$footer}

    

    <script type="text/javascript" src="{$baseURI}core/ui/lib/jquery.min.js"/>

    <script type="text/javascript" src="{$baseURI}core/ui/lib/bootstrap.bundle.min.js"/>

    <script type="module" src="{$baseURI}core/ui/js/MaxTEI.js"/>

    {$jsImports}

  </body>

</html>

````





Voir la section [Surchages, Mise en page](../overriding/#mise-en-page)

documentation/docs/text.md

+12 −0
Original line number Diff line number Diff line
@@ -79,6 +79,18 @@ return base-uri($document) 


````



Le résultat de cette requête est ensuite transformé par la xsl : :



* pour la TEI : `[projet-]MaX/ui/xsl/tei/tei.xsl`,

* pour l’EAD : `[projet-]MaX/ui/xsl/ead/ead.xsl`.



La surcharge de cette transformation se fait en rédigeant une XSL placée dans : 

`[projet-]editions/[edition]/ui/xsl/text_hook.xsl`



|Nota Bene OVP|

|---------|

|C’est redondant avec la partie précédente mais je ne vois pas trop comment faire autrement… cf. le même dilemne dans la partie "Sommaire"|



## Barre de navigation

documentation/docs/toc.md

+38 −2
Original line number Diff line number Diff line
@@ -14,11 +14,16 @@ Par défaut, la page de sommaire liste les documents présents dans la collectio 
* pour la TEI, les éléments : `/tei:TEI/tei:teiHeader/tei:fileDesc/tei:titleStmt`

* pour l’EAD, les éléments  : `/ead:ead/ead:eadheader/ead:filedesc/ead:titlestmt`



Les requêtes XQuery correspondantes sont respectivement stockées dans **??? et dans ???**

La requête XQuery correspondante est stockée dans `[projet-]MaX/rxq/tei/document_toc.xq`



Le résultat de cette requête est ensuite transformé par la xsl :



* pour la TEI : `[projet-]MaX/ui/xsl/tei/toc.xsl`

* pour l’EAD : `[projet-]MaX/ui/xsl/ead/toc.xsl`



|Nota Bene|

|---------|

|Penser à compléter ici|

|OVP : ead/toc.xsl n’existe pas encore, en fait…|



### Surcharge du comportement
@@ -52,6 +57,37 @@ Les requêtes XQuery correspondantes sont stockées dans : 
* pour l’EAD : 

  `[projet-]MaX/rxq/ead/document_toc.xq`.

  

Le résultat de cette requête est ensuite transformé par la xsl :



* pour la TEI : `[projet-]MaX/ui/xsl/tei/document_toc.xsl`

* pour l’EAD : `[projet-]MaX/ui/xsl/ead/document_toc.xsl`



|Nota Bene|

|---------|

|OVP: idem la version ead de la xsl n’existe pas encore|



### Titre du document

Par défaut, le titre du document est :



* pour la TEI : `/tei:TEI/tei:teiHeader/tei:fileDesc/tei:titleStmt`

* pour l’EAD  : `/ead:ead/ead:eadheader/ead:filedesc/ead:titlestmt`



Les requêtes pour récupérer ces titres sont :



* pour la TEI : 

  `[projet-]MaX/rxq/tei/document_title.xq`, 

* pour l’EAD : 

  `[projet-]MaX/rxq/ead/document_title.xq`.

  

Que transforme ensuite :



* pour la TEI : `[projet-]MaX/ui/xsl/tei/document_title.xsl`

* pour l’EAD : `[projet-]MaX/ui/xsl/ead/document_title.xsl`



|Nota Bene|

|---------|

|OVP : c’est la même opération qui permet de récupérer les titres des documents pour le sommaire de l’édition (cf. supra). Du coup ça fait un peu redite non ?



### Surcharge du comportement



|Nota Bene|