1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 2<html lang="en"> 3<head> 4<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2011. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > 5<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> 6<meta http-equiv="Content-Style-Type" content="text/css"> 7<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css"> 8<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"> </script> 9<title>Searching help</title> 10</head> 11<body> 12 13<h2>Searching help</h2> 14 15<p> 16The help system includes a search engine that can run simple or complex queries 17on the documentation to help you find the information you are looking for. 18</p> 19 20<p> 21To search help: 22</p> 23 24<ol> 25 <li>From the main menu, select <strong>Help > Search</strong></li> 26 <li>Type in the word or phrase for which you want to search</li> 27 <li>Click <strong>GO</strong> or press Enter. The list of results will be 28 displayed below</li> 29 <li>To view the content of a topic in the list of results, click on it</li> 30</ol> 31 32<p> 33Alternatively, you can search from the Help window using the <em>Search</em> 34field at the top of the window. 35</p> 36 37<h3>Refining the search results in the help view</h3> 38 39<p> 40If the search yields too many results, the information you are looking for may 41not appear in the top 10 or 15 results. You can then refine the search to reduce 42the number of results. 43</p> 44 45<p> 46To refine a search: 47</p> 48 49<ol> 50 <li>Click the <strong>Search Scope</strong> link. to expand search scope 51 section</li> 52 <li>Click on the <strong>Advanced Settings</strong> link. The Search Scope 53 preference dialog will open</li> 54 <li>Select <strong>Local Help</strong> from the list</li> 55 <li>Select the <strong>Search only the following topics</strong> button to 56 narrow down the search scope</li> 57 <li>In the working set content tree, select the topics to which you want to 58 narrow the search</li> 59 <li>Click <strong>OK</strong> to activate the changes and return to search 60 page in the Help view</li> 61 <li>Click <strong>GO</strong> again. The new list of results will appear</li> 62</ol> 63 64<p>Changing the appearance of the results</p> 65<p>Two buttons on the toolbar can be used to change the way results are 66displayed. The <img border="0" src="../images/e_show_categories.svg" 67alt="Show result categories" > <b>Show result categories</b> button, 68when pressed, will cause the results to be grouped by book. The 69<img border="0" src="../images/e_show_descriptions.svg" alt="Show result descriptions" > 70<b>Show result descriptions</b> button, when pressed, causes descriptions to show. </p> 71 72<h3>Highlighting Search Terms</h3> 73 74<p> 75By default, when a search result is selected, the search terms that were used 76to find the document will be highlighted. By using the <img 77src="../images/highlight.svg" alt="Highlight Search Terms" border="0"> 78<b>Highlight Search Terms</b> toolbar button, you can toggle this feature on and 79off. This button is available in both the help window and the help view and each 80will remember the state of the button for displaying subsequent search results. 81</p> 82 83<h3>Query syntax</h3> 84 85<p> 86Follow the following search expression rules for searching local help content: 87</p> 88 89<ul> 90 <li>Unless otherwise stated, there is an implied AND between all search terms. 91 In other words, topics that contain all the search terms will be returned. 92 For example: 93 <pre>Java project</pre> 94 <p>returns topics that contain the word <i>Java</i> and the word <i>project</i>, 95 but does not return topics that contain only one of these words.</p></li> 96 <li>Use OR before optional terms . For example: 97 <pre>applet OR application</pre> 98 <p>returns topics that contain the word <i>applet</i> or the word <i>application</i> 99 (or both).</p></li> 100 <li>Use NOT before terms you want to exclude from search results. For example: 101 <pre>servlet NOT ejb</pre> 102 <p>returns topics that contain the word <i>servlet</i> and do not contain 103 the word <i>ejb</i>. <b>Note:</b> NOT only works as a binary operator (that 104 is, "NOT servlet" is not a valid expression).</p></li> 105 <li>Use ? for a single-character wildcard and * for a multi-character wildcard. 106 For example: 107 <pre>par?</pre> 108 <p>returns topics that contain <i>part</i> or <i>park</i>, but not <i> participate</i>. 109 On the other hand:</p> 110 <pre>par*</pre> 111 <p>returns topics that contain <i>part</i>, <i>park</i>, <i>participate</i>, 112 <i>pardon</i>, and so on. <b>Note:</b> The search engine does not accept 113 terms with a wild card at first character position.</p></li> 114 <li>Use double quotation marks around terms you want treated as a phrase. For 115 example: 116 <pre>"creating projects"</pre> 117 <p>returns topics that contain the entire phrase <i>creating projects</i>. 118 Topics where the words <i>creating</i> and <i>projects</i> are not consecutive are not returned.</p></li> 119 <li>Punctuation acts as term delimiters. For example: 120 <pre>plugin.xml</pre> 121 <p>returns hits on topics that contain <i>plugin</i> and 122 <i>xml</i>, which is likely broader than you want. If you want to find just 123 those topics containing <i>plugin.xml</i>, use double quotes, as in:</p> 124 <pre>"plugin.xml"</pre></li> 125 <li>The search engine ignores character case. For example: 126 <pre>Workbench</pre> 127 <p>returns topics that contain 'workbench', 'Workbench', 'WorkBench', and 128 'WORKBENCH'.</p></li> 129 <li>The following stop words are common English words which will be ignored 130 (not searched for) if they appear in the search expression: a, and, are, as, 131 at, be, but, by, in, into, is, it, no, not, of, on, or, s, such, t, that, 132 the, their, then, there, these, they, to, was, will, with.</li> 133 <li>The search engine does "fuzzy" searches and word stemming. If 134 you enter <i>create</i>, it will return hits on topics that contain <i>creates</i>, 135 <i>creating</i>, <i>creator</i>, and so on. To prevent search engine from stemming 136 terms, enclose them in double quotes.</li> 137</ul> 138 139<h3>Extending the search scope</h3> 140 141<p>If you cannot locate information in the local help, you can extend search 142 scope to remote info-center or search engines.</p> 143<p>To enable search engines: </p> 144<ol> 145 <li>Click the <b>Search Scope </b> link. to expand search scope section. The 146 list of search engine is displayed.</li> 147 <li> Select the ones that contain information you are looking for.</li> 148</ol> 149<p>In addition to search engines provided, you may define additional search engines.</p> 150<p>To define a new search engine: </p> 151<ol> 152 <li>Click the <b>Search Scope </b> link. to expand search scope section. </li> 153 <li>Click the <b>Advanced Settings</b> link. Search Scope preference dialog 154 opens.</li> 155 <li>Click <b>New</b>.</li> 156 <li>Select the search engine type.</li> 157 <li>Click <strong>OK</strong>.</li> 158 <li>Provide a name and a description</li> 159 <li>Select engine specific settings and scope below. For the remote search 160 engines, accessed using URL, fill in a full URL to query the engine. Use <code>{expression}</code> in 161 the place of search expression.</li> 162</ol> 163 164<h3>Defining multiple search scopes</h3> 165 166<p>By default, changing search scope modifies the search scope named "default". 167 You can define multiple search scope. They will be saved, allowing to quickly 168 change search scope to one of them.</p> 169<p>To define a new search scope:</p> 170<ol> 171 <li>Click the current search scope name, beside the <b>Search Scope </b> link. 172 .Search Scope Sets dialog appears.</li> 173 <li>Click <strong>New</strong>.</li> 174 <li>Type a name, and confirm.</li> 175 <li>Select the newly created search scope.</li> 176 <li>Click <strong>OK</strong>. The new search scope becomes current.</li> 177</ol> 178<p>Changes to the search scope affect current search scope.</p> 179 180<h3>Search index generation</h3> 181 182<p>The first time you search the online help, the help system might initiate 183 an index-generation process. This process builds the indexes for the search 184 engine 185to use. It may take several minutes, depending on the amount of documentation 186 and whether prebuilt indexes are installed. Results of the search will be available 187 upon completion of the indexing process.</p> 188 189<p>Each time you add or modify the documentation set (for example, when you install 190a new feature or update an existing one), the index will be updated to reflect 191the new information set. 192</p> 193 194<h3 class="related">Related concepts</h3> 195<a href="../concepts/help.htm">Help</a><br> 196<a href="../concepts/help_view.htm">Help view</a> 197 198<h3 class="related">Related tasks</h3> 199<a href="help_navigate.htm">Navigating help topics</a> 200 201</body> 202</html>
