<?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_alphabetique SYSTEM "actions_alphabetique.xml" NDATA XML>
  <!ENTITY actions_controle SYSTEM "actions_controle.xml" NDATA XML>
  <!ENTITY actions_generalites SYSTEM "actions_generalites.xml" NDATA XML>
  <!ENTITY actions_gestion SYSTEM "actions_gestion.xml" NDATA XML>
  <!ENTITY actions_identification SYSTEM "actions_identification.xml" NDATA XML>
  <!ENTITY actions_index SYSTEM "actions_index.xml" NDATA XML>
  <!ENTITY actions_indexation SYSTEM "actions_indexation.xml" NDATA XML>
  <!ENTITY actions_localisation SYSTEM "actions_localisation.xml" NDATA XML>
  <!ENTITY actions_parametres SYSTEM "actions_parametres.xml" NDATA XML>
  <!ENTITY actions_pipelines SYSTEM "actions_pipelines.xml" NDATA XML>
	<!ENTITY actions_thesaurus SYSTEM "actions_thesaurus.xml" NDATA XML>
  <!ENTITY actions_recherche SYSTEM "actions_recherche.xml" NDATA XML>
  <!ENTITY actions_recuperation SYSTEM "actions_recuperation.xml" NDATA XML>
  <!ENTITY actions_requetes SYSTEM "actions_requetes.xml" NDATA XML>
  <!ENTITY actions_thematique SYSTEM "actions_thematique.xml" NDATA XML>
  <!ENTITY actions_thesaurus SYSTEM "actions_thesaurus.xml" NDATA XML>
  <!ENTITY parametres_requetes SYSTEM "parametres_requetes.xml" NDATA XML>
  <!ENTITY parametres_sdx SYSTEM "parametres_sdx.xml" NDATA XML>
  <!ENTITY xsp SYSTEM "xsp.xml" NDATA XML>
]>

<webpage id="apixsp_intro">

  <head>
	 <title lang="fr">Références de l'API-XSP de SDX</title>
	 <titleabbrev lang="fr">Référence API-XSP</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="intro">
	 <title>Introduction</title>
	 <para>SDX offre un environnement propre au développement d'applications permettant d'effectuer des recherches dans une collection de documents XML. Dans ce contexte, on peut comparer SDX à une boîte à outils dans laquelle le développeur va puiser pour bâtir son environnement de recherche (l'application de démonstration <literal>sdxtest</literal> offre une liste de quelques applications SDX). L'ensemble de ces instruments forme ce que l'on appelle communément l'API-SDX (FIXME). Celle-ci se décompose en deux groupes : l'<ulink url="../../apidocs/index.html">API-Java de SDX</ulink> (disponible au format <trademark>Javadoc™</trademark>) ; l'API-XSP de SDX qui fait l'objet de ce chapitre de la documentation. Elle documente les éléments mis à disposition pour l'écriture de
		<olink targetdocent="xsp">pages XSP</olink> (voir la section
		<olink targetdocent="xsp"><citetitle>pages XSP de <trademark>Cocoon</trademark></citetitle></olink>).</para>
	 <para lang="fr">Cette documentation se répartit en plusieurs sections : </para>
	 <itemizedlist>
		<listitem>
		  <para><olink targetdocent="xsp"><citetitle>Les pages XSP de Cocoon</citetitle></olink> ; </para>
		</listitem><listitem>
		  <para><olink targetdocent="parametres_sdx"><citetitle>La logique des paramètres SDX</citetitle></olink> ;</para>
		</listitem><listitem>
		  <para><olink targetdocent="actions_thematique"><citetitle>Classement thématique des actions</citetitle></olink> : </para>
		  <itemizedlist>
			 <listitem>
				<para><olink targetdocent="actions_generalites"><citetitle>Structure d'une page XSP et généralités</citetitle></olink> ; </para>
			 </listitem><listitem>
				<para><olink targetdocent="actions_parametres"><citetitle>Paramètres et contrôle du flux</citetitle></olink> ; </para>
			 </listitem><listitem>
				<para><olink targetdocent="actions_identification"><citetitle>Identification des utilisateurs</citetitle></olink> ; </para>
			 </listitem><listitem>
				<para><olink targetdocent="actions_gestion"><citetitle>Gestion des droits</citetitle></olink> ; </para>
			 </listitem><listitem>
				<para><olink targetdocent="actions_localisation"><citetitle>Localisation des applications, bases de documents et entrepôts</citetitle></olink> ; </para>
			 </listitem><listitem>
				<para><olink targetdocent="actions_pipelines"><citetitle>Pipelines</citetitle></olink> ; </para>
			 </listitem>

			 <listitem>
				<para><olink targetdocent="actions_thesaurus"><citetitle>Thesaurus</citetitle></olink> ; </para>
			 </listitem>

			 <listitem>
				<para><olink targetdocent="actions_indexation"><citetitle>Indexation ou suppression de documents</citetitle></olink> ; </para>
			 </listitem><listitem>
				<para><olink targetdocent="actions_recherche"><citetitle>Recherche de documents</citetitle></olink> : </para>
				<itemizedlist>
				  <listitem>
					 <para><olink targetdocent="actions_index"><citetitle>Contenu des index</citetitle></olink> ; </para>
				  </listitem><listitem>
					 <para><olink targetdocent="actions_requetes"><citetitle>Exécution des requêtes</citetitle></olink> ; </para>
				  </listitem><listitem>
					 <para><olink targetdocent="parametres_requetes"><citetitle>Paramètres communs des requêtes</citetitle></olink> ; </para>
				  </listitem><listitem>
					 <para><olink targetdocent="actions_thesaurus"><citetitle>Thesaurus</citetitle></olink> ; </para>
				  </listitem><listitem>
					 <para><olink targetdocent="actions_controle"><citetitle>Gestion des résultats</citetitle></olink> ; </para>
				  </listitem><listitem>
					 <para><olink targetdocent="actions_recuperation"><citetitle>Affichage des documents</citetitle></olink>.</para>
				  </listitem>
				</itemizedlist>
			 </listitem>
		  </itemizedlist>
		</listitem><listitem>
		  <para><olink targetdocent="actions_alphabetique">Classement alphabétique des actions</olink>.</para>
		</listitem>
	 </itemizedlist>
  </section>
  <section id="actions">
	 <title>Actions et paramètres SDX</title>
	 <para>Reprenons l'image de la boîte à outils développée
		<ulink url="#intro">plus haut</ulink>. Nous avons vu que cette boîte contient deux compartiments (<ulink url="../../apidocs/index.html">API-Java</ulink> et
		<olink targetdocent="actions_alphabetique">API-XSP</olink>). L'API-XSP est composée de plusieurs éléments (au sens XML du terme) se répartissant en deux classes : <emphasis role="bold">les actions SDX</emphasis> et <emphasis role="bold">les conteneurs de<olink targetdocent="parametres_sdx"> paramètres SDX</olink></emphasis> (voir le chapitre
		<olink targetdocent="parametres_sdx"><citetitle>logique des paramètres SDX</citetitle></olink> pour approfondir cette notion). Les actions SDX peuvent être comparées aux outils proprement dits (e.g., un marteau). Les conteneurs de paramètres SDX sont des éléments comprenant des attributs (au sens XML du terme) utilisables par les actions SDX. Ce ne sont pas des actions à proprement parler, car elles ne produisent pas directement un flux XML (le XML virtuel généré, prêt à être transformé et sérialisé comme indiqué dans le chapitre
		<olink localinfo="xsp_quelques_mots" targetdocent="xsp"><citetitle>pages XSP de <trademark>Cocoon</trademark></citetitle></olink>). Ainsi l'élément <sgmltag class="element">sdx:hilite</sgmltag> contient un attribut <sgmltag class="attribute">hilite</sgmltag> largement employé par les
		<olink targetdocent="actions_requetes">actions de recherche</olink> telles que
		<olink localinfo="sdx_executefieldquery" targetdocent="actions_requetes"><sgmltag class="element">sdx:executeFieldQuery</sgmltag></olink> ou
		<olink localinfo="sdx_terms" targetdocent="actions_index"><sgmltag class="element">sdx:terms</sgmltag></olink>. Dans le monde SDX, ces attributs sont vus comme des
		<olink targetdocent="parametres_sdx">paramètres SDX</olink>. Pour rester dans l'image de la boîte à outils, il s'agit de la quincaillerie (e.g., des clous).</para>
  </section>

</webpage>
