|
| 1 | + |
| 2 | +CONTENTS OF THIS FILE |
| 3 | +--------------------- |
| 4 | + |
| 5 | + * Overview |
| 6 | + * Quick setup |
| 7 | + * Requirements |
| 8 | + * Blocks |
| 9 | + * SiteSearch |
| 10 | + * Search module integration |
| 11 | + * Advanced settings |
| 12 | + * Installation |
| 13 | + * Maintainers |
| 14 | + |
| 15 | +OVERVIEW |
| 16 | +-------- |
| 17 | + |
| 18 | +Google Custom Search Engine (CSE) is an embedded search engine that can |
| 19 | +be used to search any set of one or more sites. No Google API key is |
| 20 | +required. Read more at http://www.google.com/cse/. |
| 21 | + |
| 22 | +QUICK SETUP |
| 23 | +----------- |
| 24 | + |
| 25 | +After installing this module, activate Google CSE at |
| 26 | +admin/config/search/settings, optionally setting it as the default |
| 27 | +search module, and configure it by entering Google's unique ID for your |
| 28 | +CSE. Once you have granted permission for one or more roles to search |
| 29 | +the Google CSE, the search page can be found at search/google, and a |
| 30 | +separate self-contained search block can also be enabled. |
| 31 | + |
| 32 | +BLOCKS |
| 33 | +------ |
| 34 | + |
| 35 | +The include Google CSE block can optionally be enabled at |
| 36 | +admin/structure/block. The "Google CSE" block provides a search box and |
| 37 | +also displays the search results. After entering search terms, the user |
| 38 | +will be returned to the same page (via GET request) and the results will |
| 39 | +be displayed. Do not allow this Google CSE block to appear on the |
| 40 | +search/google page, as the search results will fail to display. |
| 41 | + |
| 42 | +SITESEARCH |
| 43 | +---------- |
| 44 | + |
| 45 | +In addition to the CSE functionality, SiteSearch on one or more domains |
| 46 | +or URL paths can optionally be configured. Radio buttons allow users to |
| 47 | +search on either the SiteSearch option(s) or the CSE, and searches can |
| 48 | +default to either option. |
| 49 | + |
| 50 | +ADVANCED SETTINGS |
| 51 | +----------------- |
| 52 | + |
| 53 | +The collapsed advanced settings on the settings page provide various |
| 54 | +customizations such as country and language preferences. For example, |
| 55 | +with the Locale module enabled, the Google CSE user interface language |
| 56 | +can be selected dynamically based on the current user's language. |
| 57 | + |
| 58 | +INSTALLATION |
| 59 | +------------ |
| 60 | + |
| 61 | +Place the google_cse directory in your sites/all/modules directory. |
| 62 | +Enable the Google CSE module at admin/modules, configure it at |
| 63 | +admin/config/search/settings, and assign permissions for "search Google |
| 64 | +CSE" at admin/people/permissions. |
| 65 | + |
| 66 | +To configure this module, you will need your CSE's unique ID. Go to |
| 67 | +http://www.google.com/cse/manage/all, click on control panel and you |
| 68 | +will find the "Search engine unique ID" under "Basic information". |
| 69 | + |
| 70 | +MAINTAINERS |
| 71 | +----------- |
| 72 | + |
| 73 | +Authored and maintained by mfb: http://drupal.org/user/12302 |
| 74 | + |
| 75 | +The current maintainer does not plan to add new features to this module, |
| 76 | +such as support for multiple CSEs; however, patches providing new |
| 77 | +features are welcome and will be reviewed. |
| 78 | + |
| 79 | +For bugs, feature requests and support requests, please use the issue |
| 80 | +queue at http://drupal.org/project/issues/google_cse |
0 commit comments