在现代Windows应用程序中建议使用的建议帮助文件格式是什么? [英] What is the recommended help file format to use in a modern Windows app?
问题描述
我正在开发WinForms应用程序，并希望将帮助集成到该应用程序中.过去，我集成了.chm帮助文件.
I am developing a WinForms application and would like to integrate help into it. In the past I integrated .chm help files.
关于.chm文件，该 Wiki文章指出:
Regarding .chm files, this Wiki article states:
2002年，Microsoft宣布了与.CHM格式相关的安全风险以及安全公告和补丁程序.此后，他们宣布了不再进一步开发.CHM格式的意图.
In 2002, Microsoft announced security risks associated with the .CHM format, as well as security bulletins and patches. They have since announced their intentions not to develop the .CHM format further.
据我了解，Microsoft Help 2.x是VS 2008和Office 2007中使用.hxs文件扩展名帮助文件的帮助引擎.
From what I have read, Microsoft Help 2.x was the help engine used in VS 2008 and Office 2007 using .hxs file extension help files.
Office 2010中使用了什么?建议使用的帮助文件格式是什么?
What is used in Office 2010? What is the recommended help file format to be used?
更新:
我找到了以下MSDN文章，其中包含有关此主题的有用信息:
I found the following MSDN article with helpful information on this topic:
推荐答案
沙堡- http://sandcastle.codeplex.com/-被广泛使用.它具有多种输出格式，包括生成一个网站，您可以公开或私下为应用程序用户托管该网站，从而使您可以根据需要进行更新，而无需单独向所有用户推出新的帮助文件.
Sandcastle - http://sandcastle.codeplex.com/ - is widely used. It has multiple output formats, including the generation of a website which you could publicly or privately host for your application users, allowing you to make updates as needed without needing to roll out new help files to all users individually.
您还可以使用Sandcastle生成与Windows内置的MS帮助文件查看器集成的文件.我不知道这是否正式"是最好的方法，但是效果很好.
You can also use Sandcastle to generate files which integrate with the MS help file viewer built into Windows. I don't know if this is "officially" the best method, but it works well.
Sandcastle的唯一警告是它具有一定的学习曲线.
The only caveat with Sandcastle is that it has a bit of a learning curve.
同样有趣的是: http://en.wikipedia.org/wiki/Microsoft_Assistance_Markup_Language . MAML定义了一个通用模式，用于描述各种各样的帮助/文档方案. MAML允许您记录最终用户功能以及API级任务.根据您的受众，这可能具有重大价值.沙堡(Sandcastle)包含许多MAML模板.
Also of interest: http://en.wikipedia.org/wiki/Microsoft_Assistance_Markup_Language. MAML defines a common schema for describing a very wide variety of help/documentation scenarios. MAML allows you to document end user functionality as well as API-level tasks. Depending on your audience, this may be of significant value. Sandcastle includes many MAML templates.
这篇关于在现代Windows应用程序中建议使用的建议帮助文件格式是什么?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！
