rich client platform part3.mht

Rich Client Tutorial

you can=20
give your users a searchable help system with no coding on your part. =
First, you=20
add an extension to your plug-in manifest like this: </P><PRE>	=
&lt;extension
	      point=3D"org.eclipse.help.toc"&gt;
	   &lt;toc
	         file=3D"book.xml"
	         primary=3D"true"&gt;
	   &lt;/toc&gt;
	&lt;/extension&gt;
</PRE>
<P>Then you create a table of contents file (book.xml in this example) =
to define=20
a hierarchy of help topics. Not all the topics have to be in the =
contents but it=20
is good practice to do so. Here's an example you can use to get started: =
</P><PRE>	&lt;toc label=3D"RCP Help Sample"  =
topic=3D"html/book.html"&gt;
	   &lt;topic label=3D"Overview" href=3D"html/overview.html"/&gt;
	&lt;/toc&gt;
</PRE>
<P>See the references section for more information on writing and =
organizing=20
help files, including internationalization. </P>
<P>When you're debugging or deploying an RCP application that includes =
help=20
you'll need to include several more help related plug-ins in addition to =
those=20
listed in part 1 of the tutorial. Here's the current list (subject to =
change in=20
future versions): </P>
<UL>
  <LI><CODE>org.apache.ant</CODE>=20
  <LI><CODE>org.apache.lucene</CODE>=20
  <LI><CODE>org.eclipse.help.appserver</CODE>=20
  <LI><CODE>org.eclipse.help.base</CODE>=20
  <LI><CODE>org.eclipse.help.ui</CODE>=20
  <LI><CODE>org.eclipse.help.webapp</CODE>=20
  <LI><CODE>org.eclipse.tomcat</CODE> </LI></UL>
<P>See <CODE>createHelpMenu()</CODE> in the example for code to add the =
Help=20
Contents action to your Help menu. When you select it, this action will =
fire up=20
a help browser like the one shown in figure 2. </P><IMG=20
src=3D"http://eclipse.org/articles/Article-RCP-3/images/help.png">=20
<P><B>Figure 2. The Rich Client Platform provides a full featured online =
help=20
framework so you don't have to. All you do is provide the content. =
</B></P>
<H2>Build.properties</H2>
<P>As you add more resources to your plug-in such as html files, icons, =
the help=20
table of contents, and so forth, don't forget to update your =
build.properties=20
file to include all the files and/or directories that need to be =
available to=20
the plug-in at run time. Here is the updated build.properties XML file=20
containing everything needed for the example in this section: =
</P><PRE>bin.includes =3D plugin.xml,\
               *.jar,\
               part3.jar,\
               plugin.properties,\
               <B>book.xml,\</B>
               <B>html/,\</B>
               <B>icons/</B>
source.part3.jar =3D src/
</PRE>
<H2>Conclusion</H2>
<P>In this part of the tutorial, we added a simple view, some menus, and =
help=20
files to a create a sample RCP application. Hopefully you can can use =
this=20
example as a reference in your own projects. All the sample code for =
this part=20
may be viewed at the <A=20
href=3D"http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.ui.tutorials=
.rcp.part3">Eclipse=20
project here</A>. You can use <A=20
href=3D"http://dev.eclipse.org/cvshowto.html">Eclipse's built-in CVS =
client</A> to=20
download the source to your workspace. </P>
<P>Congratulations! If you made it this far, you are well on your way to =

developing your own Rich Client Platform applications. Take a look at =
the=20
references below for more information and community sites and mailing =
lists=20
where you can meet other people using RCP. </P>
<H2>References</H2>
<P><A =
href=3D"http://eclipse.org/articles/Article-RCP-1/tutorial1.html">RCP=20
Tutorial Part 1</A><BR><A=20
href=3D"http://eclipse.org/articles/Article-RCP-2/tutorial2.html">RCP =
Tutorial=20
Part 2</A><BR><A=20
href=3D"http://dev.eclipse.org/viewcvs/index.cgi/~checkout~/platform-ui-h=
ome/rcp/index.html">Eclipse=20
Rich Client Platform</A><BR><A=20
href=3D"http://eclipse.org/articles/viewArticle/ViewArticle2.html">Creati=
ng an=20
Eclipse View</A><BR><A=20
href=3D"http://eclipse.org/articles/Online%20Help/help1.htm">Contributing=
 a Little=20
Help</A><BR><A href=3D"http://www.eclipsepowered.org/" =
target=3D_blank>Eclipse=20
Powered (rich client plug-ins and resources)</A><BR></P>
<P><SMALL>IBM is trademark of International Business Machines =
Corporation in the=20
United States, other countries, or both.</SMALL></P>
<P><SMALL>Java and all Java-based trademarks and logos are trademarks or =

registered trademarks of Sun Microsystems, Inc. in the United States, =
other=20
countries, or both.</SMALL></P>
<P><SMALL>Microsoft and Windows are trademarks of Microsoft Corporation =
in the=20
United States, other countries, or both.</SMALL></P>
<P><SMALL>Other company, product, and service names may be trademarks or =
service=20
marks of others.</SMALL></P></BODY></HTML>

------=_NextPart_000_0011_01C579EC.52DCC510
Content-Type: image/jpeg
Content-Transfer-Encoding: base64
Content-Location: http://eclipse.org/articles/Article-RCP-3/images/Idea.jpg

/9j/4AAQSkZJRgABAQECWAJYAAD/2wBDAAIBAQEBAQIBAQECAgICAgQDAgICAgUEBAMEBgUGBgYF
BgYGBwkIBgcJBwYGCAsICQoKCgoKBggLDAsKDAkKCgr/2wBDAQICAgICAgUDAwUKBwYHCgoKCgoK
CgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgr/wgARCABWAHgDASIA
AhEBAxEB/8QAHQAAAgIDAQEBAAAAAAAAAAAAAAgGBwMEBQIJAf/EABwBAAEFAQEBAAAAAAAAAAAA
AAQAAgMFBgcBCP/aAAwDAQACEAMQAAABd3Sk1bVUne81nyrGO3MVPaZMdycejIkexjuMs0yUt2sK
uDH58oAMHAEtVQ29WVjKE68R63f8WxF7xuwvn7WV2qTvrieMtc8rOw+kg3ox6zsxx/VgBowAlr0N
fdV1MqU73M9fSGCaa/vn27XF9D1VNYhHYn8eaQec9EAvRn1Zabj2sALAYASxwyZQ2gJRboybtdpy
kBtXzt5izoqONDgpbVdp1ceKcTUalcWOzxgBYwACSyVi60WGBTjrXvAbOgj/AIw6xEfntSLMwrFP
qygskTlSP5+ppS637qHxhexObIh4zyYAFNAEvzADFo4gi9wc8PFoccKSSN9wI/ZkBcR//8QAKBAA
AQQDAAECBQUAAAAAAAAAAwIEBQYAAQcgERIIExQWIhAVMTI2/9oACAEBAAEFAn1iAyJq1HXhLDYf
X96ti8+vum8W4uStkXZ1aI3m94dgUujwMfvKGUMTdPBe8svR69WJA3aq1ra+ztlYvrMibDdFuC0v
r9ftY6vt2Vjq1WlznLnr1zYoD8OheC87+H6eyN3AiKQtt7qBTESuBgY5uOcp8TICuFfcw7tSEqzm
H42eG37b/wCBP5+IZvrcIjetZHK9T85Uj7Zx1vXp14afnOPZpfMHKV2qNVv798DZ3Fl9ZRRoVtDZ
RBE5pcQNQIcIIl88E3F0SzjlXJdj0vme0/ebNXpdvA39eisdSVRbtC7ZDaKTuHIcbikPEv69fpVn
Fw9hk/c6CQRsoZgjtTX/AGPgTX4S4knRHGINGlLUpHyRr56RMlLW/ThtdXahGVHw5nIKpWpJlOt1
els8FkGnJNw30RdBnnE235VPFxHKij0KgQLfNVmph0KvVgJNFXntdqyIrLw8x4dCYykLLSd4gHDd
Dzispgq3yR3qPpkUkthqV5Yu4PfW9yzq+przpj2bkphR/XeOPh6udNFgHLd0P9X0RHyWOqHHFyU4
+we7e8Hi/V1xIIto5u/YqrcUKJPKBK5sDlg9dJkKu5Or4lg19NdBLDjSx3ZOjxGcj6pdZyjQNpJL
p8N61vFtGxMLBxRsRXoceiVWDJhaRDLxxQ2WH52AmO+UxBsieeDG1iquqOV//8QALxEAAQQAAwYC
CwEAAAAAAAAAAQACAwQFERIGEBMhMWEjoRQVICIyM0FCcYGR8P/aAAgBAwEBPwHw2t1OOQXpWHN6
vRxLDG9166w9v2lQYxWmmDGs6qyAJN9xmui9alTgihrNIHVYjXidDxMuapM02mHuFZ+Zv066z29k
9jwVhFl0jeC/6LFJObYx06qvIG2GjuFZ+LfAeoTqFt0hyasLpXadsTafNYlUlxKzxT7qjwevG/W5
ynIJ5b7lE2xkJC38J+z+KtPg2j+8kaW1sUelkwP+7KN+08FHm0Okz8kzF9oWHKar/Fly5oMLuiLH
D2NRWoocxuJK/8QAMxEAAQMDAQMJBwUAAAAAAAAAAQIDBAAFEQYQEyESFCIyQVFhcYEjMVJiocHR
JEJDkbH/2gAIAQIBAT8BS7PfkbmOnlHwFIsuqnf4T9BQ0xqQjp9HzUKb0PfHRkuJ/s/ipmjJcCGu
Q44OjUQ8Dt029zbVTXiSKW2PfV2fdvVze36zhCikJzwGOFaTuM223kQgsqbWDwPYRV7e3lnfSfhN
QuptQ7za/sufMmkOpUitb2RVunJmRDjeHpDx760LbVuy3pj/ABUnoj71dGFLtbx+U/5UHt9Pvtuo
/UIUmm9SWZuMgrdGcedalv8AZLvbjGCznhg47vPFWbUDVlh7lCContPD81L1pPkMKaCEgEY76gEE
qx4ffaytyGsndBfH1pN6gY9syU01N0+6rKjjzp2Pp1+V1wE4+tCx2IjLb49cGmOUUe8U69uRldCZ
G+LaptC+sKMWOT1a5pHP7ak+ye5KaQpSyAaYix1IyU1//8QARRAAAQIEAgEPBwsEAwAAAAAAAQID
AAQFERIhBhMUICIjMUFRYXFygZGxwSQyQlNzgrIHFTNSYpKhorPR4RAWQ2Nk4vD/2gAIAQEABj8C
UymmzzyknPUJNR/Hejc9FKryXbbHeuPJtDnbcb042nuvGWjkojp1G/ciPMpaOtxX7RnVqc2PsySz
3riytKUJ9lIp8SYu9ptUFdBDSe5MWe0kqy+aeKfhgl16ecv62ecV4wmnSiVoamZNwrRqhIKgpFjn
yE7L5qqbr+rlsLCGmb7XnizcpOqPs0jxjcaC6elMAeEWk6A3775PhF2aVKI50qPjH0rKOjKiNvXH
E9FtI8I3bSCbPM8R3Q8ibnHXbyarao4Twpin8rLw+DYmKZUE5arLLbUeir/tG6CEJRbljX8xcNDg
HpRqbck2B0YKdbJbVwLQmFsvM+ad8RkrqjnlXIpvKl0fDsTFPnsP0U9hv0k/xFxCcoYI39ti7f6p
N99kX7THncMIbO/rZ3r2sUi3rXL/AHdj1Q+vEBrd5t3Pnt4wCADlwKEY8HDxRrCdXZCjtVfVMXSq
996FzDqtqhN1GFqBtwITxCLwxh9U9+mqKSf97g/Idj1xUpE+nKLtzjPwhtWone4ItjUnqgDXNs4Y
UXApSBgV1fxDrb8yhLj4wstlW2XzQrc758cYlNKtEoGxa6lC3umKSeKaV+mrYmHJZYyWkpPXBlko
uW3FJg6om3HFwow4yVX8myGKxyP8xqql4ltqVe6ySB1xjct2xil5V03PopiVn3ZRxKEObZShyRSz
/wAw/pr2OFbiRzmL65b4PTET+tJKzKptZaWXAAQTF3JhpHvXjyurH3Gou8+84enaCPmxtXHizjVJ
WhsYuC6P3jChrDxRtiBzZxK1BbTq9SdxJ2thvW8djPVGVojdXmZqabeYMw5ky2EganhO+N/thKNL
Pkrblyg5uCnINu0WjdJFuX55Ip+Ax5FpGlo/Zn3m+9cJEh8o1QQzwiXruLLmUISrQvS2Yn2cO21/
qJN+TKG5Cp01otqSslwtC2SSd8HkgU7SfRKbKzKtPB2QVfzk3sQre7YDU/T6jLEeulbn8pMBpFdY
bw8Eywpv4hCGzpNT28Y3MKm0DFzZwHpV9DiTvKQq42F5uXCjxwdbvLRyHOMb1Nk3zxrZF4JTRXEe
yfPjF2HZxrppCo3GpKUOJQKf3hb88pwqMuptGprvYqFr8HBeJmsyDjzSVoS22kOegkWHJF3FpVyP
MIV4Rg/t+SdxG19b4O4xQaTSNH1zbreNcwZMKGAABOZsf/CLyK6lJG/+Kb3vwEBNN+UyrhKfNTML
x95MS1brlepU08pTgKZgai4uyrA5ZfhAD9MUg/XZVjb+9scxG3l0H3Y28ijsiyZFHZGcmOqNpjT7
0XamVpjN9Cum1G702nue0lEnwhLEu4ywhAshtluyUjkjEai4eQR//8QAJhABAAIBAgUFAQEBAAAA
AAAAAQARITFBIFFhcYGRobHB4fDR8f/aAAgBAQABPyGmhoBPZAvDLm1jK99CMzX/AC1SUuq20jbt
PsNSOyCMnmLC27mrtI6UZug4pyn8WEK3dN96yp4gW3kTkD54V1ObBFkEcy06DZjzrp8yVGqvX4pR
+hXT64TvIcfaIH+mbjyf0XiLs6d9Kgp5YrUzZYsP97h4I5MQ7bmBkI1g5xFWDkDVmN0Qo1cjlB9O
cr7y9QmAK7m8IF4VNmNYL3WGUUDQexLzf7f64TXaGOgW3QFmwT2iUs7JUUy8l/qopUTgd44tH0SA
S57pSnok6jC1tR7P3XDQR5qV2gRVaXzctzlX3DQWNUDQXnynRgw4GQ6yqk6psRuQxyjz93zHCLzB
NpScQ/oR+XDoNQbl2uxr7iGlLrbvSBMZpc4dBVyy969HI6PhE69KWb01aLV2mR0aUi4cAdM7zaTa
cziu7XC27pZlpg35gp+ZY4MOykbcdw1qbDlJBFJQys2KR3S8KytIOVXWY1yr3gNeLXT4luf1HQo+
4SXI4TNJTQCUjciD9pXwircRM6Zi3qI/aW4HM/2jYGOr9EDN/dbw2GM5EIKZOQCvEUiS72jMWPwV
V/RcJISAGz84sTe3SX9ADPY43ZmvS9A9OZTQxbnqS0ftXHQ8fWZAqOh5FqO9QGmAg5etaeYZraGm
W3O7tEurlsOtzFFCVVvIj6zC0bWqhwcsJCwtY7eTgqBgo3wxWHSSr4GCK99ZnVm7r+BJML3sJ7B8
wPWNV8IZxUyKrdCXOZ4sNEWBXKo5cVu/3QCa2b6XzQo6x6K1PbaVbdDDcfyxq8TG1YAJ0qdHmHBN
YIbqHG0Lu3ah8cItE9ye5wJ8EZeVDrcaDu+oph2IXjAaOYW5/GBhDR1n7CKPxikbAAII6v6J/9oA
DAMBAAIAAwAAABDKHHiSgAChnqQigADU/wCDHIAA6PYRkpAA6ox1U5GBAAB/dhi//8QAJBEBAAIB
AgYCAwAAAAAAAAAAAQARMSFBEFFhcaGxgcHh8PH/2gAIAQMBAT8QcZG6xLZPa31MIvYMvUN8fmUP
7ULWnuaROLVtgfMWFQAigVS87fECEgS63uUP+jPVxefFREaaMcnYLHerx50ig1Ut12Ibj+hFZenE
gTeE7VbWPuFoaWJyJ0vvNEoAKz5ag+yjZivuH1ccTfWqiXq4ci+n3HWtMpT5BXxLASwsBp1Xf3BC
Otr9QSXQ0Wco9WqJUnEUxKd51YtRmMQzmf/EACURAQABAwMFAAIDAAAAAAAAAAERACExUXGxEEGB
ocFh0ZHh8P/aAAgBAgEBPxCXh7xIxtehYB3OSKPRJaDho1/KXCpOuEoCz5YqZ+zD6j51uix4BEDi
kDPFWtppAO6DKxMtRjQEXMtOBJkxUYYcvhrI7fesk2BPEk/aPK2SogqNC1kg0kGfzTgzsMAIMPyy
E6G9MjH3VY7eXUhdk01H+6DCgkJQwaTT3qUDYUPdljzSRGSwXwHDWnzuUqoSNTipATB1HCaSOjsX
zBbDSobFY9xR3YAp5s80pDvMUy0zh9UzTe0vQ39VAwxeIEtL/sVBlZYsz+qWSg364JdwakCeOKTR
6KcNCayburrSkyLUZSz3n91//8QAJRABAQACAQQBBQEBAQAAAAAAAREAITFBUWFxgSCRobHB8NHh
/9oACAEBAAE/EFkMaMSxrvlDTvJSLQf9+PkyHgORn+DnAKNH/wBcfX5xWTnZZ8yF9TES0/SgA/Ji
m0ym8v2txSJExHbWp4VxYwVS8+ww8CB064hpEJtXTYfWBbXIWkIBUjJaBPokU1D5FMCkALotDykg
qTZhjNwVe12h8OSkWihO6Req4EhqGUeNfvuOACUSTuUH4w9n3kz5t98UIVhEToTfziIWdJTtFWDQ
HNqoGBglNxe+BI57Xm/n0nqYs+S/txDgW9oT5BffCxepSFFh3ias/WElBYmwlla8MfWJR/QCIbk0
NKm9gdUAAIdhPKFflcBy/aVGIAG8jGcJjuDOsUCFNiRLEsQRMqD8dM3xHn2YysKyO0rPxgjrbI6a
R/P6boefmbP4Y+xOiqlPSn5DGigChpfG8IeshefPHrHdBNOeY4ONiOQCDWnh7TArsI6oR9xnxk2m
RtEeaPTfXHwB4NBI+SXF/UvsiG/sE8/SYDYL6if3ADixiRqoGm1ek65Vuk6OJwlu81cIwkJ5CJgx
lsWKAxKAG+iVIqC4ohIEo3hJkXNQkBVQLUDg5xgxFZWM01VU7MChcB7xu2O9vnWWL1UICwXuoazz
VzO6z/en0kqqR9xMT1Dzn+XXzh1gJloabmgVxKFZtkXpT3+cRDGJ6ASBzrrjQ9nFCB6jT3yI9cPE
hEsU1hEBAV5BIRMlo/fTJcqUnDRzsPZcuZca63E5564wb2WuaU5+fj6bSCiL43ipLRbXI9n5Yi9I
XQ7i8EHC/UAAlCyccw9YdwSkm16cMTWQu2TgbvGjTEFjNO6picIErQAu+OBhE1TwX4uCA0K63BOH
Tvj0jmRc3d1GgXOYw5kl/wCX0nrRxZOLF4yIVbEuhsafeFYzdGotYBZ3wYPSoNeII/fBsIawnfbf
1lTFkp7MCT74wY66Ocou34u8UCNJCdQaM9YcC0DKE0WAdmesRB6MSXpQrOnHnFFQb2ielYcLNjFD
6Wcpf5lG4xIa91VD4CcSCUJsHguJusupXyAnhMHMuHwbCHqTBOQxvMZp3Hsx0KLupI5slFDGRTeR
aZ9WaMCESug1HA7A5CzIG2Ua0QmykamS8rQ89L4xbYHarqScsU5cErxtICC7DXcwCFhUvCKifQ/0
DzJ2pjxSohHtvH0oPAVJ3PXC13U4fCx2Aniaxu46C/Sue0+ccVF1Y6FEvuHpwFv/AB4ziFIKkEY5
Gi5mwJRBWo1VK48pq8LeGfvcengQUgE6FqgAFUwFMTiCUlcGxvCKgLgkE11inZR6UwNVEKvBZo1J
0mOvP7PhKEEAwea5ED413Xgev9fTLVtlDCpB/wANYNH90Bc7JAp/eXVV6r+mKmvxZmAIyCJbxd4z
FBiydm2msIXUCgdtudGCbQQQ+ADDQIlpTtHP/9k=

------=_NextPart_000_0011_01C579EC.52DCC510
Content-Type: image/gif
Content-Transfer-Encoding: base64
Content-Location: http://eclipse.org/articles/Article-RCP-3/images/tip.gif

R0lGODlhPgANANX/AP////m0TPiJAPq8V/nHefnBbv/9+vq/df39/fvDf/m/av/8+PzeufqzXPme
L/m+Zvb17/vJi/348f317PrBevm8YPnuzviREfziwfiUGfvPmfmkO/vXqvmiN/m6XPntyviNCPiT
Ffq9cvi4VPq7bfm1TfnOh/zkxfvRnfvZrvmcKvm2UP3htvq/dv37+fvFgv3z6Pq5afm2Tvm4Vf7v
1fq3Ufq+XP/57fq7VfzJav/++/mmP/vBXvnbpf/65gAAACwAAAAAPgANAEAGu8CAUCgoGo/IpHLJ
NAYGBIB0OiQaGaeMAJFIIFCbFELVLDerwhULgDZ6EYxtFxGRTCjmvBIdqFjYVU07CXqFezw9PlNS
bUYHB0VchpNIVQoLVIFXcXJeIAIhCCKUeXxCI41LXqSTATVCNjeZQ6y1e0IFBoupAgycDQ62hmgP
EIyaAhcYGFpcXhobHAgdwkumHh+8vpFzn6Ek1bdoJSa8LS5xzggvEjAx4XsyQzM0x7RMq/BMATgB
OTqLggAAOw==