platform-help-home/v2overview.html

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

revision 1.6, Tue Mar 4 18:50:51 2003 UTC revision 1.7, Sat Mar 15 01:13:19 2003 UTC
# Line 67  Line 67 
67  &nbsp;</p></li>  &nbsp;</p></li>
68    <li><p><b>Infocenter (served)</font></b> - You can also allow your users to    <li><p><b>Infocenter (served)</font></b> - You can also allow your users to
69    access the help system over the Internet or their intranet, by installing the    access 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  server.  The
71    application accesses the documentation    application accesses the documentation
72    by calling a URL, and the help system is shown in their web browser. The    by calling a URL, and the help system is shown in their web browser. The
73    infocenter help system can be used both for client applications and for web    infocenter help system can be used both for client applications and for web
74    applications, either of which can have their help accessed remotely. All    applications, either of which can have their help accessed remotely. All
75    features except  infopops and active help are supported.</p></li>    features except  infopops and active help are supported. Search scoping is done with the Advanced options, not with working sets as in the Integrated and Standalone modes.</p></li>
76  </ol>  </ol>
77  <p>Plug-ins that contribute documentation content  <p>Plug-ins that contribute documentation content
78  (&quot;doc plug-ins&quot;) created for one of these scenarios will work in any of the  (&quot;doc plug-ins&quot;) created for one of these scenarios will work in any of the
# Line 83  Line 83 
83  <p>The help browser displays the navigation for the documentation in a frame on  <p>The help browser displays the navigation for the documentation in a frame on
84  the left-hand side of the window.</p>  the left-hand side of the window.</p>
85  <ul>  <ul>
86    <li><b>Bookshelf</b> - The first view, called the bookshelf, contains links to    <li><b>Bookshelf</b> - The first view, called the Contents, 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. </li>    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.</li>    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>Double clicking on the toolbar of the help system frames maximizes the pane or restores it if is already maximized. </li>
   navigation frame. </li>  
92    <li><b>Synchronize</b> - Another button allows you to synchronize the    <li><b>Synchronize</b> - Another button allows you to synchronize the
93    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
94    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
95    navigation tree.</li>    navigation tree.</li>
96            <LI><B>Bookmarks</B> - In the Integrated and Standalone scenarios one can bookmark topics using the button available on the toolbar. In infocenter mode, right clicking on a document brings up the browser context menu and the bookmark can be added that way.</LI>
97  </ul>  </ul>
98  <p>The navigation trees are created with XML, following the help system's TOC  <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
# Line 138  Line 138 
138    Search Results view and the topic.    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.    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 search
   clicking the Advanced link near the search field. In the workbench search, the  
   options are available right on the Help Search page. Advanced search  
142    functionality includes:    functionality includes:
143    <ul>    <ul>
144      <li><b>Boolean searches </b>- use AND, OR, and binary NOT      <li><b>Boolean searches </b>- use AND, OR, and binary NOT
145      <li><b>Phrase searches</b> - use double-quotation marks      <li><b>Phrase searches</b> - use double-quotation marks
146      <li><b>Wildcards</b> - use * for any string or ? for any character      <li><b>Wildcards</b> - use * for any string or ? for any character
147      <li><b>Filtering by book</b> - select which documentation collections (as      <li><b>Search scoping</b> - select which documentation collections you want to search in </li></ul>
     shown on the bookshelf) you want to search in </li></ul>  
148    <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
149    that contain the first 500 hits.    that contain the first 500 hits.
150    <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
# Line 165  Line 162 
162    <li><b>Lower-case conversion </b>- results in case-insensitive search.    <li><b>Lower-case conversion </b>- results in case-insensitive search.
163    <li><b>Stemming</b> - For example,    <li><b>Stemming</b> - For example,
164    if you enter &quot;compile&quot;, the search finds &quot;compiling&quot;.&nbsp;    if you enter &quot;compile&quot;, the search finds &quot;compiling&quot;.&nbsp;
165    <li><b>Stop word removal</b> - For example, search ignores words like &quot;a&quot; and    Stemming is not applied to queries enclosed by double quotes.<li><b>Stop word removal</b> - For example, search ignores words like &quot;a&quot; and
166    &quot;the&quot; in your query.    &quot;the&quot; in your query.
167    </ul>    </ul>
168  <p>If no analyzer is provided for a particular language, a simple default  <p>If no analyzer is provided for a particular language, a simple default
# Line 232  Line 229 
229  <ul>  <ul>
230    <li>Windows XP, Windows 2000, Windows 98SE*,    <li>Windows XP, Windows 2000, Windows 98SE*,
231    Windows NT*, Windows ME*</font></li>    Windows NT*, Windows ME*</font></li>
232    <li>Redhat Linux 7.2 on x86, SuSE Linux 7.3 on x86</font></li>    <li>Redhat Linux  8.0on x86, SuSE Linux 8.1 on x86</font></li>
233    <li>Sun Solaris 8 on SPARC</font></li>    <li>Sun Solaris 8 on SPARC</font></li>
234    <li>HP-UX 11i on hp9000</font></li>    <li>HP-UX 11i on hp9000</font></li>
235    <li>IBM AIX 5.1 on PowerPC</font></li>    <li>IBM AIX 5.1 on PowerPC</font></li>
# Line 257  Line 254 
254    </tr>    </tr>
255    <tr>    <tr>
256      <td width="50%">Windows 2000</td>      <td width="50%">Windows 2000</td>
257      <td width="50%">Internet Explorer 5</td>      <td width="50%">Internet Explorer 5.5 or 6</td>
258    </tr>    </tr>
259    <tr>    <tr>
260      <td width="50%">Windows 98SE</td>      <td width="50%">Windows 98SE</td>
261      <td width="50%">Internet Explorer 5</td>      <td width="50%">Internet Explorer 5.5 or 6</td>
262    </tr>    </tr>
263    <tr>    <tr>
264      <td width="50%">Windows NT</td>      <td width="50%">Windows NT</td>
265      <td width="50%">Internet Explorer 5+</td>      <td width="50%">Internet Explorer 5.5 or 6</td>
266    </tr>    </tr>
267    <tr>    <tr>
268      <td width="50%">Windows ME</td>      <td width="50%">Windows ME</td>
269      <td width="50%">Internet Explorer 5.5</td>      <td width="50%">Internet Explorer 5.5 or 6</td>
270    </tr>    </tr>
271    <tr>    <tr>
272      <td width="50%">Redhat Linux 7.2</td>      <td width="50%">Redhat Linux 8.0</td>
273      <td width="50%">Mozilla 0.9 or greater</td>      <td width="50%">Mozilla 1.0 or greater</td>
274    </tr>    </tr>
275    <tr>    <tr>
276      <td width="50%">SuSE Linux 7.3</td>      <td width="50%">SuSE Linux 8.1</td>
277      <td width="50%">Mozilla 0.9 or greater</td>      <td width="50%">Mozilla 1.0 or greater</td>
278    </tr>    </tr>
279    <tr>    <tr>
280      <td width="50%">Sun Solaris 8</td>      <td width="50%">Sun Solaris 8</td>
281      <td width="50%">Netscape 4.7</td>      <td width="50%">Netscape 7 or 4.7</td>
282    </tr>    </tr>
283    <tr>    <tr>
284      <td width="50%">HP-UX 11i</td>      <td width="50%">HP-UX 11i</td>
285      <td width="50%">Netscape 4.x</td>      <td width="50%">Netscape 7 or 4.7</td>
286    </tr>    </tr>
287    <tr>    <tr>
288      <td width="50%">AIX 5.1</td>      <td width="50%">AIX 5.1</td>
289      <td width="50%">Netscape 4.x</td>      <td width="50%">Netscape 7 or 4.7</td>
290    </tr>    </tr>
291  </table>  </table>
292  <p>For additional information about plans and restrictions, see  <p>For additional information about plans and restrictions, see
Legend:
Removed from v.1.6  
changed lines
  Added in v.1.7