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

Java web应用程序中上下文相关帮助的可扩展框架,java,web-applications,dita,context-sensitive-help,single-source,Java,Web Applications,Dita,Context Sensitive Help,Single Source,对于我们目前正在开发的web应用程序,我们必须提前考虑如何将其推广到多个不同的用户组。从功能方面来说,重要的是要有一个文档系统,可以用来从相同的源文件生成用户指南和上下文相关的帮助 我们已经计划使用DITA作为文档系统,现在正在考虑一种简单且可扩展的方法,让开发人员指定提供上下文相关帮助的元素,这些元素可以由技术作者和培训师填充 基于DITA,我们希望生成PDF格式的用户指南和集成到基于JSP的web应用程序中的上下文相关帮助。你有什么建议 我们已经在评估一个具有以下特性的商业应用程序 用于标

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

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

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

我们已经在评估一个具有以下特性的商业应用程序

  • 用于标识网页上将填充帮助信息的元素的创作工具
  • 与学习管理系统的整合
  • 支持非基于web的应用程序
你有什么框架建议吗?除上述内容外,以下几点也很好

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

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

有几个工具可以从DITA生成输出。DITA-OT(开放工具包)是Sourceforge上的一个FOSS工具,它可以生成XSL-FO,从中可以生成PDF,也可以生成HTML、CHM等。然后是免费的DITA2Go,它为PDF制作Word RTF,以及HTML和几种形式的在线帮助;它使用topicid属性作为HTML文件名的一部分(或者全部,如果需要)。此外,还有一些商业项目,尽管与DITA2Go相比没有多少好处


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

您是否提出过解决方案?我们正在考虑做类似的事情。不幸的是,没有什么可以被称为可接受的解决方案。我们在应用程序顶部弹出了一个专有的指令框架,因为客户已经将此框架用于其他解决方案。我不会向任何人推荐这个,因为它会增加帮助系统的维护成本。欢迎使用Stack Overflow!谢谢你的回复!请务必仔细阅读本手册。还请注意,每次链接到自己的网站/产品时,都需要发布免责声明。