<?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_amender SYSTEM "actions_amender.xml" NDATA XML>
<!ENTITY actions_controle SYSTEM "actions_controle.xml" NDATA XML>
<!ENTITY actions_generalites SYSTEM "actions_generalites.xml" NDATA XML>
<!ENTITY actions_recuperation SYSTEM "actions_recuperation.xml" NDATA XML>
<!ENTITY actions_requetes SYSTEM "actions_requetes.xml" NDATA XML>
]>

<webpage id="parametres_requetes">

  <head>
	<title lang="fr">Paramètres communs des requêtes</title>
	<titleabbrev lang="fr">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>2004-08-25</date>
	  </revision>
	</revhistory>
  </head>

  <para lang="fr">Cette page contient la description de l'ensemble des paramètres partagés par
	<olink targetdocent="actions_requetes" localinfo="elements_requete">les actions d'exécution de requêtes</olink>. Ces actions admettent d'autres paramètres, mais ceux-ci ne sont pas forcément communs à l'ensemble. On se reportera logiquement aux sections de description de ces actions : </para>
  <itemizedlist id="liste_actions_execution">
	<listitem>
	  <para><olink localinfo="sdx_executefieldquery" targetdocent="actions_requetes"><sgmltag class="element">sdx:executeFieldQuery</sgmltag></olink> ; </para>
	</listitem><listitem>
	  <para><olink localinfo="sdx_executelistequery" targetdocent="actions_requetes"><sgmltag class="element">sdx:executeListQuery</sgmltag></olink> ; </para>
	</listitem><listitem>
	  <para><olink localinfo="sdx_executedatequery" targetdocent="actions_requetes"><sgmltag class="element">sdx:executeDateQuery</sgmltag></olink> ; </para>
	</listitem><listitem>
	  <para><olink localinfo="sdx_executesimplequery" targetdocent="actions_requetes"><sgmltag class="element">sdx:executeSimpleQuery</sgmltag></olink> ; </para>
	</listitem><listitem>
	  <para><olink localinfo="sdx_executelinearquery" targetdocent="actions_requetes"><sgmltag class="element">sdx:executeLinearQuery</sgmltag></olink> ; </para>
	</listitem><listitem>
	  <para><olink localinfo="sdx_executecomplexquery" targetdocent="actions_requetes"><sgmltag class="element">sdx:executeComplexQuery</sgmltag></olink>.</para>
	</listitem>
  </itemizedlist>
  <table id="sdx_executesimplequery_param_comm" lang="fr">
  <title>Paramètres employés par
	<olink targetdocent="actions_requetes">les actions d'exécution de requêtes</olink></title>
  <tgroup cols="2"><colspec colnum="1" colname="col1" colwidth="1.00*"/><colspec colnum="2" colname="col2" colwidth="2.28*"/><thead>
	  <row><entry colname="col1">Nom</entry><entry colname="col2">Description</entry>
	  </row></thead><tbody>
	  <row><entry colname="col1" id="show"><sgmltag class="attribute">show</sgmltag></entry><entry colname="col2">Ce paramètre permet de définir le résumé des informations de l'environnement dans lequel la page SDX est utilisée. Les valeurs autorisées pour ce paramètre (avec les actions d'exécution de requête, voir
		  <olink localinfo="sdx_page" targetdocent="actions_generalites"><sgmltag class="element">sdx:page</sgmltag></olink> pour connaître une autre utilisation de ce paramètre) sont :
		  <variablelist><varlistentry><term><sgmltag class="attvalue">documents</sgmltag></term><listitem>
				<para><sgmltag class="attribute">show="documents"</sgmltag> déclenche la commande d'inclusion du document dans la page de résultat, non plus les seules informations permettant de retrouver ce document (avec
				  <olink localinfo="sdx_includedocument" targetdocent="actions_recuperation"><sgmltag class="element">sdx:includeDocument</sgmltag></olink> par exemple).</para>
			  </listitem></varlistentry><varlistentry><term><sgmltag class="attvalue">results</sgmltag></term><listitem>
				<para><sgmltag class="attribute">show="results"</sgmltag> déclenche la commande d'inclusion des <sgmltag class="element">sdx:result</sgmltag> contenant les informations permettant de retrouver le document (<emphasis role="bold">comportement par défaut</emphasis>).</para>
			  </listitem></varlistentry><varlistentry><term><sgmltag class="attvalue">fields</sgmltag></term><listitem>
				<para><sgmltag class="attribute">show="fields"</sgmltag> déclenche la commande d'inclusion des <sgmltag class="element">sdx:field</sgmltag> marqué <sgmltag class="attribute">brief="true"</sgmltag> dans le fichier <filename>application.xconf</filename> (<emphasis role="bold">comportement par défaut</emphasis>).</para>
			  </listitem></varlistentry></variablelist><note>
			<para>Ces valeurs sont juxtaposables (e.g., <sgmltag class="attribute">show="results documents"</sgmltag>). Noter toutefois l'obligation de préciser l'ensemble des résultats désirés dès le moment où l'une des valeurs est employées. Ainsi <sgmltag class="attribute">show="results"</sgmltag> n'inclura que les <sgmltag class="element">sdx:result</sgmltag> dans la page de résultat. Le document lui-même et les <sgmltag class="element">sdx:field</sgmltag> seront omis. <sgmltag class="element">show="results</sgmltag> document" inclura les <sgmltag class="element">sdx:result</sgmltag> et les documents eux-mêmes dans la page de résultat ; les <sgmltag class="element">sdx:field</sgmltag> seront omis.</para>
		  </note></entry>
	  </row>
	  <row><entry colname="col1" id="hilite"><sgmltag class="attribute">hilite</sgmltag></entry><entry colname="col2">Active 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ère alors le(s) terme(s) pour les mettre en évidence (cf. l'exemple
		  <olink localinfo="exemple_sdx_hilite_01" targetdocent="actions_generalites"><citetitle>Activer la mise en évidence sur une ancienne requête</citetitle></olink> de
		  <olink localinfo="sdx_debug" targetdocent="actions_generalites"><sgmltag class="element">sdx:debug</sgmltag></olink>).</entry>
	  </row>
	  <row><entry colname="col1" id="docs"><sgmltag class="attribute">docs</sgmltag></entry><entry colname="col2">Active la commande d'inclusion du ou des documents issus d'une requête. Les deux valeurs autorisées pour ce paramètres sont : <sgmltag class="attvalue">true</sgmltag> (active la commande) et <sgmltag class="attvalue">false</sgmltag> (désactive la commande).</entry>
	  </row>
	  <row><entry colname="col1" id="page"><sgmltag class="attribute">page</sgmltag></entry><entry colname="col2">Numéro de la page de résultat que l'on souhaite appeler.</entry>
	  </row>
	  <row><entry colname="col1" id="p"><sgmltag class="attribute">p</sgmltag></entry><entry colname="col2"><emphasis role="italic">Idem</emphasis>. <emphasis role="bold">Déprécié</emphasis></entry>
	  </row>
	  <row><entry colname="col1" id="no"><sgmltag class="attribute">no</sgmltag></entry><entry colname="col2">Numéro du résultat que l'on souhaite appeler.</entry>
	  </row>
	  <row><entry colname="col1" id="n"><sgmltag class="attribute">n</sgmltag></entry><entry colname="col2"><emphasis role="italic">Idem</emphasis>. <emphasis role="bold">Déprécié</emphasis></entry>
	  </row>
	  <row><entry colname="col1" id="app"><sgmltag class="attribute">app</sgmltag></entry><entry colname="col2">Identifiant de l'application. Par défaut, il s'agit de l'application courante.</entry>
	  </row>
	  <row><entry colname="col1" id="bqid"><sgmltag class="attribute">bqid</sgmltag></entry><entry colname="col2">Identifiant de la requête que l'on souhaite reprendre pour l'affiner ou l'étendre (cf.
		  <olink localinfo="sdx_basequery" targetdocent="actions_amender"><sgmltag class="element">sdx:baseQuery</sgmltag></olink> pour approfondir la notion de sur-requête).</entry>
	  </row>
	  <row><entry colname="col1" id="bop"><sgmltag class="attribute">bop</sgmltag></entry><entry colname="col2">Opérateur entrant la construction d'une sur-requête (cf.
		  <olink localinfo="sdx_basequery" targetdocent="actions_amender"><sgmltag class="element">sdx:baseQuery</sgmltag></olink>). Par défaut , l'opérateur est un <literal>ou</literal> logique (inclusif).</entry>
	  </row>
	  <row><entry colname="col1" id="ff"><sgmltag class="attribute">ff</sgmltag></entry><entry colname="col2">Identifiant un champ sur lequel on souhaite activer un filtre de recherche (voir
		  <olink targetdocent="actions_amender" localinfo="sdx_filter"><sgmltag class="element">sdx:filter</sgmltag></olink> pour approfondir la notion).</entry>
	  </row>
	  <row><entry colname="col1" id="fv"><sgmltag class="attribute">fv</sgmltag></entry><entry colname="col2">Identifiant une valeur sur laquelle on souhaite activer un filtre de recherche (cf.
		  <olink targetdocent="actions_amender" localinfo="sdx_filter"><sgmltag class="element">sdx:filter</sgmltag></olink>).</entry>
	  </row>
	  <row><entry colname="col1" id="fop"><sgmltag class="attribute">fop</sgmltag></entry><entry colname="col2">Opérateur entrant dans la construction d'un filtre (cf.
		  <olink targetdocent="actions_amender" localinfo="sdx_filter"><sgmltag class="element">sdx:filter</sgmltag></olink>). Par défaut, l'opérateur est un <literal>ou</literal> logique (inclusif).</entry>
	  </row>
	  <row><entry colname="col1" id="appbypath"><sgmltag class="attribute">appByPath</sgmltag></entry><entry colname="col2">Indique la partie de l'URL qui suit "<literal>sdx/</literal>" dans une installation standard, par exemple "<literal>sdxtest</literal>".</entry>
	  </row>
	  <row><entry colname="col1" id="base"><sgmltag class="attribute">base</sgmltag></entry><entry colname="col2">Identifiant de la base de documents. Par défaut, il s'agit de la base courante.</entry>
	  </row>
	  <row><entry colname="col1" id="qid"><sgmltag class="attribute">qid</sgmltag></entry><entry colname="col2"><para>Identifiant de la requête que l'on souhaite reprendre. Cet identifiant est donné automatiquement à chaque requête exécutée. Par défaut, SDX conserve 5 résultats de requête en mémoire. Ce nombre peut être augmenté en modifiant la variable <literal>sdx_qmax</literal> (cf. la logicsheet <filename>sdx.xsl</filename>).</para>
    <para>Il est possible de conserver un résultat de requête le temps d'une session d'utilisateur en donnant statiquement un identifiant à un résultat de requête (cf. <olink localinfo="sdx_results" targetdocent="actions_controle"><sgmltag class="element">sdx:results</sgmltag></olink> pour approfondir ce point).</para>
		  .</entry>
	  </row>
	  <row><entry colname="col1" id="hpp"><sgmltag class="attribute">hpp</sgmltag></entry><entry colname="col2">Spécifie le nombre de réponses que devra contenir la page de résultats. Par défaut, ce nombre est fixé à 20 (cf. fichier <filename>sdx.xsl</filename>).</entry>
	  </row>
	  <row><entry colname="col1" id="sf"><sgmltag class="attribute">sf</sgmltag></entry><entry colname="col2">Identifie le champ sur lequel on souhaite effectuer un tri. Ce paramètre est répétable en autant de clés de tri désirées.</entry>
	  </row>
	  <row><entry colname="col1" id="so"><sgmltag class="attribute">so</sgmltag></entry><entry colname="col2">Identifie l'ordre de classement d'une clé de tri. Par défaut, le classement s'effectue de manière ascendante (de <literal>1</literal> à <literal>10</literal>, de <literal>a</literal> à <literal>z</literal>).</entry>
	  </row><row><entry colname="col1" id="boost"><sgmltag class="attribute">boost</sgmltag></entry><entry colname="col2">Indique un facteur de pondération de la pertinence pour cette requête. La valeur doit être un nombre réel, s'il est supérieur à 1.0 alors cette requête aura un facteur de pondération positif ou, autrement dit, elle sera plus importante que la moyenne. Ce facteur est utile pour pondérer les différentes composantes d'une requête de type complexe. Cette fonctionnalité est disponible depuis la version 2.3 de SDX uniquement. Sur une version antérieure, elle n'a aucun effet.</entry></row>
	</tbody>
  </tgroup></table>

</webpage>
