问题标签 [help-files]

我在 SuperUser 处添加了这个问题以供用户查看。

所以我在 Delphi 或 .NET 中创建了一个将在桌面系统上运行的应用程序。一些不错的 GUI，具有各种功能和不错的特性。它运行良好，测试告诉我它几乎没有错误，我即将部署它......

等待！它需要一个帮助文件，因此用户可以从应用程序中调用上下文相关的帮助！

或不？如今，帮助文件真的是桌面应用程序的必需品吗？他们真的需要上下文相关，握住用户的手告诉他们必须在标有“出生日期”的字段中填写出生日期吗？还是帮助文件变得有点过时了？

这是我想知道的事情，这有点主观，所以我要问一些不同的问题，给所有开发桌面应用程序的人：你们（仍然）提供上下文相关的帮助文件吗？

是，或者不是，请。随意添加一些主观文本，但对我来说，重要的是知道现代开发人员是否仍在向他们的 GUI 应用程序添加上下文相关的帮助。

（顺便说一句，我自己已经转向可以手动打印的非上下文 PDF 文件。它更容易维护。）

我想知道如何为我目前正在创建的 applescript studio 应用程序生成帮助文件。我尝试了许多不同的创建帮助选项，并在谷歌上搜索了很长时间，但找不到答案。

当我在我的应用程序中单击菜单项“应用程序帮助”时，它会在我尝试创建帮助时打开带有空窗口的帮助查看器。

我目前正在使用 Xcode 2.4.1 运行 Tiger

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

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

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

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

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

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

标记

我正在开发一个 WinForms 应用程序，并希望将帮助集成到其中。过去我集成了 .chm 帮助文件。

关于 .chm 文件，这篇Wiki 文章指出：

2002 年，Microsoft 宣布了与 .CHM 格式以及安全公告和补丁相关的安全风险。此后，他们宣布不打算进一步开发 .CHM 格式。

根据我的阅读，Microsoft Help 2.x 是 VS 2008 和 Office 2007 中使用的帮助引擎，使用 .hxs 文件扩展名帮助文件。

Office 2010 中使用什么？推荐使用的帮助文件格式是什么？

更新：

我找到了以下 MSDN 文章，其中包含有关此主题的有用信息：

应用程序兼容性：帮助引擎支持

我想为我的应用程序创建一个 chm 文件。哪个是最好和最简单的免费软件？我尝试了 HTML Help Workshop，但它非常困难。有没有可用的免费软件？

我有一个应用程序安装了另外两个具有“帮助”选项的应用程序。这些应用程序中的每一个都有一个共同的帮助文件，但内容应根据“目录”中为应用程序选择的索引显示。如果我打开一个应用程序，则应显示该特定应用程序的帮助。

对于 Appl1，我的代码看起来像这样。

Appl2 看起来像这样

从这里我只能看到通用帮助文件的内容页面，而不是选择的特定应用程序帮助。现在我确实运行了 Appl1，但我仍然可以看到主要MyApp但不是Appl1自动选择的内容以及显示在右侧的内容。

我正在使用 VS 2010，C#，提前致谢

这个问题真的说明了一切。如果您正在编写 WPF 应用程序，您如何集成应用程序帮助？2013年年中的比赛状态如何？

从一个下午的搜索引擎来看，似乎没有明确的答案，但有几个选择：

1. 编写您自己的基于工具提示的帮助（但是您从哪里获取数据？）

2. 使用 .CHM 文件和 Windows 窗体帮助系统（对我来说似乎很古老）。

3. 使用 Microsoft Help Viewer 1.X 或 Microsoft Help 2.0。

   • 关于哪个是 MS 更新/批准的存在一些混淆。看来，Help Viewer 1.X 可能是 Microsoft Help 2.0 的推荐选项。名字这么相似也无济于事……
   • 2.0的状态如何？我们应该使用它吗？它曾经完全部署过吗？

4. 使用第三方产品创作您的帮助文件并以某种方式链接到它们 - DocToHelp/NetHelp、NetAdvantage 在线帮助等...

此外，您使用哪些基于 XAML 的标记/属性来提供必要的上下文？推荐的方法是什么？

令人惊讶的是，在 WPF 中支持基于应用程序的帮助没有明确的路径。

我有一个包含 S3 和 S4 方法组合的包（是的，我知道，但尝试为 sort()、as.matrix() 等编写一个 S4 ......）。所以我坚持使用 CRAN 的经典 roxygen2（版本 2.2.2）

我注意到无论我尝试什么，我都无法自动填写 Rd 文件中的使用标签。我知道我可以使用@usage 手动执行此操作，但我希望保持自动化，因为我拥有相当广泛的代码库，并且我不想意外错过某个标签。

一个例子：

如果我将它包装在一个包中，使用 roxygen2（和 RStudio，如果这很重要）进行 roxygenize，并检查帮助文件，它看起来像这样：

找不到 \usage 部分...

具体来说，我正在考虑的 CHM 帮助文件是PHP User Manual。我想要某种方式能够直接打开这个文件到文档中给定的函数引用（节点）。像这样：

只有那个 ↑ 语法是不正确的——这只是最终打开了 TOC 的手册。CHM 文件可以接受命令行参数吗？有没有办法将它们直接打开到某些节点？

我正在尝试使用 Sandcastle Help File Builder 从我的 C# 代码库构建文档。

我想做的是从代码库生成 CHM（已编译的 HTML 帮助文件）、独立的 HTML 帮助文件以及 OpenXml*.docx文档。

我似乎找不到一组允许我一步完成的配置设置。我已经安装了 Visual Studio 包，我可以在 VS 中编辑 Sandcastle 项目文件的项目属性。

如果我从我的项目属性/“构建”选项卡中选择“HTML Help 1 (chm)”、“Open XML (docx)”和“Website (HTML/ASP.NET)”作为“构建这些帮助格式”：

我面临这个问题：

如果我从“帮助文件”/“演示样式”下拉列表中选择“VS2013”​​，那么我可以构建 CHM 和 HTML 文件就好了 - 但 *.docx 没有构建，抛出此错误：

选定的演示文稿样式 (VS2013) 不支持一种或多种选定的帮助文件格式。支持的格式：HtmlHelp1、MSHelp2、MSHelpViewer、网站

如果我切换到“Presentation style”=“Open XML”，那么我得到

选定的演示文稿样式 (OpenXML) 不支持一种或多种选定的帮助文件格式。支持的格式：OpenXml

那么真的没有可以同时构建所有三种格式（HTML 1 = CHM、HTML/ASP.NET、DOCX）的设置吗？

必须手动设置这些设置、构建项目并重新设置为其他设置、选择正确的格式并再次构建是相当乏味的- 没有办法告诉 Sandcastle 使用“Presentation style = VS2013”对于 HTML 1 (CHM) 和 HTML/ASP.NET，以及对于 Open XML (*.docx) 输出的“Presentation style = Open XML”，然后只构建一次？