platform-help-home/v2overview.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.4, Mon Apr 1 16:21:18 2002 UTC revision 1.5, Fri Apr 5 16:34:34 2002 UTC
# Line 123  Line 123 
123    directory.</li>    directory.</li>
124  </ul>  </ul>
125  <p><a href="#top"><font 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</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 about the  engine and a front end that is specific to the Eclipse help system. Information
129  engine is available at <a href="http://www.lucene.com">www.lucene.com</a>.  about the engine is available at <a
130  Eclipse makes no modifications to the Lucene code, but provides a front end and  href="http://www.lucene.com/">http://www.lucene.com/</a>. Eclipse makes no
131  other functionality though extensions.</p>  modifications to the Lucene code, but provides a front end and other
132    functionality.</P>
133  <ul>  <ul>
134    <li><b>Integration with the workbench</b> - You can search help from within    <li><b>Integration with the workbench</b> - You can search help from within
135    the workbench. Click the flashlight toolbar button, or <b>Edit &gt; Search</b>;    the workbench. Click the flashlight toolbar button, or <b>Edit &gt;
136    then select the <b>Help Search</b> tab. Results are shown in the Search view.    Search</b>; then select the <b>Help Search</b> tab. Results are shown in the
137    Double-click one of the results to open the help browsers to the Search    Search view. Double-click one of the results to open the help browsers to the
138    Results view and the topic.</li>    Search Results view and the topic.
139    <li><b>In the help system browser</b> - The basic search field is placed in    <li><b>In the help system browser</b> - The basic search field is placed in
140    the banner, so it is always visible.</li>    the banner, so it is always visible.
141    <li><b>Advanced options</b> - Advanced searching options are available by    <li><b>Advanced options</b> - Advanced searching options are available by
142    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
143    options are available right on the Help Search page. Advanced search    options are available right on the Help Search page. Advanced search
144    functionality includes:<ul>    functionality includes:
145    <li><b>Boolean searches </b>- use AND, OR, and binary NOT</li>    <ul>
146    <li><b>Exact string searches</b> - use double-quotation marks</li>      <li><b>Boolean searches </b>- use AND, OR, and binary NOT
147    <li><b>Wildcards</b> - use * for any string or ? for any character</li>      <li><b>Phrase searches</b> - use double-quotation marks
148        <li><b>Wildcards</b> - use * for any string or ? for any character
149    <li><b>Filtering by book</b> - select which documentation collections (as    <li><b>Filtering by book</b> - select which documentation collections (as
150    shown on the bookshelf) you want to search in</li>      shown on the bookshelf) you want to search in </li></ul>
 </ul>  
   </li>  
   <li><b>Case-insensitive </b>- can be changed by providing a case sensitive  
   extension point.</li>  
   <li><b>Stemming </b>- For example, finds &quot;compiling&quot; if you enter &quot;compile&quot;.  
   Stemming is provided for English and German, with the ability to add it for  
   more languages via extension points.</li>  
   <li><b>Stop words</b> - For example, ignores words like &quot;a&quot; and &quot;the&quot; in your  
   query. Stop words are provided for English and German, with the ability to add  
   it for more languages via extension points.</li>  
151    <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
152    that contain the first 500 hits.</li>    that contain the first 500 hits.
153    <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
154    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
155    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
156    results list in terms of a percentage.</li>    results list in terms of a percentage.
157    <li><b>Highlighting</b> - For straightforward queries, search term hits are    <li><b>Highlighting</b> - For straightforward queries, search term hits are
158    highlighted in the topic contents.</li>    highlighted in the topic contents. </li></ul>
159  </ul>  
160    <p>Some aspects of search can be controlled by language analyzers that can be
161    provided through extension for every language. English and German analyzers are
162    provided. They offer very high quality searches by performing the following:
163    
164    <ul>
165      <li><b>Lower-case conversion </b>- results in case-insensitive search.
166      <li><b>Stemming</b> - For example,
167      if you enter &quot;compile&quot;, the search finds &quot;compiling&quot;.&nbsp;
168      <li><b>Stop word removal</b> - For example, search ignores words like &quot;a&quot; and
169      &quot;the&quot; in your query.
170      </ul>
171    <p>If no analyzer is provided for a particular language, a simple default
172    analyzer will be used. Words composed of English characters or digits can still
173    be found.</p>
174  <p>From an exploiting product's standpoint, there is no effort involved in  <p>From an exploiting product's standpoint, there is no effort involved in
175  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.
176  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
# Line 175  Line 181 
181  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>
182  <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
183  appear in the navigation tree will be indexed.</p>  appear in the navigation tree will be indexed.</p>
184  <p><a href="#top"><font size="1">Top</font></a></p>  <p><a href="#top"><font size=1>Top</font></a></p>
185  <h4><a name="infopop"></a>Context-sensitive help features</font></h4>  <h4><a name="infopop"></a>Context-sensitive help features</font></h4>
186  <ol>  <ol>
187    <li><b>Infopops (integrated scenario only)</b><p>An infopop is a small,    <li><b>Infopops (integrated scenario only)</b><p>An infopop is a small,
Legend:
Removed from v.1.4  
changed lines
  Added in v.1.5