Jump to: navigation, search

Difference between revisions of "E4/Search Console"

< E4
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
*How to install search console<br>
+
==== What is Search Console  ====
  
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>  
+
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>  
  
The relevant category is "E4 Search". You can individally install the Search Console framework, the example search contributor, and the "Compatibility" feature (latter is explained below).<br>  
+
<br>
 +
 
 +
==== How to install search console  ====
 +
 
 +
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>
 +
 
 +
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>  
  
*How to get search console source code<br>
+
Those who want the bleeding edge, can consume the latest integration build of E4:<br>  
  
Web UI -https://git.eclipse.org/c/e4/org.eclipse.e4.search.git/<br>  
+
'''http://download.eclipse.org/e4/downloads'''/ -&gt; 0.13 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>  
  
Clone URI - git://git.eclipse.org/gitroot/e4/org.eclipse.e4.search.git<br>  
+
<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>
 +
 
 +
Here are the links to our repository:<br>
 +
 
 +
Web UI<br> '''https://git.eclipse.org/c/e4/org.eclipse.e4.search.git/'''<br>
 +
 
 +
Clone URI<br> '''git://git.eclipse.org/gitroot/e4/org.eclipse.e4.search.git<br>''' '''ssh://git.eclipse.org/gitroot/e4/org.eclipse.e4.search.git<br>''' '''http://git.eclipse.org/gitroot/e4/org.eclipse.e4.search.git<br>'''
 +
 
 +
<br> Prior cloning the repository please make sure that you have performed the [http://wiki.eclipse.org/Platform-releng/Git_Workflows#Configuring_the_repo 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.'''<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 17: Line 37:
 
<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>
+
Developers' guide is available [http://wiki.eclipse.org/E4/Search_Console/Developers_Guide here]
  
<br>  
+
<br>
  
*What are the version / distribution requirements<br>
+
==== What are the version / distribution requirements ====
  
None, provided your eclipse is not too old. If you find incompatibilities, file a bug.<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>  
  
<br>  
+
Search console does not depend on the ''org.eclipse.core.resources ''bundle.<br>  
  
*I wish to contribute<br>
+
Since Search Console has no explicit version requirements, it may run successfully on Eclipse SDK 3.5 and higher<br>  
  
You're welcome! Follow the standard drill. It's easiest to open a bug with a patch, or write directly to e4-dev@eclipse.org<br>  
+
<br>
  
<br>
+
==== I wish to contribute  ====
  
*Why am i seeing search types that do nothing?
+
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>
  
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>
+
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 [http://wiki.eclipse.org/E4/Search_Console/Coding_Guidelines Search Console Coding Guidelines]
  
 
<br>  
 
<br>  
  
*How can I disable the compatibility search types?<br>
+
==== Why am i seeing search types that do nothing? ====
  
Just deselect the Compatibility&nbsp;feature when installing. This is available from integration build I20110630-1005 afterwards.<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>  
  
<br>  
+
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<br>  
  
<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>

Latest revision as of 05:21, 30 December 2012

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:

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
ssh://git.eclipse.org/gitroot/e4/org.eclipse.e4.search.git
http://git.eclipse.org/gitroot/e4/org.eclipse.e4.search.git


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

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


Documentation

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

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.