diff --git CHANGELOG.txt CHANGELOG.txt index 30bb24b..5bf2f9f 100644 --- CHANGELOG.txt +++ CHANGELOG.txt @@ -11,18 +11,18 @@ Show xapian options by default. all sub-options are also collapsed. Rebuild menu after changing xapian_takeover option. minor: be consistent with the way to get index status counters. -Add docs about overwritting the way to index nodes. +Add docs about overwriting the way to index nodes. Move credits to a central place, the README. - Maily for practical proposes. -Use results counter propertly. + Mainly for practical proposes. +Use results counter properly. bug #675444 by marvil07: remove all variables on uninstall. Xapian 6.x-1.1, 2010-08-25 -------------------------- task #651892: Improve documentation. - - Avoid reference to the no more used perl bindings(see #318087 for details). - - Better README file using asciidoc an updating it. + - Avoid reference to the no more used Perl bindings(see #318087 for details). + - Better README file using asciidoc and updating it. Remove no more used permission. by diegoe: avoid count(*), and do count(field_with_index) instead #690316: Better option names @@ -38,7 +38,7 @@ Xapian 6.x-1.0, 2010-01-02 Fixes and updates to Xapian courtesy of Trellon Ability to exclude certain node types Resolve bug with taxonomy not being set - Added seperate permission for xapian administration + Added separate permission for xapian administration by singularo: Fix problem when deleting comments with Drupal 6 by singularo: Stop foreach error when database is corrupt feature #369059: make stemming language configurable diff --git README.txt README.txt index 08be7b5..f223cad 100644 --- README.txt +++ README.txt @@ -3,12 +3,9 @@ == Overview == -This module will let you make votes on some entities inside drupal with -different widgets, by using Voting API and its some submodules: vud_node, -vud_comment and vud_term. - -AJAX functionality, provided by ctools, is used for voting if the browser -supports it. +This module replaces the standard SQL-based search mechanism with a +higher-performance, more scalable mechanism based on the Xapian search +library. === Features === @@ -27,14 +24,14 @@ To submit bug reports and feature suggestions, or to track changes: == Installation of the Xapian requirements == -The next documentation will summarize wht you need to do to install +The next documentation will summarize what you need to do to install Xapian. === Debian/Ubuntu === aptitude install php5-xapian -Note: With ubuntu hardy, the library was not put in the built in include +Note: With Ubuntu Hardy, the library was not put in the built in include path. Running this command resolved that sudo ln -s /usr/share/php5/xapian.php /usr/share/php/xapian.php @@ -52,9 +49,9 @@ The official documentation is on: * http://www.xapian.org/docs/install.html * http://www.xapian.org/download.php -== Instalation == +== Installation == -* Install xapian and its bidings(see Installation of the Xapian +* Install xapian and its bindings (see Installation of the Xapian requirements) * Install as usual, see http://drupal.org/node/70151 for further information. @@ -89,7 +86,7 @@ estimates the results. This setting modifies that behaviour. Logging:: It is also possible to enable query logging, which records both the search query and the time required to execute it. Once you have patched drupal -core, the reponse times for the drupal equivalent query are also logged, +core, the response times for the drupal equivalent query are also logged, making a convenient way to test the difference the Xapian module and the standard drupal search. @@ -101,7 +98,7 @@ Change the steaming language you want to use. == Advanced Xapian usage == -Xapian has the built in ability to host the database on a seperate +Xapian has the built in ability to host the database on a separate machine than the web server. It you'd like to do this, the remote host must have xapian installed and then they must run `xapian-tcpsrv --port `, which will start a @@ -112,7 +109,7 @@ defaults to port 6431, but any port can be used. - Initial development and sample view code by Lachlan Gunn (http://drupal.org/user/277696) -- Core patch, tighter drupal integration, adherance to drupal standards, +- Core patch, tighter drupal integration, adherence to drupal standards, making ready for release by Simon Lindsay (http://drupal.org/user/143) - Additional cleanup by Jeremy Andrews (http://drupal.org/user/409) diff --git xapian.lib.inc xapian.lib.inc index 4511025..c753a64 100644 --- xapian.lib.inc +++ xapian.lib.inc @@ -114,7 +114,7 @@ function _xapian_init_database($writable = FALSE, $flush = FALSE) { * stemmed automatically. * * @param $start An integer defining the first document to return - * (ie. if $start = n, then the first node returned will + * (That is, if $start = n, then the first node returned will * be that in the nth document found). * * @param $length The number of results to return. @@ -238,7 +238,7 @@ function _xapian_index_node($node, $delete = FALSE) { // Track which content is being indexed until the Xapian cache is flushed. // If we fail to flush the cache to disk for any reason, we will re-attempt // to index this content. See bug #272140 for full details. - // TODO make this query more natural in dbtng? + // @todo Make this query more natural in dbtng? // original db_query('UPDATE {xapian_index_queue} SET status = status + 1, indexed = %d WHERE nid = %d', time(), $node->nid); $status = db_query('SELECT status FROM {xapian_index_queue} WHERE nid = :nid', array(':nid' => $node->nid)) ->fetchField(); @@ -247,10 +247,10 @@ function _xapian_index_node($node, $delete = FALSE) { ->condition('nid', $node->nid) ->execute(); - // Provide mechanism to override default indexing behaviour + // Provide mechanism to override default indexing behaviour. $function = $node->type .'_xapian_index'; - // But fallback to standard node indexing + // Default to standard node indexing. if (!function_exists($function)) { $function = 'node_xapian_index'; } diff --git xapian.module xapian.module index 5aad6bf..0346f42 100644 --- xapian.module +++ xapian.module @@ -75,7 +75,7 @@ function xapian_admin_form() { $database_type = variable_get('xapian_database_type', XAPIAN_LOCAL); - // Create an all encompasing Xapian fieldset + // Create an all-encompassing Xapian fieldset $form['xapian'] = array( '#type' => 'fieldset', '#collapsed' => FALSE, @@ -438,7 +438,7 @@ function xapian_index_node(&$node) { ->execute(); } else { - watchdog('xapian', 'Failed to immediately index node with nid %nid, queing to try again later.', array('%nid' => $node->nid)); + watchdog('xapian', 'Failed to immediately index node with nid %nid, queueing to try again later.', array('%nid' => $node->nid)); // Failed to update Xapian database, queue item to index later. _xapian_queue_index($node); } @@ -467,7 +467,7 @@ function xapian_index_queued_nodes() { // Re-index content that wasn't flushed to disk last time, minus the node // which failed last time. $limit = variable_get('search_cron_limit', 100); - // FIXME make this lines more readable + // @todo Make these lines more readable. $error = $not_flushed - 1; $limit = $limit > $error ? $error : $limit; $query->condition('x.status', 0, '>') @@ -488,7 +488,7 @@ function xapian_index_queued_nodes() { } else { $limit = (int)variable_get('search_cron_limit', 100); - // TODO convert this query to dbtng if possible + // @todo Convert this query to dbtng if possible. $result = db_query_range('SELECT nid FROM {xapian_index_queue} ORDER BY COALESCE(priority, 0) DESC, added ASC', 0, $limit); }