View source for Newsreader/Tutorials/How to hook your eclipse project newsgroup to salvo

= How to hook your eclipse project newsgroup to salvo  =

== 1.Introduction  ==

This tutorial explains how you can hook your eclipse project/product newsgroup to salvo.<br>By hooking your project newsgroup with Salvo, Salvo will able to automatically figure out and suggests newsgroups to your project/product users where they can post their questions.<br> 

<br> 

== 2.Procedure  ==
<div>2.1 First add an org.eclipse.ecf.salvo.newsgroupProvider extension to your plug-in.</div><div><br></div><div>[[Image:Salvo-tutorial1-1.png]]</div><div></div><div></div><div></div><div></div><div><div><br></div> 
2.2 Now right click the added extension and add a newsgroup. 

<br> 
</div><div></div><div></div><div></div><div>[[Image:Salvo-tutorial1-2.png]]</div><div></div><div></div><div></div><div>Depending on your requirement you may add multiple newsgroups.<br></div><div></div><div></div><div><div><br></div>2.3 Define the newsgroup name and the description.</div><div></div><div></div><div></div>

<div>[[Image:Salvo-tutorial1-3.png]]</div><div></div><div></div><div></div><div><div><br></div>2.4 Create a class which provides newsgroup information.<br></div><div></div><div></div><div>A newsgroup provider must implement the org.eclipse.ecf.salvo.ui.external.provider.INewsgroupProvider interface.<br>To create a new class which implements the INewsgroupProvider interface, click on the “class” link.<br>The following dialog will appear when you click on the “class” link. </div><div></div><div></div><div></div>

<div>[[Image:Salvo-tutorial1-4.png]]<br></div><div></div><div></div><div></div><div>Set class name and the package and then click finish.<br> When you click finish, you will see the generated class which implements the INewsgroupProvider interface.<br><br>[[Image:Salvo-tutorial1-5.png]]</div><div></div><div>
<br> 2.5 Define newsgroup information.<br> 

In here you have to define the information of your newsgroup. <br>Please see the org.eclipse.ecf.salvo.ui.external.provider.INewsgroupProvider interface for more information.<br>Now first part of the process is completed. 

<br> 

2.6 Define when to enable your newsgroup. <br> 

Under the enablement section, using eclipse [http://wiki.eclipse.org/Platform_Expression_Framework core expressions] you can define the conditions that should satisfy to enable your newsgroup.<br>Following is a sample enablement definition.<br> 

<br> 
</div><div>[[Image:Salvo-tutorial1-6.png]]</div><div></div><div></div><div>Here the newsgroup is enabled when, <br>'''''org.eclipse.ecf.salvo.application.perspective perspective''''' is active or '''''org.eclipse.ecf.salvo.ui.internal.views.messageView''''' part is active or '''''org.eclipse.ecf.salvo.ui.articlepanel''''' editor is active.<br></div><div></div>

<div>[[Image:Salvo-tutorial1-7.png]]</div><div></div><div></div><div><br><br>Following is the plugin.xml configuration for the above extension.</div><div></div><div></div>

<div>[[Image:Salvo-tutorial1-8.png]]</div><div></div><div><br></div><div>Now the extension point definition is completed.<br></div><div></div><div></div> 


== 3.Test your extension point  ==
<div>When the user executes the Ask a question wizard, Salvo will automatically suggest your newsgroup to him/her, if the predefined conditions are satisfied at that moment.</div><div></div><div><br>[[Image:Salvo-tutorial1-9.png]]<br></div><div></div><div></div>