自己动手将在线文档制作成CHM文件

在线帮助文档转CHM方法

用到的工具:

      wget工具(Linux自带,Windows下请自行下载),htm2chm(共享软件,不过没什么限制)

具体步骤:

1、使用wget工具下载在线文档整个目录

    简单介绍一下wget的几个用到的参数。

         

          -c 断点续传(ps : 使用断点续传要求服务器支持断点续传)

          -r 递归下载(目录下的所有文件,包括子目录)

          -np 递归下载不搜索上层目录

          -k 把绝对链接转为相对链接(这样下载之后的网页才能离线浏览)

          -L 递归时不进入其他主机

          -p 下载网页所需要的所有文件

 

    故,使用的命令为:

 $wget -c -r -np -k -L -p http://www.dre.vanderbilt.edu/Doxygen/5.7.4/html/ace/index.html

 

2、使用htm2chm将下载的网页文件转化为CHM

     如前例,我下载了 ACE库,5.7.4版本的在线文档。接着,打开htm2chm软件。主界面如下图:

 

 

 Note:

        这里不得不提一下CHM文件索引制作的事。能够自动生成CHM索引文件的工具还不存在,只能手动制作。顶多有根据网页文件目录层次生成CHM目录的功能,其实没什么用。各种CHM制作工具都是根据HTML文件的标题生成的索引信息,像制作精良的CHM帮助文档那样方便快捷搜索能力是很难达到的。因为一般来说网页的标题和内容之间关系不是很密切,标题中常常会有多余的信息。比如,说明某个类的页面其标题并不是某个类名,这样你在CHM的搜索框里面搜索这个类的时候是没有结果的。


 

      我们要选择的是 Compiler 。Compiler 窗口如下

 

      这里说明一下其中的 Preset(预置) 选项。包含 Downloaded website、Help、Saved page 三种预置方案。由于CHM 的 Help 文档并不能智能的生成目录结构和索引,所以我直接选择了 Downloaded website 方案。

      D:/WorkSpace/www.dre.vanderbilt.edu 是前例中下载的文件的根目录。

我的 Folder: D:/WorkSpace/www.dre.vanderbilt.edu/Doxygen/5.7.4/html/ace

我的 Home: D:/WorkSpace/www.dre.vanderbilt.edu/Doxygen/5.7.4/html/ace/index.html

我的 Output: D:/WorkSpace/www.dre.vanderbilt.edu/Doxygen/5.7.4/html/ace.chm

 

      接着,按 Start 开始编译 CHM 文件。片刻之后,CHM 文档生成。如下:

 

3、生成的CHM文件的使用技巧

      由于这种方法制作的 CHM 文档没有索引功能,所以会给日常的使用带来不便。但是,一般的在线手册都会有一个索引页,里面罗列了所有的主题,所有的类名,所有的函数之类的信息。我们只需在此页上 Ctrl + F 打开查找对话框,输入关键字,就可以查找我们感兴趣的内容。我们也只能期待高人们开发出智能生成 CHM 目录和索引的工具了。

 

参考

1、方便的网络下载工具wget 可下载网站目录下的所有文件

     http://www.alibuybuy.com/posts/6701.html

 

2、htm2chm FAQ 手册(htm2chm可执行文件所在目录 FAQ.chm)

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

HtmlHelp帮助系统是基于大量的HTML文件及相关的图形、图像等文件,它最小的文件单位是主题文件,每个主题文件都表示帮助系统中的一个主题,主题文件是一个纯HTML文件,可包含图形、图像、超级连接等。HtmlHelp Workshop实际上就是一个对构HtmlHelp帮助系统的所有源文件进行管理的工具,你可以在HtmlHelp Workshop中创建目录、索引、建立主题和目录之间的超级连接。 在准备制作HtmlHelp帮助系统时,应当仔细规划文档所要表达的主题,设计目录结构,也就是说,要把所有帮助信息划分为主题,然后把每个主题文件制作为HTML文件,主题文件可大可小,大的话可包含类似书籍中一章的内容,小的话可能只含有几行文字。 目前支持所见即所得的HTML工具有很多,如FrontPage、HomeSite、Hotdog、HomePage等等,可以先用这些工具把所有主题的HTML文件制作好,需要的页面之间的超级连接以及URL地址也都设置好。然后再用HtmlHelp Workshop把这些文件组织起来,编译HtmlHelp帮助系统。 HtmlHelp Workshop包含的文件类型主要由以下几种: (1)主题的HTML文件:它包含每个主题的内容及相应的图形、图像、超级连接等。 (2)图形和多媒体文件:这些文件可包含在HTML文件中,包括图像文件(.gif、.jpg)、声音文件(.wav、.midi)、影像文件(.mpeg、.avi)等。 (3)项目文件(.hhp):HtmlHelp Workshop的项目文件用于管理组帮助文档的所有文件,它包含了帮助系统中所有源文件的名字和位置,以及其它有关帮助系统定义和选项的设置信息。 (4)目录文件(.hhc):目录文件定义显示在帮助系统左侧目录窗格中的内容和结构。它的内容和结构与普通书籍中的章节目录类似。目录文件包含两种类型的条目:标题和主题页。标题类似于书籍中章的概念,它可以与一个主题文件相连接,也可以不与任何主题文件相连。主题页表示具体的主题内容,它必须与一个主题文件或URL地址相连接。每个标题下面是相应的主题页,你可以定义多层次的目录结构。当运行编译的HtmlHelp文件时,点击目录框中的主题条目,相应的内容将显示在右侧窗格中。 (5)索引文件(.hhk):索引文件定义帮助文档的索引和关键字,它将显示在帮助系统的索引窗格中。每个关键字必须至少与一个主题文件或互连网络地址(URL)连接。关键字可以与多个主题文件或URL地址连接,当双击该关键字时,帮助系统会弹出一个窗口,显示所有与该关键字相连接的主题,可以从中选择一个主题,主题的内容将显示在右侧窗格中。
相关推荐
©️2020 CSDN 皮肤主题: 大白 设计师:CSDN官方博客 返回首页