程序文档工具Zanata、RAP、Strut、Hovercraft介绍

以下为你介绍的程序文档工具都可用在Linux系统上:Zanata(在线翻译工具)、RAP(接口文档管理工具)、Strut(幻灯片制作工具,HTML5演示文稿编辑器)、Hovercraft(演示文档创建工具)。

1、Zanata(在线翻译工具)

程序文档工具Zanata、RAP、Strut、Hovercraft介绍

Zanata 是根据 LGPL 许可的免费软件。Zanata 是基于 Web 的翻译系统,用来在线翻译文档,是基于 Web 浏览器的在线翻译软件。Zanata 除了翻译作用外,还可以给开发者管理本地项目文件。Zanata 是用 Java 编写的,并且使用了很多现代化 Web 技术:JBoss、Seam、GWT、Hibernate 和一个 REST API。当前支持通过 PO 文件的 DocBook/Publican 文档翻译。用户可以使用一个 Maven 插件或者 Python 客户端来上传项目到 Zanata 服务器,或者从服务器中下载项目。

先决条件:

Java SDK 8(推荐使用OpenJDK)。

npm。

MySQL或MariaDB。

JBoss EAP 7或WildFly 10。

建立:

快速建立.war文件:

etc/scripts/quickbuild.sh-尽快构建项目,在构建GWT组件时以Firefox和Chrome为目标,并跳过所有检查和验证(即测试,检查样式等)。

如果只希望为chrome或firefox构建GWT组件,则可以分别指定-c和-f参数。

-h参数输出脚本的帮助。

构建并运行服务器进行测试:

etc/scripts/cargowait.sh-构建Zanata工件,并使用cargo插件启动JBoss服务器,该脚本对于启动Zanata实例特别有用,其目的是从IDE运行功能测试。

-h参数输出脚本的帮助。

下载地址:http://zanata.org/

2、RAP(接口文档管理工具)

程序文档工具Zanata、RAP、Strut、Hovercraft介绍

RAP通过GUI工具帮助WEB工程师更高效的管理接口文档,同时通过分析接口结构自动生成Mock数据、校验真实接口的正确性,使接口文档成为开发流程中的强依赖。有了结构化的API数据,RAP可以做的更多,而我们可以避免更多重复劳动。

为什么我们信赖RAP?

企业级应用,包括阿里集团在内得350多个企业都在使用RAP管理重要的接口文档。

快速高效的技术支持,持续的更新,去Issues看一看就知道有多热闹。

免费、开源,一切尽在掌握中。

3、Strut(幻灯片制作工具,HTML5演示文稿编辑器)

程序文档工具Zanata、RAP、Strut、Hovercraft介绍

如果你想要一个工具,让你的工作像传统的幻灯片制作一样简单,那么Strut是一个不错的选择。Strut是一个基于网络的应用,提供了幻灯片的分类和编辑工具。图形化的界面让你轻轻松松的添加文字、图片、视屏和网页。你也可以一次性改变所有幻灯片的前景色和背景色,也可以一张一张的修改。

Strut支持Markdown的语法,而且对于有一定基础的用户,可以自定义CSS样式。当你设计好了你的幻灯片,你可以设置旋转角度和缩放比例等参数,切换不同的预览方式和页面布局。除了impress.js,Strut也可以创建基于bespoke.js 框架的演示文档。

Strut很不错,但是依旧有一些缺点。有时候会遇到一些bug,并且这个项目的待办事项有点多,虽然都不是什么大问题。

该项目遵循“早发布,常发布”的准则,愿意把这个项目做得更好的人可以去Github做贡献。你可以在官网的在线编辑器试一试,或者直接去Github下载它的源码包在本地运行。如果想在本地运行Strut,需要有NodeJS的npm工具和Grunt来安装依赖项目。

下载地址:http://strut.io/

4、Hovercraft(演示文档创建工具)

Hovercraft简化了创建 Impress.js 文档的过程,使用 reStructuredText 创建演示文档。和用HTML制作幻灯片不同,Hovercraft可以让你更加专注于写作。你可以任意改动元素而不用担心标记语言的标签封闭问题。

举个例子,我想创建了一张幻灯片,比上一张幻灯片大了五倍并且旋转了90度。那么在Hovercraft里,只需要两行代码就能完成这些工作:

:data-scale: 5

:data-rotate: 90

Heading

=======

* Bullet Point 1

* Bullet Point 2

使用Hovercraft极大的简化了impress.js的使用。Hovercraft支持四种放置幻灯片的方式,如果没有设置的话,会使用默认的切换方式,也就是向左飞出切换到下一张。如果你想让你的幻灯片更酷炫一点,你可以使用相对布局,幻灯片会基于你自定义的偏移量进行切换。如果在中间插入了一张幻灯片,接下来的其他幻灯片也会依次自动适应调整坐标。如果你想要控制其中的细节,你可以使用绝对布局,提前定义好每个幻灯片的坐标并用SVG制定好路线。

Hovercraft的文档评价SVG布局“用起来有点繁琐”,不过它可以让你更加精确的控制幻灯片的每一个细节,让你的演示更加出彩。另外,如果你想在你的演示中插入代码,那也没有问题,Hovercraft支持代码语法高亮,并且它还提供一个专门给演讲者看的屏幕,可以显示笔记,并且还有计时功能。当你写好了一份文档,一条简单的命令就可以把rst文件转换成HTML演示文稿:

hovercraft [markupfile] [output directory]

虽然Hovercraft有很多优点,但是它依然需要使用者有一定的CSS常识。默认的主题十分的朴实,如果你想要你的演示出彩的话,还是要花一些功夫的。给幻灯片加上CSS并非难事,但是和PPT中点击就能选主题相比,还是显得复杂了一些。

注明

以上就是程序文档工具Zanata、RAP、Strut、Hovercraft的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章