| 1 |
SEMANTIC_SEARCH:
|
| 2 |
- http://drupal.org/project/semantic_search
|
| 3 |
- author Jonathan Hendler jonathan[at]civicactions.com || hendlerman[at]yahoo.com
|
| 4 |
- updated 4/16/2007
|
| 5 |
- created 3/6/2006
|
| 6 |
|
| 7 |
LICENSE(S):
|
| 8 |
- Copyright 2006,2007 Lead Architect and Engineer, Jonathan Hendler
|
| 9 |
- AGPL CivicActions LLC
|
| 10 |
|
| 11 |
SUMMARY:
|
| 12 |
|
| 13 |
SEMANTIC_SEARCH is Drupal search technology which integrates with Drupal's infrastructure
|
| 14 |
for smaller organizations/websites running Drupal.
|
| 15 |
|
| 16 |
SEMANTIC_SEARCH is both a Web 2.0 functionality with a rich client experience and
|
| 17 |
webservices, and a Web 3.0 (Semantic Web) ready application using SPARQL
|
| 18 |
and an RDFStore to execute searches.
|
| 19 |
|
| 20 |
SEMANTIC_SEARCH integrates with Drupal's CCK and taxonomy modules, as well as some other
|
| 21 |
Drupal node types.
|
| 22 |
|
| 23 |
GOALS:
|
| 24 |
1. Easy to install
|
| 25 |
2. Easy to configure
|
| 26 |
3. Performant on searches over 1000s of Nodes/ Taxonomy terms
|
| 27 |
4. Import export, and synchronized live sharing
|
| 28 |
5. Adoption by the Drupal community
|
| 29 |
6. Integration with other RDFstores and sites on the Semantic Web
|
| 30 |
|
| 31 |
PREREQUISITES:
|
| 32 |
- basic understanding of Drupal
|
| 33 |
- Drupal 4.7.x, Drupal 5.x.x site with existing content
|
| 34 |
- PHP 5.x
|
| 35 |
- MySQL 5 (significant bug with MySQL 4 and ARC)
|
| 36 |
- you may need to increase PHPs memory and timeout in the php.ini
|
| 37 |
for the imports into SEMANTIC_SEARCH from Drupal
|
| 38 |
|
| 39 |
BUNDLED SOFTWARE:
|
| 40 |
- ARC: The fastest, most portable, RDF Store in native PHP
|
| 41 |
- SONIA: an abstraction layer for ARC to be used by SEMANTIC_SEARCH
|
| 42 |
|
| 43 |
CURRENT FEATURES:
|
| 44 |
- jQuery Interface and RPC in both 5.x.x and 4.7.x installs
|
| 45 |
- data is pulled from Drupal and is Synced all at once or on update
|
| 46 |
- sync from chosen CCK types and their Taxonomy to the RDF store/search
|
| 47 |
- search, rpc, and datastore are separate modules which can be enabled
|
| 48 |
- export to RDF
|
| 49 |
- fully themable
|
| 50 |
- /admin/semantic_search/export
|
| 51 |
- export the RDF
|
| 52 |
- admin/settings/semantic_search
|
| 53 |
- cache builder
|
| 54 |
- resync of data
|
| 55 |
- configuration of which CCK fields are searched on
|
| 56 |
|
| 57 |
PLANNED FEATURES:
|
| 58 |
- default search available at [site]/semantic_search
|
| 59 |
- multiple pages containing multiple searches
|
| 60 |
- full Drupal 5 integration
|
| 61 |
- taxonomy, tags, node relation, blog, events, and other Node types searchable
|
| 62 |
- tested to fully work without javascript/ Section 508 compliance
|
| 63 |
- IL8 integration (Internationalization, Translations, etc)
|
| 64 |
- relationships module integration
|
| 65 |
- /admin/
|
| 66 |
- microformats import/export
|
| 67 |
- RSS export of searches
|
| 68 |
- P2P data sharing
|
| 69 |
- SPARQL debug window
|
| 70 |
- other Store for Performance and other options
|
| 71 |
- more complete automated tests
|
| 72 |
|
| 73 |
|
| 74 |
|
| 75 |
FILE OVERVIEW:
|
| 76 |
(in drupal/modules/semantic_search. Non-relevent files excluded)
|
| 77 |
- conf/
|
| 78 |
- semantic_search.conf.inc.sample
|
| 79 |
is a configuration file that you will need to copy and edit
|
| 80 |
- settings.php.sample
|
| 81 |
provides a drupal settings.php file with the added include needed for SEMANTIC_SEARCH
|
| 82 |
- semantic_search.constants.inc
|
| 83 |
provides constants used through out the program. this should not need to be
|
| 84 |
edited
|
| 85 |
- css/
|
| 86 |
- semantic_search.css
|
| 87 |
the css file needed by semantic_search
|
| 88 |
- includes/
|
| 89 |
- semantic_search.admin.inc (planned removal)
|
| 90 |
most functions here are obsolete does use the rdf export
|
| 91 |
- semantic_search.app.api.inc (planned development)
|
| 92 |
will be used to enforce coder generated
|
| 93 |
- semantic_search.app.inc
|
| 94 |
the file currently used to generate the search form. This file is what must
|
| 95 |
be customized any time a semantic_search app is created.
|
| 96 |
- semantic_search.app.inc.sample (planned development)
|
| 97 |
a definitive sample file to guide for coders. Will be completed for Drupal 5
|
| 98 |
- semantic_search.helpers.inc
|
| 99 |
a set of static functions used through-out SEMANTIC_SEARCH (will grow)
|
| 100 |
- semantic_search.lang.inc (planned removal)
|
| 101 |
before SEMANTIC_SEARCH was Drupal only.
|
| 102 |
- semantic_search.node_hooks.inc
|
| 103 |
helper functions for working with drupal hooks
|
| 104 |
- semantic_search.node.search.inc
|
| 105 |
the main object instantiated to interface with SONIA
|
| 106 |
there are many obsolete functions being reworked
|
| 107 |
- js/
|
| 108 |
- semantic_search_fx.js
|
| 109 |
dhtml functions
|
| 110 |
- semantic_search_test.js
|
| 111 |
code to test that ajax works
|
| 112 |
also contains some benchmarking code
|
| 113 |
- semantic_search.js
|
| 114 |
rpc functions for interacting with the server
|
| 115 |
also the main control functions
|
| 116 |
- tests/
|
| 117 |
- in progress benchmarking
|
| 118 |
- semantic_search_rpc.module
|
| 119 |
a separate but required module for implementing RPC RPC calls
|
| 120 |
- semantic_search.install
|
| 121 |
sets up semantic_search (mostly the ARC DB) based on config options
|
| 122 |
- semantic_search.module
|
| 123 |
the primary module for semantic_search
|
| 124 |
- themes (planned development)
|
| 125 |
|
| 126 |
|