xml源文件的文档生成工具--DITA Open Toolkit（DITA-OT）的使用入门

公司的写作软件是oxygen xml editor，但对于文档的生成一直百思不得其解，除了使用公司定制的发布工具，试过oxygen xml editor的transformation功能，生成的文档很不好看，也不知道怎么调整参数。

oxygen已经更新到19.0版本了，回头看Editor-UserManual才有点思路。

这里明确表明了，oxygen xml editor不带有文档生成工具，请安装tool chain工具来执行生成场景。

然后又有描述，文档生成场景由DITA Open Toolkit提供。

很高兴的是，这个工具还是免费的！

下面简单说下这个工具的使用。

1. 访问官网http://www.dita-ot.org/download 下载DITA OT 压缩包。

2. 解压压缩包后将文件夹最好放在C盘。

3. 根据doc文件夹中的userguide.pdf 来搭建运行环境。

1）安装Java。

需要注意的是，Java的安装不当会导致工具使用时报错，如tools.jar工具找不到之类。这个在userguide里并没有提到。安装Java时，会安装JDK和JRE这两个组件，两个组件需要分别安装在单个文件夹中，请在安装过程中注意选择。最新版本的Java貌似是自动分开放文件夹的，如下所示。

2）为Java和DITA OT添加环境变量。

右击PC上的“此电脑”图标，选择“属性->高级系统设置->环境变量(N)…”，找到环境变量Path并双击。添加“C:\dita-ot-3.0\bin”和“C:\Program Files\Java\jdk-9.0.1\bin”这两个环境变量。

说明：当时我只添加DITA OT的环境变量，安装后有报错，根据报错信息查了下，最后补充了Java的环境变量。

4. 验证运行环境。

打开cmd窗口，进入dita-ot-3.0的bin目录，输入“dita --version”命令。如果显示“DITA-OT version 3.0”，则表示环境搭建OK。

下面给出我的运行截图，中间有个报错，之前运行是没有报错，不过好像也不影响运行结果。

5. 运行命令“dita --input=XX.ditamap --format=pdf2”，文档将生成在C:\dita-ot-3.0\bin\out目录下。

以上是关于DITA-OT的简单使用，关于自定义参数设置，还在学习当中。

xml源文件的文档生成工具--DITA Open Toolkit（DITA-OT）的使用入门相关推荐

Apiggs —— 非侵入性的 RestDoc 文档生成工具
程序员一直以来都有一个烦恼,只想写代码,不想写文档.代码就表达了我的思想和灵魂. Python提出了一个方案,叫docstring,来试图解决这个问题.即编写代码,同时也能写出文档,保持代码和文档的一 ...
.NET平台开源项目速览(4).NET文档生成工具ADB及使用
.NET平台开源项目速览(4).NET文档生成工具ADB及使用原文:.NET平台开源项目速览(4).NET文档生成工具ADB及使用很久以前就使用ADB这个工具来生成项目的帮助文档.功能强大,在学习 ...
Doxygen自动文档生成工具在Eclipse中的集成及使用举例
你有为软件编写说明文档的苦恼吗?当别人甩给你一个庞大的系统,让你根据里面的代码注释理解后写出一份完整的开发文档,你会怎么办?一个个的看代码然后耗时N天来写吗?这既是一份苦差事也极其耗时,有没有更好的 ...
.NET文档生成工具ADB[更新至2.3]
ADB2.3下载 ADB2.3源代码下载 Microsoft HTML Help Workshop下载注意:使用该软件需先安装Microsoft HTML Help Workshop 程序的注释 ...
基于文档注释接口文档生成工具(代码0侵入附源码)
本文主要分享一个基于个人兴趣,旨在提高工作效率,开发了一个基于文档注释,接口文档生成工具,欢迎大佬指点. 源码以及使用demo地址 :传送门 1.前置介绍 1.1前世现在大多数项目都走向了前后端分离 ...
python文档生成_python文档生成工具：pydoc、sphinx；django如何使用sphinx？
文档生成工具: 自带的pydoc,比较差建议使用sphinx 安装: pip install sphinx 安装主题: 由各种主题,我选择常用的sphinx_rtd_theme pip instal ...
文档生成工具-Doxygen使用方法以及注释规则
最近接触了一款程序文档生成工具-Doxygen.在网上一搜索原来这么多人知道,打算把它的使用做一个总结,以及其注释的规则. 概述: Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文 ...
mysql 文档生成器_最好用的数据库文档生成工具
一前言本文介绍一些比较流行的数据库文档生成工具,什么是数据库文档? 其实在工作中进行项目交付的时候经常用到:简单来说数据库文档就是对整个数据库设计说明的文档,比如使用了哪个数据库,每张表的字段,类 ...
python doc_Python文档生成工具pydoc使用介绍
在Python中有很多很好的工具来生成字符串文档(docstring),比如说: epydoc.doxygen.sphinx,但始终觉得pydoc还是不错的工具,用法非常简单,功能也算不错,本文主要介 ...

xml源文件的文档生成工具--DITA Open Toolkit（DITA-OT）的使用入门

xml源文件的文档生成工具--DITA Open Toolkit（DITA-OT）的使用入门相关推荐

最新文章

热门文章