基于XML帮助系统的设计与实现

基于XML帮助系统的设计与实现

摘  要：在当今开发的基于WINDOWS平台的软件产品中，帮助系统是应用软件不可缺少的一部分，它能帮助用户了解软件功能，掌握使用方法并解决使用中遇到的疑难问题。帮助文档的制作质量直接关系到应用软件记录，控制，维护，交流等一系列工作。因此制作帮助系统是应用程序设计中的一个重要环节。一个质量高的商品化软件必须具备完善丰富、使用简捷的帮助系统。

本文介绍了应用软件帮助文档出现过的主要格式，归纳了当前流行帮助文档的制作工具并对其进行了比较和总结。指出了目前帮助文档制作中存在的问题。以HELP & MANUAL为例介绍了应用软件帮助文档设计和制作的思想和方法，并且重点研究类似MSDN风格帮助系统和动态帮助设计与实现的方法，以电信公司为例介绍了动态帮助文档的设计与实现过程。讨论了动态帮助文档的优点及其存在的局限性。以及如何在Delphi开发的应用程序中实现联机帮助进行了总结。

关键词：帮助系统，文档制作，Help & Manual，XML, 动态帮助

目录

前 言 4

第一章 绪 论 5

1.1研究的目的与意义 5

1.2相关技术 5

1.3开发工具和运行环境 6

1.4本文的任务和所做的工作 6

第二章 帮助文档制作介绍 7

2.1 帮助文档简介 7

2.1.1 帮助文档的主要格式 7

2.1.2 流行帮助文档制作工具的比较和总结 8

2.2帮助文档制作的三种方法 10

2.2.1手工编制生成hlp帮助文档 10

2.2.2利用帮助文档编写工具 10

2.2.3利用hhw制做chm帮助文档 10

第三章 帮助文档设计和制作的思想和方法 11

3.1 源文件的制作 11

3.1.1采用XML来编写页面的优点 11

3.1.2 XML的使用工具 12

3.1.3 XML使用全过程 12

3.1.3 XML使用时的注意点 13

3.2 帮助文件的建立 13

3.2.1 建立工程文件 13

3.2.2 建立主题文件 14

3.2.3建立索引文件 14

3.2.4设计显示帮助的窗口 14

3.2.5 创建全文搜索 14

3.2.6 编译 14

3.3 创建上下文敏感帮助 14

3.3.1设计上下文ID号 14

3.3.2编写主题映射头文件 15

3.3.3为主题标志串和主题文件建立映射 15

3.4 帮助系统与应用程序的链接 15

3.5 帮助文档中存在的问题及解决方法 15

3.5.1中文乱码问题 15

3.5.2 编码器无法找到问题 16

3.5.3 图象不显示问题 16

3.6 Help & Manual应用的一个简单实例 17

3.6.1 HTML源文件的制作 17

3.6.2 帮助文件的建立 17

3.6.3 在Dephi中实现联机帮助 17

第四章 动态帮助的实现 20

4.1动态文档 20

4.1.1程序文档合一与动态文档 20

4.1.2目前软件的状况 20

4.1.3程序与文档合一的概念提出 20

4.2动态文档系统问题分析 21

4.2.1程序与文档的统一存储与维护 21

4.2.2文档的检索 21

4.2.3制作类似MSDN的帮助文档 22

4.2.4 NDoc 23

4.2.5文档目前支持类型 29

4.3使用.INI文件为输入界面创建“动态帮助” 29

4.3.1自定义动态帮助 29

4.3.2显示“动态帮助”窗口 30

4.3.3策略文件和“动态帮助”窗口 30

4.4.4自定义帮助中的上下文概念 30

4.4.5向企业级模板提供自定义帮助 31

4.4动态文档系统的一个应用实例 31

4.4.1动态文档系统的建立步骤 31

4.4.2程序与文档合一概念与动态文档系统的意义 32

4.4.3动态文档系统的局限与发展 32

结束语 34

参 考 文 献 35

致 谢 36