| 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 2 |
<HTML><HEAD><TITLE>Eclipse V2 Help System</TITLE> |
<html> |
| 3 |
|
<head><title>Eclipse V2 Help System</title> |
| 4 |
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| 5 |
|
|
| 6 |
<STYLE>A:link { |
<style> |
| 7 |
COLOR: #0033cc; TEXT-DECORATION: none |
<!-- |
| 8 |
} |
a:link { color: #0033CC; text-decoration: none } |
| 9 |
A:hover { |
a:hover { color: #0033CC; text-decoration: underline } |
| 10 |
COLOR: #0033cc; TEXT-DECORATION: underline |
a:visited { color: #0033CC; text-decoration: none } |
| 11 |
} |
li { line-height: 125%; font-size: 10pt } |
| 12 |
A:visited { |
p { line-height: 125%; font-size: 10pt } |
| 13 |
COLOR: #0033cc; TEXT-DECORATION: none |
th { font-size: 10pt } |
| 14 |
} |
td { font-size: 10pt } |
| 15 |
LI { |
--> |
| 16 |
FONT-SIZE: 10pt; LINE-HEIGHT: 125% |
</style> |
|
} |
|
|
P { |
|
|
FONT-SIZE: 10pt; LINE-HEIGHT: 125% |
|
|
} |
|
|
TH { |
|
|
FONT-SIZE: 10pt |
|
|
} |
|
|
TD { |
|
|
FONT-SIZE: 10pt |
|
|
} |
|
|
</STYLE> |
|
| 17 |
|
|
| 18 |
<link rel="stylesheet" href="http://dev.eclipse.org/default_style.css" type="text/css"> |
<link rel="stylesheet" href="http://dev.eclipse.org/default_style.css" type="text/css"> |
| 19 |
|
|
| 20 |
</HEAD> |
</head> |
|
<BODY> |
|
|
<H3><A name=top></A>Eclipse V2 Help System - Support and Functionality |
|
|
Overview</FONT></H3> |
|
|
<P>The Eclipse help system is a component of the Eclipse Platform. It is used |
|
|
for displaying, browsing, searching, and printing online documentation. It also |
|
|
interacts with the Eclipse-based UIs through context-sensitive help (launching |
|
|
the help system from the user interface) and active help (launching a UI action |
|
|
from the help system content).</FONT></P> |
|
|
<P>The help system not only presents online documentation about the Eclipse SDK |
|
|
and tooling, but also lets developers add their own documentation to it. Also, |
|
|
it can be used apart from the rest of Eclipse as a help system for non-Eclipse |
|
|
based applications or other projects. It can be installed either locally or on a |
|
|
web server.</FONT></P> |
|
|
<UL> |
|
|
<LI><A |
|
|
href="file:///C:/temp/C.Notes.Data/v2overview.htm#scenarios">Scenarios</A></FONT> |
|
| 21 |
|
|
| 22 |
<LI><A href="file:///C:/temp/C.Notes.Data/v2overview.htm#nav">Navigation |
<body> |
| 23 |
features</A></FONT> |
|
| 24 |
<LI><A href="file:///C:/temp/C.Notes.Data/v2overview.htm#content">Content |
<h3><a name="top"></a>Eclipse V2 Help System - Support and Functionality |
| 25 |
features</A></FONT> |
Overview</font></h3> |
| 26 |
<LI><A href="file:///C:/temp/C.Notes.Data/v2overview.htm#search">Search |
<p>The Eclipse help system is a component of the |
| 27 |
features</A></FONT> |
Eclipse Platform. It is used for displaying, browsing, searching, and printing |
| 28 |
<LI><A |
online documentation. It also interacts with the Eclipse-based UIs through |
| 29 |
href="file:///C:/temp/C.Notes.Data/v2overview.htm#infopop">Context-sensitive |
context-sensitive help (launching the help system from the user interface) and |
| 30 |
help features</A></FONT> |
active help (launching a UI action from the help system content).</font></p> |
| 31 |
<LI><A href="file:///C:/temp/C.Notes.Data/v2overview.htm#activehelp">Active |
<p>The help system not only presents online |
| 32 |
help features</A></FONT> |
documentation about the Eclipse SDK and tooling, but also lets developers add |
| 33 |
<LI><A href="file:///C:/temp/C.Notes.Data/v2overview.htm#platform">Platform |
their own documentation to it. Also, it can be used apart from the rest of |
| 34 |
support</A></FONT> |
Eclipse as a help system for non-Eclipse based applications or other projects. |
| 35 |
<LI><A href="file:///C:/temp/C.Notes.Data/v2overview.htm#browser">Browser |
It can be installed either locally or on a web server.</font></p> |
| 36 |
support</A> |
<ul> |
| 37 |
<LI><A href="file:///C:/temp/C.Notes.Data/v2overview.htm#language">Language |
<li><a href="#scenarios">Scenarios</a></font></li> |
| 38 |
support</A></FONT> |
<li><a href="#nav">Navigation features</a></font></li> |
| 39 |
<LI><A href="file:///C:/temp/C.Notes.Data/v2overview.htm#access">Accessibility |
<li><a href="#content">Content features</a></font></li> |
| 40 |
support</A></FONT> |
<li><a href="#search">Search features</a></font></li> |
| 41 |
<LI><A |
<li><a href="#infopop">Context-sensitive help features</a></font></li> |
| 42 |
href="file:///C:/temp/C.Notes.Data/v2overview.htm#compatibility">Compatibility |
<li><a href="#activehelp">Active help features</a></font></li> |
| 43 |
with previous releases</A></FONT> </LI></UL> |
<li><a href="#platform">Platform support</a></font></li> |
| 44 |
<H4><A name=scenarios></A>Scenarios</FONT></H4> |
<li><a href="#browser">Browser support</a></li> |
| 45 |
<P>The V2 help system supports the following product scenarios:</FONT></P> |
<li><a href="#language">Language support</a></font></li> |
| 46 |
<OL> |
<li><a href="#access">Accessibility support</a></font></li> |
| 47 |
<LI> |
<li><a href="#compatibility">Compatibility with previous releases</a></font></li> |
| 48 |
<P><B>Integrated</FONT> </B>- If you are creating an Eclipse-based product, |
</ul> |
| 49 |
the help system is automatically provided. You can launch the help browser |
<h4><a name="scenarios"></a>Scenarios</font></h4> |
| 50 |
from the <B>Help</B> menu in the workbench, or through infopop |
<p>The V2 help system supports the following product |
| 51 |
links.<BR> </P> |
scenarios:</font></p> |
| 52 |
<LI> |
<ol> |
| 53 |
<P><B>Stand-alone (local)</FONT></B> - If you are creating an application that |
<li><p><b>Integrated</font> </b>- If you are creating an Eclipse-based product, |
| 54 |
is not based on the Eclipse framework, you can still use the Eclipse help |
the help system is automatically provided. You can launch the help browser from the <b>Help</b> menu in the |
| 55 |
system. Your application can package and install the <I>stand-alone help |
workbench, or through infopop links.<br> |
| 56 |
system</I>, a very small version of Eclipse that has had everything except the |
</p></li> |
| 57 |
|
<li><p><b>Stand-alone (local)</font></b> - If you are creating an application |
| 58 |
|
that is not based on the Eclipse framework, you can still use the Eclipse help |
| 59 |
|
system. Your application can package and install the <i>stand-alone help |
| 60 |
|
system</i>, a very small version of Eclipse that has had everything except the |
| 61 |
help system stripped out of it. Then, your application can make API calls from |
help system stripped out of it. Then, your application can make API calls from |
| 62 |
its <B>Help</B> menu, or from UI objects, to launch the help browser. The |
its <b>Help</b> menu, or from UI objects, to launch the help browser. The |
| 63 |
stand-alone help system has all the features of the integrated help system, as |
stand-alone help system has all the features of the integrated help system, as |
| 64 |
described in the following sections. However, it interacts with the |
described in the following sections. However, it interacts with the |
| 65 |
application UI for features such as context-sensitive help or active help will |
application UI for features such as context-sensitive help or active help will |
| 66 |
vary. All features except infopops and active help are |
vary. All features except infopops and active help are supported.<br> |
| 67 |
supported.<BR> </P> |
</p></li> |
| 68 |
<LI> |
<li><p><b>Infocenter (served)</font></b> - You can also allow your users to |
| 69 |
<P><B>Infocenter (served)</FONT></B> - You can also allow your users to access |
access the help system over the Internet or their intranet, by installing the |
|
the help system over the Internet or their intranet, by installing the |
|
| 70 |
stand-alone help system and the documentation plug-ins on a web server. The |
stand-alone help system and the documentation plug-ins on a web server. The |
| 71 |
application accesses the documentation by calling a URL, and the help system |
application accesses the documentation |
| 72 |
is shown in their web browser. The infocenter help system can be used both for |
by calling a URL, and the help system is shown in their web browser. The |
| 73 |
client applications and for web applications, either of which can have their |
infocenter help system can be used both for client applications and for web |
| 74 |
help accessed remotely. All features except infopops and active help are |
applications, either of which can have their help accessed remotely. All |
| 75 |
supported.</P></LI></OL> |
features except infopops and active help are supported.</p></li> |
| 76 |
<P>Plug-ins that contribute documentation content ("doc plug-ins") created for |
</ol> |
| 77 |
one of these scenarios will work in any of the scenarios, without any revision |
<p>Plug-ins that contribute documentation content |
| 78 |
(although infopops and active help may not be supported by your UI).</P> |
("doc plug-ins") created for one of these scenarios will work in any of the |
| 79 |
<P><A href="file:///C:/temp/C.Notes.Data/v2overview.htm#top"><FONT |
scenarios, without any revision (although infopops and active help may not be |
| 80 |
size=1>Top</FONT></A></P> |
supported by your UI).</p> |
| 81 |
<H4><A name=nav></A>Navigation features</FONT></H4> |
<p><a href="#top"><font size="1">Top</font></a></p> |
| 82 |
<P>The help browser displays the navigation for the documentation in a frame on |
<h4><a name="nav"></a>Navigation features</font></h4> |
| 83 |
the left-hand side of the window.</P> |
<p>The help browser displays the navigation for the documentation in a frame on |
| 84 |
<UL> |
the left-hand side of the window.</p> |
| 85 |
<LI><B>Bookshelf</B> - The first view, called the bookshelf, contains links to |
<ul> |
| 86 |
|
<li><b>Bookshelf</b> - The first view, called the bookshelf, contains links to |
| 87 |
collections of online documentation. Clicking one of the links takes you to |
collections of online documentation. Clicking one of the links takes you to |
| 88 |
the navigation tree for that collection. |
the navigation tree for that collection. </li> |
| 89 |
<LI><B>Expand/collapse</B> - Browse by clicking the nodes to expand and |
<li><b>Expand/collapse</b> - Browse by clicking the nodes to expand and |
| 90 |
collapse the tree, and to display topic content in the right-hand frame. |
collapse the tree, and to display topic content in the right-hand frame.</li> |
| 91 |
<LI><B>Toggle navigation - </B>A toolbar button allows you to hide or show the |
<li><b>Toggle navigation - </b>A toolbar button allows you to hide or show the |
| 92 |
navigation frame. |
navigation frame. </li> |
| 93 |
<LI><B>Synchronize</B> - Another button allows you to synchronize the |
<li><b>Synchronize</b> - Another button allows you to synchronize the |
| 94 |
navigation up with the current topic; this is useful when you have followed a |
navigation up with the current topic; this is useful when you have followed a |
| 95 |
link in the topic and want to see where the new topic falls within the |
link in the topic and want to see where the new topic falls within the |
| 96 |
navigation tree. </LI></UL> |
navigation tree.</li> |
| 97 |
<P>The navigation trees are created with XML, following the help system's TOC |
</ul> |
| 98 |
|
<p>The navigation trees are created with XML, following the help system's TOC |
| 99 |
DTD which is available in drivers. The XML trees are essentially nested lists of |
DTD which is available in drivers. The XML trees are essentially nested lists of |
| 100 |
topic elements, each with an associated label and an optional href (a relative |
topic elements, each with an associated label and an optional href (a relative |
| 101 |
link to a content file). To form the whole navigation tree, merge together trees |
link to a content file). To form the whole navigation tree, merge together trees |
| 102 |
from individual plug-ins or XML files. You can build the tree in either a |
from individual plug-ins or XML files. You can build the tree in either a |
| 103 |
bottom-up or a top-down fashion:</P> |
bottom-up or a top-down fashion:</p> |
| 104 |
<UL> |
<ul> |
| 105 |
<LI><B>Bottom up</B> - Sub-trees indicate where they want to link to in the |
<li><b>Bottom up</b> - Sub-trees indicate where they want to link to in the |
| 106 |
parent tree; the parent tree provides anchor points for sub-trees to link to. |
parent tree; the parent tree provides anchor points for sub-trees to link to.</li> |
| 107 |
<LI><B>Top-down</B> - Parent trees pull in sub-trees by linking to them from |
<li><b>Top-down</b> - Parent trees pull in sub-trees by linking to them from |
| 108 |
the desired point in the tree. </LI></UL> |
the desired point in the tree.</li> |
| 109 |
<P><A href="file:///C:/temp/C.Notes.Data/v2overview.htm#top"><FONT |
</ul> |
| 110 |
size=1>Top</FONT></A></P> |
<p><a href="#top"><font size="1">Top</font></a></p> |
| 111 |
<H4><A name=content></A>Content features</FONT></H4> |
<h4><a name="content"></a>Content features</font></h4> |
| 112 |
<UL> |
<ul> |
| 113 |
<LI><B>Supported formats</B> - The content frame of the help browser will |
<li><b>Supported formats</b> - The content frame of the help browser will |
| 114 |
display any content format supported by the base browser (see <A |
display any content format supported by the base browser (see |
| 115 |
href="file:///C:/temp/C.Notes.Data/v2overview.htm#browser">Browser |
<a href="#browser">Browser Support</a>). We recommend using HTML, since search |
| 116 |
Support</A>). We recommend using HTML, since search supports it. However, you |
supports it. However, you can display PDF, XML (provided correct style sheets, |
| 117 |
can display PDF, XML (provided correct style sheets, XSL, plug-ins, or other |
XSL, plug-ins, or other client rendering technology is present), and so on.</li> |
| 118 |
client rendering technology is present), and so on. |
<li><b>Printing</b> - A toolbar button lets you print the selected topic to a |
| 119 |
<LI><B>Printing</B> - A toolbar button lets you print the selected topic to a |
printer of your choice.</li> |
| 120 |
printer of your choice. |
<li><b>Packaging</b> - In a documentation plug-in content can be packaged in a |
|
<LI><B>Packaging</B> - In a documentation plug-in content can be packaged in a |
|
| 121 |
compressed zip file called doc.zip (with subdirectories, if desired). The help |
compressed zip file called doc.zip (with subdirectories, if desired). The help |
| 122 |
system treats any file in doc.zip as though it were unzipped in the plug-in |
system treats any file in doc.zip as though it were unzipped in the plug-in |
| 123 |
directory. </LI></UL> |
directory.</li> |
| 124 |
<P><A href="file:///C:/temp/C.Notes.Data/v2overview.htm#top"><FONT |
</ul> |
| 125 |
size=1>Top</FONT></A></P> |
<p><a href="#top"><font size="1">Top</font></a></p> |
| 126 |
<H4><A name=search></A>Search features</FONT></H4> |
<h4><a name="search"></a>Search features</font></h4> |
| 127 |
<P>The Eclipse help system provides search functionality via the Lucene search |
<p>The Eclipse help system provides search functionality via the Lucene search |
| 128 |
engine and a front end that is specific to the Eclipse help system. Information |
engine and a front end that is specific to the Eclipse help system. Information about the |
| 129 |
about the engine is available at <A |
engine is available at <a href="http://www.lucene.com">www.lucene.com</a>. |
| 130 |
href="http://www.lucene.com/">http://www.lucene.com/</A>. Eclipse makes no |
Eclipse makes no modifications to the Lucene code, but provides a front end and |
| 131 |
modifications to the Lucene code, but provides a front end and other |
other functionality though extensions.</p> |
| 132 |
functionality though extensions.</P> |
<ul> |
| 133 |
<UL> |
<li><b>Integration with the workbench</b> - You can search help from within |
| 134 |
<LI><B>Integration with the workbench</B> - You can search help from within |
the workbench. Click the flashlight toolbar button, or <b>Edit > Search</b>; |
| 135 |
the workbench. Click the flashlight toolbar button, or <B>Edit > |
then select the <b>Help Search</b> tab. Results are shown in the Search view. |
| 136 |
Search</B>; then select the <B>Help Search</B> tab. Results are shown in the |
Double-click one of the results to open the help browsers to the Search |
| 137 |
Search view. Double-click one of the results to open the help browsers to the |
Results view and the topic.</li> |
| 138 |
Search Results view and the topic. |
<li><b>In the help system browser</b> - The basic search field is placed in |
| 139 |
<LI><B>In the help system browser</B> - The basic search field is placed in |
the banner, so it is always visible.</li> |
| 140 |
the banner, so it is always visible. |
<li><b>Advanced options</b> - Advanced searching options are available by |
|
<LI><B>Advanced options</B> - Advanced searching options are available by |
|
| 141 |
clicking the Advanced link near the search field. In the workbench search, the |
clicking the Advanced link near the search field. In the workbench search, the |
| 142 |
options are available right on the Help Search page. Advanced search |
options are available right on the Help Search page. Advanced search |
| 143 |
functionality includes: |
functionality includes:<ul> |
| 144 |
<UL> |
<li><b>Boolean searches </b>- use AND, OR, and binary NOT</li> |
| 145 |
<LI><B>Boolean searches </B>- use AND, OR, and binary NOT |
<li><b>Exact string searches</b> - use double-quotation marks</li> |
| 146 |
<LI><B>Exact string searches</B> - use double-quotation marks |
<li><b>Wildcards</b> - use * for any string or ? for any character</li> |
| 147 |
<LI><B>Wildcards</B> - use * for any string or ? for any character |
<li><b>Filtering by book</b> - select which documentation collections (as |
| 148 |
<LI><B>Filtering by book</B> - select which documentation collections (as |
shown on the bookshelf) you want to search in</li> |
| 149 |
shown on the bookshelf) you want to search in </LI></UL> |
</ul> |
| 150 |
<LI><B>Case-insensitive </B>- can be changed by providing a case sensitive |
</li> |
| 151 |
extension point. |
<li><b>Case-insensitive </b>- can be changed by providing a case sensitive |
| 152 |
<LI><B>Stemming </B>- For example, finds "compiling" if you enter "compile". |
extension point.</li> |
| 153 |
|
<li><b>Stemming </b>- For example, finds "compiling" if you enter "compile". |
| 154 |
Stemming is provided for English and German, with the ability to add it for |
Stemming is provided for English and German, with the ability to add it for |
| 155 |
more languages via extension points. |
more languages via extension points.</li> |
| 156 |
<LI><B>Stop words</B> - For example, ignores words like "a" and "the" in your |
<li><b>Stop words</b> - For example, ignores words like "a" and "the" in your |
| 157 |
query. Stop words are provided for English and German, with the ability to add |
query. Stop words are provided for English and German, with the ability to add |
| 158 |
it for more languages via extension points. |
it for more languages via extension points.</li> |
| 159 |
<LI><B>Results </B>- The results view lists the title tags from the HTML files |
<li><b>Results </b>- The results view lists the title tags from the HTML files |
| 160 |
that contain the first 500 hits. |
that contain the first 500 hits.</li> |
| 161 |
<LI><B>Ranking </B>- the search engine determines the relative ranking of the |
<li><b>Ranking </b>- the search engine determines the relative ranking of the |
| 162 |
hits by using a complex algorithm based on number of hits, the length of the |
hits by using a complex algorithm based on number of hits, the length of the |
| 163 |
file, and whether there are hits in the title tag. The ranking is shown in the |
file, and whether there are hits in the title tag. The ranking is shown in the |
| 164 |
results list in terms of a percentage. |
results list in terms of a percentage.</li> |
| 165 |
<LI><B>Highlighting</B> - For straightforward queries, search term hits are |
<li><b>Highlighting</b> - For straightforward queries, search term hits are |
| 166 |
highlighted in the topic contents. </LI></UL> |
highlighted in the topic contents.</li> |
| 167 |
<P>From an exploiting product's standpoint, there is no effort involved in |
</ul> |
| 168 |
|
<p>From an exploiting product's standpoint, there is no effort involved in |
| 169 |
getting search to work. The search engine and UI are packaged as plug-ins. |
getting search to work. The search engine and UI are packaged as plug-ins. |
| 170 |
Indexes are generated the first time the user runs a search. You also have the |
Indexes are generated the first time the user runs a search. You also have the |
| 171 |
option of pre-generating indexes so that they are available the first time |
option of pre-generating indexes so that they are available the first time |
| 172 |
search is used (this is particularly useful in the infocenter scenario). Indexes |
search is used (this is particularly useful in the infocenter scenario). Indexes |
| 173 |
are re-generated each time a documentation plug-in is added or removed. |
are re-generated each time a documentation plug-in is added or removed. |
| 174 |
First-use generation performance is satisfactory for several hundred topics. You |
First-use generation performance is satisfactory for several hundred topics. You |
| 175 |
may want to test if you will be using many more topics.</P> |
may want to test if you will be using many more topics.</p> |
| 176 |
<P>The search engine currently searches only HTML. Also, only those topics which |
<p>The search engine currently searches only HTML. Also, only those topics which |
| 177 |
appear in the navigation tree will be indexed.</P> |
appear in the navigation tree will be indexed.</p> |
| 178 |
<P><A href="file:///C:/temp/C.Notes.Data/v2overview.htm#top"><FONT |
<p><a href="#top"><font size="1">Top</font></a></p> |
| 179 |
size=1>Top</FONT></A></P> |
<h4><a name="infopop"></a>Context-sensitive help features</font></h4> |
| 180 |
<H4><A name=infopop></A>Context-sensitive help features</FONT></H4> |
<ol> |
| 181 |
<OL> |
<li><b>Infopops (integrated scenario only)</b><p>An infopop is a small, |
| 182 |
<LI><B>Infopops (integrated scenario only)</B> |
light-weight box that contains a description of a UI widget, and links to |
| 183 |
<P>An infopop is a small, light-weight box that contains a description of a UI |
related topics. To launch an infopop, put focus on the widget (either by |
| 184 |
widget, and links to related topics. To launch an infopop, put focus on the |
clicking on it, putting the cursor in it, or pressing Tab until the focus |
| 185 |
widget (either by clicking on it, putting the cursor in it, or pressing Tab |
indicator is on it), and press F1. If you want more information than what is |
| 186 |
until the focus indicator is on it), and press F1. If you want more |
provided in the description, click one of the links. This will open the help |
| 187 |
information than what is provided in the description, click one of the links. |
browser to the Links view and the topic you clicked; the other links from the |
| 188 |
This will open the help browser to the Links view and the topic you clicked; |
infopop will be listed. </p> |
| 189 |
the other links from the infopop will be listed. </P> |
<p>The UI developer must assign a context ID to each widget that needs an |
|
<P>The UI developer must assign a context ID to each widget that needs an |
|
| 190 |
infopop. This context ID associates the widget with its infopop content. You |
infopop. This context ID associates the widget with its infopop content. You |
| 191 |
can register the following kinds of objects for infopops: |
can register the following kinds of objects for infopops:<ul> |
| 192 |
<UL> |
<li>Control objects, and those that inherit from Control</li> |
| 193 |
<LI>Control objects, and those that inherit from Control |
<li>IAction </li> |
| 194 |
<LI>IAction |
<li>Menu and MenuItem</li> |
| 195 |
<LI>Menu and MenuItem </LI></UL> |
</ul> |
| 196 |
<P>Infopop content is written in XML, following the Contexts DTD, which is |
<p>Infopop content is written in XML, following the Contexts DTD, which is |
| 197 |
available in drivers. For each context ID there is a description and |
available in drivers. For each context ID there is a description and |
| 198 |
optionally one or more links. The XML files containing infopop content can be |
optionally one or more links. The XML files containing infopop content can be |
| 199 |
packaged in the code plug-in that also contains the UI objects it describes, |
packaged in the code plug-in that also contains the UI objects it describes, |
| 200 |
or it can be packaged in another plug-in.</P> |
or it can be packaged in another plug-in.</p> |
| 201 |
<P>You can define infopop content for a particular context ID in more than one |
<p>You can define infopop content for a particular context ID in more than one |
| 202 |
XML file, in more than one plug-in. When an infopop is displayed, content |
XML file, in more than one plug-in. When an infopop is displayed, content |
| 203 |
defined in the code plug-in itself is listed first; additional descriptions |
defined in the code plug-in itself is listed first; additional descriptions |
| 204 |
and links, if any, are appended to the first set.<BR> </P> |
and links, if any, are appended to the first set.<br> |
| 205 |
<LI><B>Launching the help system (integrated, stand-alone, and infocenter)</B> |
</li> |
| 206 |
<P>Any user interface can launch the help browser by calling a help system |
<li><b>Launching the help system (integrated, stand-alone, and |
| 207 |
API. This API can take a topic href as an attribute and thus open the browser |
infocenter)</b><p>Any user interface can launch the help browser by calling a |
| 208 |
to that topic. |
help system API. This API can take a topic href as an attribute and thus open |
| 209 |
<P>Also, it may be launched by running an executable, which can also take a |
the browser to that topic. <p>Also, it may be launched by running an |
| 210 |
URL as a parameter; this lets you set up launch points from the desktop or the |
executable, which can also take a URL as a parameter; this lets you set up |
| 211 |
Windows Start menu, and so on. </P></LI></OL> |
launch points from the desktop or the Windows Start menu, and so on.</li> |
| 212 |
<P><A href="file:///C:/temp/C.Notes.Data/v2overview.htm#top"><FONT |
</ol> |
| 213 |
size=1>Top</FONT></A></P> |
<p><a href="#top"><font size="1">Top</font></a></p> |
| 214 |
<H4><A name=activehelp></A>Active help features</FONT></H4> |
<h4><a name="activehelp"></a>Active help features</font></h4> |
| 215 |
<P>In the integrated scenario, a documentation topic can contain a special link |
<p>In the integrated scenario, a documentation topic can contain a special link |
| 216 |
that calls a class from the workbench. Using this, the user can launch workbench |
that calls a class from the workbench. Using this, the user can launch workbench |
| 217 |
actions from the documentation. For example, consider a topic called "Importing |
actions from the documentation. For example, consider a topic called "Importing |
| 218 |
external plug-ins". Instead of telling the user to go to the workbench and |
external plug-ins". Instead of telling the user to go to the workbench and |
| 219 |
select <B>File > Import</B>, and then select <B>External Plug-ins and |
select <b>File > Import</b>, and then select <b>External Plug-ins and Fragments |
| 220 |
Fragments </B>and click <B>Next</B>, the topic could simply say "Click here to |
</b>and click <b>Next</b>, the topic could simply say "Click here to open the <b> |
| 221 |
open the <B>Import External Fragments</B> wizard." The link would call a class |
Import External Fragments</b> wizard." The link would call a class you have |
| 222 |
you have defined, which in turn would open that wizard to that page.</P> |
defined, which in turn would open that wizard to that page.</p> |
| 223 |
<P><A href="file:///C:/temp/C.Notes.Data/v2overview.htm#top"><FONT |
<p><a href="#top"><font size="1">Top</font></a></p> |
| 224 |
size=1>Top</FONT></A></P> |
<h4><a name="platform"></a>Platform support</font></h4> |
| 225 |
<H4><A name=platform></A>Platform support</FONT></H4> |
<p>The help system will be available on:</font></p> |
| 226 |
<P>The help system will be available on:</FONT></P> |
<ul> |
| 227 |
<UL> |
<li>Windows XP, Windows 2000, Windows 98SE*, |
| 228 |
<LI>Windows XP, Windows 2000, Windows 98SE*, Windows NT*, Windows ME*</FONT> |
Windows NT*, Windows ME*</font></li> |
| 229 |
<LI>Redhat Linux 7.2 on x86, SuSE Linux 7.3 on x86</FONT> |
<li>Redhat Linux 7.2 on x86, SuSE Linux 7.3 on x86</font></li> |
| 230 |
<LI>Sun Solaris 8 on SPARC</FONT> |
<li>Sun Solaris 8 on SPARC</font></li> |
| 231 |
<LI>HP-UX 11i on hp9000</FONT> |
<li>HP-UX 11i on hp9000</font></li> |
| 232 |
<LI>IBM AIX 5.1 on PowerPC</FONT> </LI></UL> |
<li>IBM AIX 5.1 on PowerPC</font></li> |
| 233 |
<P>*secondary testing status</FONT></P> |
</ul> |
| 234 |
<P><A href="file:///C:/temp/C.Notes.Data/v2overview.htm#top"><FONT |
<p>*secondary testing status</font></p> |
| 235 |
size=1>Top</FONT></A></P> |
<p><a href="#top"><font size="1">Top</font></a></p> |
| 236 |
<H4><A name=browser></A>Browser support</H4> |
<h4><a name="browser"></a>Browser support</h4> |
| 237 |
<P>The help system displays online documentation inside an HTML viewer provided |
<p>The help system displays online documentation inside an HTML viewer provided |
| 238 |
by a Web browser. The standard browsers, such as Internet Explorer, Mozilla, |
by a Web browser. The standard browsers, such as Internet Explorer, Mozilla, |
| 239 |
Netscape, are pluggable into the help system, but require an adapter. The |
Netscape, are pluggable into the help system, but require an adapter. The |
| 240 |
Eclipse help system provides one adapter for each platform, as shown below. |
Eclipse help system provides one adapter for each platform, as shown below. |
| 241 |
These adapters are for the system browsers shipped with the OS, except for |
These adapters are for the system browsers shipped with the OS, except for |
| 242 |
Windows NT where IE must be upgraded to at least v5. </P> |
Windows NT where IE must be upgraded to at least v5. </p> |
| 243 |
<TABLE style="BORDER-COLLAPSE: collapse" borderColor=#111111 cellSpacing=0 |
<table border="1" cellpadding="0" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="300"> |
| 244 |
cellPadding=0 width=300 border=1> |
<tr> |
| 245 |
<TBODY> |
<th width="50%">Platform</th> |
| 246 |
<TR> |
<th width="50%">Browser adapter supplied</th> |
| 247 |
<TH width="50%">Platform</TH> |
</tr> |
| 248 |
<TH width="50%">Browser adapter supplied</TH></TR> |
<tr> |
| 249 |
<TR> |
<td width="50%">Windows XP</td> |
| 250 |
<TD width="50%">Windows XP</TD> |
<td width="50%">Internet Explorer 6</td> |
| 251 |
<TD width="50%">Internet Explorer 6</TD></TR> |
</tr> |
| 252 |
<TR> |
<tr> |
| 253 |
<TD width="50%">Windows 2000</TD> |
<td width="50%">Windows 2000</td> |
| 254 |
<TD width="50%">Internet Explorer 5</TD></TR> |
<td width="50%">Internet Explorer 5</td> |
| 255 |
<TR> |
</tr> |
| 256 |
<TD width="50%">Windows 98SE</TD> |
<tr> |
| 257 |
<TD width="50%">Internet Explorer 5</TD></TR> |
<td width="50%">Windows 98SE</td> |
| 258 |
<TR> |
<td width="50%">Internet Explorer 5</td> |
| 259 |
<TD width="50%">Windows NT</TD> |
</tr> |
| 260 |
<TD width="50%">Internet Explorer 5+</TD></TR> |
<tr> |
| 261 |
<TR> |
<td width="50%">Windows NT</td> |
| 262 |
<TD width="50%">Windows ME</TD> |
<td width="50%">Internet Explorer 5+</td> |
| 263 |
<TD width="50%">Internet Explorer 5.5</TD></TR> |
</tr> |
| 264 |
<TR> |
<tr> |
| 265 |
<TD width="50%">Redhat Linux 7.2</TD> |
<td width="50%">Windows ME</td> |
| 266 |
<TD width="50%">Mozilla 0.9 or greater</TD></TR> |
<td width="50%">Internet Explorer 5.5</td> |
| 267 |
<TR> |
</tr> |
| 268 |
<TD width="50%">SuSE Linux 7.3</TD> |
<tr> |
| 269 |
<TD width="50%">Mozilla 0.9 or greater</TD></TR> |
<td width="50%">Redhat Linux 7.2</td> |
| 270 |
<TR> |
<td width="50%">Mozilla 0.9 or greater</td> |
| 271 |
<TD width="50%">Sun Solaris 8</TD> |
</tr> |
| 272 |
<TD width="50%">Netscape 4.7</TD></TR> |
<tr> |
| 273 |
<TR> |
<td width="50%">SuSE Linux 7.3</td> |
| 274 |
<TD width="50%">HP-UX 11i</TD> |
<td width="50%">Mozilla 0.9 or greater</td> |
| 275 |
<TD width="50%">Netscape 4.x</TD></TR> |
</tr> |
| 276 |
<TR> |
<tr> |
| 277 |
<TD width="50%">AIX 5.1</TD> |
<td width="50%">Sun Solaris 8</td> |
| 278 |
<TD width="50%">Netscape 4.x</TD></TR></TBODY></TABLE> |
<td width="50%">Netscape 4.7</td> |
| 279 |
<P>For additional information about plans and restrictions, see <A |
</tr> |
| 280 |
href="http://dev.eclipse.org/viewcvs/index.cgi/~checkout~/platform-help-home/eclipse_project_plan_2_0_supported_browsers.html">Supported |
<tr> |
| 281 |
Browsers in Eclipse V2</A>.</P> |
<td width="50%">HP-UX 11i</td> |
| 282 |
<P>The help system displays better in Mozilla, and best in Internet Explorer. |
<td width="50%">Netscape 4.x</td> |
| 283 |
</P> |
</tr> |
| 284 |
<P>We recommend you work with and require the browsers listed above. If you want |
<tr> |
| 285 |
|
<td width="50%">AIX 5.1</td> |
| 286 |
|
<td width="50%">Netscape 4.x</td> |
| 287 |
|
</tr> |
| 288 |
|
</table> |
| 289 |
|
<p>For additional information about plans and restrictions, see |
| 290 |
|
<a href="http://dev.eclipse.org/viewcvs/index.cgi/~checkout~/platform-help-home/eclipse_project_plan_2_0_supported_browsers.html"> |
| 291 |
|
Supported Browsers in Eclipse V2</a>.</p> |
| 292 |
|
<p>The help system displays better in Mozilla, and best in Internet Explorer. |
| 293 |
|
</p> |
| 294 |
|
<p>We recommend you work with and require the browsers listed above. If you want |
| 295 |
your users to use a browser other than the ones listed above, you must ensure |
your users to use a browser other than the ones listed above, you must ensure |
| 296 |
that it is available on their platform (i.e., you may have to get them to |
that it is available on their platform (i.e., you may have to get them to |
| 297 |
install a browser that didn't come with their OS), and you must supply your own |
install a browser that didn't come with their OS), and you must supply your own |
| 298 |
adapter.</P> |
adapter.</p> |
| 299 |
<P><B>Integrated scenario</B></P> |
<p><b>Integrated scenario</b></p> |
| 300 |
<P>There is a Help preferences page that lets the user choose from the available |
<p>There is a Help preferences page that lets the user choose from the available |
| 301 |
browser adapters to select which browser they prefer to view help in.</P> |
browser adapters to select which browser they prefer to view help in.</p> |
| 302 |
<P><B>Stand-alone scenario</B></P> |
<p><b>Stand-alone scenario</b></p> |
| 303 |
<P>If you want to allow users to select among browsers (if more than one adapter |
<p>If you want to allow users to select among browsers (if more than one adapter |
| 304 |
is available), you must provide your own UI for doing this.</P> |
is available), you must provide your own UI for doing this.</p> |
| 305 |
<P><B>Infocenter scenario</B></P> |
<p><b>Infocenter scenario</b></p> |
| 306 |
<P>In this scenario, the Web browser <I>is</I> the help browser. It's |
<p>In this scenario, the Web browser <i>is</i> the help browser. It's |
| 307 |
recommended that you use one of the supported browsers (listed above).</P> |
recommended that you use one of the supported browsers (listed above).</p> |
| 308 |
<P><A href="file:///C:/temp/C.Notes.Data/v2overview.htm#top"><FONT |
<p><a href="#top"><font size="1">Top</font></a></p> |
| 309 |
size=1>Top</FONT></A></P> |
<h4><a name="language"></a>Language support</font></h4> |
| 310 |
<H4><A name=language></A>Language support</FONT></H4> |
<p>The help system fully supports Latin-1 locales |
| 311 |
<P>The help system fully supports Latin-1 locales and, on Windows platforms, |
and, on Windows platforms, DBCS locales. The help system will also display BiDi |
| 312 |
DBCS locales. The help system will also display BiDi navigation and |
navigation and content.</font></p> |
| 313 |
content.</FONT></P> |
<p><a href="#top"><font size="1">Top</font></a></p> |
| 314 |
<P><A href="file:///C:/temp/C.Notes.Data/v2overview.htm#top"><FONT |
<h4><a name="access"></a>Accessibility support</font></h4> |
| 315 |
size=1>Top</FONT></A></P> |
<ul> |
| 316 |
<H4><A name=access></A>Accessibility support</FONT></H4> |
<li>uses system colors</li> |
| 317 |
<UL> |
<li>uses browser's accessibility support</li> |
| 318 |
<LI>uses system colors |
<li>can navigate using only the keyboard</li> |
| 319 |
<LI>uses browser's accessibility support |
</ul> |
| 320 |
<LI>can navigate using only the keyboard </LI></UL> |
<p><a href="#top"><font size="1">Top</font></a></p> |
| 321 |
<P><A href="file:///C:/temp/C.Notes.Data/v2overview.htm#top"><FONT |
<h4><a name="compatibility"></a>Compatibility with previous release</font></h4> |
| 322 |
size=1>Top</FONT></A></P> |
<p>The design for help content (doc.zip) and infopop |
| 323 |
<H4><A name=compatibility></A>Compatibility with previous release</FONT></H4> |
content has not changed since V1. However, the name of the extension point for help |
| 324 |
<P>The design for help content (doc.zip) and infopop content has not changed |
contributions has changed, and the XML for creating and merging navigation |
| 325 |
since V1. However, the name of the extension point for help contributions has |
TOC trees has been simplified. This means that plugin.xml and all navigation XML files will need |
| 326 |
changed, and the XML for creating and merging navigation TOC trees has been |
a moderate amount of re-writing.</font> V1-level navigation is not supported.</p> |
| 327 |
simplified. This means that plugin.xml and all navigation XML files will need a |
<p>Also, support for nested contexts and context |
| 328 |
moderate amount of re-writing.</FONT> V1-level navigation is not supported.</P> |
computers for infopops has been removed, meaning that code that registers UI |
| 329 |
<P>Also, support for nested contexts and context computers for infopops has been |
objects via arrays or context computers will have to be changed.</font></p> |
| 330 |
removed, meaning that code that registers UI objects via arrays or context |
<p>Also, support has been removed for putting |
| 331 |
computers will have to be changed.</FONT></P> |
translatable strings from the XML into doc.properties and context.properties. |
| 332 |
<P>Also, support has been removed for putting translatable strings from the XML |
Translatable strings must remain in the XML.</font></p> |
| 333 |
into doc.properties and context.properties. Translatable strings must remain in |
|
| 334 |
the XML.</FONT></P> |
<p><a href="#top"><font size="1">Top</font></a></p> |
| 335 |
<P><A href="file:///C:/temp/C.Notes.Data/v2overview.htm#top"><FONT |
|
| 336 |
size=1>Top</FONT></A></P></BODY></HTML> |
</body> |
| 337 |
|
|
| 338 |
|
</html> |
Parent Directory
| 
Revision Log
| 
Patch