platform-help-home/online_help2.0.html

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

revision 1.4, Tue Nov 20 21:25:41 2001 UTC revision 1.5, Wed Nov 21 17:35:50 2001 UTC
# Line 1  Line 1 
1  <!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en">  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2  <html>  <html>
3  <head>  <head>
4    
5    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
6    
7    <meta http-equiv="Content-Language" content="en-us">    <meta http-equiv="Content-Language" content="en-us">
8    <META name="GENERATOR" content="IBM WebSphere Homepage Builder V5.0.1 for Windows">
9    
10    <title>Eclipse online help 2.0 changes</title>    <title>Eclipse online help 2.0 changes</title>
11  </head>  </head>
# Line 94  Line 95 
95    
96  <ul>  <ul>
97    
98    <li> Removed</li>    <li>Removed
   
99    <ul>    <ul>
   
100      <li> information sets (infosets)</li>      <li> information sets (infosets)</li>
   
101      <li> information views (infoviews)</li>      <li> information views (infoviews)</li>
   
102      <li> actions</li>      <li> actions</li>
   
103      <li> topic ids's</li>      <li> topic ids's</li>
   
104      <li> properties files: doc.properties and context.properties</li>      <li> properties files: doc.properties and context.properties</li>
   
105    </ul>    </ul>
106      </li>
107    <li> Unchanged:</li>    <li>Unchanged:
   
108    <ul>    <ul>
109        <li>html help content still goes into doc.zip
110      <li> html help content still goes into doc.zip or unpacked in the plugin      or unpacked in the plugin
111   dir</li>   dir</li>
112        <li>pluggability (i.e. documentation and navigation
113      <li> pluggability (i.e. documentation and navigation can stay in the same      can stay in the same
114  plugins): plugins contribute documentation and corresponding navigation structure(s),  plugins): plugins contribute documentation
115  that will be merged at runtime into an eclipse-wide documentation.</li>      and corresponding navigation structure(s),
116    that will be merged at runtime into an eclipse-wide
117        documentation.</li>
118    </ul>    </ul>
119      </li>
120    <li> Slightly changed</li>    <li>Slightly changed
   
121    <ul>    <ul>
   
122      <li> topics.xml files are now toc.xml files</li>      <li> topics.xml files are now toc.xml files</li>
   
123      <li> the extension point for contributing help</li>      <li> the extension point for contributing help</li>
   
124    </ul>    </ul>
125      </li>
126    <li> New</li>    <li>New
   
127    <ul>    <ul>
128        <li>document/web centric approach to building
129      <li>document/web centric approach to building tables of contents using      tables of contents using
130   linking of smaller, distributed tables of contents</li>   linking of smaller, distributed tables of
131        contents</li>
132      <li> href/URL based mechanism for naming any help resource, including      <li>href/URL based mechanism for naming any
133        help resource, including
134   navigation</li>   navigation</li>
   
135    </ul>    </ul>
136      </li>
137  </ul>  </ul>
138     The above suggests that migrating from version 1.0 should be straightforward,     The above suggests that migrating from version 1.0 should be straightforward,
139   as the html help content (doc.zip) does not change, the topics.xml files   as the html help content (doc.zip) does not change, the topics.xml files
# Line 167  Line 156 
156  <p>plugin.xml&nbsp;</p>  <p>plugin.xml&nbsp;</p>
157    
158  <div align="Right">  <div align="Right">
159    <div align="Right"></div>
160  <table border="1" cellpadding="0" width="100%">  <table border="1" cellpadding="0" width="100%">
161      <caption><br>      <caption><br>
162      </caption>   <TBODY>
   <div align="Right"></div>  
      </caption><tbody>  
   
   </tbody>   <tbody>  
163         <tr>         <tr>
164      <td width="100%" bgcolor="#c0c0c0">      <td width="100%" bgcolor="#c0c0c0">
165        <div style="line-height: 100%; "><font size="-1">&lt;plugin id="MyPlugin"&gt;</font></div>        <div style="line-height: 100%; "><font size="-1">&lt;plugin id="MyPlugin"&gt;</font></div>
# Line 193  Line 179 
179      </td>      </td>
180      </tr>      </tr>
181    
182        </tbody>        </TBODY>
183      </table>      </table>
184         </div>         </div>
185      toc.xml&nbsp;      toc.xml&nbsp;
186      <div align="Right">      <div align="Right">
187    <div align="Right"></div>
188      <table border="1" cellpadding="0" width="100%">      <table border="1" cellpadding="0" width="100%">
189      <caption><br>      <caption><br>
190      </caption>   <TBODY>
       <div align="Right"></div>  
          </caption><tbody>  
   
       </tbody>   <tbody>  
191             <tr>             <tr>
192      <td width="100%" bgcolor="#c0c0c0">      <td width="100%" bgcolor="#c0c0c0">
193            <div style="line-height: 100%; "><font size="-1">&lt;toc label="My            <div style="line-height: 100%; "><font size="-1">&lt;toc label="My
# Line 229  Line 212 
212      </td>      </td>
213      </tr>      </tr>
214    
215            </tbody>            </TBODY>
216          </table>          </table>
217             </div>             </div>
218      The doc.zip file contains docs/compile.html, docs/java.html and docs/cpp.html      The doc.zip file contains docs/compile.html, docs/java.html and docs/cpp.html
# Line 237  Line 220 
220          <p>The Help library consists of the following navigation structure</p>          <p>The Help library consists of the following navigation structure</p>
221    
222          <center>          <center>
223    <center></center>
224          <table border="1" cellpadding="0" width="100%" bgcolor="#c0c0c0">          <table border="1" cellpadding="0" width="100%" bgcolor="#c0c0c0">
225      <caption><br>      <caption><br>
226      </caption>   <TBODY>
           <center></center>  
              </caption><tbody>  
   
           </tbody>   <tbody>  
227                 <tr>                 <tr>
228      <td width="808" height="137"><font size="-1">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;      <td width="808" height="137"><font size="-1">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
229    Compiling</font>    Compiling</font>
# Line 255  Line 235 
235                   </td>                   </td>
236      </tr>      </tr>
237    
238            </tbody>            </TBODY>
239          </table>          </table>
240             </center>             </center>
241    
# Line 280  Line 260 
260          <p>plugin.xml in PluginA and PluginB&nbsp;</p>          <p>plugin.xml in PluginA and PluginB&nbsp;</p>
261    
262          <div align="Right">          <div align="Right">
263    <div align="Right"></div>
264          <table border="1" cellpadding="0" width="100%">          <table border="1" cellpadding="0" width="100%">
265      <caption><br>      <caption><br>
266      </caption>   <TBODY>
           <div align="Right"></div>  
              </caption><tbody>  
   
           </tbody>   <tbody>  
267                 <tr>                 <tr>
268      <td bgcolor="#c0c0c0">      <td bgcolor="#c0c0c0">
269                <div style="line-height: 100%; "><font size="-1">&lt;plugin                <div style="line-height: 100%; "><font size="-1">&lt;plugin
# Line 333  Line 310 
310      </td>      </td>
311      </tr>      </tr>
312    
313                    </tbody>                    </TBODY>
   
314                  </table>                  </table>
315                     </div>                     </div>
316      toc.xml in PluginA and PluginB&nbsp;      toc.xml in PluginA and PluginB&nbsp;
317    
318                  <div align="Right"><br>                  <div align="Right"><br>
319    <div align="Right"></div>
320                  <table border="1" cellpadding="0" width="100%">                  <table border="1" cellpadding="0" width="100%">
321      <caption><br>      <caption><br>
322      </caption>   <TBODY>
                   <div align="Right"></div>  
                      </caption><tbody>  
   
                   </tbody>   <tbody>  
323                         <tr>                         <tr>
324      <td width="50%" bgcolor="#c0c0c0">      <td width="50%" bgcolor="#c0c0c0">
325    
# Line 418  Line 390 
390      </tr>      </tr>
391    
392    
393                            </tbody>                            </TBODY>
   
394                          </table>                          </table>
395                             </div>                             </div>
396      The doc.zip file in PluginA contains docs/compile.html, docs/java.html      The doc.zip file in PluginA contains docs/compile.html, docs/java.html
# Line 431  Line 402 
402    
403    
404                          <center>                          <center>
405    <center></center>
406                          <table border="1" cellpadding="0" width="100%" bgcolor="#c0c0c0">                          <table border="1" cellpadding="0" width="100%" bgcolor="#c0c0c0">
407      <caption><br>      <caption><br>
408      </caption>   <TBODY>
   
                           <center></center>  
                              </caption><tbody>  
   
   
                           </tbody>   <tbody>  
409                                 <tr>                                 <tr>
410      <td width="808" height="137"><font size="-1">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;      <td width="808" height="137"><font size="-1">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
411    Compiling</font>    Compiling</font>
# Line 463  Line 428 
428      </tr>      </tr>
429    
430    
431                                </tbody>                                </TBODY>
   
432                              </table>                              </table>
433                                 </center>                                 </center>
434    
# Line 500  Line 464 
464    
465    
466                              <div align="Right">                              <div align="Right">
467    <div align="Right"></div>
468                              <table border="1" cellpadding="0" width="100%">                              <table border="1" cellpadding="0" width="100%">
469      <caption><br>      <caption><br>
470      </caption>   <TBODY>
   
                               <div align="Right"></div>  
                                  </caption><tbody>  
   
   
                               </tbody>   <tbody>  
471                                     <tr>                                     <tr>
472      <td bgcolor="#c0c0c0">      <td bgcolor="#c0c0c0">
473    
# Line 572  Line 530 
530      </tr>      </tr>
531    
532    
533                                        </tbody>                                        </TBODY>
   
   
534                                      </table>                                      </table>
535                                         </div>                                         </div>
536      toc.xml in PluginA and PluginB&nbsp;      toc.xml in PluginA and PluginB&nbsp;
537    
538    
539                                      <div align="Right"><br>                                      <div align="Right"><br>
540    <div align="Right"></div>
   
541                                      <table border="1" cellpadding="0" width="100%">                                      <table border="1" cellpadding="0" width="100%">
542      <caption><br>      <caption><br>
543      </caption>   <TBODY>
   
                                       <div align="Right"></div>  
                                          </caption><tbody>  
   
   
                                       </tbody>   <tbody>  
544                                             <tr>                                             <tr>
545      <td width="50%" bgcolor="#c0c0c0">      <td width="50%" bgcolor="#c0c0c0">
546    
# Line 674  Line 623 
623      </tr>      </tr>
624    
625    
626                                                </tbody>                                                </TBODY>
   
   
627                                              </table>                                              </table>
628                                                 </div>                                                 </div>
629     The following table of contents is built:&nbsp;     The following table of contents is built:&nbsp;
630    
631    
632                                              <center></center>                                              <center></center>
633    <center></center>
   
634                                              <table border="1" cellpadding="0" width="100%" bgcolor="#c0c0c0">                                              <table border="1" cellpadding="0" width="100%" bgcolor="#c0c0c0">
635                                                  <caption><br>                                                  <caption><br>
636      </caption>
637      <TBODY>
                                               <center></center>  
                                                 </caption><tbody>  
   
   
                                               </tbody><tbody>  
638                                                    <tr>                                                    <tr>
639                                                      <td width="808" height="137"><font size="-1">                                                      <td width="808" height="137"><font size="-1">
640    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<font size="-1">Compiling</font></font>    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<font size="-1">Compiling</font></font>
# Line 721  Line 662 
662                                                          </tr>                                                          </tr>
663    
664    
665                                                      </tbody>                                                      </TBODY>
   
   
666                                                    </table>                                                    </table>
667    
668    
# Line 809  Line 748 
748                                                      <table border="1" cellspacing="2" cellpadding="2" width="100%">                                                      <table border="1" cellspacing="2" cellpadding="2" width="100%">
749      <caption><br>      <caption><br>
750                                                           </caption><tbody>                                                           </caption><tbody>
   
   
   
                                                       </tbody>  <tbody>  
751                                                             <tr>                                                             <tr>
752      <td valign="Top" bgcolor="#cccccc">      <td valign="Top" bgcolor="#cccccc">
   
   
753                                                            <blockquote>                                                            <blockquote>
754          <div style="line-height: 100%; "><font size="-1">&lt;extension point="org.eclipse.help.toc<b>"</b>&gt;<br>
   
   
                                                             <div style="line-height: 100%; "><font size="-1">  
    &lt;extension point="org.eclipse.help.toc<b>"</b>&gt;<br>  
755                                                                </font></div>                                                                </font></div>
   
   
   
756                                                              <blockquote>                                                              <blockquote>
757          <div style="line-height: 100%; "><font size="-1">&lt;!-- this defines a standalone table
758          of contents --&gt;<br>
   
                                                               <div style="line-height: 100%; "><font size="-1">  
   &lt;!-- this defines a standalone table of contents --&gt;<br>  
759    &lt;toc file="toc.xml" &nbsp;primary="true"/&gt;</font></div>    &lt;toc file="toc.xml" &nbsp;primary="true"/&gt;</font></div>
760      </blockquote>      </blockquote>
761          <div style="line-height: 100%; "><font size="-1">&lt;/extension&gt;<br>
   
   
                                                               <div style="line-height: 100%; "><font size="-1">  
    &lt;/extension&gt;<br>  
762                                                                  <br>                                                                  <br>
763                                                                  </font></div>                                                                  </font></div>
764          <div style="line-height: 100%; "><font size="-1">&lt;extension point="<b> org.eclipse.help.toc</b>"&gt;</font></div>
   
   
                                                               <div style="line-height: 100%; "><font size="-1">  
    &lt;extension point="<b> org.eclipse.help.toc</b>"&gt;</font></div>  
   
   
   
765                                                                <blockquote>                                                                <blockquote>
766          <div style="line-height: 100%; "><font size="-1">&lt;!-- this defines two sections --&gt;</font><b><font size="-1"><br>
   
   
   
                                                                 <div style="line-height: 100%; "><font size="-1">  
   &lt;!-- this defines two sections --&gt;</font><b><font size="-1"><br>  
767    &lt;toc file=</font></b><font size="-1">"tocWSAD.xml"/</font></div>    &lt;toc file=</font></b><font size="-1">"tocWSAD.xml"/</font></div>
768       <br>       <br>
769                                                                     <font size="-1">        <font size="-1">&lt;<b>toc&nbsp; href</b>="referencesWSAD.xml" /&gt;</font></blockquote>
770     &lt;<b>toc&nbsp; href</b>="referencesWSAD.xml" /&gt;</font></blockquote>        <div style="line-height: 100%; "><font size="-1">&lt;/extension&gt;</font></div>
771          <div style="line-height: 100%; "></div>
   
   
                                                                 <div style="line-height: 100%; "><font size="-1">  
    &lt;/extension&gt;</font></div>  
   
   
   
                                                                 <div style="line-height: 100%; "><font size="-1">  
                                                                   </font></div>  
772      </blockquote>      </blockquote>
773      </td>      </td>
774      </tr>      </tr>
   
   
   
775                                                              </tbody>                                                              </tbody>
   
   
   
776                                                            </table>                                                            </table>
777      </div>      </div>
778      </blockquote>      </blockquote>

Legend:
Removed from v.1.4  
changed lines
  Added in v.1.5