Web 应用程序中上下文相关帮助的可扩展框架
对于我们目前正在开发的 Web 应用程序，我们必须提前考虑如何将其推广到许多不同的用户组。从功能方面来看，拥有一个可用于从相同源文件生成用户指南和上下文相关帮助的文档系统非常重要。
我们计划使用 DITA 作为文档系统，现在正在考虑一种简单且可扩展的方法，让开发人员指定提供上下文相关帮助并可由技术编写者和培训师填充的元素。
基于 DITA，我们希望生成 PDF 格式的用户指南以及集成到基于 JSP 的 Web 应用程序中的上下文相关帮助。您有什么建议？
我们已经在评估一个商业应用程序，该应用程序具有以下功能
- 创作工具可识别网页上的元素，这些元素将填充帮助信息
- 与学习管理系统集成
- 支持非基于网络的应用程序
您有吗框架建议？除了上述内容之外，以下内容将
- 与 DITA 很好地集成（以任何可能的方式）
- 用户组特定内容（从 Web 应用程序检索的用户）
- 可以在简单的 Web 应用程序中使用来显示（html）工具提示
- 关联的帮助上下文具有以下层次结构：应用程序>页>元素（HTML id？）
For the web application we are currently working on, we will have to think in advance on how to roll it out to a number of different user groups. From a functional side it is important to have a documentation system in place that can be used to generate a user guide and context-sensitive help from the same source files.
We have planned to use DITA as documentation system and are now thinking about an easy and extensible way to let developers specify elements that provide context-sensitive help and can be populated by the technical writers and trainers.
Based on DITA we would like to generate a user guide in PDF and context-sensitive help integrated into a JSP-based web application. What recommendations do you have?
We are already in the process of evaluating a commercial application that has the following features
- authoring tool to identify elements on a web page that will be populated with help information
- integration with learning management systems
- support for applications that are not web-based
Do you have any framework recommendations? In addition to the above, the following would be great
- integrate with DITA (in any conceivable way)
- user group specific content (user retrieved from web application)
- can be used from within a simple web application to show (html) tool tips
- association of help context with the following hierarchy: application > page > element (HTML id?)
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（1）
DITA 是一种文档架构，而不是一种工具。因此，它不会限制您对创作工具或从 DITA 源生成 PDF 和在线帮助的选择。目前尚不清楚您想要的是哪种在线帮助，但听起来更像是您想要可以由应用程序本身显示的 HTML 页面，而不是像 CHM 这样的三窗格。
有多种工具可以从 DITA 生成输出。 DITA-OT（开放工具包）是 Sourceforge 上的一个 FOSS 工具，可以生成 XSL-FO，您可以从中生成 PDF、HTML、CHM 等。然后还有免费的 DITA2Go http://dita2go.com，它可以生成用于 PDF 制作的 Word RTF、HTML 和多种表单在线帮助；它使用主题 ID 属性作为 HTML 文件名的一部分（或全部，如果您需要）。另外还有商业程序，尽管与 DITA2Go 相比没有太多优势。
您最好不要将 PDF 视为在线帮助交付格式，而只是将其视为客户可以打印出来并用作硬拷贝的版本。工具提示实际上更取决于您的 Web 应用程序，而不仅仅是帮助生成工具。
DITA is a document architecture, not a tool. So it does not constrain your choices for an authoring tool, or for producing PDF and on-line Help from your DITA source. It's not clear what sort of on-line Help you have in mind, but it sounds more like you want HTML pages that can be displayed by the application itself than a tripane like CHM.
There are several tools that will generate your outputs from DITA. The DITA-OT (Open Toolkit) is a FOSS tool on Sourceforge that can make XSL-FO, from which you can produce PDF, and also HTML, CHM, and a few more. Then there is free DITA2Go http://dita2go.com which makes Word RTF for PDF production, as well as HTML and several forms of on-line Help; it uses the topic ID attribute as part (or all, if you want) of the HTML file names. Plus there are commercial programs, though not with much of a benefit over DITA2Go.
You are best off not to think of PDF as an on-,line Help delivery format, but just as a version that customers can print out and use as hard copy. And tooltips are really up to your Web application more than a help-generating tool.