Pleade Menus - Historique des versions

Groche : a déplacé Doc/Pleade/Menus vers Pleade Menus

2013-04-24T10:50:30Z

a déplacé Doc/Pleade/Menus vers Pleade Menus

← Version précédente	Version du 24 avril 2013 à 10:50
(Aucune différence)

Groche : /* Élément {{tag|item}} */ typo

2012-05-28T14:19:18Z

Élément {{tag|item}} : typo

← Version précédente		Version du 28 mai 2012 à 14:19
Ligne 108 :		Ligne 108 :
	Le texte affiché pour l'item est celui que l'on trouve à l'intérieur de l'élément {{tag\|item}}. Dans le fichier par défaut de Pleade, ce texte utilise le mécanisme [[i18n]] de Cocoon, mais cela n'est pas obligatoire et n'est pas documenté ici. On peut également y insérer du simple texte.		Le texte affiché pour l'item est celui que l'on trouve à l'intérieur de l'élément {{tag\|item}}. Dans le fichier par défaut de Pleade, ce texte utilise le mécanisme [[i18n]] de Cocoon, mais cela n'est pas obligatoire et n'est pas documenté ici. On peut également y insérer du simple texte.

			==== Attributs de l'élément {{tag\|item}} ====
	Ensuite, les informations qui définissent le comportement de l'item sont renseignées en attribut de l'élément item. Nous les définissons de la façon suivante :		Ensuite, les informations qui définissent le comportement de l'item sont renseignées en attribut de l'élément item. Nous les définissons de la façon suivante :
	{\| class="wikitable sortable"		{\| class="wikitable sortable"
Ligne 160 :		Ligne 161 :
	\| {{attr\|onclick}} \|\| ''Optionnel''. Cet attribut et son contenu sont reportés dans le HTML généré.		\| {{attr\|onclick}} \|\| ''Optionnel''. Cet attribut et son contenu sont reportés dans le HTML généré.
	\|-		\|-
	\| {{attr\|context}} \|\| ''Optionnel''. Le contexte où cet item est « actif », c'est-à-dire le patron d'URL qui, s'il est respecté par la page en cours d'affichage, rend l'item actif. Le patron est une expression régulière valide selon la norme XSLT<ref>[http://www.w3.org/TR/xpath-functions/#regex-syntax Regular Expression Syntax] XQuery 1.0 and XPath 2.0 Functions and Operators (Second Edition)</ref><ref>[http://www.datypic.com/books/defxmlschema/chapter10.html Definitive XML Schema, Chapter 10: Regular expressions]</ref><ref>[http://www.xml.com/pub/a/2003/06/04/tr.html Regular Expression Matching in XSLT 2]</ref>. Le contexte peut aussi être donné par l'attribut {{attr\|href}}, dans ce cas, il faut indiquer {{value\|@href}}		\| {{attr\|context}} \|\| ''Optionnel''. Le contexte où cet item est « actif », c'est-à-dire le patron d'URL qui, s'il est respecté par la page en cours d'affichage, rend l'item actif. Le patron est une expression régulière valide selon la norme XSLT<ref>[http://www.w3.org/TR/xpath-functions/#regex-syntax Regular Expression Syntax] XQuery 1.0 and XPath 2.0 Functions and Operators (Second Edition)</ref><ref>[http://www.datypic.com/books/defxmlschema/chapter10.html Definitive XML Schema, Chapter 10: Regular expressions]</ref><ref>[http://www.xml.com/pub/a/2003/06/04/tr.html Regular Expression Matching in XSLT 2]</ref>.
			Le contexte peut aussi être donné par l'attribut {{attr\|href}}, dans ce cas, il faut indiquer {{value\|@href}}
	comme contexte.		comme contexte.

	Par exemple, si le contexte est {{path\|edit/.*}}, cela signifie que l'item sera actif lorsque la page affiché a une URL qui comme par {{path\|edit/}}.		Par exemple, si le contexte est {{path\|edit/.*}}, cela signifie que l'item sera actif lorsque la page affiché a une URL qui comme par {{path\|edit/}}.
	\|-		\|-
Ligne 168 :		Ligne 171 :
	\|-		\|-
	\| {{attr\|title}} \|\| ''Optionnel'', mais recommandé pour des raisons d'accessibilité et de facilité d'utilisation.		\| {{attr\|title}} \|\| ''Optionnel'', mais recommandé pour des raisons d'accessibilité et de facilité d'utilisation.
	Le texte qui sera affiché en bulle d'aide lorsque l'utilisateur passe la souris au-dessus du lien. Par défaut, le		Le texte qui sera affiché en bulle d'aide lorsque l'utilisateur passe la souris au-dessus du lien. Par défaut, le contenu de cet attribut est une clé [[i18n]] dont la valeur est définie dans un fichier de message.
	contenu de cet attribut est une clé [[i18n]] dont la valeur est définie dans un fichier de message.
	Cette méthode simplifie l'internationalisation de l'application. Mais ce n'est pas obligatoire, on peut y mettre le texte directement.		Cette méthode simplifie l'internationalisation de l'application. Mais ce n'est pas obligatoire, on peut y mettre le texte directement.
	\|-		\|-
	\| {{attr\|reserve}} \|\| ''Optionnel''. Cet attribut peut contenir un ou plusieurs rôles (séparés par une {{var\|espace}}), et si c'est le cas		\| {{attr\|reserve}} \|\| ''Optionnel''. Cet attribut peut contenir un ou plusieurs rôles (séparés par une {{var\|espace}}), et si c'est le cas l'item ne sera visible que si l'utilisateur est identifié et joue l'un de ces rôles.
	l'item ne sera visible que si l'utilisateur est identifié et joue l'un de ces rôles.
	{{important\|Par défaut, c'est-à-dire si l'attribut n'est pas renseigné, l'item est visible par tous}}		{{important\|Par défaut, c'est-à-dire si l'attribut n'est pas renseigné, l'item est visible par tous}}
	\|-		\|-
	\| {{attr\|reserve-uri}} \|\| ''Optionnel''. Cet attribut peut contenir un ou plusieurs patrons d'URL (séparés par une {{var\|espace}}), et si		\| {{attr\|reserve-uri}} \|\| ''Optionnel''. Cet attribut peut contenir un ou plusieurs patrons d'URL (séparés par une {{var\|espace}}), et si c'est le cas l'item ne sera visible que si l'URL demandée correspond à l'un des patrons.
	c'est le cas l'item ne sera visible que si l'URL demandée correspond à l'un des patrons.
	{{important\|Par défaut, c'est-à-dire si l'attribut n'est pas renseigné, l'item est visible pour toutes les URL}}		{{important\|Par défaut, c'est-à-dire si l'attribut n'est pas renseigné, l'item est visible pour toutes les URL}}
	\|}		\|}


	== Références ==		== Références ==

Groche : /* Élément {{tag|menu}} */ typo

2012-05-28T13:59:46Z

Élément {{tag|menu}} : typo

← Version précédente		Version du 28 mai 2012 à 13:59
Ligne 66 :		Ligne 66 :
	\|}		\|}
	\|-		\|-
	\| {{attr\|depends}} \|\| ''Optionnel''. La dépendance du menu par rapport à un autre. Si un menu est dépendant d'un autre, il ne sera affiché que si le menu dont il est dépendant est lui-même actif. Le contenu de l'attribut est		\| {{attr\|depends}} \|\| ''Optionnel''. La dépendance du menu par rapport à un autre.
	l'identifiant du menu dont il dépend. Si l'attribut n'est pas présent, il n'y a aucune dépendance (le		Si un menu est dépendant d'un autre, il ne sera affiché que si le menu dont il est dépendant est lui-même actif.

			Le contenu de l'attribut est l'identifiant du menu dont il dépend. Si l'attribut n'est pas présent, il n'y a aucune dépendance (le
	menu est toujours affiché).		menu est toujours affiché).
	\|-		\|-
Ligne 73 :		Ligne 75 :
	Dans le cas, d'un menu vertical (type vleft), si on donne la classe {{value\|pl-accordion}} à un menu, celui-ci s'affichera sous la forme d'un accordéon, c'est-à-dire que l'on peut plier ou déplier ses sous-entrées.		Dans le cas, d'un menu vertical (type vleft), si on donne la classe {{value\|pl-accordion}} à un menu, celui-ci s'affichera sous la forme d'un accordéon, c'est-à-dire que l'on peut plier ou déplier ses sous-entrées.
	[[Image:Exemple/menu-accordéon.png]]		[[Image:Exemple/menu-accordéon.png]]
			\|-
			\| {{attr\|default}} \|\| ''Optionnel''. Avec la valeur {{value\|true}} permet de préciser le menu à afficher par défaut.
			{{remarque\|Il ne doit être présent que sur un seul menu par type}}

			Il est surtout utile pour les menus verticaux ; il peut y en avoir plusieurs car on peut associer à menu vertical à un onglet.
	\|}		\|}

	Un attribut default avec la valeur true permet de préciser le menu à afficher par défaut. Il ne doit être mis que sur un seul menu par type. Il est surtout utile pour les menus verticaux ; il peut y en avoir plusieurs car on peut associer à menu vertical à un onglet.

	=== Élément {{tag\|item}} ===		=== Élément {{tag\|item}} ===

Groche : /* Élément {{tag|menu}} */ typo

2012-05-28T13:55:09Z

Élément {{tag|menu}} : typo

← Version précédente		Version du 28 mai 2012 à 13:55
Ligne 66 :		Ligne 66 :
	\|}		\|}
	\|-		\|-
	\| {{attr\|depends}} \|\| ''Optionnel''. La dépendance du menu par rapport à un autre. Si un menu est dépendant d'un autre, il ne		\| {{attr\|depends}} \|\| ''Optionnel''. La dépendance du menu par rapport à un autre. Si un menu est dépendant d'un autre, il ne sera affiché que si le menu dont il est dépendant est lui-même actif. Le contenu de l'attribut est
	sera affiché que si le menu dont il est dépendant est lui-même actif. Le contenu de l'attribut est
	l'identifiant du menu dont il dépend. Si l'attribut n'est pas présent, il n'y a aucune dépendance (le		l'identifiant du menu dont il dépend. Si l'attribut n'est pas présent, il n'y a aucune dépendance (le
	menu est toujours affiché).		menu est toujours affiché).

Groche : création+catégories+formatage

2012-05-23T16:34:17Z

création+catégories+formatage

Nouvelle page

== Menus ==
Pleade propose des menus de navigation qui sont construits dynamiquement à partir du fichier de
configuration {{path|module-eadeac/conf/menus.xconf}} (voir en [[Annexe/Fichier de configuration des
menus]]). Chaque menu et chaque item y est défini de manière déclarative, sans programmation. La structure
XML de ce fichier est très simple. Nous allons l'aborder par étape.

=== Structure générale ===
La structure générale du fichier est la suivante :
<syntaxhighlight lang="xml">
<menus>
<menu id="" type="">
<item id="" type="" … />
<item id="" type="" … />
<item id="" type="" … >
<item id="" type="" … />
<item id="" type="" … />
⋮
</item>
⋮
</menu>
<menu>
⋮
</menu>
</menus>
</syntaxhighlight>
Ainsi, au premier niveau, le fichier contient un élément {{tag|menus}} qui contient un ou plusieurs élément(s) {{tag|menu}}.
Ces derniers contiennent des éléments {{tag|item}}, qui peuvent eux-mêmes contenir d'autres éléments {{tag|item}}, ce qui constitue un sous-menu en quelque sorte.

Nous allons documenter d'abord la définition d'un {{tag|menu}}, ensuite des {{tag|item}}.

=== Élément {{tag|menu}} ===
La définition d'un menu est fait à l'aide de la structure XML suivante :
<syntaxhighlight lang="xml">
<menu
id=""
type=""
depends=""
reserve=""
class="pl-accordion"
>
<item … />
<menu … />
⋮
</menu>
</syntaxhighlight>
Un élément {{tag|menu}} peut contenir un sous-élément {{tag|menu}}, {{tag|item}} ou les deux types.

Les informations importantes sont donc définies dans les quatre attributs, définis ci-dessous :
{| class="wikitable sortable"
|-
!Paramètre !! Description
|-
| {{attr|id}} || '''Obligatoire'''. L'identifiant du menu.
Il doit être unique parmi tous les identifiants du fichier, menus ou items. Il sert notamment à déclarer les dépendances entre menus.
|-
| {{attr|type}} || '''Obligatoire'''. Le type de menu, qui détermine notamment son emplacement dans la page. Les valeurs possibles sont :
{| class="wikitable sortable"
|-
!Paramètre !! Description
|-
| {{value|htop}} || pour un positionnement horizontal en haut de page, avant même l'en-tête de la page.
|-
| {{value|htabs}} || pour un positionnement sous l'en-tête de la page, sous la forme d'onglets à l'horizontal.
|-
| {{value|vleft}} || pour un menu de navigation vertical à gauche de la page.
|}
|-
| {{attr|depends}} || ''Optionnel''. La dépendance du menu par rapport à un autre. Si un menu est dépendant d'un autre, il ne
sera affiché que si le menu dont il est dépendant est lui-même actif. Le contenu de l'attribut est
l'identifiant du menu dont il dépend. Si l'attribut n'est pas présent, il n'y a aucune dépendance (le
menu est toujours affiché).
|-
| {{attr|class}} || ''Optionnel''. Permet de donner une classe particulière pour ajuster la mise en forme dans une feuille de style CSS.
Dans le cas, d'un menu vertical (type vleft), si on donne la classe {{value|pl-accordion}} à un menu, celui-ci s'affichera sous la forme d'un accordéon, c'est-à-dire que l'on peut plier ou déplier ses sous-entrées.
[[Image:Exemple/menu-accordéon.png]]
|}

Un attribut default avec la valeur true permet de préciser le menu à afficher par défaut. Il ne doit être mis que sur un seul menu par type. Il est surtout utile pour les menus verticaux ; il peut y en avoir plusieurs car on peut associer à menu vertical à un onglet.

=== Élément {{tag|item}} ===
La définition des attributs des items permet d'automatiser la création de plusieurs types de liens.

Pour ce qui est de son contenu, un item doit fournir une indication à l'utilisateur (un « texte ») et, dans la plupart des cas, un lien hypertexte.

La structure générale d'un item de menu est la suivante :
<syntaxhighlight lang="xml">
<item
id=""
type=""
href=""
context=""
title=""
field=""
reserve=""
reserve-uri=""
>
Texte affiché du menu
<item … />
⋮
</item>
</syntaxhighlight>
Un {{tag|item}} peut contenir d'autres items, qui définissent ainsi des sous-menus, ou encore des items de niveau inférieur. La structure des éléments {{tag|item}} est la même peu importe le niveau.

Le texte affiché pour l'item est celui que l'on trouve à l'intérieur de l'élément {{tag|item}}. Dans le fichier par défaut de Pleade, ce texte utilise le mécanisme [[i18n]] de Cocoon, mais cela n'est pas obligatoire et n'est pas documenté ici. On peut également y insérer du simple texte.

Ensuite, les informations qui définissent le comportement de l'item sont renseignées en attribut de l'élément item. Nous les définissons de la façon suivante :
{| class="wikitable sortable"
|-
!Paramètre !! Description
|-
| {{attr|id}} || '''Obligatoire'''. L'identifiant de l'item.
Il doit être unique parmi tous les identifiants du fichier, menus ou items.
|-
| {{attr|type}} || '''Obligatoire'''. Le type d'item.
{| class="wikitable sortable"
|-
!Paramètre !! Description
|-
Plusieurs valeurs sont possibles, et le contenu de l'attribut {{attr|href}} sera interprété différemment selon le type d'item :
|-
| {{value|link-normal}} || un lien normal, c'est-à-dire dont la cible sera affichée dans la même page que celle où se trouve l'item.
|-
| {{value|link-ead}} || un lien vers un document EAD, qui ouvrira la fenêtre de consultation d'un document EAD. L'attribut {{attr|href}} doit alors contenir l'identifiant du document EAD.
|-
| {{value|link-window}} || un lien qui ouvrira une autre fenêtre de navigation dans le navigateur Internet. Si l'on souhaite que la fenêtre ait un nom spécifique dans le navigateur (ce nom n'est
pas visible, mais cela permet d'éviter plusieurs fenêtre différentes), on peut renseigner ce nom après un « {{var|:}} » (deux-points), par exemple {{value|link-window:}}{{value|'''ext'''}}.
|-
| {{value|txt}} || un item qui n'est pas un lien, mais uniquement un texte affiché.
|-
| {{value|grp}} || un item qui contient uniquement d'autres items. S'il contient directement du texte, celui-ci sera ignoré.
|-
| {{value|simple-search}} || un formulaire de recherche simple sera inséré par Pleade à l'emplacement de cet item. Si ce type est utilisé, on peut ajouter quatre attributs à l'élément item :
{| class="wikitable sortable"
|-
!Paramètre !! Description
|-
| {{attr|action}} || pour indiquer la page de résultats de recherche (par défaut {{path|results.html}}) ;
|-
| {{attr|method}} || pour indiquer la méthode de soumission du formulaire (par défaut {{value|get}}) ;
|-
| {{attr|base}} || pour indiquer la ou les base(s) de documents à rechercher (par défaut {{value|ead}}), séparées par un {{var|espace}} ;
|-
| {{attr|@field}} || pour modifier le champ de recherche (par défaut {{value|fulltext}}).
|}
[[Image:Exemple/recherche-simple.png]]
|}
|-
| {{attr|href}} || '''Obligatoire''', sauf pour les liens de {{attr|type}}={{value|txt}} ou {{attr|type}}={{value|simple-search}}.
Indique l'adresse de la cible du lien représenté par cet item.

Pour les items de {{attr|type}}={{value|link-window}} ou {{value|link-normal}}, {{attr|href}} doit contenir l'adresse URL, qui peut être relative ou absolue (les protocoles supportés sont : {{path|http}} et {{path|mailto}}). Dans le cas d'adresse relative, on doit la renseigner par rapport à l'URL racine de l'application Pleade.

Pour les items de {{attr|type}}={{value|link-ead}}, c'est l'identifiant du document EAD uniquement qui doit être
renseigné dans cet attribut.
|-
| {{attr|onclick}} || ''Optionnel''. Cet attribut et son contenu sont reportés dans le HTML généré.
|-
| {{attr|context}} || ''Optionnel''. Le contexte où cet item est « actif », c'est-à-dire le patron d'URL qui, s'il est respecté par la page en cours d'affichage, rend l'item actif. Le patron est une expression régulière valide selon la norme XSLT<ref>[http://www.w3.org/TR/xpath-functions/#regex-syntax Regular Expression Syntax] XQuery 1.0 and XPath 2.0 Functions and Operators (Second Edition)</ref><ref>[http://www.datypic.com/books/defxmlschema/chapter10.html Definitive XML Schema, Chapter 10: Regular expressions]</ref><ref>[http://www.xml.com/pub/a/2003/06/04/tr.html Regular Expression Matching in XSLT 2]</ref>. Le contexte peut aussi être donné par l'attribut {{attr|href}}, dans ce cas, il faut indiquer {{value|@href}}
comme contexte.
Par exemple, si le contexte est {{path|edit/.*}}, cela signifie que l'item sera actif lorsque la page affiché a une URL qui comme par {{path|edit/}}.
|-
| {{attr|field}} || ''Optionnel'' et uniquement pour un item de {{attr|type}}={{value|simple-search}}.
Précise le nom du champ de recherche pour la recherche simple, par défaut celui-ci est {{value|fulltext}}.
|-
| {{attr|title}} || ''Optionnel'', mais recommandé pour des raisons d'accessibilité et de facilité d'utilisation.
Le texte qui sera affiché en bulle d'aide lorsque l'utilisateur passe la souris au-dessus du lien. Par défaut, le
contenu de cet attribut est une clé [[i18n]] dont la valeur est définie dans un fichier de message.
Cette méthode simplifie l'internationalisation de l'application. Mais ce n'est pas obligatoire, on peut y mettre le texte directement.
|-
| {{attr|reserve}} || ''Optionnel''. Cet attribut peut contenir un ou plusieurs rôles (séparés par une {{var|espace}}), et si c'est le cas
l'item ne sera visible que si l'utilisateur est identifié et joue l'un de ces rôles.
{{important|Par défaut, c'est-à-dire si l'attribut n'est pas renseigné, l'item est visible par tous}}
|-
| {{attr|reserve-uri}} || ''Optionnel''. Cet attribut peut contenir un ou plusieurs patrons d'URL (séparés par une {{var|espace}}), et si
c'est le cas l'item ne sera visible que si l'URL demandée correspond à l'un des patrons.
{{important|Par défaut, c'est-à-dire si l'attribut n'est pas renseigné, l'item est visible pour toutes les URL}}
|}

== Références ==
<references/>
[[category:Doc]]
[[category:Menu]]
[[category:Pleade]]

Pleade Menus - Historique des versions

Groche : a déplacé Doc/Pleade/Menus vers Pleade Menus

Groche : /* Élément {{tag|item}} */ typo

Groche : /* Élément {{tag|menu}} */ typo

Groche : /* Élément {{tag|menu}} */ typo

Groche : création+catégories+formatage

Groche : a déplacé Doc/Pleade/Menus vers Pleade Menus

Groche : /* Élément {{tag|item}} */ typo

Groche : /* Élément {{tag|menu}} */ typo

Groche : /* Élément {{tag|menu}} */ typo

Groche : création+catégories+formatage