platform-ui-home/rcp-proposal/rich_client_platform_facilities.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.19 - (download) (as text) (annotate)
Thu Jun 24 04:25:00 2004 UTC (5 years, 5 months ago) by nick
Branch: MAIN
Changes since 1.18: +36 -8 lines 
Added browser example, and improved instructions on running the browser example

<html>

<head>
<meta http-equiv="Content-Language" content="en-us">
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<meta name="GENERATOR" content="Microsoft FrontPage 4.0">
<meta name="ProgId" content="FrontPage.Editor.Document">
<link rel="stylesheet" href="http://dev.eclipse.org/default_style.css" type="text/css">
<title>Rich Client Platform Facilities</title>
</head>

<body>

<h1>Eclipse Rich Client Platform UI</h1>
<p>The rich client platform (RCP) is a major theme for Eclipse 3.0. This is the
main plan item:</p>
<blockquote>
  <p><b>Enable Eclipse to be used as a rich client platform.</b> Eclipse was
  designed as a universal tool integration platform. However, many facets and
  components of Eclipse are not particularly specific to IDEs and would make
  equal sense in non-IDE applications (e.g., window-based GUI, plug-ins, help
  system, update manager). The Eclipse Platform should factor out and segregate
  IDE-specific facilities (e.g., everything having to do with workspace
  resources) so that a subset of it can be used as a rich client platform for
  building applications. [Platform Core, Platform UI, Platform Update] [Theme:
  Rich client platform] (<a href="http://bugs.eclipse.org/bugs/show_bug.cgi?id=36967">36967</a>)</p>
</blockquote>
<p>Additional plan items cover other important issues such as adding and
removing plug-ins dynamically.</p>
<p>Note: The following documents are under active development and are being
updated by the Eclipse team on an ongoing basis to reflect the latest thinking.
The goal is to carve a UI for the rich client platform out of the Eclipse
Platform UI. By the nature of this kind of work, it's difficult to plan
everything in advance of actually doing the work; so we're not even going to
try. Instead, we are revising these documents as we incrementally make our way
towards a satisfactory solution:</p>
<ul>
  <li><a href="generic_workbench_summary.html">Executive Summary of the Eclipse
    Rich Client Platform UI</a> (includes excerpts from the documents below)</li>
</ul>
These changes are covered in the <a href="http://dev.eclipse.org/viewcvs/index.cgi/~checkout~/org.eclipse.platform.doc.isv/porting/eclipse_3_0_porting_guide.html">Eclipse
3.0 Porting Guide</a>. The original porting for the generic workbench is <a href="generic_workbench_porting_guide.html">here</a>.
<h4>FAQs</h4>
<ul>
  <li><a href="faq.html">Rich Client Platform FAQ</a></li>
</ul>
<h4>Articles</h4>
<ul>
  <li><a href="http://dev.eclipse.org/viewcvs/index.cgi/%7echeckout%7e/org.eclipse.ui.tutorials.rcp.part1/html/tutorial1.html">Rich Client Platform Tutorial - Part 1</a></li>
  <li><a href="http://dev.eclipse.org/viewcvs/index.cgi/%7echeckout%7e/org.eclipse.ui.tutorials.rcp.part2/html/tutorial2.html">Rich Client Platform Tutorial - Part 2</a></li>
  <li><a href="http://dev.eclipse.org/viewcvs/index.cgi/%7echeckout%7e/org.eclipse.ui.tutorials.rcp.part3/html/tutorial3.html">Rich Client Platform Tutorial - Part 3</a></li>
</ul>
<h4>Design documents</h4>
<ul>
  <li><a href="generic_workbench_direction.html">Statement of Direction for the
    Eclipse Rich Client Platform UI</a></li>
  <li><a href="generic_workbench_approach.html">Eclipse Rich Client Platform UI
    - Proposed Approach</a></li>
  <li><a href="generic_workbench_overview.html">Overview of the Generic
    Workbench</a></li>
  <li><a href="generic_workbench_structure.html">Generic Workbench Plug-in
    Structure</a></li>
</ul>
<h4>Browser Example</h4>
  The RCP Browser Example is an example of a simple RCP app.
  <p>
  To load the browser example source into your workspace, load project <a href="http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/org.eclipse.ui.examples.rcp.browser">org.eclipse.ui.examples.rcp.browser</a> from the Eclipse CVS repository.
  <br>
  Click <a href="http://dev.eclipse.org/cvshowto.html">here</a> for instructions on using CVS with Eclipse.
  <p>
  For instructions on running the example, see the 
  <a href="http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/org.eclipse.ui.examples.rcp.browser/readme.html">readme file</a>.
  <p>
  To run the example in binary form (last updated June 11, 2004 for the 3.0 RC2 build):
  <ol>
    <li>Download the RCP Runtime build from the <a href="http://eclipse.org/downloads/index.php">Downloads</a> page, and extract it to a folder such as <em>c:\browser-example</em>.
    <li>Download the <a href="org.eclipse.ui.examples.rcp.browser_3.0.0.zip">browser plugin zip</a> and extract it to the eclipse/plugins subfolder.
    <li>Replace the eclipse/configuration/config.ini file with the appropriate config file from the browser plugin.  For example, on Windows,
	    copy eclipse/plugins/org.eclipse.ui.examples.rcp.browser_3.0.0/config_win32.ini to eclipse/configuration/config.ini .
    <li>Run: <code>eclipse.exe</code>.
  </ol>
  </p>
<h4>Text Editor Example</h4>
  The RCP Text Editor Example is an example of a simple RCP app that makes use of the text editing infrastructure (an optional RCP component).
  <br>
  Click <a href="examples/texteditor/rcp_texteditor_ex.html">here</a> for the documentation for the example.
  <p>
  To load the text editor example source into your workspace:
  <ol>
  <li> Click <a href="examples/texteditor/org.eclipse.ui.workbench.rcp.texteditor.zip">here</a> to download a zip file containing the source
  for the example.
  <li>Extract the zip to your Eclipse SDK workspace directory (your host workspace).
  <li>Choose File > Import > Existing Project Into Workspace.
  <li>Use the Browse button to select the <b>org.eclipse.ui.workbench.rcp.texteditor</b> directory extracted above.
  <li>Press Finish.
  </ol>
  To run the example:
  <ol>
  <li>Choose Run > Debug...
  <li>Under Run-time Workbench, there should be two new configurations: RCP Text Editor (gtk) and RCP Text Editor (win32).
  <li>Edit the appropriate one as follows:
    <ul>
	<li>on the Arguments tab, change the workspace location to some directory with write access (different than your host workspace, and different than the workspace used for other launch configs);
	<li>in the Program to Run group, ensure that the application <b>org.eclipse.ui.workbench.rcp.texteditor.application</b> is selected;
	<li>on the Plug-ins tab, press Deselect All, check org.eclipse.ui.workbench.rcp.texteditor, press Add Required Plug-ins, and also check org.eclipse.update.configurator.
	</ul>
  <li>Press Debug.
  <li>When the RCP Text Editor Example window opens, use File > Open to open a plain text, .xml, or .html file.
  </ol>
	   
  <p>
  </p>
</body>

</html>