Guide d'utilisation

 

Sommaire



Installation de la médiathèque

Le kit <Document Libre> que vous pouvez télécharger et installer sur votre ordinateur ou à la racine de votre site peut avoir deux raisons d'être :

- installer seulement un outil de recherche sur votre ordinateur ou sur votre site web

- présenter sur votre site web une collection de documents en ligne

Il faut avoir à l'esprit que l'outil d'indexation ne recopie pas les documents numériques, il ne manipule que des données qui les décrivent : les métadonnées. L'accès au document lui-même se fait donc toujours via le site où il est stocké. L'outil de recherche effectue des requêtes sur une base de données, présente à l'utilisateur des "fiches de bibliothèque", et fournit un lien qui le dirige finalement vers le site qui détient le document cherché.

Le site de base est donc au coeur du dispositif. Il n'y a d'ailleurs pas de point d'entrée vers un sur-ensemble qui viendrait en quelque sorte chapeauter toutes les collections. L'outil de recherche commence toujours par explorer une collection particulière avant de passer éventuellement à une recherche élargie à l'ensemble des collections.

Outil de recherche seulement

Vous pourrez appeler la médiathèque en arrivant par défaut dans l'une des collections existantes et en choisissant l'une des présentations disponibles.

Vous pourrez toutefois appliquer un style personnalisé si vous mettez en ligne votre propre feuille de styles, et que vous passez son adresse en paramètre d'appel comme indiqué plus bas.

La médiathèque de votre site

Si vous décidez de créer et d'administrer vous-mêmes une collection de documents dans le cadre du réseau <Document Libre>, vous devez alors vous inscrire . Toutes les informations sont sur notre site http://www.documentlibre.org. A la suite de votre inscription, la base de données connaîtra :

Et vous connaîtrez le code de provenance (représenté par XXXX dans les exemples donnés plus bas) qui vous permettra d'invoquer spécifiquement votre collection lors de l'appel de votre page de médiathèque.

Le système sera donc en mesure d'appliquer vos feuilles de styles, et de fournir l'ensemble des services décrits à la suite. Vos éléments personnalisés (feuilles de styles, images...) se trouvent réunis dans le dossier mediadl de votre site (il doit conserver ce nom et les éléments qui s'y trouvent doivent avoir aussi les noms que le système va rechercher).



Placer l'outil médiathèque dans son site

L'outil de recherche est destiné à prendre place dans tout site où sa fonction est jugée utile. Pour cela, son aspect peut être adapté en ce qui concerne les fontes et les couleurs au moyen d'une feuille de styles. Celle-ci peut être aménagée par l'utilisateur. Un outil d'aide au paramétrage est disponible sur le site <Document Libre>.

Trois feuilles de styles par défaut font partie du kit <Document Libre> : style.css concerne les interfaces de type standard, styleexplo.css concerne l'interface en mode explorateur, styleperso.css concerne l'interface personnalisable. Ces feuilles de styles sont recherchées par le système d'indexation dans le dossier mediadl de la collection appelée. La feuille de styles peut toutefois être remplacée par une autre dont l'adresse est indiquée par un paramètre d'appel comme indiqué plus bas.

L'intégration de la médiathèque se fait par l'intermédiaire d'un hyperlien ou, mieux, d'un frameset. Si les framesets sont logiquement de moins en moins utilisés, ils restent cependant intéressants dans le cas qui nous intéresse.



Appel de la médiathèque par un hyperlien

Une simple ligne de code HTML permet d'appeler la médiathèque par un clic de souris sur un texte ou sur une image. Pour un hyperlien de type texte, on peut faire quelque chose comme :

<a href="http://www.documentlibre.org/entree.php?prov=XXXX>Rechercher un document</a>

Dans cet appel, XXXX représente le code qui précise la collection invoquée. On peut passer d'autres paramètres à la suite de l'adresse, par exemple pour préciser une feuille de styles différente :

<a href="http://www.documentlibre.org/entree.php?prov=XXXX&style=http://monsite.fr/monstyle.css>Rechercher un document</a>

On peut aussi insérer un lien activé par un clic sur une icône de la manière suivante :

<a href="http://www.documentlibre.org/entree.php?prov=XXXX><img src="http://mesimages/monimage.jpg" alt="Médiathèque"</a>



Appel de la médiathèque par un frameset

Le frameset a plusieurs avantages :

Nous ne détaillons pas ici l'usage des framesets que l'on trouve abondamment sur les sites d'aide à la création Internet, mais donnons deux exemples à compléter.



Pour scinder l'écran en trois cadres haut , milieu et bas de sorte que le cadre du milieu puisse accueillir la médiathèque :

<frameset rows="130,*,50" >

  <frame name="cadre_haut" frameborder="0" marginwidth="0" marginheight="0" noresize src="monhautdepage.html">

  <frame name="cadre_centre" frameborder="0" marginwidth="0" marginheight="0" src="http://www.documentlibre.org/entree.php?prov=XXXX>

  <frame name="cadre_bas" marginwidth="0" marginheight="0" noresize src="monbasdepage.html">

</frameset>



Pour scinder l'écran en deux cadres gauche et droite :

 <frameset cols="180,*" >

  <frame name="menugauche" scrolling="no" frameborder="0" marginwidth="0" marginheight="0" src="monmenu.html">

  <frame name="mediatheque"  frameborder="0" marginwidth="0" marginheight="0"  src="http://www.documentlibre.org/entree.php?prov=XXXX">

 </frameset>



NOTES :

les framesets peuvent être imbriqués, d'ailleurs la médiathèque introduira aussi un nouveau frameset dans le cadre qui lui est réservé.

L'appel de la médiathèque n'utilise ici que le paramètre "prov", il y a d'autres paramètres qui permettent de personnaliser l'usage que l'on veut en faire.



Comment aménager le style de la médiathèque pour son site

Les fichiers au format html générés par la base de données sont dénués de contraintes de formatage. L'apparence et en particulier les fontes et les couleurs utilisées sont liées à une feuille de styles dont l'adresse peut être choisie par l'utilisateur de sorte que tout utilisateur peut faire usage de sa propre feuille de styles.

Selon l'interface que vous utilisez, vous pouvez intervenir sur le style de plusieurs manières.

Si la feuille de styles s'applique a votre collection, et que vous avez placé le dossier mediadl sur votre site comme il convient, le système viendra lire cette feuille chaque fois qu'un usager visite votre médiathèque.

S'il s'agit simplement de substituer votre feuilles de styles à une autre, utilisez le paramètre d'appel 'style' lors de l'appel de la page de recherche comme indiqué plus bas.

Il n'est pas dans notre propos d'introduire les notions qui permettent de concevoir une feuille de styles. Les pages qui traitent de ces questions sont nombreuses sur Internet. Si vous n'êtes pas à l'aise sur ce sujet, contentez-vous de modifier les couleurs utilisées, ainsi vous n'altérerez pas la mise en page des formulaires.

Les couleurs s'expriment au moyen d'un triplet RVB, d'est à dire une suite de trois nombres qui fixent l'intensité lumineuse de trois couleurs fondamentales, rouge, vert, bleu. Chacun de ces trois nombres est exprimé en hexadécimal  par un couple de  deux chiffres. La notation standard consiste à former une suite de six chiffres précédée par le signe '#'.

Tandis que les nombres décimaux sont représentés par dix chiffres qui vont de 0 à 9, les nombres hexadécimaux sont représentés par seize chiffres qui vont de 0 à F :

0, 1, 2, 3, 4, 5, 6, 7, 8, 9, a, b, c, d, e, f.

Ainsi, pour chaque composante, l'obscurité s'exprime par '00' et l'intensité maximale par 'ff'

Le noir sera noté '#000000' tandis que le blanc sera '#ffffff''  le gris moyen sera '#808080'  le rouge vif sera '#ff0000', le vert vif '#00ff00' etc...

Toute combinaison des trois nombres donne une teinte particulière.



Les paramètres d'appel

La médiathèque peut être utilisée de différentes manières. Il n'est pas nécessaire, par exemple, de proposer à l'utilisateur le choix de tous les rayons et de tous les thèmes si le site qui l'utilise est par nature destiné à ne présenter qu'une collection particulière de documents. Un certain nombre de paramètres ont donc été prévus pour personnaliser sa présentation.

De plus, il est possible d'accéder directement à des fonctions particulières de la base de données, par exemple une recherche rapide, dans ce cas, l'appel de l'une de ces fonctions nécessite au moins un paramètre comme nous le verrons à la section suivante.

Les paramètres sont introduits directement à la suite de l'URL (adresse Internet) la séparation se faisant au moyen d'un point d'interrogation. Un paramètre est formé d'un couple nom=valeur. Plusieurs paramètres peuvent être utilisés, on les place les uns à la suite des autres en les séparant par un "&". L'ordre n'a pas d'importance. Lorsqu'un terme contient des espaces (par exemple le titre d'un thème) ces espaces sont remplacés par %20. Souvent, votre navigateur le fait pour vous ce petit aménagement.

prov 

Ce paramètre permet d'ouvrir la médiathèque sur une collection déterminée de documents. Dans ce cas, on obtient par défaut le style adopté par le gestionnaire de la collection en question. La valeur appliquée au paramètre peut être le nom de la collection tel qu'il est enregistré dans la base de données (les minuscules et les majuscules sont des caractères différents) ou le code numérique qui identifie cette collection. Par exemple :

http://www.documentlibre.org/entree.php?prov=GESI

L'absence de code renvoie aux "contributions individuelles", c'est en réalité l'ensemble des documents "hors collection" (soumis directement à Document Libre et en attente d'intégration dans une collection.)

reset

Si l'on désire que le système "oublie" les sélections précédemment faites (normalement, il les garde en mémoire) on applique le paramètre :

http://www.documentlibre.org/entree.php?prov=XXXX&reset=1

ret

Permet de préciser à quel endroit l'internaute doit se trouver lorsqu'il quitte la médiathèque. Normalement, l'adresse de retour est établie par le système, vers la page qui a appelé la mediathèque, typiquement vers le site qui gère la collection. Cependant ce paramètre peut forcer le retour à une adresse précise. Exemple :

http://www.documentlibre.org.entree.php?prov=XXXX&ret=http://www.monsite.fr/accueil.html

skip

Lorsqu'on désire sauter l'étape de la page d'entrée permettant de choisir le rayon et le thème des documents, on applique le paramètre :

http://www.documentlibre.org/entree.php?skip=1

Dans ce cas, il faut préciser le thème par défaut.

style

Comme nous l'avons évoqué plus haut, le paramètre style permet de choisir la feuille de styles liée à la médiathèque. La valeur appliquée à ce paramètre est l'adresse complète de la feuille de styles. L'appel prend la forme :

www.documentlibre.org/entree.php?prov=XXXX&style=http://www.monsite.fr/monstyle.css



theme

Ce paramètre, permet de préciser le thème par défaut sélectionné dès l'entrée. Il est indispensable lorsque l'on utilise le paramètre skip=1. Il est important de notre que ce paramètre n'a  l'effet recherché que si le thème est orthographié exactement comme le champ de sélection qui apparaît dans les listes de la page d'entrée. Les majuscules et les minuscules sont distinguées. Les espaces doivent être remplacés par "%20", de même, %E9, %E8 et %20 remplacent respectivement é et è.

Astuce : Pour connaître ce codage, écrivez l'adresse et ses paramètres dans la barre d'adresse de votre navigateur, en écrivant las espaces et lettres accentuées sans vous soucier de les coder, et voyez comment votre navigateur les code automatiquement lorsque vous appuyez sur "entrée".

rayon

Ce paramètre n'est actuellement compris que par le script stage2.php qui se situe au deuxième niveau de la recherche arborescente (interface de type "explorateur"). Il permet de sauter le premier niveau en assumant un choix par défaut du rayon. Attention à l'écriture exacte du nom du rayon, au respect des majuscules, au traitement des espaces et caractères accentués comme ci-dessus.



Exemple d'un appel de la médiathèque

Soit à réaliser un cadre destiné à la médiathèque dans un frameset (ce peut d'ailleurs être l'unique élément du frameset le cas échéant).

Pour respecter la cohérence graphique avec le site, la feuille de styles "alterstyle.css" a été préparée. On souhaite de plus ouvrir par défaut la collection d'identifiant 105 - à supposer qu'il existe - en sautant le choix initial et en sélectionnant d'entrée de jeu le thème Phénomènes naturels dans le rayon "Illustrations et images".

Comme l'intitulé du thème est unique dans la base de données, il est inutile de préciser le rayon. Il suffit de préciser le thème.

La ligne du frameset  pourra par exemple s'écrire (sans exclure la présence d'autres attributs comme marginwidth...):

    <frame name="mediatheque" target="cadremilieu" src="http://www.documentlibre.org/entree.php?style=http://www.monsite.fr/alterstyle.css&prov=105&skip=1&theme=Ph%E9nom%E8nes%20naturesl">

Notez les %E9, %E8 et %20 qui représentent respectivement é, è, et espace.



La médiathèque en pièces détachées

Plusieurs fonctions particulières de l'outil <Document Libre> peuvent être appelées directement. Ce sont en particulier :



Formulaires de soumission d'un document

Les formulaires permettant la soumission d'un document se mettent prendre place sur un site de manière comparable aux formulaires de recherche, dans un cadre ( faisant partie d'un "frameset"), ou par un hyperlien. Les paramètres d'appel sont les mêmes. La page d'entrée de la soumission de document s'appelle entreesoum.php. C'est un formulaire de sélection du rayon et du thème qui - à l'instar de "entree.php" pour la recherche - peut être sautée avec le paramètre skip=1. Bien entendu, il faut dans ce cas préciser le thème par le paramètre "theme".



Voici par exemple comment on peut  appeler le formulaire de soumission par un hyperlien :

<a href="http://www.documentlibre.org/entreesoum.php?prov=XXXX>Proposer un document</a>



Utiliser l'outil de recherche rapide

La barre de recherche rapide peut être utilisée seule dans un site, par exemple dans un cadre ("frame") . On l'appelle de cette manière :

http://www.documentlibre.org/rapide.php? prov=XXXX

D'autres paramètres, comme style peuvent aussi être ajoutés.



Obtenir directement la liste de documents correspondant à un mot-clé

L'outil de recherche par mots-clé peut être appelé directement dans une barre d'adresse ou dans un document html.

ATTENTION : ces mots sont recherchés dans les métadonnées et non dans le corps du document.

Une recherche par "expressions régulières" ne tenant pas compte des majuscules/minuscules porte sur les mots passés en paramètre, en appliquant la relation logique ET. Ces mots sont recherchés dans le titre du document, dans les noms et prénoms des auteurs, dans les mots-clés, dans les noms de collection. La requéte se présente sous la forme suivante :

http://www.documentlibre.org/recherche.php?search=IUT%20moteur%20electrique

Pour rechercher les documents dont le nom de collection comprend "IUT" et dont les champs examinés contiennent moteur et électrique. Notez que les mots sont séparés par "%20". Il n'est pas nécessaire de porter les lettres avec leurs accents.



Obtenir directement la liste de documents correspondant à un identifiant ou une partie d'identifiant

La fonction est "rech_identifiant" et son paramètre est "idrecherche". La requête se présente sous la forme suivante :

http://www.documentlibre.org/rech_identifiant.php?idrecherche=1034-03



Obtenir directement la liste de documents mis à jour depuis une durée donnée

La fonction est "rech_maj" et son paramètre est "maj". Ce paramètre indique EN SECONDES la période précédant la recherche au cours de laquelle on espère trouver des documents mis à jour. Pour 24 heures, maj vaut donc 86400.  Il suffit donc de multiplier 86400 par le nombre de jours choisi. La requête se présente sous la forme suivante pour une recherche des documents mis à jour depuis 10 jours  :

http://www.documentlibre.org/rech_maj.php?maj=864000



Obtenir directement la liste des documents référencés par un auteur d'identifiant donné

La fonction est "prod.php" et son paramètre est "idauteur". Pour obtenir la production d'un auteur dont l'iddentifiant serait 1023, la requête serait :

http://www.documentlibre.org/prod.php?idauteur=1023



Obtenir directement la fiche descriptive d'un document à partir de son identifiant

Il suffit d'appeler la fonction "document" dont le paramètre est id :

http://www.documentlibre.org/document?id=DL-001012-03-02.04.01



Obtenir directement les métadonnées Dublin Core d'un document à partir de son identifiant

Le fichier est directement disponible, puisqu'il est formé de l'identifiant du document suivi de l'extension ".xml"



Accéder directement à un document à partir de son identifiant

Le gros avantage du passage par identifiant est l'assurance de pouvoir accéder à la dernière version du document, même si une révision a eu lieu, même si l'URL du document a changé. Même si l'identifiant a changé du fait d'une mise à jour, l'ancien identifiant permet d'accéder directement à la source unique de téléchargement. Il suffit de faire comme dans l'exemple ci-dessous :

http://www.documentlibre.org/urlt.php?id=DL-011056-04-06.01.00

ou plus simplement, puisque les champs de révision ne sont pas pris en compte :

http://www.documentlibre.org/urlt.php?id=DL-011056-04-06



Liens bibliographiques

Les possibilités détaillées ci-dessus permettent non seulement d'intégrer différentes fonctions dans un site, mais elles permettent aussi d'insérer dans un document électronique des hyperliens qui vont déclencher des requêtes sur la base de donnée et ainsi ouvrir des cadres avec des indications diverses. Ainsi, d'un simple clic, le lecteur pourra obtenir la fiche descriptive d'un document, la liste des publications d'un auteur, une liste de documents traitant d'un sujet ...

Filtrage d'accès

La médiathèque <Document Libre> n'a pas vocation à priver tout lecteur de l'accès à un document. Tout document exploitable est donc en principe accessible. Il existe cependant des cas où son accès doit être limité, au moins provisoirement. C'est le cas, par exemple, pour des travaux en développement ou pour certains corrigés de travaux. Lorsqu'un dispositif de filtrage d'accès s'impose, il est mis en place sur le site source, à l'initiative du gestionnaire de la collection.

Dans un cas typique, l'identifiant d'un document limité ne pointe pas directement vers un document en ligne, mais sur la page à même de contrôler son accès ou d'indiquer les conditions d'accès. Ce peut être aussi simple qu'une adresse mél pour joindre l'auteur.



Composition de l'identifiant

L'identifiant est formé de six champs successifs . Prenons un exemple : un document au format pdf (Acrobat) reçoit l'identifiant suivant :

DL-001032-03-04.01.01

Le fichier dans le site de l'auteur sera renommé ou recopié sous le nom :  DL-001032-03-04.01.01.pdf

DL exprime qu'il s'agit d'une référence <Document Libre>

Le champ suivant est en fait un champ composite formé de six chiffres. Les deux premiers indiquent la collection dans laquelle le document est classé - ici, '00' correspond aux contributions individuelles (hors collection) - le suivant (ici 1032) est  le code identifiant l'auteur.

Le champ suivant (03) indique le millésime (année de référencement 2003) le suivant (04) signifie que le document est le quatrième de l'auteur dans l'année.

Les deux derniers champs terminés par des '.' sont les codes de révision. Ils sont initialisés au départ à 01.01 et évolueront à mesure des améliorations du document (à l'instar des logiciels).

Si l'auteur apporte une modification significative (ajout, rectification...) à son document, il en change l'identifiant en faisant progresser le dernier champ d'une unité. Le fichier devient donc :

 DL-001032-03-04.01.02.pdf

Cette modification est très vite détectée par le robot de surveillance des liens, et la date de mise à jour est actualisée dans la base de données.

Si l'auteur apporte une modification importante (compléments, refonte partielle ou totale...), il considérera sans doute  qu'il s'agit d'une révision majeure. Dans ce cas, il fait progresser le champ de révision majeure d'une unité et le fichier devient :

DL-001032-03-04.02.01.pdf

Dès que le robot de surveillance s'aperçoit de cette évolution, il adresse à l'auteur un courrier électronique avec un lien vers un formulaire pré-rempli par lequel l'auteur est invité à rectifier le descriptif du document et à résumer la teneur des changements.