maj (0beeba57) · Commits · pdn-certic / MaX

documentation/docs/text.md

+19 −20

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

		La feuille de transformation appliquée par défaut se trouve dans :

		* pour la TEI : ``[projet-]MaX/ui/xsl/tei/tei.xsl`` ;
		* pour l’EAD : ``[projet-]MaX/ui/xsl/ead/ead.xsl`` ;
		* pour la TEI : <span class="dossier">[projet-]MaX</span>/<span class="dossier">ui</span>/<span class="dossier">xsl</span>/<span class="dossier">tei</span>/<span class="fichier">tei.xsl</span> ;
		* pour l’EAD : <span class="dossier">[projet-]MaX</span>/<span class="dossier">ui</span>/<span class="dossier">xsl</span>/<span class="dossier">tei</span>/<span class="fichier">ead.xsl</span> ;

		La surcharge de cette transformation se fait en rédigeant une XSL placée dans :
		`[projet-]editions/[edition]/ui/xsl/text_hook.xsl`.
		<span class="dossier">[projet-]editions</span>/<span class="dossier">[edition]</span>/<span class="dossier">ui</span>/<span class="dossier">xsl</span>/<span class="dossier">text_hook.xsl</span>.

		<div class="mermaid">
		graph LR;
		@@ -49,8 +49,8 @@ Voir [Surcharges, Barre de navigation](../overriding#barre-de-navigation).

		![Options de lecture](images/optionsLecture.png)

		Les options de lecture permettent au lecteur d'afficher ou masquer (via des cases à cocher) certains éléments textuels (les sauts de page de la version manuscrite par exemple, ou les sauts de ligne).
		Ces éléments doivent être déclarés dans le fichier de configuration de l'édition (le fichier mon-edition_config_inc.xml).
		Les options de lecture permettent au lecteur d’afficher ou masquer (via des cases à cocher) certains éléments textuels (les sauts de page de la version manuscrite par exemple, ou les sauts de ligne).
		Ces éléments doivent être déclarés dans le fichier de configuration de l’édition (le fichier <span class="fichier">mon-edition_config_inc.xml</span>).

		Par exemple pour les sauts de page TEI (éléments `<pb/>`) :

		@@ -66,18 +66,17 @@ Par exemple pour les sauts de page TEI (éléments `<pb/>`) :

		Les noeuds TEI `<pb/>` étant transformés en noeud HTML `<li>` de classe `.pb` pourront alors être affichés ou masqués depuis l'interface de consultation.

		Pour les éléments plus complexes, comme l'affichage de certains éléments à la place d'autres, avec l'utilisation de la balise `<choice>` notamment, des plugins ont été développés. C'est le cas des plugins
		ajout, abreviation, normalisation, etc. Voir [les plugins](../plugins).
		Pour les éléments plus complexes, comme l’affichage de certains éléments à la place d’autres, avec l'utilisation de la balise `<choice>` notamment, des plugins ont été développés. C’est le cas des plugins ajout, abreviation, normalisation, etc. Voir [les plugins](../plugins).

		## Alignement

		Cette fonctionnalité permet la consultation d’un fragment en deux versions alignées. Chaque couple de fragment alignés doit respecter une nomenclature d’identification : `[prefixlang1][identifiant]` et `[prefixlang2][identifiant]`. Les parties de texte qui sont à aligner doivent donc avoir un identifiant identique avec le préfixe de la langue.
		Cette fonctionnalité permet la consultation d’un fragment en deux versions alignées. Chaque couple de fragments alignés doit respecter une nomenclature d’identification : `[prefixlang1][identifiant]` et `[prefixlang2][identifiant]`. Les parties de texte qui sont à aligner doivent donc avoir un identifiant identique avec le préfixe de la langue.

		```
		Exemple : fr_p1 et lat_p1
		```

		La déclaration des documents qui doivent être consultés avec l'alignement se fait dans le fichier de configuration de l’édition `mon-edition_config_inc.xml`.
		La déclaration des documents qui doivent être consultés avec l'alignement se fait dans le fichier de configuration de l’édition <span class="fichier">mon-edition_config_inc.xml</span>.

		<div class="mermaid">
		graph LR;
		@@ -85,10 +84,10 @@ graph LR;
		B-->C
		A["projet-editions"]
		B["mon-edition"]
		C("mon-edition_config_inc.xq")
		C("mon-edition_config_inc.xml")
		</div>

		Il faut alors préciser le document (attribut `@document`) ainsi que les préfixes d'identifications utilisés (attributs `@first-prefix` et `@second-prefix`) dans les sources. L'attribut `@first-prefix` correspondant à la langue qui sera affichée en colonne de gauche.
		Il faut alors préciser le document (attribut `@document`) ainsi que les préfixes d’identifications utilisés (attributs `@first-prefix` et `@second-prefix`) dans les sources. L’attribut `@first-prefix` correspondant à la langue qui sera affichée en colonne de gauche.

		Par exemple :

		@@ -123,7 +122,7 @@ del stretto detto di Magallanes [...]

		Lors de la consultation d’un fragment, il peut s’avérer nécessaire d’afficher du contenu issu d’un ou plusieurs autres fragments.

		L’ajout d'une XQUERY dans ``[projet-]editions/[edition]/xq/text_hook.xq`` offre cette fonctionnalité. Celle-ci sera automatiquement exécutée lors
		L’ajout d'une XQUERY dans <span class="dossier">[projet-]editions</span>/<span class="dossier">[edition]</span>/<span class="dossier">xq</span>/<span class="fichier">text_hook.xq</span> offre cette fonctionnalité. Celle-ci sera automatiquement exécutée lors
		de la consultation d’un fragment ou d’un document complet.

		<div class="mermaid">
		@@ -154,23 +153,23 @@ return base-uri($document)
		````


		## Marquage d’occurrences & focus
		## Marquage d’occurrences et focus

		Il est possible de mettre en évidence les occurences d’une chaîne de caractères et/ou de mettre le focus sur un fragment identifié de la page pour les 2 URLs (ou routes) 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 complet :
		`http://[host]:[port]/[edition]/doc/[document_path].html`
		`http://[host]:[port]/[edition]/doc/[document].html`

		Le marquage d’occurrences se fait par l’ajout du paramètre `search` :

		`http://[host]:[port]/[edition]/[document_path.xml]/[id].html?search=[texte recherché]`
		`http://[host]:[port]/[edition]/[document].xml/[id].html?search=[texte recherché]`

		Le focus sur un fragment identifié se fait par l’ajout du paramètre `focus` :

		`http://[host]:[port]/[edition]/[document_path].xml/[id].html?focus=[identifiant fragment]`
		`http://[host]:[port]/[edition]/[document].xml/[id].html?focus=[identifiant fragment]`

		Il est possible de combiner les deux paramètres :

		`http://[host]:[port]/[edition]/[document_path.xml]/[id].html?search=[texte recherché]&focus=[identifiant fragment]`
		No newline at end of file
		`http://[host]:[port]/[edition]/[document].xml/[id].html?search=[texte recherché]&focus=[identifiant fragment]`
		No newline at end of file

documentation/docs/toc.md

+9 −8

Original line number	Diff line number	Diff line
		@@ -33,7 +33,7 @@ Le résultat de cette requête est ensuite transformé par la xsl :

		<br/>

		Dans le cas où les fichiers XML sont organisés en dossiers et sous-dossiers, l’arborescence est restituée dans le sommaire. Voir max_ead_demo ;
		Dans le cas où les fichiers XML sont organisés en dossiers et sous-dossiers, l’arborescence est restituée dans le sommaire. Voir l’édition de démonstration EAD : max_ead_demo ;

		### Surcharge du comportement

		@@ -48,31 +48,32 @@ Voir la section [surcharges, sommaire d’une édition](../overriding/#sommaire-

		## Sommaire d’un document

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

		Par exemple :

		```
		http://localhost:17002/mon-edition/sommaire/document1.xml
		http://localhost:17002/mon-edition/sommaire/document1.html
		```

		Par défaut, MaX parcourt le document XML, mentionné dans l’URL, et affiche :


		* pour la TEI : les éléments `<head/>` des éléments ``<div>`` identifiées (avec un attribut ``@xml:id``) contenant un attribut ``@type`` ;
		* pour l’EAD : les balises `<unittitle/>` et `<unittid/>` des composants (éléments `<c>`) identifiés.
		* pour l’EAD : les balises `<unittitle/>` et `<unittid/>` des composants (éléments `<archdesc>` et `<c>`) identifiés.

		Les requêtes XQuery correspondantes sont stockées dans :

		* pour la TEI :
		`[projet-]MaX/rxq/tei/document_toc.xq`,
		<span class="dossier">[projet-]MaX</span>/<span class="dossier">rxq</span>/<span class="dossier">tei</span>/<span class="fichier">document_toc.xq</span>,
		* pour l’EAD :
		`[projet-]MaX/rxq/ead/document_toc.xq`.
		<span class="dossier">[projet-]MaX</span>/<span class="dossier">rxq</span>/<span class="dossier">ead</span>/<span class="fichier">document_toc.xq</span>.

		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`
		* pour la TEI : <span class="dossier">[projet-]MaX</span>/<span class="dossier">ui</span>/<span class="dossier">xsl</span>/<span class="dossier">tei</span>/<span class="fichier">document_toc.xsl</span>
		* pour l’EAD : <span class="dossier">[projet-]MaX</span>/<span class="dossier">ui</span>/<span class="dossier">xsl</span>/<span class="dossier">ead</span>/<span class="fichier">document_toc.xsl</span>

		\|Nota Bene\|
		\|---------\|