search/README.txt

   1 This directoery contains the central implementation of
   2 Moodle's Global Search Engine.
   3
   4 The Global Search Engine stores indexes about a huge quantity
   5 of information from within modules, block or resources stored
   6 by Moodle either in the database or the file system.
   7
   8 The administrator initialy indexes the existing content. Once this
   9 first initialization performed, the search engine maintains indexes
  10 regularily, adding new entries, deleting obsolete one or updating
  11 some that have changed.
  12
  13 Search will produce links for acceding the information in a similar
  14 context as usually accessed, from the current user point of view.
  15 Results filtering removes from results any link to information the
  16 current user would not be allowed to acces on a straight situation.
  17
  18 Deployment
  19 ###########
  20
  21 The search engine is now part of Moodle core distribution.
  22
  23 Some extra libraries might be added for converting physical documents to text
  24 so it can be indexed. Moodle CVS (entry contrib/patches/global_search_libraries)
  25 provides packs for antiword and xpdf GPL libraries the search engine is ready for
  26 shockwave indexing, but will not provide Adobe Search converters that should be
  27 obtained at http://www.adobe.com/licensing/developer/
  28
  29 1. Go to the block administration panel and setup once the Global Search
  30 block. This will initialize useful parameters for the global search engine.
  31
  32 2. Insert a new Global Search block somewhere in a course or top-level screen.
  33
  34 3. Launch an empty search (you must be administrator).
  35
  36 4. Go to the statistics screen.
  37
  38 5. Activate indexation (indexersplash.php). Beware, if your Moodle has
  39 a large amount of content, indexing process may be VERY LONG.
  40
  41 To search, go back to the search block and try a query.
  42
  43 Handled information for indexing
  44 ################################
  45
  46 In the actual state, the engine indexes the following information:
  47
  48 - assignment descriptions
  49 - forum posts
  50 - database records (using textual fields only)
  51 - database comments
  52 - glossary entries
  53 - glossary comments on entries
  54 - Moodle native resources
  55 - physical MSWord files as resources (.doc)
  56 - physical Powerpoint files as resources (.ppt)
  57 - physical PDF files as resources
  58 - physical text files as resources (.txt)
  59 - physical html files as resources (.htm and .html)
  60 - physical xml files as resources (.xml)
  61 - wiki pages
  62 - chat sessions
  63 - lesson pages
  64
  65 Some third party plugins are also searchable using the new Search API implementation
  66
  67 - Techproject
  68
  69 Extensions
  70 ##########
  71
  72 The reviewed search engine API allows:
  73
  74 - indexing of blocks contents
  75 - indexation of modules or blocks containing a complex information model
  76 - securing the access to the results
  77 - adding indexing handling for additional modules and plugins adding a php calibrated script
  78 - adding physical filetype handling adding a php calibrated script
  79
  80 Global Search on NFS Mounted clusters
  81 #####################################
  82
  83 This version contains a patched Lucene Zend implementation that allows using the Global Search engine in an NFS mounted shared volume for Web clustering. This implementation
  84 remains highly experimental and not all tests have been processed. Some changes may
  85 occur in the SoftLockManager that was added to the Lucene engine.
  86
  87 Future extensions
  88 #################
  89
  90 - Should be added more information to index such as forum and glossary attachements,
  91   so will other standard module contents.
  92 - extending the search capability to a mnet network information space by aggregating remote search responses.