global search review and extension for physical files

search/LISEZMOI.txt

@@ -0,0 +1,89 @@
+Cette distribution partielle contient une refonte du moteur de 
+recherche globalde Moodle.
+
+Le moteur de recherche est capable d'indexer et de rechercher 
+des informations dans un grand nombre de contenus stock�s
+dans la plate-forme � travers la manipulation des activit�s et
+des blocs.
+
+Le moteur de recherche proc�de � une premi�re indexation des
+ressources disponibles par action de l'administrateur. Une fois
+cette indexation effectu�e, le moteur maintient r�guli�rement les
+indexes, en ajoutant les nouvelles entr�es et en nettoyant les 
+entr�es obsol�tes.
+
+La recherche permet d'obtenir des r�f�rences d'acc�s au contexte
+qui diffuse cette information, au nom de l'utilisateur courant.
+Le filtrage des r�sultats enl�ve de la liste des r�ponses toute
+ressource que la situation de l'utilisateur emp�cherait de voir
+s'il y acc�dait dans son contexte habituel.
+
+Mise en oeuvre
+##############
+
+Pour d�ployer le moteur : 
+
+
+* Copie de fichiers
+
+1. Ajouter les deux librairies fournies aux librairies de Moodle
+2. Ecraser le r�pertoire "search" par le r�pertoire fourni
+3. Ecraser le bloc "blocs/search" par le bloc fourni.
+
+* Installation logique
+
+4. Aller dans les notifications administratives et d�rouler la proc�dure d'installation/mise � jour du bloc. L'installation cr�e la table image
+des documents index�s et utilis�s dans le module search.
+
+5. Ins�rer un nouveau bloc de recherche globale dans la plate-forme
+
+6. Effectuer une recherche vide (en administrateur)
+
+7. Aller sur la page des statistiques
+
+8. Activer l'indexation (indexsplash.php). Attention, si la plate-form contient beaucoup de contenus cette indexation peut �tre TRES LONGUE.
+
+Pour effectuer des recherches, une fois la premi�re indexation termin�e, retourner au bloc de recherche et tenter une recherche.
+
+El�ments pris en charge
+#######################
+
+Dans l'�tat actuel, les �l�ments index�s par le moteur sont :
+
+- les entr�es de forum
+- les fiches de base de donn�es
+- les commentaires sur fiches de donn�es
+- les entr�es de glossaire
+- les commentaires sur entr�es de glossaire
+- les ressources natives Moodle
+- les ressources physiques de type MSWord
+- les ressources physiques de type PDF
+- les ressources physiques de type fichier texte (.txt)
+- les ressources physiques de type HTML (.htm et .html)
+- les ressources physiques de type XML (.xml)
+- les ressources physiques de type (Microsoft) Powerpoint (.ppt)
+- les pages de wiki
+- les entit�s de projet technique
+- les sessions de chat
+
+Extensions
+##########
+
+L'API du moteur de recherche permet d�sormais : 
+
+- l'indexation de contenus de blocs.
+- l'indexation de modules contenant une information complexe ou de plusieurs types distincts
+- la s�curisation des informations index�es lors des extractions de r�sultats
+- l'indexation de tout module tiers par ajout d'un fichier php calibr�
+- l'indexation de toute nouvelle resource physique par ajout d'un fichier php calibr�
+
+Extensions futures
+##################
+
+- De nouvelles prises en charge de contenus tels que les attachements des forums, les attachement des glossaires, ainsi que d'autres modules non encore
+impl�ment�s.
+
+- l'extension mnet de la recherche dans un r�seau de moodle interconnect�s.
+
+
+

search/READMETOO.txt

@@ -0,0 +1,90 @@
+This partial distribution contains a complete review of the
+Global Search Engine of Moodle.
+
+The Global Search Engine stores indexes about a huge quantity  
+of information from within modules, block or resources stored 
+by Moodle either in the database or the file system.
+
+The administrator initialy indexes the existing content. Once this 
+first initialization performed, the search engine maintains indexes
+regularily, adding new entries, deleting obsolete one or updating
+some that have changed.
+
+Search will produce links for acceding the information in a similar
+context as usually accessed, from the current user point of view.
+Results filtering removes from results any link to information the
+current user would not be allowed to acces on a straight situation.
+
+Deployement
+###########
+
+For setting the engine : 
+
+
+* File copy
+
+1. Add to Moodle's library both additional libraries provided in the distribution
+2. Replace the "search" directory with the new one
+3. Replace the "blocks/search" with the new one.
+
+* Logical install
+
+4. Browse to the administrative notification screen and let the 
+install/update process run. The install process creates the Moodle
+table needed for backing the indexed documents identities.
+
+5. Go to the block administration panel and setup once the Global Search
+block. This will initialize useful parameters for the global search engine.
+
+6. Insert a new Global Search block somewhere in a course or top-level screen. 
+
+7. Launch an empty search (you must be administrator).
+
+8. Go to the statistics screen.
+
+9. Activate indexation (indexersplash.php). Beware, if your Moodle has
+a large amount of content, indexing process may be VERY LONG.
+
+To search, go back to the search block and try a query.
+
+Handled information for indexing
+################################
+
+In the actual state, the engine indexes the following information:
+
+- forum posts
+- database records (using textual fields only)
+- database comments
+- glossary entries
+- glossary comments on entries
+- Moodle native resources
+- physical MSWord files as resources (.doc)
+- physical Powerpoint files as resources (.ppt)
+- physical PDF files as resources 
+- physical text files as resources (.txt)
+- physical html files as resources (.htm and .html)
+- physical xml files as resources (.xml)
+- wiki pages
+- techproject descriptions
+- char sessions
+
+Extensions
+##########
+
+The reviewed search engine API allows: 
+
+- indexing of blocks contents
+- indexation of modules or blocks containing a complex information model
+- securing the access to the results
+- adding indexing handling adding a php calibrated script
+- adding physical filetype handling adding a php calibrated script
+
+Future extensions
+#################
+
+- Should be added more information to index such as forum and glossary attachements, so will other standard module contents.
+
+- extending the search capability to a mnet network information space.
+
+
+