| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><HTML> |
| <HEAD> |
| <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1"> |
| <META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> |
| <link REL="STYLESHEET" HREF="../../book.css" CHARSET="ISO-8859-1" TYPE="text/css"> |
| <title>Welcome Page Configuration</title> |
| </head> |
| <body> |
| |
| <h1>Welcome Pages</h1> |
| |
| <p>Welcome pages are used to familiarize the user with a given aspect of the |
| workbench.</p> |
| |
| <p><img alt="Default Welcome Page" border="0" src="welcome.jpg" width="602" height="480"></p> |
| |
| <p>Each feature can contribute a welcome page. This is done by including a <b>welcomePage</b> |
| attribute in the <b>about.ini</b> file in the sub-directory of the feature's plug-in.</p> |
| |
| <p class="Code">welcomePage = $nl$/welcome.xml</p> |
| |
| <p> |
| The value of the <b>welcomePage</b> attribute is an XML-like file defining the welcome page.<br> |
| The file has the following format:</p> |
| |
| <p><b> <welcomePage></b> tag with </p> |
| <ol> |
| <li>an optional title attribute</li> |
| <li>an optional format attribute</li> |
| <li>an optional <intro> tag</li> |
| <li>0 or more <item> tags</li> |
| </ol> |
| <p>The <b> format</b> tag can have a value of "wrap" or "nowrap". |
| If the format attribute is "wrap", the text within the Welcome Editor will be wrapped |
| to fit the size of its window. Note that line breaks within text will be preserved when |
| wrapping unless paragraph (<b><p></b>) tags are used. If the format attribute is not specified, the default |
| value of "nowrap" will be used. |
| </p> |
| <p>The <b> intro</b> and <b> item</b> tags can contain the following</p> |
| <ol> |
| <li>Text (with line breaks preserved)</li> |
| <li>Paragraph (<b><p></b>) tags to indicate which text should be wrapped. |
| <p>Text between <b><p></b> tags will be treated as one continuous line (i.e., line breaks within the <b><p></b> text |
| will be "soft"). The <b><p></b> tag only applies when format = "wrap". |
| If format = "nowrap", paragraph tags will be ignored.</p> |
| </li> |
| <li>Bold (<b><b></b>) tags</li> |
| <li>Action (<b><action></b>) tags containing the following attributes |
| <p><b>pluginId</b> (the id of the plug-in containing the action)</p> |
| <p><b> |
| class</b> (the qualified name of the action class to instantiate and run)</li> |
| <li>Help topic (<b><topic></b>) tags containing the following attributes |
| <p><b> |
| id</b> (the id of the infoset to show in the help viewer) |
| <p><b>href</b> (optional - a valid help topic URL |
| contained in the specified infoSet and having the following |
| format: <b><br> |
| /pluginID/path_to_document</b>)</li> |
| </ol> |
| <p> |
| Note that text between the start and end tags for actions and help topics will appear as a highlighted link.</p> |
| <p>Below is an example welcome page. The text for the second item will be wrapped.</p> |
| <pre><font color="#4444CC"><?xml version="1.0" encoding="UTF-8" ?> |
| <welcomePage |
| title="Eclipse Platform" |
| format = "wrap"> |
| |
| <intro>This page will help familiarize you with the Eclipse Workbench. |
| To get started, read the sections below and click on the related links. </intro> |
| |
| <item><b>Installed Features </b> |
| To find out more about the features installed in your workbench, choose |
| <action pluginId="org.eclipse.ui" |
| class="org.eclipse.ui.internal.QuickStartAction">Help > Welcome...</action> |
| and select the feature you are interested in.</item> |
| |
| <item><b>Perspectives, views and editors </b> |
| <p>A window contains one or more perspectives. A perspective consists of views (e.g. Navigator) |
| and editors for working with your resources. |
| The shortcut bar at the far left of the window allows you to open new perspectives and move |
| between perspectives that are already open. The perspective you are currently working with |
| is shown in the title of the window and in the shortcut bar as a pushed-in icon.</p></item> |
| |
| <item><b>Configuring your perspectives</b> |
| You can move views and editors around the workbench by dragging their titlebars. You can |
| also add more views to your current perspective by using Window > Show View. |
| To reset the perspective to its original state, choose |
| <action pluginId="org.eclipse.ui" |
| class="org.eclipse.ui.internal.ResetPerspectiveAction">Window > Reset Perspective</action>. |
| Once you have arranged your perspective, you can save it using Window > Save Perspective As.... |
| You can customize the views, perspectives and New menu operations that show up for |
| your perspective. To do this choose |
| <action pluginId="org.eclipse.ui" |
| class="org.eclipse.ui.internal.EditActionSetsAction">Window > Customize Perspective...</action> . |
| A view can additionally be converted into a Fast View by dragging it to the shortcut bar (at the |
| far left of the window). </item> |
| |
| <item><b>Learn more </b> |
| To learn more you can browse the |
| <topic id="/org.eclipse.platform.doc.user/toc.xml">Workbench User Guide</topic>.</item> |
| |
| </welcomePage></font></pre> |
| |
| <p><a href="hglegal.htm"><img SRC="ngibmcpy.gif" ALT="Copyright IBM Corp. and others 2000, 2002." BORDER=0 width="250" height="12"></a> |
| </body> |
| </html> |
