如何用 JavaHelp 系统开发和交付更好的文档-搜狐数码天下

搜狐首页-新闻-体育-娱乐-财经-IT-汽车-房产-家居-女人-TV-ChinaRen-邮件-博客-BBS-搜狗

	数码天下 > 网狐学园-全中国人的电脑学习中心 > 程序开发-网狐学园 > 程序设计其他

如何用 JavaHelp 系统开发和交付更好的文档

时间：2006年01月17日09:17

我来说两句(0)

　　5. 创建索引文件

　　索引文件向索引导航器描述索引的内容和布局。示例代码 5 显示了一个索引文件的示例。

　　示例代码 5: SampleIndex.xml

＜?xml version='1.0' encoding='ISO-8859-1'  ?＞  

＜!DOCTYPE index  
  PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp Index Version 1.0//EN"  
         "https://java.sun.com/products/javahelp/index_1_0.dtd"＞  

＜index version="1.0"＞  
   ＜indexitem text=".prof extension (profile data)" target="prof.profile"/＞  
   ＜indexitem text="accelerators (keyboard), see 'keyboard commands'"/＞     

   ＜indexitem text="adding an existing project" expand="false"＞  
      ＜indexitem text="naming the project" target="proj.importdirectory"/＞  
      ＜indexitem text="naming the storage directory"  
   target="proj.importdirectory"/＞  
      ＜indexitem text="procedures for" target="proj.importproject2"/＞  
   ＜/indexitem＞  

   ＜indexitem text="arguments" expand="false"＞  
      ＜indexitem text="passing" target="debug.arguments"/＞  
      ＜indexitem text="specifying" target="debug.arguments"/＞  
   ＜/indexitem＞  

   ＜indexitem text="beans" expand="false"＞  
      ＜indexitem text="adding existing sources to a bean project"   
   target="proj.existingbeans"/＞  
      ＜indexitem text="changing bean file status"   
   target="proj.existingbeans"/＞  
      ＜indexitem text="creating a bean project" target="proj.beansproject"/＞  
   ＜indexitem text="removing existing sources from a bean project"  
   target="proj.existingbeans"/＞  
   ＜/indexitem＞  
＜/index＞

　　示例索引文件运行结果见图 3。

图 3: 索引文件示例

　　眼见为实

　　这时，您就可以查看以上所创建的帮助信息了。对它进行实验的最简单的方法就是按照以下的步骤：

在 c:\ 下创建一个目录，名称可任取。为了演示方便，我将该目录称为 myhelp。

将 Sample.hs、 map.jhm、 SampleTOC.xml、 SampleIndex.xml 拷贝至 myhelp 目录下

在 myhelp 下创建一个子目录，叫做 help。

将文件 welcome.html 拷贝至该子目录。

运行如下命令 (helpset 查看器) 以查看以上创建的帮助信息。
prompt＞ java -jar c:\jh2.0\demos\bin\hsviewer.jar -helpset c:\myhelp\Sample.hs

　　如果一切正常，您将会看到类似图 4 的情况。

图 4: 帮助信息示例

　　如上所述，您可以将所有的帮助信息文件封装并压缩到一个 Java ARchive (JAR) 文件中。方法是：

　　c:\myhelp＞ java -cvf help.jar *

　　现在，您就可以用以下的命令查看帮助系统了：

　　prompt＞ java -jar c:\jh2.0\demos\bin\hsviewer.jar -helpset c:\myhelp\help.jar

　　创建全文搜索

　　全文搜索引擎使用了自然语言搜索技术，它除了检索文档外，也可以定位到查询结构可能存在于其中的这些文档的特定段落。它包括一个用于文档分析的概念性的索引引擎，以生成其内容的索引，它也包括一个查询引擎，该引擎使用索引在材料当中查找相关的段落。

　　搜索数据库是用 jhindexer 命令创建而成的。这将在 JavaHelpSearch 目录下创建 6 个文件。这和其他的元数据文件位于同一个文件夹下。举个例子，假设您在该文件夹下有三个子目录叫做 "topic-a"、 "topic-b"和 "topic-c"。这些主题应该指定为 jhindexer 命令的参数：

jhindexer topic-a topic-b topic-c

　　当完成数据库的创建后，它将保存到 JavaHelpSearch 下。

　　要验证它是一个有效的数据库，请运行如下命令：

　　jhsearch JavaHelpSearch

　　您将看到：

　　initialized; enter query

　　现在输入一个查询或者一个术语进行搜索，或者输入一个点（.）退出。