标签: help-system

目前我正在重新设计一个旧的Windows桌面应用程序.重新设计的一个目标是在Office2010-Style with Ribbons中实现现代化的用户界面.
除了我们的UI,我们希望实现一个现代化的在线帮助.目前我们使用Microsoft HTML帮助(*.chm).但它甚至看起来有点陈旧.
我现在做了一些研究,微软目前使用的帮助系统:

• Microsoft AP帮助(*.h1s)
• Microsoft Help 2.x(*.hxs)
• Microsoft Help Viewer 1.x/Help 3.0(*.mshc)

我的问题是,如果其中一个系统打算用独立的应用程序进行分发,我就找不到任何信息.

对于面向未来的现代应用,您更喜欢哪种帮助系统？我很感谢每一个提示或经验.

我们有一个相对较大的Web应用程序(> 200页),我们需要开始添加帮助屏幕.我们想知道是否有类似CMS的应用程序特别适合这种努力(而不是尝试自己构建所有业务所有者编辑屏幕,搜索,格式化等).

有什么建议？

R的大多数帮助页面都是为了提供特定命令的文档而设计的,如果你知道命令并试图找出如何使用它,就可以轻松找到它们.但是有许多帮助页面主要与单个命令无关,而是与影响许多单个命令的编程工具或技术有关,并且页面名称不是任何命令的名称.示例包括"regex"的帮助页面,"连接","内部通用功能"等等.

我担心在我不知道如何找到的这组帮助页面中的某些地方我应该知道这些内容.是否有我可以探索的此类页面的已发布列表？或者有没有办法使用R或R帮助函数来生成这样的列表？

我曾经想过如何在通常的发行版中生成所有R命令的列表 - 如果我没记错的话,大约2000个 - 但我不知道如何找到一个匹配的帮助页面名称列表.

在阅读下面的有用和有趣的答案后,我意识到这是一个比我想象的更难的问题.通过以下方式:

things <- mget(ls("package:base"), inherits = TRUE)
fns <- Filter(is.function, unique(things))
length(fns)

我们了解到基础包中有1169个独特的功能.根据G. Grothendieck的建议,我们了解到有1216个帮助页面与基础包相关联.因此,这些页面中至少有47个是针对特定功能以外的其他内容.但这个数字实际上比这个要大得多,因为有很多帮助页面可以提供有关多个功能的信息,而我并不知道任何在多个页面上有多个偶然处理的功能.因此,将它们放入正确的对应关系需要对每页进行额外的检查.

例如,考虑名为"funprog"的帮助页面.其简短描述是"函数式编程语言中的通用高阶函数".你可以通过搜索它讨论的六个函数之一(Reduce,Filter,Find,Map,Negate,Position)来实现它.在下面Grothendieck建议的帮助页面列表中,此页面不会出现在其页面名称下面,而只会出现在"Reduce"下,而"Reduce"必须代表其他五个功能.但这意味着还有五个页面与特定功能无关,但与其他内容无关.我希望通过一些机械方式将功能与其帮助页面进行匹配,并生成剩余页面的完整列表.它不会那么容易.

此外,根据以下建议进行探讨,使我得到了与基础和推荐包相关的33个小插图,其中我通常不知道.我认为很难在这些插图和与特定命令无关的帮助页面之间画出一条概念线,比如上面描述的funprog帮助页面.

getAnywhere() 是否有任何相当简单、直接的函数，它返回带有任何注释的函数的源代码，这样，如果我没有看到注释，我可以确信没有注释，无论代码是否在 R 中， c、c++、Fortran 还是其他？例如，stats:::plot.acf 中似乎没有任何注释。我是否可以由此得出结论，其案文没有评论？

我知道有一个类似流程图的搜索过程，如果您知道源代码是用 R 编写的，那么可以通过某种适当的搜索方法 tp gethub 从特定的 github 存储库中获取包含注释的源代码。此外，如果您确定代码采用某种指定的其他语言，则可以通过更复杂的搜索过程来使用它，该过程包括查找正确的文件，然后在其中进行文本搜索，这对于基本包和贡献包来说是不同的。我的印象是，至少直到最近，如果您想了解是否存在包含注释的代码版本，则没有捷径可以通过隐式流程图搜索方法来学习和工作。此外，我相信，除了注释本身或先验知识之外，没有任何地方可以识别包含或不包含注释的代码版本。

然而，R 是一个发展相当迅速的生态系统，我认为现在可能存在更简单的工具来确定是否存在包含注释的源版本，并查找它（如果有），这并不是完全没有道理的。他们有吗？

我一直在尝试使用仅接受 JSON 对象中的原始文本或 base64 编码值的 API。我要发布的内容是来自 XML 文件的数据。因此，我使用 Powershell 的Get-Contentcmdlet（不带-Raw）从 .xml 检索数据，然后对其进行 base64 编码并将其发送到 API。然后 API 对其进行解码，但 XML 格式丢失。

我发现了一篇关于使用-Rawswitch on 的帖子Get-Content，但似乎这个开关的文档很模糊。当我使用该-Raw开关、对其进行编码并将其发送回 API 时，格式很好。

我正在尝试为新应用程序(桌面WPF,还有asp.net网站)规划帮助功能.我花了一些时间来研究这个,似乎没有太多的信息.我已经看到了各种解决方案,例如此处,但在继续之前,最好先向此论坛寻求帮助.

是微软的HTML Help Workshop的仍然是一个很好的路要走？是否有一些特定的帮助系统解决方案是很多人的首选,或者是有多少程序员和解决方案？

在这个答案中，作者提出了以下片段：

dir -Path C:\FolderName -Filter *.fileExtension -Recurse | %{$_.FullName}

我可以理解其中的大部分内容，但我无法搜索最后一部分的文档。搜索的输出通过管道传输|并在%{}和 as 中使用$_。

我已经围绕它进行了实验，%{}我相信是一个 for-each 语句，bing search 是无效的。$_也有点神奇：它是一个变量，没有名字，因此立即被消耗？我不太关心.FullName我整理出来的那部分。同样，bing 搜索无效，也无法在 PowerShell 文档中搜索这些字符序列。

有人可以向我解释一下吗？