目录(TOC)

org.eclipse.help.toc

用于为各个插件注册联机帮助添加项。

向帮助文件进行添加的每个插件一般应执行下列操作:

可以通过使用 index 元素有选择地预构建和注册搜索索引,以尝试执行首次搜索。每个插件只能注册一个索引 - 多个 index 元素将导致未定义的行为。

<!ELEMENT extension (toc* , index?)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT toc EMPTY>

<!ATTLIST toc

file     CDATA #REQUIRED

primary  (true | false) "false"

extradir CDATA #IMPLIED>


<!ELEMENT index EMPTY>

<!ATTLIST index

path CDATA #REQUIRED>

从 3.1 开始)一个可选元素,它允许声明从此插件提供的文档创建的预构建搜索索引。



以下是使用 toc 扩展点的一个示例。

(在 plugin.xml 文件中)

 

<extension point=

"org.eclipse.help.toc"

>

<toc file=

"maindocs.html"

primary=

"true"

/>

<toc file=

"task.xml"

/>

<toc file=

"sample.xml"

extradir=

"samples"

/>

<index path=

"index/"

/>

</extension>

(在 maindocs.xml 文件中)

<toc label="Help System Example">
 <topic label="Introduction" href="intro.html"/>
 <topic label="Tasks">
  <topic label="Creating a Project" href="tasks/task1.html">
   <topic label="Creating a Web Project" href="tasks/task11.html"/>
   <topic label="Creating a Java Project" href="tasks/task12.html"/>
  </topic>
  <link toc="task.xml" />
  <topic label="Testing a Project" href="tasks/taskn.html"/>
 </topic>
 <topic label="Samples">
  <topic label="Creating Java Project" href="samples/sample1.html">
   <topic label="Launch a Wizard" href="samples/sample11.html"/>
   <topic label="Set Options" href="samples/sample12.html"/>
   <topic label="Finish Creating Project" href="samples/sample13.html"/>
  </topic>
  <anchor id="samples" />
 </topic>
</toc>


(在 tasks.xml 文件中)

<toc label="Building a Project">
 <topic label="Building a Project" href="build/building.html">
  <topic label="Building a Web Project" href="build/web.html"/>
  <topic label="Building a Java Project" href="build/java.html"/>
 </topic>
</toc>


(在 samples.xml 文件中)

<toc link_to="maindocs.xml#samples" label="Using The Compile Tool">
 <topic label="The Compile Tool Sample" href="compilesample/example.html">
  <topic label="Step 1" href="compilesample/step1.html"/>
  <topic label="Step 2" href="compilesample/step2.html"/>
  <topic label="Step 3" href="compilesample/step3.html"/>
  <topic label="Step 4" href="compilesample/step4.html"/>
 </topic>
</toc>

假定以“samples”开头的路径中存在多个文档,则这些文档不会显示在导航树中,但是可以使用搜索来访问。这是由于 plugin.xml 文件内的 <toc file="sample.xml" extradir="samples" /> 元素中存在“extradir”属性。例如,搜索“创建 Java 项目”可能会返回文档“创建 Java 项目的其它方法”,路径为 samples/sample2.html

国际化可以翻译 TOC XML 文件并且生成的副本(具有已翻译的标签)应放置在 nl/<language>/<country> 或 nl/<language> 目录中。<language> 和 <country> 表示两字母语言和国家或地区代码,如在语言环境代码中使用的那样。例如,“繁体中文”翻译应放置在 nl/zh/TW 目录中。nl/<language>/<country> 目录具有比 nl/<language> 高的优先级。仅当在 nl/<language>/<country> 目录中找不到文件时,才会使用 nl/<language> 中的文件。将最后搜索插件的根目录。

可通过创建具有已翻译版本的文档的 doc.zip 文件并将 doc.zip 文件放置在
nl/<language>/<country> 或 nl/<language> 目录中来使 doc.zip 中包含的文档本地化。在缺省查找插件目录之前,帮助系统将查找这些目录下面的文件。
 

使用此扩展点不需要任何代码。所需要的只是提供在 plugin.xml 文件中提到的适当清单文件。

随 Eclipse 平台一起提供的帮助系统用户界面的缺省实现完全支持 toc 扩展点。