DocBook vs Apache Forrest
最近工作需要在研究开源的文档产品,举个例子吧,Spring和Hibernate的官方帮助手册就是借助这类产品生成的。在这个方面,DocBook和Apache Forrest这两种基于XML的文档框架工具无疑是占有统治地位的。基本来说,这两种框架都可以让你自由的定义文档的布局、格式、章节,从而完成你的“著作”。它们需要你完全使用基于一种特定schema/dtd的XML书写文档,然后根据应用的样式表去
最近工作需要在研究开源的文档产品,举个例子吧,Spring和Hibernate的官方帮助手册就是借助这类产品生成的。
在这个方面,DocBook和Apache Forrest这两种基于XML的文档框架工具无疑是占有统治地位的。基本来说,这两种框架都可以让你自由的定义文档的布局、格式、章节,从而完成你的“著作”。它们需要你完全使用基于一种特定schema/dtd的XML书写文档,然后根据应用的样式表去生成诸如XHTML、PDF、RTF之类的最终文档产品。
对于一个基于Java 1.5平台的企业应用项目来说,我更倾向于使用DocBook,因为它看起来要更加成熟而且有更多的辅助工具,但是,相比较而言,Forrest似乎拥有更短的学习曲线。
我认为Forrest的XML方言能覆盖80%的应用场景,同时相对的容易上手。但是,如果是一个大型软件项目的话,很难想象不需要产生可打印格式的文档,这一点是DocBook的优势。
正如我上面所提及的,在使用DocBook撰写文档时,会有很多工具供你选择,尽管我没有发现多少特别杰出的(工具:-):
- Conglomerate - 这个工具看上去挺有发展前途的,但是,它只能运行在unix系统上。
- DocBook Template for OpenOffice - 使用这个工具生成“章节”时似乎有点毛病,不支持所有的DocBook特性。
- Vex - Vex是一个Eclipse的插件,看上去有发展前途,但是我认为它有些难用。
- Big list of docbook tools - 这是个什么东东,我不知道。
也许手写XML文档也不失为一个好的方法,但是如果能有一个称心应手的可视化工具辅助那就更爽啦,不是么?
最后,我要说的DocBook的另一个优势就是它有一些已经完成的书籍著作:
开放原子开发者工作坊旨在鼓励更多人参与开源活动,与志同道合的开发者们相互交流开发经验、分享开发心得、获取前沿技术趋势。工作坊有多种形式的开发者活动,如meetup、训练营等,主打技术交流,干货满满,真诚地邀请各位开发者共同参与!
更多推荐
所有评论(0)