Moteur de recherche interne [XSearch 5.0]

Manuel d'utilisation

Généralités
Xsearch est un moteur de recherche totalement écrit en Javascript. Cependant, il a tout d'un véritable moteur de recherche. Il suffit en effet d'entrer votre ou vos mot(s)-clé(s) et le script générera dynamiquement une page avec les résultats de votre requête.

XSearch est conçu en Javascript. Cela présente l'avantage que tout le monde pourra l'utiliser sans devoir recourir à des cgi-bin ou autres applications faisant appel au serveur. Le désavantage est qu'il est impossible de faire une recherche automatique dans les répertoires et les fichiers du serveur. Ainsi, il faudra enregistrer manuellement chaque élément de la base de données, et ce pour toutes les pages de votre site ! Et croyez-moi, c'est du boulot...

Aperçu
Parcourons quelques caractéristiques de ce script :

1. Facile à configurer. Toutes les procédures détaillées ci-après sont un peu fastidieuses mais n'ont rien de très compliquées.
2. Un "look" complètement modifiable. Du moins selon l'auteur du script. Pour ma part, je serais plutôt d'avis que pour apporter de profondes modifications au script, une connaissance pointue du Javascript est indispensable.
3. Compatibilité - XSearch est compatible avec les "big-browsers" de la nouvelle génération (IE4 et IE5 ainsi que Netscape4). Le script ne fonctionnera pas sur des navigateurs plus anciens ! Attention, il est important de noter que le script ne fonctionne pas en mode off-line sous Explorer 4.
4. Une (légère...) lenteur. Xsearch doit recharger et redessiner une page complète à chaque recherche. Ce qui peut ralentir le processus en fonction du nombre de résultats trouvés dans la base de données.
5. La taille de la base de données. Bien qu'en principe illimitée, la base de donnés deviendra trop lente à manipuler si elle contient trop d'enregistrements.
6. Free - Dans le bon esprit du Web [On dira peut-être bientôt, comme dans le bon vieux temps du Web !], ce script est freeware et peut être utilisé et modifié (à vos propres risques) mais en aucun cas être vendu. En voilà une bonne raison pour garder la source bien visible sur votre site. ©1999 Just4Fun Productions.

Le kit des fichiers nécessaires
Les fichiers suivants sont compris dans xsearch-fr.zip :

• db.js
  Ce fichier contient la base de données qui alimentera le moteur de recherche.
• manuel.html
  Le fichier que vous êtes en train de lire.
• xsearch.css
  Un fichier de feuilles de style qui définit les attributs du texte utilisé par le moteur..
• xsearch-5.0.js
  Le fichier de code Javascript du moteur de recherche.
• xsearchbutton.gif
  L'image du bouton "search".
• xsearch.htm
  Un fichier d'exemple pour l'implémentation du moteur de recherche.

Création de la base de données
Ce chapitre vous expliquera comment alimenter la base de données avec vos propres mots-clés et vos propres liens.
Pour rappel, c'est le fichier db.js qui contient la base de données nécessaire au moteur de recherche interne.

Initialisation
Le fichier db.js file contient quelques lignes qui initialisent la base de données.

var records_count=0
v1=new Array(records_count)
v2=new Array(records_count)
v3=new Array(records_count)
var a=0

Ces lignes de code devront rester inchangées et commenceront toujours une base de données utilisée par XSearch.

Données
Chaque enregistrement dans la base de données XSearch comportera 3 lignes de texte. La première contiendra l'intitulé et le lien, la seconde contiendra une série de mots-clés et finalement la troisième contiendra la description de l'entrée réalisée.

a+=1
v1[a]="<a href='fichier_intitulé1.htm'>Intitulé 1</a>"
v2[a]="mot-clé1 mot-clé2 mot-clé3 mot-clé4 mot-clé5 mot-clé6 mot-clé7 etc..."
v3[a]="Description de l'intitulé 1"

Rien de bien compliqué mais la plus grande précision est de rigueur. Le a+=1 devant chaque entrée sert à incrémenter le compteur d'enregistrements. N'oubliez donc pas ce a+=1, sinon vous risquez de perdre des enregistrements.

Le fichier de feuilles de style CSS

Le fichier xsearch.css contient les feuilles de styles utilisées par le script pour afficher les différentes lignes de texte. En modifiant ce fichier, on peut ainsi changer l'aspect de chaque ligne du texte utilisé le moteur de recherche..

h3
En-tête utilisée pour "Résultats : ..." au début de la page de résultats.
p
Utilisé pour le texte normal comme dans la page "Pas de résultats", la ligne "Votre recherche sur - xxx - n'a trouvé aucun document correspondant dans la base de données."
li
Utilisé dans la page "Pas de résultats", pour la liste des options pour une meilleure recherche.
xtitle
Employé pour afficher l'intitulé et le lien de chaque résultat de la requête.
xresult
Utilisé pour la description de chaque enregistrement.
xlocation
Pour afficher le lien sous forme de texte (après la description).
xsmall
Utilisé pour "Page précédente" et "Page suivante".

Le fichier xsearch-5.0.js
Il est indispensable de bien configurer, tout au début du script, le nom de votre page de lancement du moteur de recherche (ici xsearch.htm).
// Le nom du fichier
var searchname = 'xsearch.htm';

Des parties du script relatives au texte affiché sont plus ou moins faciles à modifier. L'auteur les a entourées de :
////// modifications possibles ///////
Code relatif au texte affiché et modifiable
////// fin de modifications ///////

La page de lancement du moteur
Pour terminer, vous devez créer un fichier Html (ici xsearch.htm) pour relier le script du moteur de recherche et la base de données :

<html>
<head>
<title>Mon moteur de recherche interne</title>
<script language="Javascript" src="db.js"></script>
<script language="Javascript" src="xsearch-5.0.js"></script>
</head>
<body>
<script language="Javascript">
initXsearch()
</script>
</body>
</html>