platform-help-home/online_help2.0.html

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

revision 1.1, Mon Nov 12 22:43:53 2001 UTC revision 1.2, Tue Nov 13 01:00:30 2001 UTC
# Line 738  Line 738 
738                                                    <h3> Plugin.xml</h3>                                                    <h3> Plugin.xml</h3>
739      A plugin can contribute one or more tables of contents. Tables of contents      A plugin can contribute one or more tables of contents. Tables of contents
740  files contain navigation info for the help content, i.e.a hierarchical structure  files contain navigation info for the help content, i.e.a hierarchical structure
741  of &nbsp;topics nodes that point to the actual html help documents. By default  of &nbsp;topic nodes that point to the actual html help documents. By default
742  tables of contents are meant to be integrated to other tables of contents.  tables of contents are meant to be integrated to other tables of contents.
743  Some are considered standalone or master tables of contents, and marked as  Some are considered standalone or master tables of contents, and marked as
744  primary.&nbsp; Each TOC contributed by a plugin must be defined in the plugin.xml  primary.&nbsp; Each TOC contributed by a plugin must be defined in the plugin.xml
# Line 894  Line 894 
894  Stepping up  in complexity, &nbsp;a table of contents can <b>link </b>other  Stepping up  in complexity, &nbsp;a table of contents can <b>link </b>other
895  tables of contents when desired, creating larger tables of contents. Conversely,  tables of contents when desired, creating larger tables of contents. Conversely,
896  a table of contents can <b>link to</b> another table of contents, forming  a table of contents can <b>link to</b> another table of contents, forming
897  larger navigation tables of contents in a  bottom up approach. Linkining to  larger navigation tables of contents in a  bottom up approach. Linking to
898  another topics file is done by specifying an anchor in the target topics file.<br>  another table of contents file is done by specifying an anchor in the target table of contents file.<br>
899     Since topics behave like pointers to a help file, the same html help file     Since topics behave like pointers to a help file, the same html help file
900   can be reused in many places, by defining the appropriate topic. Reuse can   can be reused in many places, by defining the appropriate topic. Reuse can
901   also be done in groups of topics, with the topics file acting as a reusable   also be done in groups of topics, with the table of contents file acting as
902   navigation component.The same topics file can be linked&nbsp;  many times.   a reusable component.The same table of contents file can be linked&nbsp;  many times.
903  Two branches of the navigation tree will look identical from the reused topics  Two branches of the navigation tree will look identical from the reused table
904  file and down.  of contents and down.
905    
906    
907                                                            <p>The DTD for the                                                            <p>The DTD for the
908  topics file follows: </p>  table of contents file follows: </p>
909    
910    
911    
912                                                            <p><font size="-1">                                                            <p><font size="-1">
913     &lt;!ELEMENT&nbsp; topics&nbsp; (topic | anchor |&nbsp; link)* &gt;</font>     &lt;!ELEMENT&nbsp; toc&nbsp; (topic | anchor |&nbsp; link)* &gt;</font>
914      <br>      <br>
915                                                                 <font size="-1">                                                                 <font size="-1">
916     &lt;!ATTLIST&nbsp; topics&nbsp; link_to&nbsp; CDATA&nbsp; #IMPLIED&gt;</font>     &lt;!ATTLIST&nbsp; toc&nbsp; link_to&nbsp; CDATA&nbsp; #IMPLIED&gt;</font>
917      <br>      <br>
918                                                                 <font size="-1">                                                                 <font size="-1">
919     &lt;!ATTLIST&nbsp; topics&nbsp; label&nbsp;&nbsp;&nbsp; CDATA&nbsp; #REQUIRED&gt;</font>     &lt;!ATTLIST&nbsp; toc&nbsp; label&nbsp;&nbsp;&nbsp; CDATA&nbsp; #REQUIRED&gt;</font>
920      <br>      <br>
921                                                                 <font size="-1">                                                                 <font size="-1">
922     &lt;!--</font> <br>     &lt;!--</font> <br>
# Line 933  Line 933 
933  label is only shown when the table of contents &nbsp;is primary and not integrated  label is only shown when the table of contents &nbsp;is primary and not integrated
934  into another table of contents (i.e. it is part of the library of the tables  into another table of contents (i.e. it is part of the library of the tables
935  of contents for the product). When linked, the toc element gets bypassed,  of contents for the product). When linked, the toc element gets bypassed,
936  and it topics are directly connected to topics at the link point .</font>  and its topics are directly connected to topics at the link point .</font>
937     <br>     <br>
938                                                                 <font size="-1">                                                                 <font size="-1">
939     A TOC&nbsp; file consist of any number of&nbsp; (nested) topics, anchor     A TOC&nbsp; file consist of any number of&nbsp; (nested) topics, anchor
940  points  or links of other topics files.</font> <br>  points  or links of other TOC files.</font> <br>
941                                                                 <font size="-1">                                                                 <font size="-1">
942     --&gt;</font> </p>     --&gt;</font> </p>
943    
# Line 954  Line 954 
954                                                                 <font size="-1">                                                                 <font size="-1">
955     &lt;!--</font> <br>     &lt;!--</font> <br>
956                                                                 <font size="-1">                                                                 <font size="-1">
957     Each topic is a node in a topics tree and can contain topics, anchor points     Each topic is a node in a table of contents tree and can contain topics, anchor points
958   or can include the topics form other tables of contents.</font><br>   or can include the topics form other tables of contents.</font><br>
959                                                                 <font size="-1">                                                                 <font size="-1">
960     For presentaton purposes, each topic must have a label.</font> <br>     For presentaton purposes, each topic must have a label.</font> <br>
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.2