我用Sandcastle生成了我的项目的网站文档。这个网站使用框架,所以当我点击浏览器时,我的网址没有变化。如何在Sandcastle文档网站中创建类似MSDN的链接?
我想有网址的浏览器改变了,当我浏览通过与沙堡生成的网站文件。为什么?因为我想链接到我的开发人员环境其他部分的文档的具体子页面。
还有更多,我想这个链接永久。所以当我再次从我的项目的新版本生成文档时,链接不会改变,因此我不需要将所有链接更改为新的。
这是可能的,以及如何acomplish呢?
我用Sandcastle生成了我的项目的网站文档。这个网站使用框架,所以当我点击浏览器时,我的网址没有变化。如何在Sandcastle文档网站中创建类似MSDN的链接?
我想有网址的浏览器改变了,当我浏览通过与沙堡生成的网站文件。为什么?因为我想链接到我的开发人员环境其他部分的文档的具体子页面。
还有更多,我想这个链接永久。所以当我再次从我的项目的新版本生成文档时,链接不会改变,因此我不需要将所有链接更改为新的。
这是可能的,以及如何acomplish呢?
为了建立正确的链接文件的特定子页面,你可以使用类似的请求:$ DOCUMENTATION_ROOT $/Index.aspx的话题= HTML/$ TOPIC_ID $的.htm
例如http://www.ewoodruff.us/shfbdocs/Index.aspx?topic=html/8dcbb69b-7a1a-4049-8e6b-2bf344efbbc9.htm 代替http://www.ewoodruff.us/shfbdocs/html/8dcbb69b-7a1a-4049-8e6b-2bf344efbbc9.htm
如果添加下面的代码的SplitScreen.js
顶部的浏览器将“注入”的TOC帧,并专注于您直接链接到内容(使用的伎俩维塔利Shibaev显示)。
if (window==top) {
window.location = "/?topic=" + (window.location.pathname.substring(1));
}
此代码工作它的文件被放置在您的网站的根 - 如果你在子文件夹中有它,你需要扩大“/话题?”,然后从删除子文件夹中的一部分路径名部分。
随着这一变化,您可以使用“直接联系”。我也希望通过Google找到你的人可以获得更好的体验(获取他们搜索的内容和TOC栏)。
Vitaliy和mawtex已经解决了“如何链接到文档子页面”部分的问题。
的“造链接永久所以再生文档时,他们不会改变”你的问题部分,因为创建的HTML文件名称是基于默认的主题名称的哈希值会自动解决。即如果你不改变你正在记录的代码部分,那么它将使用相同的文件名。
您可以更改正在生成的HTML文件名的方式,但所有给出的方法是基于成员的名称或主题ID的哈希值,所以如果代码并没有改变链接应该不会打破。
见沙堡帮助文件生成的NamingMethod文档获取更多信息。