XSearch 5.2

Manuel de l'usager

Survol

Le script XSearch est un puissant moteur de recherche écrit en Javascript. La version 5 est une version améliorée de l'ancienne version v4.x. Un des changements majeurs est qu'il n'est pas compatible avec les versions 3 des navigateurs. Quelque changement mineur et quelques fonctionnalités inutilisées ont été retirés. Si vous désirez ses fonctionnalités, téléchargez la version 4.3 sur le site dynamic-core.net (version anglaise seulement) http://www.dynamic-core.net. Noter que XSearch5 est beaucoup plus rapide, et plus paramétrable que l'ancienne version.

Explication des fichiers

Les fichiers suivants sont compris avec XSearch5 :

• db.js
  • Ce fichier contient la base de données utilisée par XSearch dans ses recherches.
• manual.htm
  • Le fichier que vous lisez en version anglaise.
• manualfr.htm
  • Le fichier que vous lisez.
• xsearch.css
  • Le fichier CSS (feuille de styles) utilisé pour définir le style du texte avec XSearch.
• xsearch-5.2.js
  • Le fichier du moteur javascript XSearch5.2.
• xsearch-5.2.htm
  • Le fichier d'exemple HTML, qui montre le moteur XSearch5 en action.

Création de la base de données

ATTENTION: La version 5.2 utilise une nouvelle façon de construire la base de données!

Ce chapitre explique comment remplir la base de données XSearch avec vos propres adresses (URL) et mots clés.

Le fichier db.js contient la définition de la base de données requise par XSearch. XSearch est construit en utilisant le Javascript, avec l'avantage que tout le monde peut l'installer sans devoir utiliser un répertoire cgi-bin ou autres solutions côté serveur. Le désavantage d'utiliser le Javascript est l'impossibilité de rechercher à travers l'architecture des répertoires (dossiers) et des fichiers du serveur. Vous devez donc créer manuellement une base de données pour chacune des pages de votre site.

Entrés (records)

Chaque entrée de la base de données XSearch est créée avec trois tableaux de texte (array). Le premier de ses tableaux doit contenir une adresse (URL) valide vers la page de référence, le deuxième tableau contient une série de mots clés, et finalement le troisième tableau contient la description de l'entrée. Xsearch comprend une nouvelle fonction appelée add() qui permet d'ajouter une entrée (record) dans la base de données:

add(url,motsCles,description)

example:

add("<a href='http://www.dynamic-core.net'>dynamic-core.net</a>","bon moteur recherche dhtml xsearch javascript search engine","Ceci est la page d'accueil du site de dynamic-core.net, concepteur du moteur de recherche XSearch5.0")

Comme vous pouvez voir dans l'exemple précédent, il est très aisé d'ajouter une nouvelle entrée (record).

La feuille de style (CSS) de XSearch

Le fichier xsearch.css contiens le style utilisé par le moteur de recherche XSearch5 pour afficher les différentes lignes de texte. En modifiant ce fichier, vous pouvez changer l'apparence de chacune des lignes générées par le moteur de recherche XSearch. C'est une grande amélioration comparativement à l'ancienne version qui ne pouvait que changer la couleur du texte.

• h3
  • Petit en-tête de texte utilisé pour afficher la ligne du "résultat..." au début de la page des résultats.
• p
  • Utilisé pour l'affichage du texte normal, par exemple, voir la page "Aucune résultat" et la ligne qui dit "Votre recherche avec ... ne correspond ..."
• li
  • Utilisé dans la page "Aucun résultat" afin d'identifier les options pour une meilleure recherche.
• xtitle
  • Utilisé pour afficher les titre avec liens hypertexte de chaque entrée du résultat.
• xresult
  • Utilisé pour afficher la description de chaque entrée.
• xlocation
  • Utilisé pour afficher le lien hypertexte de chaque entrée du résultat (sous la description).
• xsmall
  • Utilisé pour afficher "page précédente" et "page suivante".

Les paramètres de configuration

Le fichier db.js contiens quelques variables qui demande à être ajustées afin que la recherche fonctionne efficacement.

• searchname
  • Comme avec la version précédente de XSearch, cette variable définie le nom du fichier principal de recherche.
• usebannercode
  • Comme avec la version précédente de XSearch, cette variable définie si vous désirez afficher le code d'une bannière, mettre "true" ou "false" (vrais ou faux). Noter que vous devez ajuster le code de la bannière, vois plus loin.
• ButtonCode
  • La version 5 de Xsearch ne requiert aucun bouton pour activer la recherche, vous pouvez mettre le code que vous voulez. Par exemple, si vous désirez afficher le bouton comme avec la version précédente de XSearchm, ajouter ce code:

ButtonCode = "<img src='searchbutton.gif' border=0>"

• templateBody() , templateEnd() et bannerCode()
  • Utilisé pour afficher l'en-tête et le pied de page. Vous pouvez ajouter le code que vous désirez. bannerCode() ne contient aucun code, si vous avez activé cette fonctionnalité en configurant la variable "userbannercode" à "true", c'est ici que vous devez ajouter votre code.

Pour plus d'information sur ces fonctions, lire l'article: Setting up your own search engine. L'article a été écrit pour les anciennes versions de XSearch, mais le fonctionnement de templateBody(), templateEnd() et bannerCode() n'a pas changé.

Faire fonctionner XSearch

En terminant, vous devez créer le fichier HTML principal du moteur de recherche. Le fichier "xsearch-5.2.htm" est comme l'exemple suivant. Noter que si vous changez le nom du fichier, vous devez aussi ajuster la variable "searchname" du fichier "db.js".

Attention: L'ordre des liens vers les deux fichiers inclus est très important. Soyez sûr que le lien vers le fichier xsearch-5.js est fait en premier et que le lien vers le fichier db.js vient ensuite. Sinon, vous risquez d'obtenir un message d'erreur.

<html>
<head>
<title>Xsearch 5</title>

<script language="Javascript" src="xsearch-5.2.js"></script>
<script language="Javascript" src="db.js"></script>

<body bgColor="#ffffff">
<script language="Javascript">
    initXsearch()
</script>
</body>
</html>

Information et contact

Si vous avez des questions après avoir lu ce manuel, veuillez s'il vous plaît lire le fichier des questions fréquentes des anciennes versions de XSearch avant de contacter le concepteur (voir http://www.dynamic-core.net). La grande majorité des problèmes a déjà été discutée. Si vous persistez à avoir des problèmes, contactez l'auteur à : <pascal@dynamic-core.net>. Pour un support en français, vous pouvez poser vos questions sur le Forum Javascript des Trucsweb ( Forum Javascript des Trucsweb ).