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

documentation/docs/overriding.md

+28 −25

Original line number	Diff line number	Diff line
		@@ -2,19 +2,18 @@

		## Accueil

		Éditer le fichier `editions/[project]/fragments/accueil.frag.html` pour modifier la page d’accueil d’une édition.
		Éditer le fichier <span class="dossier">[projet-]editions</span>/<span class="dossier">[edition]</span>/<span class="dossier">fragments</span>/<span class="fichier">accueil.frag.html</span> pour modifier la page d’accueil d’une édition.


		## Menu

		Le menu HTML est le résultat de la transformation du fichier mon-edition/menu.xml par la feuille XSL par défaut placée dans {MAX-dir}/ui/menu.xsl.
		Une feuille de transformation placée dans mon-edition/ui/xsl/menu.xsl remplacera celle par défaut. 3 paramètres sont disponibles dans cette XSL :
		Le menu HTML est le résultat de la transformation du fichier <span class="dossier">mon-edition</span>/<span class="fichier">menu.xml</span> par la feuille XSL par défaut placée dans <span class="dossier">[projet-]MaX</span>/<span class="dossier">ui</span>/<span class="dossier">xsl</span>/<span class="fichier">menu.xsl</span>.
		Une feuille de transformation placée dans <span class="dossier">[projet-]editions</span>/<span class="dossier">[edition]</span>/<span class="dossier">ui</span>/<span class="dossier">xsl</span>/<span class="fichier">menu.xsl</span> peut remplacer celle par défaut.
		Trois paramètres sont disponibles dans cette XSL :

		* projectId : identifiant du projet,
		* baseURI : baseURI du projet,
		* selectedTarget : entrée de menu courante (valeur d'un des attributs @target).


		* selectedTarget : entrée de menu courante (valeur d’un des attributs @target).

		## Sommaires

		@@ -28,7 +27,7 @@ Il est possible de :
		#### Modification de la XQuery
		Pour modifier la Xquery, il convient de :

		1. Créer un fichier editions/[projectId]/xq/toc.xq,
		1. Créer un fichier <span class="dossier">editions</span>/<span class="dossier">[edition]</span>/<span class="dossier">xq</span>/<span class="fichier">toc.xq</span>,
		2. Y rédiger une requête Xquery prenant en compte 3 paramètres :

		* $baseURI : valeur de la variable de configuration [baseURI](../config#la-variable-baseuri)
		@@ -49,10 +48,10 @@ declare variable $project external;
		<ul>
		```

		Afin d'être compatible avec la XSL de la table des matières de MaX (fichier MAX/ui/xsl/toc.xsl), cette XQuery doit générer
		une balise `<ul/>` composée d'élements `<li/>` et `<ul/>`. Les items de liens devront renseigner ces liens dans l'attribut data-href.
		Afin d'être compatible avec la XSL de la table des matières de MaX (fichier <span class="dossier">[projet-]MaX</span>/<span class="dossier">ui</span>/<span class="dossier">xsl</span>/<span class="dossier">[tei ou ead]</span>/<span class="fichier">toc.xsl</span>), cette XQuery doit générer
		un élément `<ul/>` composé d’éléments `<li/>` (et `<ul/>` s’il y a besoin de listes impriquées). Les valeurs des liens devront être renseignées en valeur de l’attribut data-href de l’élément ``<li>``.

		Exemple de listing (généré par la XQuery par défaut de MaX) compatible avec MAX/ui/xsl/toc.xsl :
		Exemple de listing (généré par la XQuery par défaut de MaX) compatible avec <span class="dossier">[projet-]MaX</span>/<span class="dossier">ui</span>/<span class="dossier">xsl</span>/<span class="dossier">tei</span>/<span class="fichier">toc.xsl</span> :

		```
		<ul>
		@@ -77,27 +76,29 @@ Exemple de listing (généré par la XQuery par défaut de MaX) compatible avec
		#### Modification de la XSL


		Créer un fichier editions/[projectId]/ui/xsl/toc.xsl afin de transformer le résultat de la XQuery
		(XQuery par défaut ou surcharge editions/[projectId]/xq/toc.xq ) en HTML.
		Pour modifier la XSL par défaut, il faut créer un fichier <span class="fichier">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">toc.xsl</span>
		Cette XSL permet detransformer le résultat de la XQuery par défaut ou celle qui la surcharge (<span class="dossier">[projet-]editions</span>/<span class="dossier">[edition]</span>/<span class="dossier">xq</span>/<span class="fichier">toc.xq</span>) en HTML.

		En l'absence d'un tel fichier, MaX exécutera MAX/ui/xsl/toc.xsl.
		En l’absence d'un tel fichier, MaX exécutera <span class="dossier">[projet-]MaX</span>/<span class="dossier">ui</span>/<span class="dossier">xsl</span>/<span class="dossier">[tei ou ead]</span>/<span class="fichier">toc.xsl</span>.

		### Sommaire d'un document
		Tout comme le sommaire d'une édition, il est possible de :
		### Sommaire d’un document

		* Modifier la XQuery afin de modifier les éléments sélectionnés pour le sommaire,
		* Modifier la XSL transformant ces éléments au format HTML.
		Tout comme le sommaire d’une édition, il est possible de :

		* modifier la XQuery afin de modifier les éléments sélectionnés pour le sommaire,
		* modifier la XSL transformant ces éléments au format HTML.

		#### Modification de la XQuery

		1. Créer un fichier editions/[projectId]/xq/document_toc.xq
		1. Créer un fichier <span class="dossier">[projet-]editions</span>/<span class="dossier">[edition]</span>/<span class="dossier">xq</span>/<span class="fichier">document_toc.xq</span>
		2. Y rédiger une requête Xquery prenant en compte 4 paramètres :
		* $baseURI : valeur de la variable de configuration [baseURI](../config#la-variable-baseuri),
		* $dbPath : valeur de la variable de configuration [dbPath](../config),
		* $project : identifiant de l'édition,
		* $project : identifiant de l’édition,
		* $doc : nom du document courant pour lequel est construite la table des matières.

		Exemple de squelette d'une telle XQuery :
		Exemple de squelette d’une telle XQuery :

		```

		@@ -119,15 +120,17 @@ declare variable $doc external;

		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.
		* retourner le sommaire dans un élement `<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.

		#### Modification de la XSL

		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>

		Créer un fichier editions/[projectId]/ui/xsl/document_toc.xsl afin de transformer le résultat de la XQuery
		(XQuery par défaut ou surcharge 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">editions/[projectId]/xq/document_toc.xq** ) en HTML.
		Cette XSL reçoit en entrée :

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

documentation/docs/static_pages.md

+2 −2

Original line number	Diff line number	Diff line
		# Pages statiques

		Les pages statiques d’une édition sont écrites en XHTML et se placent dans le dossier ``[projet-]editions/[edition]/fragments``. Chaque fichier a pour extension `.frag.html`
		Les pages statiques d’une édition sont écrites en XHTML et se placent dans le dossier <span class="dossier">[projet-]editions</span>/<span class="dossier">[edition]</span>/<span class="dossier">fragments</span>. Chaque fichier a pour extension `.frag.html`

		<div class="mermaid">
		graph LR;
		@@ -14,5 +14,5 @@ graph LR;
		</div>


		Si le contenu de l’élément `<target>` est `presentation.html` dans le fichier `menu.xml`, MaX va alors chercher dans le dossier `[projet-]editions/[mon-edition]/fragments` un fichier `presentation.frag.html` afin de l’afficher.
		Si le contenu de l’élément `<target>` est `presentation.html` dans le fichier <span class="fichier">menu.xml</span>, MaX va alors chercher dans le dossier <span class="dossier">[projet-]editions</span>/<span class="dossier">[edition]</span>/<span class="dossier">fragments</span> un fichier <span class="fichier">presentation.frag.html</span> afin de l’afficher.
		Voir d’autres exemples dans la section [[Menu]](../menu#menu).
		No newline at end of file

documentation/docs/text.md

+2 −2

Original line number	Diff line number	Diff line
		@@ -3,9 +3,9 @@
		La consultation des textes se fait aux URLs suivantes :

		* consultation d’un fragment identifié :
		`http://[host]:[port]/[edition]/[document_path].xml/[id].html`
		`http://[host]:[port]/[edition]/[document].xml/[id].html`
		* consultation d’un document XML complet
		`http://[host]:[port]/[edition]/doc/[document_path].html]`
		`http://[host]:[port]/[edition]/doc/[document].html]`
		* consultation « isolée », pour afficher le texte seul en dehors du site (c'est-à-dire sans menu, barre de navigation, etc., par exemple pour l'afficher dans une pop-up) : `http://[host]:[port]/[edition]/fragment_html/[id].html`.
		L’ajout du paramètre `?wrap=true` offre une consultation dans une page HTML complète (avec appels aux css et js du site) :
		`http://[host]:[port]/[edition]/fragment_html/[id].html?wrap=true`

documentation/docs/toc.md

+1 −1

Original line number	Diff line number	Diff line
		@@ -49,7 +49,7 @@ Voir la section [surcharges, sommaire d’une édition](../overriding/#sommaire-
		## Sommaire d’un document

		Le sommaire d’un document est disponible enn consultant l’URL :
		`http://[host]:[port]/[edition]/sommaire/[document_path].html`
		`http://[host]:[port]/[edition]/sommaire/[document].html`

		Par exemple :