Jump to: navigation, search

Difference between revisions of "E4/Search Console"

< E4
Line 1: Line 1:
*What is Search Console<br>
+
*
 +
==== 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.<br>  
+
 
 +
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.<br>  
  
 
<br>  
 
<br>  
  
*How to install search console<br>
+
*
 +
==== How to install search console ====
 +
 
  
 
We recommend using the latest milestone release of the E4 update site.<br>  
 
We recommend using the latest milestone release of the E4 update site.<br>  
  
It can be found in the "0.12 Stream Stable Builds" section at http://download.eclipse.org/e4/downloads/.<br>  
+
It can be found in the "0.12 Stream Stable Builds" section at '''http://download.eclipse.org/e4/downloads/''' .<br>  
  
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.<br>  
+
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.<br>  
  
 
<br>  
 
<br>  
Line 17: Line 21:
 
Those who want the bleeding edge, can consume the latest integration build of E4:<br>  
 
Those who want the bleeding edge, can consume the latest integration build of E4:<br>  
  
http://download.eclipse.org/e4/downloads/ -&gt; 0.11 Stream Integration Builds -&gt; 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.<br>  
+
'''http://download.eclipse.org/e4/downloads'''/ -&gt; 0.11 Stream Integration Builds -&gt; 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.<br>  
  
 
<br>  
 
<br>  
  
*How to get search console source code<br>
+
*
 +
==== 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.<br>  
 
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.<br>  
Line 27: Line 33:
 
Here are the links to our repository:<br>  
 
Here are the links to our repository:<br>  
  
Web UI -https://git.eclipse.org/c/e4/org.eclipse.e4.search.git/<br>  
+
Web UI - '''https://git.eclipse.org/c/e4/org.eclipse.e4.search.git/'''<br>  
  
Clone URI - git://git.eclipse.org/gitroot/e4/org.eclipse.e4.search.git<br>  
+
Clone URI -'''git://git.eclipse.org/gitroot/e4/org.eclipse.e4.search.git'''<br>  
  
 
'''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.'''<br>  
 
'''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.'''<br>  
Line 35: Line 41:
 
<br>  
 
<br>  
  
*Filing a bug<br>
+
*
 +
==== Filing a bug ====
  
https://bugs.eclipse.org/bugs/enter_bug.cgi?product=e4&amp;component=Search<br>  
+
 
 +
'''https://bugs.eclipse.org/bugs/enter_bug.cgi?product=e4&amp;component=Search'''<br>  
  
 
<br>  
 
<br>  
  
*Documentation<br>
+
*
 +
==== Documentation ====
 +
 
  
Developer guide - https://bugs.eclipse.org/bugs/attachment.cgi?id=180106<br>  
+
Developer guide is available at '''https://bugs.eclipse.org/bugs/attachment.cgi?id=180106'''<br>  
  
 
<br>  
 
<br>  
  
*What are the version / distribution requirements<br>
+
*
 +
==== 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.<br>  
 
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.<br>  
Line 55: Line 67:
 
<br>  
 
<br>  
  
*I wish to contribute<br>
+
*
 +
==== 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 e4-dev@eclipse.org .<br>  
 
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 e4-dev@eclipse.org .<br>  
Line 63: Line 77:
 
<br>  
 
<br>  
  
*Why am i seeing search types that do nothing?
+
*
 +
==== 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.<br>  
 
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.<br>  
Line 69: Line 85:
 
<br>  
 
<br>  
  
*How can I disable the compatibility search types?<br>
+
*
 +
==== How can I disable the compatibility search types? ====
 +
 
  
Just deselect the Compatibility&nbsp;feature when installing. This is available from integration build I20110630-1005 afterwards.<br>
+
Just deselect the Compatibility&nbsp;feature when installing. This is available from integration build''I20110630-1005'' afterwards.<br>

Revision as of 10:54, 16 August 2011

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.11 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:

Web UI - https://git.eclipse.org/c/e4/org.eclipse.e4.search.git/

Clone URI -git://git.eclipse.org/gitroot/e4/org.eclipse.e4.search.git

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

https://bugs.eclipse.org/bugs/enter_bug.cgi?product=e4&component=Search


Documentation

Developer guide is available at https://bugs.eclipse.org/bugs/attachment.cgi?id=180106


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.

Since Search Console has no explicit version requirements, it may run successfully on Eclipse SDK 3.5 and 3.6. However this is not officially supported and tested.


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 e4-dev@eclipse.org .

A good starting point for new contributors is http://wiki.eclipse.org/Development_Resources


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.


How can I disable the compatibility search types?

Just deselect the Compatibility feature when installing. This is available from integration buildI20110630-1005 afterwards.