问题标签 [helpfile]

我正在为我的应用程序实施帮助系统。它是用 C 和 Gtk+ 编写的。帮助分为书籍。每本书只是一堆带有资源的 HTML 页面。我遇到的问题是每本书大约 30M（使用 WebKit Gtk 端口来显示它）。压缩后它变成〜7M，但打开文档变得非常慢:(所以我正在考虑使用某种能够为我提供的库：全文搜索索引创建，文档列表，树结构（a-la文件系统） ，当然还有压缩。

对这样的事情有什么想法吗？

PS 并不是所有的要求都是“必须的”，我还在探索这部分，不确定所有这些都是必需的，所以如果它会遗漏一些东西就可以了。

我正在用 c# 4.0 开发一个 WinForm 应用程序，并希望其他（非开发人员）同事为编写上下文敏感的最终用户帮助文件做出贡献。首先，我认为我可以使用 Microsoft 的“HTML Help Workshop”，但它似乎已经过时（不支持 Vista 和 Windows 7）。然后我看了Sandcastle，但是缺少文档，我想知道它是否适合非技术用户编写最终用户文档。因此，我阅读了有关 RoboHelp 的信息，但这对我来说太贵了。我迷失在有关帮助文件的所有可用信息中。有人可以帮助提供一些关于使用哪些工具以及我应该针对什么输出格式（仍然是 chm 或其他）的最佳实践或信息。

如何在我的代码（Delphi）中从一堆 HTML（带有链接的图像文件）制作 CHM 文件？需要详细资料，谢谢！

我想创建一个帮助文件，随时按 F1 时打开。如何创建它并包含到代码中？

我正在尝试使用 Sandcastle 帮助文件生成器，但无法让它正常工作。这是我所做的：

1）安装程序；正常工作

2) 在项目中启用 xml 我希望在 /bin 中生成相关文档

3）创建了一个新的sandcastle帮助文件项目

4) 将 C# 项目添加为（如果重要，它是 WCF 服务）文档服务

5）运行“构建”以生成帮助文件

6) 在 GUI 中转到“文档”/“查看帮助文件”/“查看帮助文件”

7）文件打开并包含适当的“文件夹”，但每个页面都显示“导航到网页已取消”

我在 /bin 中看到了 xml 文件，它包含了我所有的 /// 注释，那么为什么它们没有出现在帮助文件中呢？有任何想法吗？

我在帮助查看器中看到的最酷的功能之一是能够隐藏继承的成员，这样您就可以只关注特定子类提供的内容。一个很好的例子是here...

http://james.newtonking.com/projects/json/help/html/T_Newtonsoft_Json_JsonConvert.htm

实际上，该页面有多种显示帮助的选项，而不仅仅是隐藏继承的成员。

现在在线 MSDN 有一个习惯，就是把所有东西都扔到太阳底下，这意味着试图弄清楚子类添加了什么，更不用说需要大量的扫描甚至更多的滚动了。

也就是说，是否有任何方式（本地或在线）来启用这些或类似功能？是否有人制作了执行此操作或类似操作的外部或第三方帮助查看器？

（注意：我不确定这是否适用于 SO，因为它不是编程的东西，但它是一种与 IDE 相关的东西，所以我想我会赌博并将它放在这里。）

标记

这是这个问题的延续。我有一个要包含在我的安装包中的文件（一个 .CHM 帮助文件），我需要在安装期间从代码中访问该文件。它不需要安装到用户的机器上。所以我想
- 将文件包含在安装包中，可能是未压缩的（所以我想我会用一个[Files] ... external标志来做）。
- 在安装过程中使用如下代码引用文件：

那么我可以在安装开始之前引用该文件吗 - 即在将任何文件复制到用户计算机之前？如何指定ExpandConstant ('{???}')文件的路径？我在调用上述处理程序的向导表单上有一个帮助按钮。

我正在为我编写的 C# 程序创建帮助文件。我正在使用 Windows HTML 帮助程序来创建 CHM 文件。我怎样才能在其中创建链接以跳转到另一个页面或 CHM 文件的另一部分？

谢谢

是否有任何约定、模式或工具可用于通过 Nuget 提供 Visual Studio 帮助文件？

目前我正在完成一个应用程序，我正处于需要为任何想要使用它的人记录应用程序的阶段。

在这一点上，我只需要一些可以告诉用户如何使用我的程序的东西。尽管我尝试将其设计为尽可能用户友好，但我有一群不精通技术的用户需要他们可以参考的东西。

所以我的问题基本上是：我能做些什么来轻松创建帮助文件？