platform-update-home/doc/working/documentation/user guide.html
Parent Directory
| 
Revision Log
Revision 1.4 -
(download)
(as text)
(annotate)
Thu Apr 25 12:12:53 2002 UTC (7 years, 7 months ago) by celek
Branch: MAIN
Changes since 1.3: +2955 -1715 lines
Thu Apr 25 12:12:53 2002 UTC (7 years, 7 months ago) by celek
Branch: MAIN
Changes since 1.3: +2955 -1715 lines
*** empty log message ***
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns="http://www.w3.org/TR/REC-html40"> <head> <meta http-equiv="Content-Type" content="text/html; charset=windows-1252"> <meta name="ProgId" content="Word.Document"> <meta name="Generator" content="Microsoft Word 9"> <meta name="Originator" content="Microsoft Word 9"> <link rel="File-List" href="./user%20guide%20structure_files/filelist.xml"> <!--[if gte mso 9]><xml> <o:DocumentProperties> <o:Author>Labuser</o:Author> <o:LastAuthor>Labuser</o:LastAuthor> <o:Revision>3</o:Revision> <o:TotalTime>23</o:TotalTime> <o:Created>2002-04-12T13:24:00Z</o:Created> <o:LastSaved>2002-04-13T17:21:00Z</o:LastSaved> <o:Pages>12</o:Pages> <o:Words>3593</o:Words> <o:Characters>20485</o:Characters> <o:Company>IBM Canada Ltd.</o:Company> <o:Lines>170</o:Lines> <o:Paragraphs>40</o:Paragraphs> <o:CharactersWithSpaces>25157</o:CharactersWithSpaces> <o:Version>9.2720</o:Version> </o:DocumentProperties> </xml><![endif]--><!--[if gte mso 9]><xml> <w:WordDocument> <w:View>Normal</w:View> </w:WordDocument> </xml><![endif]--> <style> <!-- /* Style Definitions */ p.MsoNormal, li.MsoNormal, div.MsoNormal {mso-style-parent:""; margin:0in; margin-bottom:.0001pt; mso-pagination:widow-orphan; font-size:12.0pt; font-family:"Times New Roman"; mso-fareast-font-family:"Times New Roman"; mso-bidi-font-family:"Times New Roman";} a:link, span.MsoHyperlink {color:blue; text-decoration:underline; text-underline:single;} a:visited, span.MsoHyperlinkFollowed {color:blue; text-decoration:underline; text-underline:single;} @page Section1 {size:8.5in 11.0in; margin:1.0in 1.25in 1.0in 1.25in; mso-header-margin:.5in; mso-footer-margin:.5in; mso-paper-source:0;} div.Section1 {page:Section1;} --> </style> <!--[if gte mso 9]><xml> <o:shapedefaults v:ext="edit" spidmax="1026"/> </xml><![endif]--><!--[if gte mso 9]><xml> <o:shapelayout v:ext="edit"> <o:idmap v:ext="edit" data="1"/> </o:shapelayout></xml><![endif]--> </head> <body lang="EN-US" link="blue" vlink="blue" style="tab-interval:.5in"> <div class="Section1"> <h1> </h1> <div align="Center"> <h1>Install/Update User Guide</h1> </div> <p class="MsoNormal"><!--[if !supportEmptyParas]--> <!--[endif]--><o:p></o:p></p> <h2>Getting Started: Install/Update in three steps</h2> <blockquote> This section will teach you how to install a new Feature and how to revert to a previous state in three easy steps. Before you start, make sure you installed the 'mockup' site following the <a href="http://www.eclipse.org"> install mockup site</a> instructions.</blockquote> <h3>Find new Feature</h3> <blockquote>This section will focus on finding a feature to install. There are different ways of finding a feature. The one we are going to focus in this section is <a href="http://www.eclipse.org">browsing a site</a> . For more information about other ways of finding a feature, look at the <a href="http://www.eclipse.org">Find Features</a> section.<br> </blockquote> <blockquote>Before browsing a site, we will have to create a site bookmark to access it.<br> </blockquote> <p class="MsoNormal"></p> <h4>Create a new site bookmark</h4> <p class="MsoNormal"></p> <ul> <li>Open the Install/Update perspective (TODO: menu path + key)</li> <li>Select the Updates View.</li> <li>Open the context menu </li> <li>Select new->site bookmark...</li> <li>In the Site Name entry field type: Test Site</li> <li>In the Site Address entry field type the URL where you installed the mockup site. (i.e. file:c:/eclipse/site)</li> <li>Click Ok </li> </ul> <blockquote> The Site should appear on the view. The provider of a feature should give you the URL of their site so you can find their feature. We will now browse the site to discover the features.<br> </blockquote> <h4> Choose Feature</h4> <blockquote>You can expand the site and the categories to see the Features. In this site you should see one category: Red Dot Versions, and two features: Red Dot Feature 1.0.0 and Red Dot Feature 2.0.0. <br> <ul> <li>Select Red Dot Feature 1.0.0</li> </ul> </blockquote> <blockquote>The Preview page should now look like the following picture:<br> </blockquote> <div align="Center"> <img src="images/pic001.gif" alt="PIC001.gif Preview Page of Red Dot 1.0.0" width="678" height="518"> <br> </div> <blockquote>You may want to check the license and copyright or decide to have more information about the Feature you are about to install. 'Click' on the appropriate link at the bottom of the view to automatically open a browser that will show you the desired page.<br> </blockquote> <blockquote><TIP the preference page lets you decide if you want to view the HTML page within the workbench or by launching an external browser><br> </blockquote> <h3> Install Feature</h3> <blockquote>When you are ready to install the feature click on the Install button in the Preview View. This will launch the Install Wizard.<br> </blockquote> <h4>Install Wizard</h4> <p class="MsoNormal"></p> <ul> <li>The first page of the Wizard summarizes the action you are going to take. Click Next.</li> <li>The second page shows the license you have to accept to install the feature. Click next of you accept the presented license otherwise click cancel.</li> <li>The last page of the Wizard presents the list of Site you can install your feature in. You can create a new site from this page. For more information about creating new Site see: <a href="http://www.eclipse.org"> Site Location Tab</a> . You should see only one site and it should point to the path where the workbench is installed. Click Finish.</li> </ul> <blockquote> The feature will then be downloaded, verified and installed in the site. You can see the progress monitor showing you the evolution of theses tasks. During verification, you may be prompted to accept the verification. Click 'Ok' when prompted.<br> </blockquote> <blockquote> When the feature has been installed you will need to restart the workbench for the changes to take effect. Click 'Ok' on the dialog box.<br> </blockquote> <p class="MsoNormal"></p> <h4>Verify the feature has been installed</h4> <blockquote>The feature you installed will add a red button icon to the tool bar when activated. To activate this specific feature customize your perspective and add the Red Dot Set Action Set:<br> </blockquote> <p class="MsoNormal"></p> <ul> <li>Open the menu Window</li> <li>Select Customize Perspective</li> <li>Expand Action Sets</li> <li>Check Red Dot Set</li> <li>Click Ok</li> </ul> <blockquote>You should now se a red button icon on the toolbar. If you click on it the following dialog box should appear, meaning the feature and associated plug-ins have been successfully installed and configured.<br> </blockquote> <blockquote> We will now see how to manage your feature in your configuration.<br> </blockquote> <h3> Configure Environment</h3> <blockquote> A feature that is installed may be configured or unconfigured for your workspace. A configured feature means that Install/Update will 'suggests' that the runtime configures the feature to be available. An unconfigured feature means that Install/Update will make the feature unavailable to the user.<br> </blockquote> <blockquote>When you installed Red Dot Feature 1.0.0, Install/Update installed and configured the feature for you. You can see that in the Configuration History. For more information about Configuration History see <a href="http:/ww.eclipse.org"> Configuration History</a> .<br> </blockquote> <blockquote>A configuration is a list of configured and unconfigured features that determine what tool you can use.<br> The current configuration is the configuration currently active.<br> </blockquote> <blockquote>For more information about configuration, see <a href="http://www.eclipse.org">Configuring/Unconfiguring</a> .<br> </blockquote> <blockquote>In this section we will add the current history configuration to the list of preserved configuration. We will unconfigure Red Dot 1.0.0, so the feature will be unavailable. Then we will restore the preserved configuration, which will re-configure the feature.<br> </blockquote> <h4>Add configuration to preserved</h4> <blockquote>To add the current configuration, we will first need to find it in the list of configurations and then add it to the list of preserved configurations. The current configuration is the configuration in the configuration history folder with an icon with a running person. It is the last configuration in the list.<br> </blockquote> <p class="MsoNormal"></p> <ul> <li>Select the current configuration.</li> <li>Open the context menu.</li> <li>Select Add to preserved.</li> <li>The configuration now appears under the Preserved Configurations folder.</li> </ul> <h4>Rename configuration</h4> <blockquote>We will rename the configuration to give it a meaningfull name.<br> </blockquote> <p class="MsoNormal"></p> <ul> <li>Select the configuration.</li> <li>Open the context menu and click Properties.</li> <li>Change the name of the configuration to: RedDot 1</li> <li>Click Ok.</li> </ul> <h4>Unconfigure Feature</h4> <blockquote>We will now unconfigure the feature.<br> </blockquote> <p class="MsoNormal"></p> <ul> <li>Expand Current Configuration;</li> <li>Expand the site</li> </ul> <blockquote> <div align="Left"><img src="images/pic004.gif" alt="Expand Current Configuration to reveal the configured Feature." width="202" height="118"> <br> </div> </blockquote> <ul> <li>Select Red Dot Feature 1.0.0</li> <li>In the preview view click Unconfigure.</li> <li>When the Dialog opens click Ok.</li> </ul> <p class="MsoNormal"></p> <blockquote>The workspace will shut-down and restart automatically.</blockquote> <p class="MsoNormal"></p> <h4> </h4> <h3>Restore Configuration</h3> <blockquote>We shall now restore the configuration we added to preserve, so the feature will be configured again.<br> </blockquote> <h4>Verify the Feature is not available</h4> <blockquote>You should not see the red button icon in the toolbar, meaning the feature was not activated<br> </blockquote> <p class="MsoNormal"></p> <ul> <li>In the Configuration View, expand Current Configuration.</li> <li>Expand the site.</li> <li>Verify Red Dot Feature 1.0.0 does NOT appear as an icon.</li> <li>Click on the view toolbar button 'show unconfigured features'</li> <li>Verify Red Dot Feature 1.0.0 does appear</li> </ul> <blockquote><img src="images/pic005.gif" alt="Unconfigured feature revealed" width="257" height="117"> </blockquote> <blockquote>The icon <img src="images/unconf_feature_obj.gif" alt="Unconfigured Feature unconf_feature_obj.gif " width="16" height="16"> means the feature is still installed but not available at this time in your workspace. To be able to use the feature we will need to configure the feature.<br> </blockquote> <h4>Revert to preserved configuration</h4> <p class="MsoNormal"> We will now go back to the configuration we had previously in which Red Dot Feature 1.0.0 was configured.</p> <ul> <li>Expand Preserved Configurations</li> <li>Select RedDot 1</li> <li>In the preview view click Restore</li> <li>When the Dialog opens click Ok.</li> </ul> <blockquote>The workspace will shut-down and restart automatically. After the workspace restart, the feature is configured, based on the revert configuration.</blockquote> <blockquote>There are different way of configuring a feature. To know more about configuring and unconfiguring features see: <a href="http://www.eclipse.org"> Configuring/Unconfiguring features</a> .<br> </blockquote> <p class="MsoNormal"> In this section you learnt how to find a feature you want to install, how to install a feature, how to unconfigure a feature and how to restore a preserved configuration. The rest of the book will go into more details.<br> </p> <h2> The User Interface</h2> <blockquote> This section describes in details the User Interface of the Install/Update perspective. The perspective is composed of four different views: The Configuration View to manage the configurations, the Updates View to manage update sites and features as well as searches. The Preview View is used to show the details of the element selected in the previous two views and the Web View, which is used to browse HTML document from either sites or features.</blockquote> <h3>The Configuration View</h3> <blockquote> The configuration view helps you manage your configurations. A configuration is a list of configured and unconfigured features that determine what tool are available fro you to use in your workspace. <br> <img src="images/pic006.gif" alt="Configuration View" width="251" height="251"> <br> </blockquote> <h4> Current Configuration</h4> <blockquote> The current configuration is the configuration currently active. When you expand the Current Configuration you can see the sites you are connected to. Expanding each site reveals the list of Features you have access to. Some feature may be configured, some may be unconfigured. The configured features are the tools the Install/Update suggested the runtime to activate. To know more about configured/Unconfigured features see: <a href="http://www.eclipse.org"> Configured/Unconfigued</a> .<br> </blockquote> <h4> Configuration History</h4> <blockquote> The Configuration History folder contains the last <i>n</i> configurations you used. <i>n</i> is a number you can set in the Install/Update preference page. See: <a href="http://www.eclipse.org">Install/Update Preference Page</a> .<br> </blockquote> <blockquote> You can use the history list to see what are the different activities that occurred as well as restoring an old configuration to make it the current one.<br> </blockquote> <blockquote> Install/Update creates a new configuration history when one or more activities are performed (i.e. install, configure, unconfigure etc...). When the Install/Update creates a new configuration, it will add it to the list. If you already have n configurations, the framework will automatically delete the oldest configuration from the list. To know when the Install/Update creates new configuration history and what are the Activities see: <a href="http://www.eclipse.org"> Configuration History</a> .<br> </blockquote> <h4> Preserved Configuration</h4> <blockquote> The Preserved Configurations folder contains history configurations you want to keep. The framework does not automatically delete the configurations in the Preserved Configurations folder, you have to explicitly delete them.<br> </blockquote> <h4> Configured/Unconfigured</h4> <blockquote> <p class="MsoNormal"> You can decide to see only the configured features or both configured/unconfigured features by clicking the 'Show Unconfigured Features' toggle button in the view tool bar. To know more about configured/unconfigured features see: <a href="http://www.eclipse.org"> Configured/Unconfigued</a> . </p> </blockquote> <h4> Local View Toolbar Actions</h4> <h5> Show Unconfigured Feature</h5> <blockquote> <p class="MsoNormal"> This button allows you to see only the configured features or both configured and unconfigured features. Unconfigured features appear with a red circle around the icon. For more information about configuring/unconfiguring features see: <a href="http://www.eclipse.org">Configuring/Unconfiguring</a> .<br> </p> </blockquote> <h4> Context Actions</h4> <blockquote> This section describes the different context actions available in the Configuration View.<br> </blockquote> <h5> Go Home</h5> <blockquote> This action <TODO be consistent with navigator><br> </blockquote> <h5> Go Back</h5> <blockquote> This action <TODO be consistent with navigator><br> </blockquote> <h5> Go Into</h5> <blockquote> This action <TODO be consistent with navigator><br> </blockquote> <h5> Show Details</h5> <blockquote> This action opens or refreshes the Preview View with the details of the selected element.<br> </blockquote> <h5> Properties</h5> <blockquote> This opens a Dialog box that presents the label of the selected configuration. You are able to change the label of a configuration. Click Ok when you have finished and you want to preserve your changes or click Cancel if you do not want to change the properties.<br> </blockquote> <h5> Add to Preserved</h5> <blockquote> This action adds the selected configuration in the Configuration History folder to the list of preserved configuration.<br> </blockquote> <h5> Remove from Preserved</h5> <blockquote> This action removes the selected configuration from the list of preserved configurations. This action will not delete any Site, Site Bookmark or Feature. This action will not delete the configuration it was created from or any other configuration.<br> </blockquote> <h5> Restore</h5> <blockquote> This action creates a new configuration based on the selected configuration and marks it as current. Install/Update will automatically configure all the features that were configured in the selected configuration you want to restore. To know more about restoring or reverting to a configuration see: <a href="http://www.eclipse.org"> Restore a Configuration/Revert to previous configuration</a> .<br> </blockquote> <h3> The Updates View</h3> <blockquote> The Updates view allows you to manage the remote sites you can install from to search for features as well as features you can install. <br> <img src="images/pic007.gif" alt="Updates View" width="251" height="249"> <br> </blockquote> <h4> My Computer</h4> <blockquote> My Computer lets you browse your computer and any mounted local file to discover any site on your file system. You can also search My Computer to discover sites: see <a href="http://www.eclipse.org">Search the file system</a> .<br> </blockquote> <h4> Places to Visit</h4> <blockquote> Places to visit are sites suggested by the features you installed for you to visit. <br> </blockquote> <p class="MsoNormal"> </p> <h4> Available Updates</h4> <blockquote> Available Updates will let you search for updates of already installed features. The search occurs in the background so you can still use the workbench while searching for updates. To know more about searching: see <a href="http://www.eclipse.org"> Search</a> .<br> </blockquote> <h4> Sites Bookmark</h4> <blockquote> <p class="MsoNormal"> A site is a location that contains features. In the Updates View, the sites contain features you can install. You can browse or search features in Site bookmarks. There are two ways of adding a site bookmark. You can use the context menu and the context action add site bookmarks, or you may browse My Computer and add a site as a site bookmark. See <a href="http://www.eclipse.org"> Context Action</a> for more details. <br> </p> </blockquote> <h4> Search</h4> <blockquote> <p class="MsoNormal"> Search is a bookmark for a specific query that will retrieve features from update sites. You can create a new specific query based on a template or execute the query to fetch the features from the desired update sites. You can also query your local file system. The resulting features appear on the same search preview than the query. To know more about how to create your own query: see <a href="http://www.eclipse.org">Context Action [new->Search]</a> . To know how to search the file system: see <a href="http://www.eclipse.org"> Search the file system</a> . To search for availables updates: see <a href="http://www.eclipse.org"> Update Already Existing Fetaures</a> . To search for new features: see <a href="http://www.eclipse.org">Finding New Features</a> . To know more about the search Preview View: see <a href="http://www.eclipse.org"> Search Preview View</a> .<br> </p> </blockquote> <h4> Folder</h4> <blockquote> <p class="MsoNormal"> Folders are placeholders in the Updates View. They are used to help you categorize and organize the view. Folders can contain folders, update sites and/or searches. You chan change the label of a folder. To know more about how to create a folder see: <a href="http://www.eclipse.org">Context Action [new->folder]</a> .</p> </blockquote> <h4> Local View Toolbar Actions</h4> <blockquote> This section describes the local view toolbar actions of the Updates View.<br> </blockquote> <h5> Show Feature Categories </h5> <blockquote> When this action is selected, you will see the features organized in categories.<br> <img src="images/pic008.gif" alt="Categories" width="253" height="193"> <br> <br> When this action is not selected, you will see all the features as a list.<br> <img src="images/pic008b.gif" alt="No Categories" width="253" height="97"> </blockquote> <h5> Show My Computer Files </h5> <blockquote> When this action is seelcted, you will be able to browse the files when you expand MyComputer.<br> <img src="images/pic009.gif" alt="Browse Files" width="251" height="249"> <br> </blockquote> <h4> Context Actions</h4> <blockquote> This section describes the different context actions available in the Updates View. </blockquote> <h5> New->Site Bookmark...</h5> <blockquote> <p class="MsoNormal"> Creates a new Site bookmark. This opens a Dialog box that presents the properties of the Bookmark Site you want to create. The properties of a Bookmark Site are the label you want to see in the View as well as the Address of the physical site. You have to enter the Site URL. Optionally you can enter the Site Name. If you o not enter a Site Name, it will default to the Site URL. Click Ok when you have finished and you want to preserve your changes or click Cancel if you do not want to create a new Site Bookmark.<br> </p> </blockquote> <h5> New->Folder</h5> <blockquote> This action lets you create a new Folder. When you select this action, a dialog will open.<br> <img src="images/pic011.gif" alt="New Folder Dialog" width="438" height="481"> <br> <br> Type the label of the folder in the 'Name;' entry field.<br> Type the name of the parent folder in the 'Create in:' entry field, or select it in the 'Existing folders:' tree view. If no parent are selected, the newly created folder will appear in the updates view as a root folder.<br> <img src="images/pic010.gif" alt="folders" width="251" height="249"> <img src="pic010.gif" alt="folders"> <br> </blockquote> <h5> New->Search</h5> <blockquote> This action will create a new Search. It will open a dialog window. Enter the name of the search you desire in Name. Select the folder you want the Search to appear in by selecting the appropriate folder under the existing folders tree or by typing its name in the Create in entry field. Open the Category combo box and select the search you want. You can change the category of a search after it has been created: see <a href="http://www.eclipse.org"> Search Preview View</a> . Click finish to close the dialog and create the search or click Cancel to close the dialog and abort the creation. To know more about the different type of search: see <a href="http://www.eclipse.org">Searching New Features</a> .<br> </blockquote> <h5> Show Details</h5> <blockquote> <p class="MsoNormal"> This action opens or refreshes the Preview View with the details of the selected element.<br> </p> </blockquote> <h5> Refresh</h5> <blockquote> This action re-initializes the content of an element <TODO see dejan><br> </blockquote> <h5> Bookmark Location</h5> <blockquote> This action lets you create bookmark site for a site found on your local file system. This opens a Dialog box that presents the properties of the selected site. The properties of a Site are the label you want to see in the View as well as the Address of the site. You are able to change the Site Name. Click Ok when you have finished and you want to preserve your changes or click Cancel if you do not want to change the properties.<br> </blockquote> <h5> Properties</h5> <blockquote> This action opens a Dialog box that presents the properties of the selected site. The properties of a Site are the label you want to see in the View as well as the Address of the site. If the element you selected was a bookmark, you are able to change both the Site Name and the Site Address of the site. If you change the Site Address of a Bookmark Site you will need to 'refresh' the Bookmark Site to access its new content. Click Ok when you have finished and you want to preserve your changes or click Cancel if you do not want to change the properties.<br> </blockquote> <h5> Delete</h5> <blockquote> This action removes the Bookmark Site from the workbench. This does not erase the content of the Site nor the physical remote or local Site itself.<br> </blockquote> <h3> The WebView</h3> <blockquote> The Web View is <TODO ><br> </blockquote> <h3> The flat concept (see Dejan)</h3> <blockquote> <TODO><br> </blockquote> <h3> The Preview View</h3> <blockquote> The preview shows information about the selected element. The preview view is different for each selected element.<br> </blockquote> <h4> </h4> <blockquote> You can open the preview view by either selecting an element in the updates or Configuration view, by opening a context menu on any element in the Updates or Configuration View and selecting Show Details or by open the Preview View from the Workbench menu. Select Window->Show View->Other to open the list of available Views. Expand Update Manager Folder, select Preview and Click Ok.<br> </blockquote> <h4> The 'Home' Preview view.</h4> <blockquote> You can open the 'Home' Preview by clicking on the home in the local tool bar menu if the View. This view summarizes the different tasks you can achieve through the Install/Update. By using the flat concept you are able to <TODO link><br> <div align="Center"><img src="images/pic012.gif" alt="Home Preview" width="507" height="503"> <br> </div> </blockquote> <h4> The current configuration Preview view</h4> <blockquote> This Preview shows information about the product you are using. The content of the view depends on the product you launched. <br> <div align="Center"><img src="images/pic012b.gif" alt="product preview" width="507" height="503"> <br> </div> </blockquote> <h4> The Site and Site Bookmark Preview View</h4> <blockquote> This Preview shows the Site Address of the selected Site or Bookmark Site.<br> <div align="Center"><img src="images/pic012c.gif" alt="Site Preview" width="507" height="503"> <br> </div> </blockquote> <h4> The Feature Preview View</h4> <blockquote> This Preview View shows information about a feature.<br> <div align="Center"><img src="images/pic012d.gif" alt="Feature Preview" width="507" height="669"> <br> </div> </blockquote> <h5> Provider</h5> <blockquote> The name of the provider of the feature.<br> </blockquote> <h5> Version</h5> <blockquote> The version of the feature.<br> </blockquote> <h5> Installed Version</h5> <blockquote> The list of already installed version of this feature or 'Not Installed' if no version of this feature has been configured in the current configuration.<br> </blockquote> <h5> Download Size</h5> <blockquote> The maximum download size for the feature. If the site you will install the feature in already contains some of the files the feature require, the files will not be installed twice, and thus the downloaded and installed size will be smaller than the maximum one.<br> </blockquote> <h5> Supported Platforms</h5> <blockquote> This expandable category shows the different supported platforms for this feature. The categories are Operating Systems, Windowing Systems, Architectures and Languages.<br> </blockquote> <ul> <li> Operating Systems: the list of supported Operating Systems.</li> <li> Windowing Systems: the list of supported Windowing Systems.</li> <li> Supported Architectures: the list of supported processor architecture.</li> <li> Supported Languages: the list of supported languages.<br> </li> </ul> <h5> Description </h5> <p class="MsoNormal"> The description of the Feature<br> <br> </p> <h5> More Info <TODO should we say it is optional ?></h5> <blockquote> Opens a page with more information about the feature. The page may be found locally or remotely.<br> </blockquote> <h5> License</h5> <blockquote> Opens a page with the license of the Feature.<br> </blockquote> <h5> Copyright</h5> <blockquote> <p class="MsoNormal"> Opens a page with the copyright of the Feature.<br> </p> </blockquote> <h5> Actions</h5> <blockquote> <p class="MsoNormal"> In the lower left side of the Preview View for a feature you may see one or multiple buttons. They provide you with actions you can take on the Feature depending of its configuration. If a change is pending for this feature, no actions will be available until the workbench is restarted.<br> </p> </blockquote> <ul> <li> <span style="mso-spacerun: yes"></span>Install: this launches the Install Wizard for this feature. See <a href="http://www.eclipse.org"> Installing a Feature</a> .<br> </li> <li> Unconfigure: this launches the Unconfigure Wizard for this configured feature. See <a href="http://www.eclipse.org"> Configuring/Unconfiguring a Feature</a> .<br> Configure: this launches the Configure Wizard for this unconfigured feature. See <a href="http://www.eclipse.org">Configuring/Unconfiguring a Feature</a> .<br> Uninstall: this removes the unconfigure feature from the file system. See <a href="http://www.eclipse.org">Removing a Feature</a> .</li> </ul> <h4> The Configuration Preview View</h4> <blockquote> <p class="MsoNormal"> This preview shows information about the select configuration.<br> </p> <div align="Center"><img src="images/pic013.gif" alt="Configuration Preview" width="621" height="488"> <br> </div> </blockquote> <p class="MsoNormal"><br> </p> <h5> Created On</h5> <blockquote> <p class="MsoNormal"> The date in the current locale, the configuration was created on.<br> </p> </blockquote> <h5> Current Configuration</h5> <blockquote> <p class="MsoNormal"> If the selected configuration is the active configuration.<br> </p> </blockquote> <h5> Activities</h5> <blockquote> List of activities that led to the creation of the configuration. For more information about the differents activities, see <a href="http://www.eclipse.org"> Activities</a> .<br> </blockquote> <p class="MsoNormal"></p> <h5> Configuration Reversal</h5> <blockquote> In the lower left side of the Preview View for a configuration you may see one button. It provides you with actions you can take on the Configuration depending if it is the current configuration or another one. If a change is pending for a feature, no actions will be available until the workbench is restarted.</blockquote> <ul> <li> Restore: this restores the selected configuration. See <a href="http://www.eclipse.org"> Restore a Configuration/Revert to previous configuration</a> .<br> </li> <li> Revert: this revert the current configuration to the previous configuration. See <a href="http://www.eclipse.org">Restore a Configuration/Revert to previous configuration</a> .</li> </ul> <p class="MsoNormal"></p> <h4> The search Preview View</h4> <blockquote> This view allows you to change the search query, enter the appropriate settings for the query, set the scope of the serahc, run the query and see the result of the query. The settings are different for each query.<br> </blockquote> <h5> Change the query</h5> <blockquote> To change the category of the query, expand Query Settings. Expand the Search Category Settings and select the desired search category.<br> </blockquote> <h5> Enter the settings</h5> <blockquote> Each category has its own settings. For more information about the different settings for a category: see <a href="http://www.eclipse.org">Searching New Features</a> .<br> </blockquote> <h5> Set the scope</h5> <blockquote> To change the scope of the search, expand Scope Settings. You can select to search the local file system, the discovery sites in 'places to visit' and/or the bookmarked sites you created. When searching the local file system, click Settings to select which root folder will be searched.<br> </blockquote> <h5> Run the query</h5> <blockquote> Click Search Now to run the query.<br> </blockquote> <h5> See the results</h5> <blockquote> The result will appear at the bottom of the View. Select Show Results in Extended Form to have more information about the features.<br> </blockquote> <h3> The Install/Update Preference Page</h3> <blockquote> You can open the preference page from the Workbench main menu. Click Window->preferences to open the Preference Dialog. Select Install/Update to reveal the Install/Update preference Page. In this page, you can modify the number of history configuration you want the workbench to manage as well as decide which browser to open .<br> </blockquote> <p class="MsoNormal"></p> <h4> Maximum number of 'History' configurations entry field.<br> </h4> <blockquote> Enter the number of history configurations you want the Install/Update to keep. See <a href="http://www.eclipse.org">Configuration History</a> for more information.<br> </blockquote> <h4> Web Links radio buttons.</h4> <blockquote> When opening Web links. Allows you to choose between opening the internal WebView or opening an external browser.<br> </blockquote> <h2> Finding features</h2> <blockquote> This section will explain how to find the features to install. There are different way of looking for features; you may know exactly which feature you need and where it is located, or you may want to search for an update of an already installed feature is available, finally you may just decide to browse or search to discover new sites and new features. <br> </blockquote> <h3> Find a specific feature </h3> <blockquote> <p class="MsoNormal"> This section will focus on finding a feature when you know exactly where to find it. To find a feature you may either add the Update Site that contains this feature and browse the site to find the feature or you can open the WebView and browe to the Feature WebPage.</p> </blockquote> <h4> Add a new Update Site </h4> <blockquote> <p class="MsoNormal"> To add a new Update site, open the context Menu in the Updates View and select New->Site Bookmerk.... This opens a Dialog box that presents the properties of the Bookmark Site you want to create. The properties of a Bookmark Site are the label you want to see in the View as well as the URL of the physical site. You have to enter the Site URL. Optionally you can enter the Site Name. If you do not enter a Site Name, it will default to the Site URL. Click Ok when you have finished and you want to preserve your changes or click Cancel if you do not want to create a new Site Bookmark. </p> </blockquote> <h4> Find the feature </h4> <blockquote> <p class="MsoNormal"> Expand the site to find the feature you want. You can find the feature by looking at the label or selecting a feature and reading the preview view. To know more about preview view: See <a href="http://www.eclipse.org"> Preview View</a> .</p> </blockquote> <h4> Browse WebPages </h4> <blockquote> Open the <a href="http://www.eclipse.org">WebView</a> and enter the URL for the feature web page. Follow the indication of the webpage. <TODO web install><br> </blockquote> <h3> Update already existing features</h3> <blockquote> <p class="MsoNormal"> This section will focus on updating features that are configured in your current configuration.To know how to configure/unconfigure a fetaure; see: <a href="http://www.eclipse.org"> Configuring/Unconfiguring</a> .<TODO only configured features ?> </p> </blockquote> <h4> Search for updates</h4> <blockquote> To search for available updates, select Available Updates in the Updates View. In the preview view, press Search now. This will search the site the configured feature come from for new version the installed and configured feature. During the search you will see the progress monitor move, indicating the search is in progress. When new version of configured features are found, they will appear under the progress monitor. You can decide to see the result in a short form or an extended form by checking the 'Show results in extended form' box, under the Scope Settings section in the preview view.<br> </blockquote> <h4> Search the file system</h4> <blockquote> <p class="MsoNormal"> You can decide to search the file system for updates by checking the 'Include my computer in the search' box, under the Scope Settings section in the preview view. Click on the Settings... button to customize which part of the file system you want to search.</p> </blockquote> <h4> Customize Search</h4> <blockquote> <p class="MsoNormal"> You can cutomize the search for updates by creating a new search. To know how to create a new search: see <a href="http://www.eclipse.org">Updates View: Context Action [new->search]</a> .</p> </blockquote> <h3> Browse to discover</h3> <blockquote> <p class="MsoNormal"> This section will focus on browsing update sites to find the features you want to install. All the update site appear in the Updates View. There are different places in the view where you can find sites to browse. You may have sites in the folder 'Places to visit' or you may have sites on your file system. You can also add some update site if you know their URL.<br> </p> </blockquote> <h4> Browse already existing sites</h4> <blockquote> <p class="MsoNormal"> If you expand the folder 'Places to visit' you may see some sites. They were automatically added to the folder by the feature you installed. You can expand the site and browse the features.</p> </blockquote> <h4> Browse the file system</h4> <blockquote> <p class="MsoNormal"> To browse the file system, expand 'My Computer'. <TODO what more to say?></p> </blockquote> <h4> Add a new Update Site </h4> <blockquote> You can add a new update site from the context menu. Select new->SiteBookmark... This opens a Dialog box that presents the properties of the Bookmark Site you want to create. The properties of a Bookmark Site are the label you want to see in the View as well as the Address of the physical site. You have to enter the Site URL. Optionally you can enter the Site Name. If youdo not enter a Site Name, it will default to the Site URL. Click Ok when you have finished and you want to preserve your changes or click Cancel if you do not want to create a new Site Bookmark. Once the site has been created, expand the icon to see the categories and or the available features.<br> </blockquote> <h4> Add a bookmark of a file system site.</h4> <blockquote> When you browse the file syste, you can add a file system site as a bookmark. Select the site. Open the context menu. Select 'Bookmark Location'. This action lets you create bookmark site for a site found on your local file system. This opens a Dialog box that presents the properties of the selected site. The properties of a Site are the label you want to see in the View as well as the Address of the site. You are able to change the Site Name. Click Ok when you have finished and you want to preserve your changes or click Cancel if you do not want to change the properties. Once the site has been created, expand the icon to see the categories and or the available features.<br> </blockquote> <h3> Searching Features</h3> <blockquote> This section will explain how to find features by using the search mecanism. It will first focus on finding features that are update of already installed features, then it will explain how to search the file system, finally it will expose how to customize a search by presenting the three default search categories.<br> </blockquote> <h4></h4> <h5></h5> <h4> Search for updates</h4> <blockquote> To search for available updates, select Available Updates in the Updates View. In the preview view, press Search now. This will search the site the configured feature come from for new version the installed and configured feature. During the search you will see the progress monitor move, indicating the search is in progress. When new version of configured features are found, they will appear under the progress monitor. You can decide to see the result in a short form or an extended form by checking the 'Show results in extended form' box, under the Scope Settings section in the preview view.<br> </blockquote> <h4> Search the file system</h4> <blockquote> <p class="MsoNormal"> You can decide to search the file system for updates by checking the 'Include my computer in the search' box, under the Scope Settings section in the preview view. Click on the Settings... button to customize which part of the file system you want to search.</p> </blockquote> <h4> Customize Search</h4> <blockquote> Three default categories of search are provided: Search for availables updates, search features based on regular expression and search features that containf a specific plugins. You may see other categories. Check the user documentation of the features that provide the extra categories to learn more about them.<br> </blockquote> <h5> Available Updates</h5> <blockquote> This search attemps to find update of already installed features. There is no special settings to fill when running this query. The query will find all new version of installed features based on the scope. To know more about the scope of the search: see <a href="http://www.eclipse.org">Search Preview View</a> .<br> </blockquote> <h5> Regular Expression</h5> <blockquote> This search attemps to find features based on a simple regular expression query. You must change the settings of the query before running it. Select the query in the Updates View. In the preview view, expand Query Settings.<br> </blockquote> <ul> <li> Type the string you want to search for in the Expression Entry Field.</li> <li> Check the check box if you want the search to be case sensitive. A case sensitive search will consider UpperCase and LowerCase character as different.</li> <li> Selection where you want the search to occur by checking Feature Name, Feature Provider and/or Feature Description.</li> </ul> <blockquote> The query will find the features that match the query based on the scope. To know more about the scope of the search: see <a href="http://www.eclipse.org"> Search Preview View</a> .</blockquote> <h5> Plug-ins</h5> <blockquote> This search attempts to find feature that contain a specific plug-in.You must change the settings of the query before running it. Select the query in the Updates View. In the preview view, expand Query Settings.<br> </blockquote> <ul> <li> Click New to add a specific plugin. <TODO doesn't work in 0423></li> </ul> <blockquote> The query will find the features that match the query based on the scope. To know more about the scope of the search: see <a href="http://www.eclipse.org"> Search Preview View</a> .<br> </blockquote> <h2> Installing a Feature</h2> <blockquote> This section will describe the Wizard used to install, configure, unconfigure and remove a feature as well as the verification task that may occur when installing a new feature. The first part will focus on the three tab that are part of the Wizard, while the second part will deal with verification and security issues when installing a feature.<br> </blockquote> <h3> Install Wizard</h3> <blockquote> The Wizard will help you install, configure, unconfigure and remove a feature. It will allow you to review any license agreement and to choose the Site in which you wish to install the feature.<br> </blockquote> <h4> The Preview Tab</h4> <blockquote> This tab summarizes the action you are going to take. <br> </blockquote> <div align="Left"><img src="images/pic002.gif" alt="Install Wizard Preview Tab PIC002.gif" width="500" height="500"> <br> </div> <h4> The License Tab</h4> <blockquote> This tab will present you the license you have to agree with to install the product. Click on agree if you agree with the whole license and whish to continue or click cancel to abort the installation<br> </blockquote> <h4> Site location Tab</h4> <blockquote> This tab has three main goals. The first one is to show you the available sites on your local file system, the second is the ability to create a new site if the one proposed are not satisfactory, finally you will be able to see the space left on the selected site and the size in kilobyte of the feature you are about to install.<br> </blockquote> <h4> Verification <TODO explain basic certificate ></h4> <blockquote> Verification is an important part of the install process. It will allow you to verify if the feature you are about to install has been digitally signed, not digitally signed or tempered with.<br> </blockquote> <h5> Signed</h5> <blockquote> A dialog with the following <PICTURE> will appear if the feature or one of its file has been signed. A signed feature means the file has been digitally signed by the signer, and the signer has been authenticated by the authenticator. The authenticator can be the same entity as the signer, in which case you will see such a dialog <PICTURE>. In some cases, the authenticator is a different entity than the signer, in which case you will see such a dialog. <PICTURE>. If the authenticator has never been authenticated by you, you will see such a dialog <PICTURE>. If the signature of the authenticator has been authorized before, you will see such a dialog <PICTURE>. Click continue or install only if you trust the signer of the feature file and you want to install the feature, or click cancel if you want to abort the installation.<br> </blockquote> <h5> Non Signed</h5> <blockquote> A dialog like the following <PICTURE> will appear if the feature or one of its file has not been signed. When a feature has not been signed, we cannot authenticate the sender of the package, nor can we certify the validity of any of the file. Click continue or install only if you want to install the feature, or click cancel if you want to abort the installation.<br> </blockquote> <h5> Corrupted </h5> <blockquote> <p class="MsoNormal"> If the content of a feature has changed since it has been signed, you will see such a dialog <PICTURE>. This means the content has been tempered with. Install/Update will prevent you from installing such a feature. Click cancel if you want to abort the installation and contact the provider of the feature and/or the site. </p> </blockquote> <h5> Feature verification dialog</h5> <blockquote> <p class="MsoNormal"> <TODO explain the dialog with feature/ install/ cancel></p> </blockquote> <h5> Feature file verification dialog</h5> <blockquote> <p class="MsoNormal"> <TODO explain the dialog with feature file/ continue/ cancel></p> </blockquote> <h5> Persistence of the answer</h5> <blockquote> <p class="MsoNormal"> If click continue or install on a verification dialog, the Install/Update component will remember your action and will not prompt you again if one of the file of the feature is about to show the exact same verification dialog. <br> </p> </blockquote> <h2> Configuring/Unconfiguring a Feature</h2> <blockquote> This section will focus on configuring and unconfiguring the feature you can manage in your current configuration. A configuration is a list of configured and unconfigured features that determine what tool are available for you to use in your workspace. To know more about configuration see: <a href="http://www.eclipse.org"> Configuration</a> . <br> </blockquote> <h3> Checking if a feature is configured or unconfigured.<br> </h3> <blockquote> Feature you installed appear in the Configuration View. Expand the Current Configuration to see the configured sites. Expand the site to see the Features. Use the local view toolbar button to switch between configured features and all the features. Unconfigured features appear with such icon <img src="images/unconf_feature_obj.gif" alt="unconf_feature_obj.gif Unconfigured Feature" width="16" height="16"> <br> </blockquote> <h3> Configure/Unconfigure Wizard</h3> <blockquote> <p class="MsoNormal"> The Wizard will help you configure or unconfigure a feature. <br> </p> </blockquote> <h4> Preview Tab</h4> <blockquote> This tab summarizes the action you are going to take. <br> <div align="Left"><img src="images/pic003.gif" alt="PIC003.gif Configure Wizard Preview Tab" width="500" height="500"> <br> </div> <div align="Left"> </div> </blockquote> <h2> Configuration</h2> <blockquote> <p class="MsoNormal"> A configuration is a list of configured and unconfigured features that determine what tool are available for you to use in your workspace. A configuration determines what task you can execute. There are three types of configuraions: the current configuration, the history configuration and the preserved configuration.<br> </p> </blockquote> <h3> Current Configuration</h3> <blockquote> <p class="MsoNormal"> The current configuration is the configuration currently active.</p> </blockquote> <h3> Configuration History or Preserved Configuration</h3> <blockquote> <p class="MsoNormal"> Configuration History are automatically created by the Install/Update as a snapshot of your current configuration at a certain time, before an activity occurs. Preserved Configuration are configuration in the History Configuration you want to persist.</p> </blockquote> <h3> Configuration History</h3> <blockquote> <p class="MsoNormal"> When you install a feature, the install/update component will copy your current configuration in the history configuration, and then install and configure the feature in you current configuration. You will end up with two configurations, one without the feature installed and configured and one with the feature installed and configured. The install/update will also copy your current configuration when you install or remove a site, when you configure or unconfigure a feature or when a reconciliation is needed. Each actvity will be recorded in the configuration. For each configuration selected in the history configuration folder, you can see in the preview view the list of activities that were executed. See <a href="http://www.eclipse.org"> Activities </a> for more information about the different activities.</p> </blockquote> <blockquote> The install/update will keep a certain number of configuration in the configuration history folder. After this number has been reached, if a new configuration is created, the oldest configuration inside Configuration History folder will be deleted. <br> </blockquote> <h4> Renaming an history configuration</h4> <blockquote> <p class="MsoNormal"> You can rename any configuration in the Configuration History folder. To change the label of a Configuration, select the configuration, open the context menu and click Properties. This will open a dialog where you can change the label of the selected configuration. Click Ok if you want to save the label or click cancel if you do not want to change the label of the configuration.</p> </blockquote> <h4> Revert the current configuration to the previous configuration</h4> <blockquote> <p class="MsoNormal"> You can revert the current configuration to the previous configuration. <TODO explain better> <br> </p> </blockquote> <h3> Preserved Configuration</h3> <blockquote> Preserved Configurations are configurations of the Configuration History folder you want to Preserved because it represents a set of configured features for a certian task. If you do not preserved a configuration, <TODO> <br> </blockquote> <h4> Add a Configuration in the preserved folder</h4> <blockquote> <TODO><br> </blockquote> <h4> Remove a Configuration in the preserved folder </h4> <blockquote> <p> <TODO> </p> </blockquote> <h4> Rename a Preserved Configuration</h4> <blockquote> <p class="MsoNormal"> You can rename any configuration in the Preserved Configurations folder. To change the label of a Configuration, select the configuration, open the context menu and click Properties. This will open a dialog where you can change the label of the selected configuration. Click Ok if you want to save the label or click cancel if you do not want to change the label of the configuration.</p> </blockquote> <p class="MsoNormal"><br> </p> <h3> Restore a Configuration/Revert to previous configuration</h3> <p class="MsoNormal"> <TODO></p> <p class="MsoNormal"><br> </p> <h3> The Activities </h3> <blockquote> Activities are tasks that are part of a configuration. Activities are the actions are were taken to create the Configuration. You can see activities in the preview view when you select a configuration.<br> <div align="Center"><img src="images/pic014.gif" alt="activities" width="594" height="151"> <br> </div> </blockquote> <div align="Center"> <div align="Left"> <h5> Date</h5> </div> </div> <blockquote> <div align="Center"> <div align="Left"> The date using the locale format ate which the action took place.<br> </div> </div> </blockquote> <div align="Center"> <div align="Left"> <h5> Target</h5> </div> </div> <blockquote> <div align="Center"> <div align="Left"> The identifier of the target of the action (see the different type of activities)<br> </div> </div> </blockquote> <div align="Center"> <div align="Left"> <h5> Action</h5> </div> </div> <blockquote> <div align="Center"> <div align="Left"> The label of the action (see the different types of activities)<br> </div> </div> </blockquote> <div align="Center"> <div align="Left"> <h5> Status</h5> </div> </div> <blockquote> <div align="Center"> <div align="Left"> The status of the action. Sucess if teh action was sucessful.<br> </div> </div> </blockquote> <blockquote> There are nine different actions that create an activity in a configuration.<br> </blockquote> <h4> Feature Installed </h4> <blockquote> <p class="MsoNormal"> When a new feature is installed in a configured site.<br> The target in the preview view is the identifier of the installed feature.<br> </p> </blockquote> <h4> Feature Removed</h4> <blockquote> <p class="MsoNormal"> When a new feature is physically removed from a configured site.<br> The target in the preview view is the identifier of the removed feature.<br> </p> </blockquote> <h4> Site Installed</h4> <blockquote> <p class="MsoNormal"> When a Site is added to the current configuration.</p> <p class="MsoNormal"> The target in the preview view is the Address of the site</p> </blockquote> <h4> Site Removed</h4> <blockquote> <p class="MsoNormal"> When a Site is removed from the current configuration.</p> <p class="MsoNormal"> The target in the preview view is the Address of the site</p> </blockquote> <h4> Feature Configured</h4> <blockquote> <p class="MsoNormal"> When a new feature is configuredin a configured site.<br> The target in the preview view is the identifier of the configured feature.<br> </p> </blockquote> <h4> Feature Unconfigured</h4> <blockquote> <p class="MsoNormal"> When a new feature is unconfigured in a configured site.<br> The target in the preview view is the identifier of the unconfigured feature.<br> </p> </blockquote> <h4> Revert to Configuration</h4> <blockquote> <p class="MsoNormal"> When the user reverted to a configuration from either the configuration history or the preserved configuration</p> <p class="MsoNormal"> The target in the preview view is the identifier of the configuration we reverted to.</p> </blockquote> <h4> Reconciliation</h4> <blockquote> <p class="MsoNormal"> When the Install/Update detected a changed occured between the last shutdown and this startup.</p> <p class="MsoNormal"> The URL of the file maintaing the overall configuration.</p> </blockquote> <h4> Added to Preserved Configuration</h4> <blockquote> <p class="MsoNormal"> When a the configuration was added to the list of preserved configurations.<br> </p> <p class="MsoNormal"> The target in the preview view is the identifier of the configuration added to the preserved configurations.</p> </blockquote> <p class="MsoNormal"> <br> </p> <h2> Removing a Feature</h2> <blockquote> <p class="MsoNormal"> This section explains how to physicaslly remove an Unconfigured feature from the file system. You can only remove unconfigured features. Yo know how to unconfigure a feature see: <a href="http://www.eclipse.org">Configure/Unconfigure Features</a> .</p> </blockquote> <h3> Remove Wizard</h3> <blockquote> This Wizard will help you uninstall an unconfigured feature.<br> To launch the wizard, select an unconfigured feature in your current configuration. See <a href="http://www.eclipse.org">Configure/Uncofingue</a> a feature to know how to unconfigure a configured feature, and if a feature is configured or not.<br> </blockquote> <h4> Preview Tab</h4> <blockquote> This tab summarizes the action you are going to take.<br> <img src="images/pic015.gif" alt="uninstall wizard" width="600" height="500"> <br> </blockquote> <h2> Troubleshooting</h2> <p class="MsoNormal"> If the workbench does not start after you installed a new feature.<br> The Install/Update views do not show anything.<br> I created a Site but nothing shows (verify URL)</p> <h2> Advanced User</h2> <p class="MsoNormal"> Security and keystore management.</p> <p class="MsoNormal"> </p> </div> </body> </html>
| help@eclipse.org | ViewVC Help |
| Powered by ViewVC 1.0.3 |