Как создать ссылки типа MSDN на веб-сайте документации Sandcastle?

Question

Я создал документацию для своего проекта на веб-сайте с помощью Sandcastle.На этом веб-сайте используются фреймы, поэтому, когда я просматриваю сайты, мой URL-адрес в браузере не меняется.

Я хотел бы, чтобы URL-адрес менялся в браузере при просмотре документации веб-сайта, созданной с помощью Sandcastle.Почему?Потому что я хотел бы дать ссылку на конкретные подстраницы документации из других частей моей среды разработки.

И еще, мне хотелось бы, чтобы эти ссылки были постоянными.Поэтому, когда я снова создаю документацию из новой версии моего проекта, ссылки не изменятся, поэтому мне не нужно будет менять все ссылки на новые.

Возможно ли это и как этого добиться?

Answer 1

Чтобы создать корректные ссылки на конкретные подстраницы документации, вы можете использовать аналогичный запрос:$DOCUMENTATION_ROOT$/Index.aspx?topic=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

Answer 2

Если вы добавите приведенный ниже код в верхнюю часть SplitScreen.js , браузер " вставит " рамка TOC и сфокусируйтесь на контенте, на который вы ссылались (используя трюк, который показал Виталий Шибаев).

if (window==top) {
    window.location = "/?topic=" + (window.location.pathname.substring(1));
}

Этот код работает, если документация находится в корневом каталоге вашего веб-сайта. Если у вас он есть в подпапке, вам нужно расширить раздел " /? topic " и удалите часть подпапки из части пути.

С этим изменением вы можете использовать " прямые ссылки " ;. Я также ожидаю, что люди, которые находят вас через Google, получат лучший опыт (получая контент, который они искали, и панель оглавления).

Answer 3

Виталий и mawtex решили часть вопроса, касающаяся ссылок на подстраницы документации.

" делает ссылки постоянными, чтобы они не менялись при восстановлении документации " часть ваших вопросов решается автоматически, так как созданные имена html-файлов по умолчанию основаны на хэше имени темы. То есть Если вы не измените ту часть кода, которую вы документируете, он будет использовать то же имя файла.

Вы можете изменить способ генерирования имен файлов html, но все данные методы основаны на имени члена или хэше идентификатора темы, поэтому ссылки не должны разрываться, если код не изменился.

См. Документация NamingMethod для получения дополнительной информации.