本主题包含有关Microsoft Help Viewer的信息,该帮助系统是Visual Studio 2010以上的帮助系统。Microsoft Help Viewer只能用于创建与Visual Studio帮助系统集成的帮助材料,不适用于通用帮助系统。
如果要将多个不同的帮助系统部署为单个产品的一部分,您可能希望创建一个父项目,包括登录页面或其他一些伞形主题,以便为用户提供方便的链接链接到不同的帮助系统。在Microsoft Help Viewer中,可以通过在子帮助系统中的根主题上设置TocParentId来标识公共父主题,并使用特定的Microsoft Help Viewer链接格式从父主题链接到子帮助系统中的主题来实现。 。
创建父项目
父项目要包含在Microsoft Help Viewer目录的根目录中显示的主题。编写所需主题,并使用目录编辑器组织所需层次结构中的主题。
在此示例中,组件文档主的题是我们希望子项目中主题出现的位置。这可以是项目中的任何主题,这个由您决定哪个主题在您的方案中会比较有意义。
为了将子项目中的主题连接到父项目主题,我们将需要组件文档主题的主题ID。我们可以通过构建项目,在生成的输出中打开该主题,右键单击内容并从帮助查看器上下文菜单中选择查看源来实现此目的。在显示的源中,您可以在Microsoft.Help.Id元标记中找到主题ID,例如 :
主题是content属性中的值 - 在此示例中为53468d8a-a886-482e-8bce-90c32091a564。
配置子项目
现在,您需要设置子项目中每个根主题的TocParentId属性,设置为您希望它们显示在Microsoft帮助查看器目录下面父项目中主题的主题ID。您可以通过在Project Explorer中选择Topic来设置此属性 - 然后在Properties窗口中显示属性。如果您有多个与同一TocParentId关联的主题,则可以将TocOrdinal设置为将用于对子主题进行排序的数字。
注意:仅当您将构建配置文件配置为生成Microsoft Help Viewer输出时(在构建配置文件编辑器中的格式页面上),才会显示这些属性。
为了保持结构简单,并避免在目录中混淆,您可能需要在子帮助系统中创建单个根主题,在该主题下可以包含所有其他主题。这也将简化配置 - 您只需要在该单个根节点上设置TocParentId即可。
建立两个项目
您现在应该构建这两个项目,并在Microsoft Help Viewer中检查布局是否符合要求。
父与子主题之间的链接
您可以使用主题ID在父与子主题之间创建链接。
注意:通过在Microsoft Help Viewer中查看主题,右键单击内容并从帮助查看器菜单中选择查看源,可以在生成的输出中找到给定主题的主题ID。在显示的源中,您可以在Microsoft.Help.Id元标记的content属性中找到主题ID。
例如,您可以在父项目中的主题内创建指向子项目中主题的链接。您可以通过在链接到网页或其他Internet URL页面上的链接设计器中键入Microsoft Help Viewer特定的链接格式来完成此操作。
链接格式为:ms-xhelp:///?method = page&id = [target_topic_id] ,其中[target_topic_id]是您要链接到的主题的主题ID。
您可以通过这种方式在Parent>Child、Child>Parent或者不同的Child项目中创建链接。
示例项目
下载父项目和子项目的示例,该项目说明了本主题中描述的模块化Microsoft Help Viewer帮助的技术。以下是示例图片: