maj (da57f645) · Commits · pdn-certic / MaX

documentation/docs/layout.md

+19 −22

Original line number	Diff line number	Diff line
		@@ -5,28 +5,28 @@
		Le template de mise en page par défaut se trouve dans :

		* pour la TEI :
		`[projet-]MaX/ui/templates/tei.html`
		<span class="dossier">[projet-]MaX</span>/<span class="dossier">ui</span>/<span class="dossier">templates</span>/<span class="fichier">tei.html</span>

		* pour l'EAD :
		`[projet-]MaX/ui/templates/ead.html`
		<span class="dossier">[projet-]MaX</span>/<span class="dossier">ui</span>/<span class="dossier">templates</span>/<span class="fichier">ead.html</span>


		Il est possible de remplacer cette mise en page en créant son propre template dans `[projet-]editions/[edition]/ui/templates/template.html`.
		Il est possible de remplacer cette mise en page en créant son propre template dans <span class="dossier">[projet-]editions</span>/<span class="dossier">[edition]</span>/<span class="dossier">ui</span>/<span class="dossier">templates</span>/<span class="fichier">template.html</span>.

		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 : le titre de l’édition (tel qu'il doit s'afficher)
		* $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)`
		* ``$projectId`` : identifiant de l’édition,
		* ``$prettyName`` : le titre de l’édition (tel qu’il doit s'afficher)
		* ``$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\|
		\|---------\|
		@@ -35,14 +35,11 @@ Le template contient des références à des variables qui seront remplacées pa
		<br/>


		Il peut être également pratique, dans certains cas, de faire référence à un template autrement nommé ou qui se trouve dans une autre édition. Dans ce cas, il est possible d’ajouter dans mon-edition\_config\_inc.xml un élément :

		```
		<template file="uneAutreEdition/ui/templates/template.html"/>
		```
		Il peut être également pratique, dans certains cas, de faire référence à un template autrement nommé ou qui se trouve dans une autre édition. Dans ce cas, il est possible d’ajouter dans <span class="fichier">mon-edition\_config\_inc.xml</span> un élément :
		``<template file="une-autre-edition/ui/templates/template.html"/>``

		````xml
		<!-- Exemple de template -->
		<!-- Exemple de fichier template.html -->

		<!DOCTYPE html>
		<html>
		@@ -68,7 +65,7 @@ Il peut être également pratique, dans certains cas, de faire référence à un
		</div>
		</header>

		<div id="mmain-max-container">
		<div id="main-max-container">
		{$content}
		</div>
		<!-- footer -->

documentation/docs/overriding.md

+1 −1

Original line number	Diff line number	Diff line
		@@ -130,7 +130,7 @@ La XSL par défaut peut également surchargée :
		Il faut alors créer un fichier <span class="fichier">document_toc.xsl</span>.
		<span class="dossier">[projet-]editions</span>/<span class="dossier">[edition]</span>/<span class="dossier">ui</span>/<span class="dossier">xsl</span>/<span class="dossier">[tei ou ead]</span>/<span class="fichier">document_toc.xsl</span>

		Cette XSL permet de transformer le résultat de la XQuery (XQuery par défaut ou surcharge présente dans <span class="dossier">editions/[projectId]/xq/document_toc.xq** ) en HTML.
		Cette XSL permet de transformer le résultat de la XQuery (XQuery par défaut ou surcharge présente dans <span class="dossier">[projet-]editions/[projectId]/xq/document_toc.xq** ) en HTML.
		Cette XSL reçoit en entrée :

		* le titre du document courant dans une variable $docTitle,