Document! X 和HelpStudio的小技巧,轻松制作文档工具!

点击下载最新版Document! X v2019.1

点击下载最新版HelpStudiov2019.1


    本主题包含有关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。

在另一个Microsoft Help Viewer项目中指向主题的链接示例

    您可以通过这种方式在Parent>Child、Child>Parent或者不同的Child项目中创建链接。

示例项目

    下载父项目和子项目的示例,该项目说明了本主题中描述的模块化Microsoft Help Viewer帮助的技术。以下是示例图片:

mshv-child toclayout


截图未命名2.jpg


截图未命名3.jpg


mshv-link designer


mshv-Example Parent Table Of Contents

mshv modular

============================================================================ 软件版本: 5.0.0.0 Beta 基础版本: 1.2.0.0 Beta 软件著作人:NickDal,Alexander Kozlenko 软件修改人:Cruise Young 数据来源: http://services.mtps.microsoft.com/ServiceAPI/catalogs/ 源代码托管: https://github.com/CruiseYoung/vshdp 修改内容: v5.0.0.0(2015.11.30日)更新内容 1、增加对dev10(Visual Studio 2010)版本的支持,至此“Visual Studio Help Downloader Plus”支持Visual Studio 2010以及其后所有已发布的版本,理论上也支持Visual Studio未来版本的支持,为庆祝此跨越,特将版本号从5.0.0.0开始编号; 2、由于该版本支持Visual Studio 2010版本,为了能使VS2010--“帮助”--“管理帮助设置”--“从磁盘安装内容”能识别msha文件,特统一更改msha文件命名方式,遵从"Visual Studio 2010 Help Downloader Plus" 的命名规则; 3、优化代码,增加对“PackageList.txt”、“HelpContentSetup.msha”文件内容排序; v3.0.0.3(2015.08.15日)更新内容 1、增加在有某vs版本时,而没有对应语言列表,或对应语言列表不足14(Visual Studio 2012/2013语言列表数目)时,手动添加其语言列表(该需求由“CSDN”的“qq_30108695”提提交,在此表示感谢); v3.0.0.2(2015.08.13日)更新内容 1、修复dev14(Visual Studio 2015)加载语言时挂死(该bug由“远景论坛”的“铁浪”提交,在此表示感谢), 修改为默认加载"en-us"语言,如果没有该语言则显示提供的第一种语言; v3.0.0.1(2014.05.28日)更新内容 1、按照资源加载顺序,调整界面布局; 2、修复动态加载微软官网配置时的方式; v3.0.0.0(2014.05.23日)更新内容 1、将获取文件的下载路径,由拼接改为由代码从微软官网直接获取;从而可以支持Visual Studio 2012/2013,以及未来版本; 2、由于该版本支持Visual Studio 2012/2013、以及未来版本,特将软件名更改为“Visual Studio Help Downloader Plus”,版本号从3.0.0.0开始编号; v2.0.0.2(2013.06.12日)更新内容 1、将各文件的创建,修改,访问时间修改为文件内容的最后更新的时间; v2.0.0.1(2013.05.26日)更新内容 1、为了响应网友提出的利用本工具下载过慢的情况,特将下载的package的url汇总到“PackageList.txt”文件,可以利用迅雷下载后,再用本工具创建索引; v2.0.0.0(2013.04.13日)更新内容 1、修改索引文件生成的目录结构,将多个xml文件合并到一个msha文件,并增加“path”等信息,从而与微软官网的一致; 2、将不同语言的文件包分语言放置; 3、兼容将不同语言的Help Library放置到同一文件夹; 4、为方便用户,特对用迅雷等下载工具下载包的方式做了兼容,并对该软件面世之前的“MSHAGen”下载的包做了兼容; 5、自动删除过期文件; 6、自动删除下载错误的文件(由于是用文件长度校验,所以该条只保证99%,最好用解压软件的“测试压缩包”功能测试一下); 7、为和基础版本有所区别,特将修改版本号从2.0.0.0开始编号; 修改依据: 1、依据是微软官方发布的VS2012Documentation的ISO中的“helpcontentsetup.msha”; 注意事项: 1、运行本软件必须安装“.NET Framework 4.5”; 2、务必在下载一门语言的“Help Library”之前设置“存储目录”; 3、本软件为了更好的服务大家,因而不兼容本软件的修改基础“Visual Studio 2012/2013/2015 Help Downloader 1.2.0.0 Beta”所下的包; 联系修改人: 1、如有修改意见或建议,请到“http://blog.csdn.net/fksec/article/details/8796446”留言,本人将第一时间回复。 2、如不方便上“csdn”的朋友,可以email到“CruiseYoung@Outlook.com”。 ============================================================================
软件名称: Visual Studio 2010 Help Downloader 原 名 称: Visual Studio 2010 Help Downloader 原 官 网: http://vshelpdownloader.codeplex.com/ (已失效) 软件版本: 2.0.0.5 Beta 基础版本: 1.0.0.3 Beta 软件著作人:Alexander Kozlenko 软件修改人:Cruise Young 数据来源: http://services.mtps.microsoft.com/serviceapi/ 修改内容: 1、完整索引文件内容; 2、将不同语言的文件包分语言放置; 3、兼容将不同语言的Help Library放置到同一文件夹; 4、将“xml”文件后缀更改为“html”; 5、兼容本软件的修改基础软件“Visual Studio 2010 Help Downloader v1.0.0.3 Beta”; 6、为方便用户,特对用迅雷等下载工具下载包的方式做了兼容; 7、自动删除过期文件; 8、自动删除下载错误的文件(由于是用文件长度校验,所以该条只保证99%,最好用解压软件的“测试压缩包”功能测试一下); 9、非英语“Help Library”的“Book”包含完整的“英语“Help Library”Book”,从而和vs2012一样; 10、为和基础版本有所区别,特将修改版本号从2.0.0.0开始编号; 2013.05.04日更新内容 11、在下载一门语言的“Help Library”后,不关闭软件再下其它非英语的“Help Library”不用重新“Load Books”; 12、去掉重复的“product”项,和直接用VS2010--“帮助”--“管理帮助设置”--“联机安装内容”里的“product”项完全一致; 13、为了能使VS2010--“帮助”--“管理帮助设置”--“从磁盘安装内容”能识别msha文件,特更改msha文件命名方式; 2013.05.26日更新内容 14、为了响应网友提出的利用本工具下载过慢的情况,特将下载的package的url汇总到“PackageList.txt”文件,可以利用迅雷下载后,再用本工具创建索引; 15、自动加载上次所选择下载的Book项; 2013.06.12日更新内容 16、将各文件(不包括文件夹,但代码已经有相关代码,如需包括修改文件夹时间,则只需打开注释即可)的创建,修改,访问时间修改为文件内容的最后更新的时间; 2014.05.23日更新内容 17、将获取文件的下载路径,由拼接改为由代码从微软官网直接获取; 2014.05.28日更新内容 18、按照资源加载顺序,调整界面布局; 修改依据: 1、依据是VS2010安装ISO中的“helpcontentsetup.msha”等信息; 2、微软官网“http://services.mtps.microsoft.com/serviceapi/”帮助信息。 注意事项: 1、运行本软件必须安装“.NET Framework 4”; 2、务必在下载一门语言的“Help Library”之前设置“存储目录”; 联系修改人: 如有修改意见或建议,请到“http://blog.csdn.net/fksec/article/details/8796446”留言,本人将第一时间回复。 如不方便上“csdn”的朋友,可以email到“CruiseYoung@Outlook.com”。
软件名称: Visual Studio 2010 Help Downloader 原 名 称: Visual Studio 2010 Help Downloader 原 官 网: http://vshelpdownloader.codeplex.com/ (已失效) 软件版本: 2.0.0.0 Beta 基础版本: 1.0.0.3 Beta 软件著作人:Alexander Kozlenko 软件修改人:Cruise Young 数据来源: http://services.mtps.microsoft.com/serviceapi/ 修改内容: 1、完整索引文件内容; 2、将不同语言的文件包分语言放置; 3、兼容将不同语言的Help Library放置到同一文件夹; 4、将“xml”文件后缀更改为“html”; 5、兼容本软件的修改基础软件“Visual Studio 2010 Help Downloader v1.0.0.3 Beta”; 6、为方便用户,特对用迅雷等下载工具下载包的方式做了兼容; 7、自动删除过期文件; 8、自动删除下载错误的文件(由于是用文件长度校验,所以该条只保证99%,最好用解压软件的“测试压缩包”功能测试一下); 9、非英语“Help Library”的“Book”包含完整的“英语“Help Library”Book”,从而和vs2012一样; 10、为和基础版本有所区别,特将修改版本号从2.0.0.0开始编号; 修改依据: 1、依据是VS2012安装ISO中的“helpcontentsetup.msha”等信息; 2、微软官网“http://services.mtps.microsoft.com/serviceapi/”帮助信息。 注意事项: 1、运行本软件必须安装“.NET Framework 4”; 2、务必在下载一门语言的“Help Library”之前设置“存储目录”; 3、在下载一门语言的“Help Library”后,不关闭软件再其它非英语的“Help Library”必须重新“Load Books”; 联系修改人: 如有修改意见或建议,请到“http://blog.csdn.net/fksec/article/details/8796446”留言,本人将第一时间回复。 如不方便上“csdn”的朋友,可以email到“CruiseYoung@Outlook.com”。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值