- 1 What is Search Console
- 2 How to install search console
- 3 How to get search console source code
- 4 Filing a bug
- 5 Documentation
- 6 What are the version / distribution requirements
- 7 I wish to contribute
- 8 Why am i seeing search types that do nothing?
- 9 How can I disable the compatibility search types?
What is Search Console
Search console is an Eclipse-based search framework with enhanced user experience and extensibility capabilities. It aims to provide the Next-generation search framework of Eclipse. It is expected that search console will ultimately support both existing org.eclipse.search extensions, and “native” Search Console extensions.
How to install search console
We recommend using the latest milestone release of the E4 update site.
It can be found in the "0.12 Stream Stable Builds" section at http://download.eclipse.org/e4/downloads/ .
From the Eclipse Install manager, select the category "E4 Search". You can individally install the Search Console framework, the example search contributor, and the "Compatibility" feature (latter is explained below). Source features are also available on the site from build I20110809-2000 afterwards, and will be available in the 4.2 Milestone 2 Build.
Those who want the bleeding edge, can consume the latest integration build of E4:
http://download.eclipse.org/e4/downloads/ -> 0.13 Stream Integration Builds -> Select the latest build you see there.(If 404 not found is returned, select next latest build). Click on "online p2 repo link" - that is the update site.
How to get search console source code
You can either install the source features from the update site (suitable if you want to develop an extension for search console), or fetch the sources from the Git repo, if you want to modify the sources / contribute back to the community.
Here are the links to our repository:
Prior cloning the repository please make sure that you have performed the GIT repository configuration steps
The source code of an example search provider is under folder /examples in our repo. This can prove very useful if you want to implement a search provider.
Filing a bug
Developers' guide is available here
What are the version / distribution requirements
Search console only depends on the core Eclipse SDK plugins. It has been tested, and is supported, on Eclipse SDK versions 3.7 and later. This includes versions 4.1, 4.2 and later of Eclipse SDK.
Search console does not depend on the org.eclipse.core.resources bundle.
Since Search Console has no explicit version requirements, it may run successfully on Eclipse SDK 3.5 and higher
I wish to contribute
You're welcome! Follow the standard drill. It's easiest to open a bug with a patch on component E4/Search, or write directly to email@example.com .
A good starting point for new contributors is http://wiki.eclipse.org/Development_Resources. In case you would like to contribute patches, have a look at Search Console Coding Guidelines
Why am i seeing search types that do nothing?
Because it's work in progress. These are the compatibility search types, which adapt the extensions contributed to the org.eclipse.search.searchPages extension point, to the Search console framework.
There is a prototype of the compatibility layer in the prototype branch. If interested, you can check it out, run it inside a runtime worbench, and give your feedback. You can post comments in in https://bugs.eclipse.org/bugs/show_bug.cgi?id=331581
How can I disable the compatibility search types?
Just deselect the Compatibility feature when installing. This is available from integration build I20110630-1005 afterwards.