(文/Janet Swisher)假设你正在为跨平台应用程序撰写文本相关辅助说明,并且译成了包括日语在内的六种语言,如果你编写的应用程序是基于Eclipse的(Eclipse 是一个开放源代码的、基于 Java 的可扩展开发平台),那就比较简单了。Eclipse的用户辅助平台无疑是灵活且强大的,它的格式也很简单,有国际化的内核,可以用多种软件包括DocBook,DITA和一些经典的HATs(创作辅助工具)。即使你编写的是Windows在某地区的应用程序说明,也只需要生成一个chm文件,然后把转化成日语的工作交给当地供货商去做。但你会发现当自己需要编写Web应用程序的说明时,选择就不那么清晰了。( ?0 D+ O! @* Q: t0 f/ ?+ u
当然,你可以直接在Eclipse信息中心中创建一个war版本,但这会扼杀只含单个文件的辅助系统。而且,很多技术员在使用这项技术时会遇到技术屏障,即使技术上允许,也会遭到开发者的反对。你的项目经理可能会担心增加app服务器的性能负担,如果另架设一台app服务器,他们担心又会遭遇把小小的war文件运行在新环境中的麻烦。通常开发者只想从程序员那儿得到捆绑的HTML、CSS和JS文件,其他的一概都是浮云。
2 N" Y5 [7 Z1 R. N6 b5 e现在,有一些跨平台设计可以提供我们期望在辅助系统里获得的所有信息,左侧有带搜索标签的内容列表,还有索引标签。理想情况下页面中的搜索结果会给以高亮显示。检索需要支持自动字串和英语以外的语言,包括汉语,日语,和韩语(中日韩统一表意文字)。中日韩统一表意文字很难,因为它们的语言中词和词间没有空格,所以大部分客户端搜索引擎的设置都会失效。因为找不到可用的分隔符来象征一个词,所以索引中很难列出这些词的列表并说明这些索引词出现在哪些页面中。除了这些,你可能还需要一个按钮来隐藏内容列表,把内容区域优化。当然还会需要内容与内容列表同步,这样就可以在从原主题跳转到相关主题或其他链接时,知道它在内容列表中的位置。当然,你还必须有进入辅助平台中上一层链接的方法,这样就可以编写文本辅助说明了。这不是一件难事,但一直以来,我们的选项全部局限在商业工具上,并且这些工具都还问题如麻。* ]- f* k$ ?6 r) A( Z
http://www.guokr.com/gkimage/k0/l7/q9/k0l7q9.png
输入Google Summer of Code 2010和斯里兰卡莫勒图沃大学的一名学生Kasun Gajasinghe会发现,过去的春天里,通过Dick Hamilton和Stefan Seefeld的推动,DocBook开源工程第一次成为技术领袖。为什么以前不这么做?我也不知道。我猜测大家都在埋头做自己的事情,谁也没有想到Summer of Code(编程之夏)引入一些聪明的学生参与进开源发展的细节里来是推动DocBook发展最给力的方法。! \4 J) W7 m$ I; N4 u% O
原文看这里
$ V$ e- v! v2 [4 e) X8 x相关参考内容:- N4 y, t/ D, w1 l( L6 F
http://docbook.sourceforge.net/release/xsl-ns/current/webhelp/docs/content/ch01.htmlhttp://kasunbg.blogspot.com/2010/08/docbook-webhelp-project.html
; x9 y0 f- ?7 i6 K" c9 X博主介绍:Janet Swisher是一名技术方面的作家。1989年以来一直在IT和软件行业工作,1999年开始研究交流技术,现在在Mozilla做文档开发工作。他作为一名技术类撰稿人,写作范围包括线帮助、API文档和程序员指南教程。Janet主要关注与技术相关的话题,特别是软件产业。南通0 |