Commit 8a5a8624 authored by Jerome Chauveau's avatar Jerome Chauveau
Browse files

maj doc

parent 416c1446

README.md

+0 −63
Original line number Diff line number Diff line
@@ -249,63 +249,6 @@ Le sommaire d'un document est accessible à l'URL **http://[host]:[port]/[projec 
Actuellement, seule la TEI est dotée d'un comportement par défaut : le sommaire d'un document liste les balises *head* des *div* identifiée (avec un attribut @xml:id) contenant un attribut *@type*.





#### Surcharge

La modification peut se faire par l'ajout d'un fichier **document_toc.xq** dans **editions/[projectId]/xq/**.



Le fichier doit à minima déclarer les variables qui lui sont automatiquement passées en paramètres par MAX :

```

declare default element namespace "http://www.tei-c.org/ns/1.0";

declare variable $baseURI external;

declare variable $dbPath external; (:path du document dans la db:)

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

declare variable $doc external; (: nom du document :)



(: xquery listant les items du sommaire du document $doc:)

<ul>

    <li id="..." data-href="..."><head>...</head></li>

 [ ... ]

</ul>



```

Afin d'être compatible avec la feuille de transformation XSL appliquée par défaut au résultat de cette XQUERY, celle-ci doit :



 * retourner le sommaire dans un élement tei **ul**

 * construire des sous-éléments **li** pour chaque entrée en spécifiant l'url des liens dans un attribut **data-href**

 * construire un sous-élement **head** pour chaque li, contenant le libellé de l'entrée.





Tout comme pour la table des matières d'une édition, cette XSL peut être remplacée par une XSL **editions/[projectId]/xsl/document-toc.xsl**.

Cette feuille de transformation recevra en entrée :



 * le XML de la table des matières du document généré automatiquement par MAX **ou**

    le XML généré par la surcharge XQUERY **editions/[projectId]/xq/document-toc.xq**.

 * les paramètres **$baseuri**, **$project** et **$docTitle** contenant respectivement la variable base_uri, l'identifiant de l'édition et le titre

 document courant.





### Affichage des titres



 todo: document_title.xsl





### Textes



La consultation des textes se fait aux URLs suivantes :



 * **http://[host]:[port]/[project]/[chemin_fichier.xml]/[id]** : consultation d'un fragment identifié

 * **http://[host]:[port]/[project]/doc/[chemin_fichier.xml]** : consultation d'un document XML complet

 * **http://[host]:[port]/[project]/fragment_html/[id]** : consultation "isolée" (sans css, jc, menu, barre de navigation, etc.). L'ajout du query parameter

 *?wrap=true* offre une consultation dans une page HTML complète (css + js).



 La feuille de transformation appliquée par défaut se trouve dans **ui/xsl/[environnement]/[environnement].xsl** (environnement = tei ou ead).

 La surcharge de cette transformation se fait en ajoutant un fichier xsl **text_hook.xsl** dans ** **editions/[projectId]/xsl/text_hook.xsl**.



Aussi, les XSL des plugins activés respectant la convention de nommage **plugins/NOM_PLUGIN/NOM_PLUGIN.xsl** sont automatiquement appliquées.







#### Options de lecture



### Barre de navigation



Lors de l'affichage du texte d'un fragment, la barre de navigation (liste déroulante) permet de naviguer de fragment en fragment.
@@ -320,12 +263,6 @@ Celle-ci recevra en entrée le même arbre XML que **editions/[projectId]/xsl/do 






#### Alignement



### Page statique









![UNICAEN-PDN-CERTIC](https://www.certic.unicaen.fr/ui/images/UNICAEN_PDN_CERTIC.png)

documentation/docs/reading_options.md

deleted100644 → 0
+0 −1
Original line number Diff line number Diff line 
# Options de lecture