<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (C) 2000-2010  Ministere de la culture et de la communication (France), AJLSM
See LICENCE file
-->
<!DOCTYPE webpage PUBLIC "-//Norman Walsh//DTD Website V2.1b1//EN" "../../../dtd/website.dtd" [
  <!ENTITY actions_controle SYSTEM "actions_controle.xml" NDATA XML>
  <!ENTITY actions_indexation SYSTEM "actions_indexation.xml" NDATA XML>
  <!ENTITY actions_localisation SYSTEM "actions_localisation.xml" NDATA XML>
  <!ENTITY actions_recuperation SYSTEM "actions_recuperation.xml" NDATA XML>
  <!ENTITY actions_requetes SYSTEM "actions_requetes.xml" NDATA XML>
  <!ENTITY ations_generalites SYSTEM "actions_generalites.xml" NDATA XML>
]>
<webpage id="conteneurs_parametres"> 

  <head>
	 <title lang="fr">Conteneur de paramètres SDX</title>
	 <titleabbrev lang="fr">Conteneur paramètres</titleabbrev>
	 <author lang="fr"><firstname>Malo</firstname><surname>Pichot</surname><affiliation><orgname>AJLSM</orgname></affiliation></author><revhistory>
		<revision lang="fr">
		  <revnumber>1.0</revnumber><date>2003-06-04</date> 
		</revision>
	 </revhistory>
  </head>

  <section id="concepts"> 
	 <title>Concepts clés</title>
	 <para lang="fr">Cette page réuni un certains nombre d'éléments de l'API-XSP de SDX qui ne sont pas véritablement des actions SDX dans le sens où elles ne produisent pas directement un flux XML. Ces éléments ne peuvent pas être employées seules dans une page XSP. Elles sont toujours utilisées avec une ou des actions SDX et, de manière générale, il est tout à fait possible de s'en passer pour ne reprendre que leurs paramètres spécifiques. C'est dans ce sens que l'on parle de conteneurs de paramètres SDX.</para>
	 <example id="exemple_reserve_paramatre_sdx_hilite"> 
		<title>La réserve de paramètres SDX 
		  <ulink url="#sdx_hilite"><sgmltag class="element">sdx:hilite</sgmltag></ulink></title>
		<para><sgmltag class="element">sdx:hilite</sgmltag> est un bon candidat pour illustrer ce type d'éléments. Il n'est jamais utilisé tel que dans une page XSP. Pourtant la fonction de mise en évidence du ou des termes d'une requête est largement usitée. En réalité, c'est le paramètre <sgmltag class="attribute">hilite</sgmltag> qui se retrouve dans les actions (généralement les 
		  <olink targetdocent="actions_requetes">actions d'exécution de requête</olink> et 
		  <olink targetdocent="actions_recuperation">l'action d'inclusion de document</olink>). Le code ci-dessous offre un exemple concret de ce développement : </para>
		<programlisting>
&lt;sdx:page&gt;
 &lt;sdx:includeDocument idParam="id" baseParam="base" hilite="true"/&gt;
&lt;/sdx:page&gt;
</programlisting> 
		<para>La page XSP exposée ci-dessus génère l'inclusion d'un document issue de la collection de documents XML 
		  <olink targetdocent="actions_indexation">indexés</olink> par SDX. Cette inclusion peut se produire grâce à une URL telle que <literal>htpp://localhost:8080/sdx/sdxtest/doc.xsp?base="sdxdocs"&amp;id="a17b15"</literal>. Dans un tel cas, l'activation de la commande de mise en évidence ne sert pas ; aucune requête n'a été employée pour retrouver le document. Par contre, lorsque cette page est appelée à la suite d'une requête (via la feuille XSLT transformatrice du flux XML), la commande <literal>hilite</literal> activée produit l'effet de mise en évidence attendu sur le(s) terme(s) de cette requête dans le document inclus.</para>
	 </example> 
  </section> 
  <section lang="fr" id="sdx_hilite"> 
	 <title><sgmltag class="element">sdx:hilite</sgmltag>(CHECK)</title>
	 <para></para>
	 <informaltable lang="fr"> 
		<tgroup cols="2"><colspec colnum="1" colname="col1" colwidth="1.00*"/><colspec colnum="2" colname="col2" colwidth="2.48*"/><tbody> 
			 <row><entry colname="col1">Code implémentant cette action</entry><entry colname="col2"><filename>sdx-pipeline.xsl</filename></entry> 
			 </row> 
			 <row><entry colname="col1">Contexte d'utilisation</entry><entry colname="col2">La commande de mise en évidence s'emploie avec 
				  <olink targetdocent="actions_recuperation">l'action d'inclusion de document</olink> ainsi qu'avec l'ensemble des 
				  <olink targetdocent="actions_requetes">actions d'exécution de requête</olink>.</entry> 
			 </row> 
			 <row><entry colname="col1">Contenu éventuel</entry><entry colname="col2">Aucun.</entry> 
			 </row></tbody> 
		</tgroup> 
	 </informaltable> 
	 <table id="sdx_hilite_param"> 
	 <title>Paramètres spécifiques</title>
	 <tgroup cols="2"><colspec colnum="1" colname="col1" colwidth="1.16*"/><colspec colnum="2" colname="col2" colwidth="4.70*"/><thead> 
		  <row><entry colname="col1">Nom</entry><entry colname="col2">Description</entry> 
		  </row></thead><tbody> 
		  <row><entry colname="col1"><sgmltag class="attribute">hilite</sgmltag></entry><entry colname="col2">Active la prise en charge de la mise en évidence du (des) terme(s) de la requête. Deux valeurs sont autorisées pour ce paramètre : <sgmltag class="attvalue">true</sgmltag> et <sgmltag class="attvalue">false</sgmltag>. Ce paramètre peut également être employé pour passer l'identifiant d'une requête dont SDX récupérera le(s) terme(s) à mettre en évidence.</entry> 
		  </row> 
		  <row><entry colname="col1"><sgmltag class="attribute">qid</sgmltag></entry><entry colname="col2">Identifiant de la requête.</entry> 
		  </row> 
		</tbody> 
	 </tgroup></table> 
	 <para>Un exemple de l'utilisation de la commande de mise en évidence a été donné plus haut dans la section 
		<ulink url="#concepts">Concepts Clés</ulink>.</para>
  </section> 

</webpage>
