Génération du site web de l'ULB - format xml
sommairesommaireindexindexpage suivantepage suivanteimprimerimprimerenvoyerenvoyermarquermarquer

Utiliser des paramètres dans un texte, dans un lien hypertexte, dans un formulaire...

Grâce à l'utilisation de paramètres placés entre accolades, on peut automatiquement inclure des données dans, par exemple, le texte d'un paragraphe, l'URL d'un lien hypertexte, le champ d'un formulaire, etc.

Ces paramètres sont regroupés dans des ensembles. Chaque ensemble possède son identificateur propre, et chaque paramètre possède un nom et une valeur.

Pour utiliser la valeur d'un paramètre, il suffit d'écrire {xxxx:yyyy}, où xxxx est l'identificateur de l'ensemble qui contient le paramètre et yyyy le nom du paramètre désiré.

Dans cet exemple, on écrit un paragraphe qui contient la date et l'heure de la dernière génération. Ces informations sont données par les paramètres genDate et genTime présents dans l'ensemble de paramètres page (voir ci-après). Ils s'utilisent donc en écrivant {page:genDate} et {page:genTime}.

Exemple
<p>Cette page a été générée le {page:genDate} à {page:genTime}.</p>

Cette page a été générée le {page:genDate} à {page:genTime}.

Les ensembles de paramètres

Les ensembles de paramètres permettent de mieux gérer la synchronisation de la page avec toutes les applications éventuelles qui peuvent fournir ces paramètres (par exemple, éviter d'utiliser un formulaire web tant que l'ensemble des paramètres renvoyés par une application ne soient parvenus au navigateur). Pour plus d'information, consultez la page Les ensembles de paramètres.


De base, il existe les ensembles de paramètres suivants:

  • page: qui donne des informations sur la page web

  • server: qui donne des informations fournie par un serveur distant

  • navigator: qui donne des informations fournies localement par le navigateur de l'internaute

  • intranet: qui donne des informations sur la personne connectée à l'Intranet

  • form: qui contient les valeurs récoltées par un formulaire

  • url: qui donne des informations sur l'URL de la page courante

  • url-param: qui contient la liste des valeurs passées dans l'URL


Les éléments <interaction> vous permettent de créer vos propres ensembles de paramètres, à partir d'une application PHP par exemple. L'appel à cette application peut se faire en lui passant la valeur d'autres paramètres (par exemple, le matricule de la personne qui est connectée à l'Intranet).


En savoir plus sur les ensembles de paramètres


Ensemble de paramètres "page" donnant des informations sur la page web

L'ensemble de paramètres page contient une série d'information sur la page courante créée lors de la génération de la page.

Il contient les paramètres suivants (chaque paramètre est illustré avec un exemple):


{page:designDir}

chemin d'accès relatif au répertoire contenant les ressources utilisées dans le design de l'ULB (images, icônes, css, javascript...)

{page:designDir}

{page:topDir}

chemin d'accès relatif vers le répertoire principal (homedir) du site de l'université

{page:topDir}

{page:genDate}

date de la dernière génération de la page

{page:genDate}

{page:genTime}

heure de la dernière génération de la page

{page:genTime}

{page:genDateTime}

date et heure de la dernière génération de la page

{page:genDateTime}

{page:lang}

langue utilisée dans la page ("en", "fr", "nl"...)

{page:lang}

{page:pageId}

identificateur de la page (à utiliser dans un attribut docref)

{page:pageId}

{page:pageLocalId}

identificateur local de la page (à utiliser dans un attribut docref au sein du même projet)

{page:pageLocalId}

{page:pageTarget}

URL relative de la page, par rapport au répertoire principal (homedir) du site de l'université

{page:pageTarget}

{page:pageURL}

URL absolue de la page, lorsqu'elle sera publiée

{page:pageURL}

{page:projectId}

identificateur du projet dont est issue la page

{page:projectId}

{page:sourceId}

identificateur de la source xml au sein du projet dont est issue la page

{page:sourceId}

{page:sourceFile}

nom du fichier de la source xml dont est issue la page

{page:sourceFile}


Exemple d'utilisation

Dans cet exemple, on affiche l'identificateur de la page, ainsi que celui du projet. Cet affichage fait appel à une icône qui se trouve dans le répertoire designDir.

Exemple
<bloc style="class1">
   <p>page<image rel-href="{page:designDir}img/icons/news-more.gif"/>{page:pageId}</p>
   <p>projet<image rel-href="{page:designDir}img/icons/news-more.gif"/>{page:projectId}</p>       
</bloc>

page{page:pageId}

projet{page:projectId}

Ensemble de paramètres "server" donnant des informations fournies par une application distante

L'ensemble de paramètres server contient une série d'information sur le navigateur et l'ordinateur de l'internaute vue du coté du serveur web (en réalité, une application PHP est appelée pour générer ces paramètres).

Il contient les paramètres suivants (chaque paramètre est illustré avec un exemple):


{server:ip}

adresse IP de la machine faisant fonctionner le navigateur

{server:ip}

{server:host}

adresse DNS de la machine faisant fonctionner le navigateur (cette information n'est pas toujours fournie, dans ce cas, l'adresse IP sera utilisée)

{server:host} 

{server:date}

date courante provenant du serveur web

{server:date} 

{server:time}

heure courante provenant du serveur web

{server:time} 

{server:dateTime}

date et heure courantes provenant du serveur web

{server:dateTime} 

{server:user-agent}

Signature du navigateur (reçue par le serveur)

{server:user-agent} 

{server:accept}

Types mime acceptés par le navigateur

{server:accept} 

{server:accept-charset}

Jeux de caractères acceptés par le navigateur

{server:accept-charset} 

{server:accept-encoding}

Types d'encodage acceptés par le navigateur

{server:accept-encoding} 

{server:accept-language}

Langages acceptés par le navigateur

{server:accept-language} 


Exemple d'utilisation

Dans cet exemple, on affiche l'adresse IP du navigateur web.

Exemple
<bloc style="class1">
   <p>votre adresse ip est: {server:ip}</p>	        
</bloc>

votre adresse ip est: {server:ip}

Ensemble de paramètres "navigator" donnant des informations fournie par le navigateur de l'Internaute

L'ensemble de paramètres navigator contient une série d'informations sur le navigateur ou sur l'ordinateur de l'internaute. Celles-ci sont fournies localement par le navigateur de l'internaute.

Il contient les paramètres suivants (chaque paramètre est illustré avec un exemple):


{navigator:app-code-name}

Nom de code du navigateur

{navigator:app-code-name}

{navigator:app-name}

Nom du navigateur

{navigator:app-name} 

{navigator:app-version}

version du navigateur

{navigator:app-version} 

{navigator:cookie-enabled}

Indique si les cookies sont autorisés ou non (true ou false)

{navigator:cookie-enabled} 

{navigator:language}

langue configurée dans le navigateur

{navigator:language} 

{navigator:on-line}

Indique si le navigateur est en ligne (true ou false)

{navigator:on-line} 

{navigator:platform}

Plate-forme (operatring system) visée par le navigateur

{navigator:platform} 

{navigator:product}

Moteur utilisé par le navigateur

{navigator:product} 

{navigator:user-agent}

Signature du navigateur qui sera envoyé aux applications distantes (si elles sont appelées)

{navigator:user-agent} 

{navigator:date}

date courante provenant de l'ordinateur de l'internaute

{navigator:date} 

{navigator:time}

heure courante provenant de l'ordinateur de l'internaute

{navigator:time} 

{navigator:dateTime}

date et heure courantes provenant de l'ordinateur de l'internaute

{navigator:dateTime} 


Exemple d'utilisation

Dans cet exemple, on affiche l'adresse IP du navigateur web.

Exemple
<bloc style="class1">
   <p>votre navigateur utilise la signature suivante: {navigator:user-agent}</p>	        
</bloc>

votre navigateur utilise la signature suivante: {navigator:user-agent}

Ensemble de paramètres "intranet" donnant des informations sur la personne connectée à l'Intranet

L'ensemble de paramètres intranet contient une série d'information sur la personne qui consulte votre page, si celle-ci est connectée à l'Intranet.

Attention: cela ne peut fonctionne qu'à l'intérieur d'une section optionnelle activées par l'Intranet (voir ci-après).

Cet ensemble de paramètres intranet contient les paramètres suivants (chaque paramètre est illustré avec un exemple):

Dans cet exemple, le prénom de la personne connectée est affichée dans le texte d'un paragraphe (grâce au paramètre {intranet:prénom} et l'adresse e-mail de la personne connectée est insérée dans l'attribut value d'un champ <input> au sein d'une formulaire, grâce au paramètre {intranet:email}.

Exemple
<bloc options="intranet" style="colorBar2">
   <p>Bonjour {intranet:prénom},</p>
   <p>Complètez et/ou modifiez les données suivantes:</p>
   <formulaire>
      <action href="#" méthode="post"/>
      <input>
         <nom>email</nom>
         <libellé>Votre adresse email:</libellé>
         <value>{intranet:email}</value>					
      </input>
      <bouton>		
         <nom>ok</nom>
         <libellé>Envoyer</libellé>
      </bouton>
   </formulaire>
</bloc>

Attention, pour rappel, cela ne peut fonctionner que dans une section optionnelle! (dans l'exemple ci-dessus, c'est l'attribut options du <bloc> qui détermine la section optionnelle).

Ces informations sont issues de la première identité qui satisfait aux conditions d'affichage de la section optionnelle.

Ainsi, si une personne est à la fois étudiante et membre du personnel (ce qui est souvent le cas d'un doctorant, par exemple), le nom et le prénom affichés seront ceux de la base de données du personnel si la <section> est réservée aux membres du personnel. Ils seront ceux de la base de données des étudiants si elle est réservée aux étudiants.


Exemples d'utilisation

Dans cet exemple, on insère des données sur l'utilisateur dans un titre et un paragraphe, ainsi que dans le libellé d'un lien hypertexte (on verra dans un autre exemple que l'URL de ce lien hypertexte peut également contenir ces données).

Exemple
<bloc style="colorBar1" options="intranet">
   <titre2 toc="non">Bonjour {intranet:prénom},</titre2>
   <p>Votre matricule est le <b>{intranet:matri}</b>.</p>
   <p>Envoyez-le à votre adresse mail <a href="mailto:...">{intranet:email}</a></p>
</bloc>

Dans cet exemple, on passe le matricule en paramètre à une application PHP:

Exemple
<bloc style="colorBar1" options="intranet">
   <p><a cible="html:dumpget" href="dumpget.php?matricule={intranet:matricule}">vos infos</a></p>
</bloc>

Dans ce dernier exemple, on insère des données sur l'utilisateur dans l'attribut href d'un lien hypertexte. Cet attribut est un mailto: qui permet d'envoyer un message à l'utilisateur (en l'occurence à vous même si vous êtes connecté à l'Intranet avec votre nom d'utilisateur).

Exemple
<bloc style="colorBar1" options="intranet">
   <p>Envoyez votre matricule à votre adresse mail <a href="mailto:{intranet:email}?subject=vos infos&amp;body=Votre matricule est le {intranet:matri}">{intranet:email}</a></p>
</bloc>

Ensemble de paramètres "form" qui contient les valeurs récoltées par un formulaire

Chaque formulaire est associé à ensemble de paramètres contenant l'ensemble des paramètres récoltés via ce formulaire.

Cet ensemble form si vous l'utilisez à l'intérieur du formulaire. Vous pouvez lui donner un autre nom à l'aide d'un attribut set afin d'y accèder en dehors du formulaire (ceci de manière à pouvoir utiliser et distinguer plusieurs formulaires différents dans la même page web).


Ensemble de paramètres "url" donnant des informations sur l'URL de la page courante

L'ensemble de paramètres url contient toutes les informations sur l'URL de la page courante (l'adresse qui a été appelée afin d'afficher cette page).

Il contient les paramètres ci-dessous. Chaque paramètre est illustré avec un exemple. Pour voir un exemple plus complet, vous pouvez cliquer sur le lien suivant; il va réafficher la même page mais avec une URL plus complète:


{url:href}

L'URL entière de la page

{url:href}

{url:protocol}

Le protocole de l'URL

{url:protocol} 

{url:origin}

L'origine de l'URL

{url:origin} 

{url:host}

Le nom de l'hôte et son numéro de port (80 est la valeur du port par défaut, elle n'est généralement pas mentionnée)

{url:host} 

{url:hostname}

Le nom de l'hôte (sans le numéro de port)

{url:hostname} 

{url:port}

Le numéro de port (80 est la valeur par défaut, elle n'est généralement pas mentionnée)

{url:port} 

{url:pathname}

Le chemin de l'URL (par rapport au répertoire de base de l'hôte)

{url:pathname} 

{url:hash}

L'ancre suivie (la partie de l'URL qui suit le symbole #, ce symbole inclus)

{url:hash} 

{url:search}

Les paramètres de l'URL (la partie qui suit le symbole ?, ce symbole inclus). Vous pouvez accèder individuellement à chacun de ces paramètres grâce à l'ensemble de paramètre url-param.

{url:search} 


Ensemble de paramètres "url-param" qui contient la liste des valeurs passées dans l'URL

L'ensemble de paramètres url-param contient les paramètres éventuels donnés dans l'URL qui a servi à afficher la page courante (paramètres qui se trouvent derrière le signe ? dans l'URL, séparés par des signes & et écrits sous la forme nom=valeur).

Pour voir un exemple, vous pouvez cliquer sur le lien suivant. Il va réafficher la même page mais avec une URL possèdant plusieurs paramètres (id et date):

{url-param:id}

Le paramètre id présent dans l'URL

{url-param:id}

{url-param:date}

Le paramètre date présent dans l'URL

{url-param:date} 

{url-param:inconnu}

Le paramètre inconnu qui n'est pas présent dans l'URL

{url-param:inconnu} 
sommairesommaireindexindexpage suivantepage suivante
ULB - entreprise écodynamique