注册 登录  
 加关注
   显示下一条  |  关闭
温馨提示!由于新浪微博认证机制调整,您的新浪微博帐号绑定已过期,请重新绑定!立即重新绑定新浪微博》  |  关闭

学会珍惜

You've been saying for the longest time

 
 
 

日志

 
 

DocBook Ant Tools 使用指南  

2012-09-29 13:19:49|  分类: 持续集成 |  标签: |举报 |字号 订阅

  下载LOFTER 我的照片书  |

整理自:  docbook-ant-tools

1. 使用

1.1. 安装使用

  • 安装Java运行环境

  • 安装Apache Ant

  • 从Donwloads页面下载docbook-ant-tools解压或者从svn中checkout:

    svn co http://docbook-ant-tools.googlecode.com/svn/trunk/docbook docbook

    Note

    这一步操作时间会比较长,需要从 Goole Code 的SVN下载大概100M的数据

  • 修改main.xml,写自己的文档

  • 在build.xml所在目录运行ant

    Note

    这一步操作在Mac OSX上可能报出堆内存不足,在执行这一步前设置下ANT_OPTS系统环境变量

    export ANT_OPTS=-Xmx256m
  • 生成的文档在out目录

1.2. 添加文档

  1. 新建文档,如: docbook_guide.xml

  2. main.xml的适当位置,用xinclude插入一个文档比如:

    <xi:include href="docbook_guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

然后运行ant,文档会出现在合集文档中

1.3. DocBook XML 的编辑

关于DocBook的基本知识,以及其XML语法等内容建议参考 DocBook: The Definitive Guide [BI_001]

1.4. 只转换指定文档

新建一个build.properties文件和build.xml同目录,在build.properties中设定doc.main参数为想要转换的xml文档

doc.main=${doc.dir}/guide.xml

1.5. 其他转换命令

  1. ant build-html:生成单页html文件

  2. ant build-chunk:生成多页html文件

  3. ant build-pdf:生成PDF文件

  4. ant build-rtf:生成RTF文件

  5. ant build-docx:生成DOCX文件[1]

  6. ant build-epub:生成epub文件

2. 设置

2.1. 语法高亮

目前docbook-ant-tools支持语法高亮,只要是支持的语言会被自动语法高亮,支持的语言见xsl/docbook/highlighting目录

下面的示例演示了Java语法高亮

<programlisting language="java"> package docbook.ant.tools;  /**  *  * @author xmxsuperstar  *  */ public class Test {   public static void main(String[] args) {   // TODO Auto-generated method stub   /*    *中文注释    */   System.out.println("Hello World");  }  } </programlisting>    

输出的效果为:

package docbook.ant.tools;  /**  *  * @author xmxsuperstar  *  */ public class Test {   public static void main(String[] args) {   // TODO Auto-generated method stub   /*    *中文注释    */   System.out.println("Hello World");  }  }

2.2. 图片

文档中所有用到的图片请放置在doc/resources/images目录下,生成文档的时候doc/resources目录下所有的文件会被拷贝到目标目录中去。

插入图片时为了保证生成文档中图片的大小合适,请加上contentdepth="100%" width="100%" scalefit="1"三个参数,比如:

<xi:include></xi:include>

效果:

Figure 1. 硕大的图片

DocBook Ant Tools 使用指南 - 听歌 - 学会珍惜
 

2.3. FOP以及PDF字体设置

FOP的配置文件在res/fonts/conf.xml。 FOP可用的字体在res/fonts目录。 运行以下命令可以列出所有可用的字体并在out目录下生成font-sample.pdf文件,该文件包含了所有字体效果的示例:

ant read-font

docbook-ant-tools默认打开了FOPauto-detect选项,因此不能使用操作系统安装的字体,如果要关闭该选项编辑conf/fop/conf.xml注释:

<auto-detect/>

2.4. 设置XSL转换相关参数

所有XSL转换相关的配置均在xsl目录下,其中docbook目录中是官方发布的docbook xsl sheet。其余的几个文件是自定义xsl参数用到的。

common.xsl 通用的设置,主要是语言。如果有其他所有输出格式都通用的设置也可以放在该文件里。

chunk.xsl 输出多页HTML的配置。

html.xsl 输出单页HTML的配置。

fo.xsl 输出xsl-fo的配置,在这里控制输出PDF、RTF、DOCX的格式。

关于XSL的相关自定义配置,建议参考 DocBook XSL: The Complete Guide [BI_002] 这本书几乎涵盖了DocBook所有可以自定义设置的方方面面,如果想要对XSL的转换或者输出的格式做深入的定制,这本书必须阅读。

此外 DocBook XSL Stylesheets: Reference Documentation [BI_003] 这本书涵盖了所有可以设置的XSL参数。

参考资料

[BI_001] DocBook: The Definitive Guide. Norman Walsh. Richard Hamilton. 1.0.4 for DocBook V5.0. http://www.docbook.org/tdg5/en/html/docbook.html .

[BI_002] DocBook XSL: The Complete Guide. Bob Stayton. Forth Edition. http://www.sagehill.net/docbookxsl/index.html .

[BI_003] DocBook XSL Stylesheets: Reference Documentation. Norman Walsh. http://docbook.sourceforge.net/release/xsl/current/doc/ .

  评论这张
 
阅读(217)| 评论(0)
推荐

历史上的今天

评论

<#--最新日志,群博日志--> <#--推荐日志--> <#--引用记录--> <#--博主推荐--> <#--随机阅读--> <#--首页推荐--> <#--历史上的今天--> <#--被推荐日志--> <#--上一篇,下一篇--> <#-- 热度 --> <#-- 网易新闻广告 --> <#--右边模块结构--> <#--评论模块结构--> <#--引用模块结构--> <#--博主发起的投票-->
 
 
 
 
 
 
 
 
 
 
 
 
 
 

页脚

网易公司版权所有 ©1997-2017