使用DITA-OT发布一份CouchBase Server文档

最近需要学习CouchBase Server。而CouchBase Server官方网站访问速度非常慢,所以尝试使用DITA-OT发布一份本地文档。(其实CouchBase Server官网上的文档也是用DITA-OT发布的。)

DITA Open Toolkit简称DITA-OT,是一款基于DITA标准的文档的发布工具。DITA-OT的官方文档参见http://www.dita-ot.org/dev/getting-started/installing-

client.html。

我在下载DITA-OT软件的时候,下载了好几次都没有下载成功。所以只能先一个编译DITA-OT,再

发布CouchBase Server文档。如果你能顺利下载DITA-OT,可以直接跳过编译DITA-OT的步骤。

步骤1、安装JDK或JRE
官网下载路径:http://www.oracle.com/technetwork/java/javase/downloads/index.html
JRE是JAVA的开发环境,而DITA-OT是JAVA语言编写的。所以,如果要编译DITA-OT源码,必须安装

JRE。如果只是运行DITA-OT这种JAVA程序,安装JDK即可。其实JAVA我不懂……

步骤2、配置JAVA环境变量
网上这种教程有很多,比如

http://jingyan.baidu.com/article/9f63fb91d87fb0c8400f0e93.html

步骤3、编译DITA-OT
下载源代码,进行本地编译,github路径:https://github.com/dita-ot/dita-ot
根据README.markdown完成本地编译。

步骤4、发布CouchBase Server文档
下载CouchBase Server文档源代码,github路径:https://github.com/couchbase/docs-cb4

进入clone到本地的DITA-OT源码所在目录(比如我的是“cd /d/work/DITA-OT/dita-ot”),执

行发布命令:

src/main/bin/dita -f html5 -i /d/work/doc/docs-cb4/content/cb-docs.ditamap -o

~/tmp/output/

使用资源管理器打开目录C:\Users\[用户名]\tmp\output,使用浏览器打开index.html即可查看

到刚刚发布出的本地CouchBase Server文档。如果想发布成PDF格式的文档,将发布命令中

的“html5”改为“pdf”即可。

时间: 2024-10-12 19:48:46

使用DITA-OT发布一份CouchBase Server文档的相关文章

程序员如何写出一份好的文档?

写文档的重要性 对于软件相关行业,在学校或单位大家也许都已经注意到了,除了要编写的程序.绘制设计图之外,还有一个重要的工作便是写文档.为什么要写文档呢?因为我们要把自己做的东西展示出来,不光展示给同行看,可能还要展示给其他岗位上的工作人员看,甚至展示给用户看.如果我们只是会写程序,不会在文档中恰当且优雅地描述自己的想法,那么就真正的成为“码农”了. 我注意了一下,周围的同事会写高质量文档的确实很少.李开复老师在<浪潮之巅>的序言中说到:“我认识很多顶尖的工程师,但具备强大叙事能力的优秀工程师,

How to Send an Email Using UTL_SMTP with Authenticated Mail Server. (文档 ID 885522.1)

APPLIES TO: PL/SQL - Version 9.2.0.1 to 12.1.0.1 [Release 9.2 to 12.1]Information in this document applies to any platform.***Checked for relevance on 07-Apr-2014*** GOAL The UTL_SMTP package is designed for sending electronic mails (emails) over Sim

.NET项目工程生成一份项目帮助文档chm--Sandcastle工具

.NET项目工程生成一份项目帮助文档chm--Sandcastle工具

程序员如何写出一份好的文档?(转)

程序员如何写出一份好的文档? 分类: 杂谈2015-06-10 16:37 1249人阅读 评论(6) 收藏 举报 在实际的软件开发工作中,除了编写代码之外,程序员还会花大量的时间来编写相关的研发文档,这些文档包括:详细设计文档.单元/集成测试文档.软件版本开发报告.软件安装说明.软件升级指导书等. 在<程序员既要写好代码,又要写好文档>(http://www.zhouzhaoxiong.com/142.html)一文中,我提到过:“代码”和“文档”就像是一个人的左膀右臂,一定要让两者均衡发展

dedecms发布信息员的权限【文档审核】

在给dedecms网站添加信息发布员后,登录该账号发布文章你会发现该文章显示的是待审核稿件,且并没有生成静态文件,通过下列方式就可以实现: 1,打开文件dede/templets/article_add.htm,删除where adminrank<='$urank' 2,依次打开后台>系统设置>系统用户管理>用户组管理>信息发布员>权限设定,把"审核我发布的文档"勾上就可以了,如图 注意:一定要重新登录查看

PDF 补丁丁 0.4.2.1013 测试版发布:修复替换PDF文档字体等问题

新的测试版修复了若干问题,建议下载了旧测试版的用户更新.修复的问题列表: 替换PDF文档字体可能将字体宽度变成0. 书签编辑器在加载XML书签时不显示对应文档的预览. 自动生成书签功能复制文本筛选器后两个项目共享同一个文本筛选器.

拯救你的文档 – 【DevOps敏捷开发动手实验】开源文档发布

今天上海的天气真是不错,风和日丽.再次来到微软上海紫竹研发中心,心情很是愉快,喜欢这里的大草坪,喜欢这里的工程气氛,更喜欢今天来陪我的小伙伴们. 这次动手实验培训与以往最大的不同就是采用了开源文档的方式.其实,小编一直在寻找一种更好的技术文档编写方式.说到文档,我在过去的几年中也写了不下500份不同类型的文档.我估计,每个写过技术文档的同学都有类似这样的文件夹. 是不是很有一种蛋疼的感觉,没有办法啊,需求改来改去,客户的要求变来变去 … … 最后么,就没有最后了,你就自己苦逼去吧. 所以,自从开

在SharePoint 2013 中使用文档库Scheduling (计划发布功能)

本文讲述在SharePoint2013 中使用文档库Scheduling (计划发布功能)的步骤和注意的事项. 文档库Scheduling (计划发布功能) 用于设定当文档通过审批后特定的时间区间内才可以被普通用(非管理员,审批人员和作者)户看到.也就是说要启用Scheduling,必须先启用文档库的内容审批和小版本控制.这是官方文档的说法,但是笔者注意到除此之外Draft Item Security要设置成Only users who can approveitems (and the aut

使用 Github Pages 发布你的项目文档

导读 你可能比较熟悉如何用 Github Pages 来分享你的工作,又或许你看过一堂教你建立你的第一个 Github Pages 网站的教程.近期 Github Pages 的改进使得从不同的数据源来发布您的网站更加的方便,其中的来源之一就是你的仓库的 /docs 目录. 文档的质量是一个软件项目健康发展的标志.对于开源项目来说,维护一个可靠而不出错的知识库.详细说明所有的细节是至关重要的.精心策划的文档可以让增加项目的亲切感,提供一步步的指导并促进各种方式的合作可以推动开源软件开发的协作进程