Skip to content

如何参与DocBook文档

kenshin edited this page Sep 18, 2013 · 9 revisions

简单来说,DocBook是一种特定的xml格式,它可以让开发者不再关心排版样式,一次书写,多种格式的输出,所以它非常适合多人协作开发的文档编写。 ###FixFlow的文档源码结构:

  1. chapters:章节代码。
  2. dtd:docbook的语法声明。
  3. images:用到的图片。
  4. js:用到的js。
  5. pretty.js:用于代码高亮的js处理。
  6. style.css:样式文件。
  7. userguide.xpr:oxygen xml文档工具的工程文件。
  8. index.xml:起始页。

###FixFlow的用户向导管理 FixFlow的用户向导是作为一个eclispe项目存在的,您可以将他和其他FixFlow源文件一样,用eclispe的git插件来管理,也可以借助一下xml编辑工具编辑完成之后,用eclipse的git插件或git的客户端软件来管理。 ###DocBook的编辑工具 DocBook文档工具,我个人推荐oxygen工具,它可以使用可视化的编辑和非常方便的生成html、pdf来进行预览。 ####下面介绍下oxygen工具的简单使用:

  1. 下载安装oxygen工具后,打开oxygen
  2. 选择Project->open Project,选择FixFlow下的docbook目录下的userguide.xpr就可以打开FixFlow的文档工程了。 复制项目 图4
  3. 预览:打开index.xml,选中右下角的DocBook Html选项,点击红色启动键,就可以打开生成的FixFlow的用户向导文件了。

注:如果生成的样式不对,可能是因为oxygen的版本不一样导致编译环境不同。解决方法如:右键点击上一步的DocBook HTML选项,选择Duplicate选项,在弹出的界面中修改docbook_custom.xls文件,参考生成的html文件的结构,将style.css和pretty.js的路径修改正确即可。 复制项目 图4 ###说明

  1. 在修改完文档之后,您可以将您的建议反馈到我们的版本上来,操作和代码的反馈一致。可以参看如何参与FixFlow社区开发
  2. DocBook的介绍以及工具都可以在网上找到很详细的介绍。这里不做过多说明。
Clone this wiki locally