【问题标题】:Implementing a application HTML help system [closed]实现应用程序 HTML 帮助系统 [关闭]
【发布时间】:2023-08-08 17:17:01
【问题描述】:

我们想要实现一个应用程序帮助和文档系统。它应该基于 HTML,因为有很多现有的文件,它给了我们最大的灵活性。目前我们使用 CHM 文件。我们希望让内部人员(而非开发人员)能够编辑内容。

我们想到了一个支持 TOC、索引(标签)、搜索等的独立应用程序。我们还想到了使用本地 Web 服务器。

到目前为止,我们的应用程序使用纯 C#,最好保留它。

我们完全没有 web/asp 知识,所以问题是:
从哪里开始比较好?

【问题讨论】:

    标签: c# html documentation webserver chm


    【解决方案1】:

    您可以使用 SandCastle 等文档应用程序

    在您的代码中使用您的 XML 文档来生成帮助文件。

    【讨论】:

    • 感谢您的回答。我已经在使用 Sandcastle 作为我的源文档。但我正在寻找我的应用程序附带的帮助系统,用于最终用户文档。
    【解决方案2】:

    最后我们最终实现了一个本地 HTTP 服务器:

    1. 内部人员在我们的内部网络中创建 HTML 内容
    2. 我们自己的构建工具会创建目录和搜索索引,并将所有内容打包到一个压缩文件中
    3. 压缩文件被打包到应用程序安装中
    4. 当最终用户从我们的应用程序中调用帮助时,本地 http 服务器会启动
    5. HTTP 服务器使用HttpListener
    6. 有了这个,就可以有一些特殊任务的 HTTP 查询,比如通过点击链接来启动我们应用程序的工具,而不会拦截浏览器

    【讨论】:

      最近更新 更多