Web应用程序中上下文相关帮助的可扩展框架

时间:2010-06-16 15:40:47

标签: java web-applications dita context-sensitive-help single-source

对于我们目前正在处理的Web应用程序,我们必须提前考虑如何将其推广到许多不同的用户组。从功能方面来说,有一个文档系统非常重要,可用于从相同的源文件生成用户指南和上下文相关帮助。

我们计划使用DITA作为文档系统,现在正在考虑一种简单易用的方法,让开发人员指定提供上下文相关帮助的元素,并且可以由技术作者和培训师填充。

基于DITA,我们希望生成PDF格式的用户指南和集成到基于JSP的Web应用程序中的上下文相关帮助。您有什么建议?

我们已经在评估具有以下功能的商业应用程序

  • 创作工具,用于识别将填充帮助信息的网页上的元素
  • 与学习管理系统的整合
  • 支持非基于网络的应用程序

您有任何框架建议吗?除上述内容外,以下内容还不错

  • 与DITA(以任何可能的方式)集成
  • 用户组特定内容(从Web应用程序检索的用户)
  • 可以在简单的Web应用程序中使用,以显示(html)工具提示
  • 帮助上下文与以下层次结构的关联:application>页面> element(HTML id?)

1 个答案:

答案 0 :(得分:1)

DITA是一种文档架构,而不是一种工具。因此,它不会限制您对创作工具的选择,也不会限制您从DITA源生成PDF和联机帮助。目前还不清楚你想要什么样的在线帮助,但听起来更像是你希望应用程序本身可以显示的HTML页面而不是像CHM这样的tripane。

有几种工具可以从DITA生成输出。 DITA-OT(Open Toolkit)是Sourceforge上的一个FOSS工具,它可以生成XSL-FO,您可以从中生成PDF,还可以生成HTML,CHM等等。然后有免费的DITA2Go http://dita2go.com,它可以生成用于PDF制作的Word RTF,以及HTML和几种形式的在线帮助;它使用主题ID属性作为HTML文件名的一部分(或所有,如果需要)。此外还有商业节目,但与DITA2Go相比没有太大的好处。

最好不要将PDF视为在线帮助交付格式,而是将客户可以打印出来并用作硬拷贝的版本。工具提示实际上取决于您的Web应用程序,而不仅仅是一个帮助生成工具。