couchbase java 手册_使用 DITA-OT 发布一份 CouchBase Server 手册
最近需要學習 CouchBase Server。而 CouchBase Server 官方網站訪問速度非常慢,所以嘗試使用 DITA-OT 發布一份本地文檔。(其實 CouchBase Server 官網上的文檔也是用 DITA-OT 發布的。)
DITA Open Toolkit 簡稱 DITA-OT,是一款基于 DITA 標準的文檔的發布工具。DITA-OT的官方文檔參見這里。
我在下載 DITA-OT 的時候,下載了好幾次都沒有下載成功。所以只能先本地一個編譯 DITA-OT,再發布 CouchBase Server 文檔。如果你能順利下載 DITA-OT,可以直接跳過編譯 DITA-OT 的步驟。
步驟1、安裝 JDK 及 JRE
點擊這里,訪問 Oracle 官網下載。如果只是運行 DITA-OT 這種 JAVA 程序,那么安裝 JDK 即可。而對于要編譯 DITA-OT 源碼的情況,則必須安裝 JRE。(JRE 是 JAVA 的開發環境,而 DITA-OT 是 JAVA 語言編寫的。好吧,其實 JAVA 我不懂……)
步驟2、配置 Windows 下 JAVA 環境變量
網上這種教程有很多,比如這個。但要注意一點,JAVAHOME 的變量值應設置為 JDK 的安裝路徑,不要大意設置成 JRE 的安裝路徑。否則,發布手冊時會報找不到 tools.jar 的錯誤。如果已設置為 JRE 的安裝路徑,那么即使后續改成 JDK 的安裝路徑,也依然會報錯。這種情況,只能把 JDK 和 JRE 卸載重裝,重新配置JAVA環境變量。
步驟3、編譯 DITA-OT 工具
克隆源代碼,github 地址:https://github.com/dita-ot/dita-ot。
根據 README.md 完成本地編譯。(如果后續有 update 源碼,記得要重新編譯)
步驟4、發布 CouchBase Server 文檔
克隆 CouchBase Server 文檔源代碼,github 地址:https://github.com/couchbase/docs-cb4。
進入克隆到本地的 DITA-OT 源碼所在目錄(比如我的是“cd /d/work/DITA-OT/dita-ot”),執行發布命令:
src/main/bin/dita -f html5 -i /d/work/doc/docs-cb4.6/docs-cb4/content/cb-docs.ditamap -o ~/tmp/output/date
其中-f表示發布文檔保存格式,-i表示待發布的文檔的頂級 ditamap 文件,-o 表示發布結果保存路徑。詳細命令及參數可參考 DITA-OT 文檔。
過程如下圖:
發布過程中會有告警,這個我暫時沒有研究原因。不過不影響結果。
步驟5、查看結果
資源管理器中打開發布結果目錄(比如我的是“C:\Users\lifc\tmp\outout”),使用瀏覽器打開 index.html 即可查看剛剛發布出的本地 CouchBase Server 文檔,如下圖。如果想發布成 PDF 格式的文檔,將發布命令中的“html5”改為“pdf”即可。
----------------補充內容------------------
修改 dita-ot 構建手冊默認語言的方法:
D:\Work\DITA-OT\dita-ot\src\main\plugins\org.dita.base\build_init.xml
第53行,“en” 改為 “zh”,默認語言就從英文變為了中文。
這個有什么用呢?就是對模板中的固定短語進行自動轉換語言。
比如 note 標簽,從 dita 發布為 html 時,對于中文該標簽內容前面要加“注:”,對于英文文該標簽內容前面要加“Note:”。
中文 dita 文件:
發布成 html 文件后:
英文 dita 文件:
發布成 html 文件后:
(完)
總結
以上是生活随笔為你收集整理的couchbase java 手册_使用 DITA-OT 发布一份 CouchBase Server 手册的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 流媒体协议-- HTTP-FLV
- 下一篇: 利用HTML5的本地存储制作的个性化导航