用Devhelp看自己的文档

我最开始用Linux的目的就是方便开发，同时接触更多的底层。一段时间后发现，Linux对我来说什么都好，就是help doc不如Windows。经常是遇到一个问题，却找不相应文档，硬着头皮去论坛提问，又被一句“请先阅读《提问的智慧》”给打了回来。最早在Windows XPE上面开发时，充分体会到MSDN的方便，所以在Linux下一直关注有没有一个同等替代品。其实Linux下的Howto和说明很多，还有man和info，资料是很充分了，但实在是分散，不方便应急的查找。我曾经试过用c写了一个命令行下的helpdoc打印程序，通过读文件（html）事先，但毕竟还是命令行的，看，查，都不够方便。现在终于找到一个专门用于GNOME开发的帮助软件devhelp。

Devhelp 是一个GNOME下的文档浏览器，是为了阅读用 gtk-doc 生成的格式的文档而设计的，gtk-doc 是构建 GTK+ 文档的标准工具，相关的项目，例如 Pango 和 GNOME 也使用它。使用 Devhelp，可以迅速地搜索函数索引并浏览已经安装的文档，从而可以更迅速地获得需要的信息。

这玩意很好装，可以通过aptitude install devhelp-books，也可以从官网下载源代码来安装。装完了大概是这模样

当然我们不能光装完就完了，不然这写的也太没有水准了。我们有了这么一个方便的看文档的地方，得琢磨一个啥法子来充分利用阿。默认从源代码安装完的devhelp只带了17个reference manual，这明显是不够的，我们需要来扩充它。

首先，我们需要从这里下载安装脚本devhelp-install。然后我们需要devhelp格式的doc文件。devhelp使用的是一种XML文件来存储table of contents, index以及元数据，这种文件的后缀名通常都是devhelp或者devhelp2。提供devhelp格式的帮助文件的地方，这里推荐一个，是htmlhelp项目主站提供的download列表。

顺便说说安装的事。看一下这个bash脚本，就会知道其实安装过程很简单，其实你要手工安装也可以，因为手工的话灵活性更强，首先下载某个tgz文件，针对devhelp格式的。然后解压缩，你会发现有一个充斥着html的文件夹和一个以devhelp为扩展名的文件，就是刚才说的XML文件。然后把这个文件和那些HTML文件一起放到同一个文件夹下（是文件，不是存放HTML的文件夹），文件夹名字要和XML文件名字一样就行了。存放位置呢，一般是各个软件在share目录下属于自己html文件夹，比如/usr/share/doc/python2.5/html/，也有很多gtk开发的软件对应的开发文档存放在/usr/share/gtk-doc/html/下，当然也可以和安装脚本一样安装在home的.local下，这就看个人了。

目前还有一个值得研究的地方，就是看能不能搞一个脚本出来把html文件转成devhelp格式的XML，然后打包安装。我最近忙着找美国的房子，实在没有时间，如果有朋友知道有的，可以帮忙告诉我，如果没有，看去了学校有没有时间自己写一个吧。

转载地址：http://www.kunli.info/2008/07/16/devhelp/