我用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文檔獲取更多信息。