Jak utworzyć linki podobne do MSDN na stronie dokumentacji Sandcastle?

Question

Wygenerowałem dokumentację internetową mojego projektu z Sandcastle. Ta strona używa ramek, więc gdy klikam strony, mój adres URL w przeglądarce się nie zmienia.

Chciałbym zmienić adres URL w przeglądarce, przeglądając dokumentację wygenerowaną przez Sandcastle. Czemu? Ponieważ chciałbym połączyć się z konkretnymi podstronami dokumentacji z innych części mojego środowiska programistycznego.

Co więcej, chciałbym, aby te linki były trwałe. Kiedy więc generuję po raz kolejny dokumentację z nowej wersji mojego projektu, linki się nie zmienią, więc nie będę musiał zmieniać wszystkich linków do nowych.

Czy to możliwe i jak to osiągnąć?

Answer 1

Aby stworzyć odpowiednie linki do konkretnych podstron dokumentacji można używać podobnego wniosku: $ DOCUMENTATION_ROOT $/Index.aspx topic = html/$ TOPIC_ID $ .htm

Np http://www.ewoodruff.us/shfbdocs/Index.aspx?topic=html/8dcbb69b-7a1a-4049-8e6b-2bf344efbbc9.htm zamiast http://www.ewoodruff.us/shfbdocs/html/8dcbb69b-7a1a-4049-8e6b-2bf344efbbc9.htm

Answer 2

Jeśli dodać poniższy kod na górę SplitScreen.js przeglądarka „wstrzyknąć” ramkę TOC i skupić się na treści, połączonej bezpośrednio (za pomocą sztuczki Witalij Shibaev pokazał).

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

Ten kod działa to dokumentacja znajduje się w katalogu głównym swojej stronie - jeśli masz go w podkatalogu trzeba rozszerzyć na „/ temacie?” I usunąć część sub-folder z część nazwy ścieżki.

Dzięki tej zmianie można użyć "bezpośrednich linków". Oczekuję też, że osoby, które znajdą Cię za pośrednictwem Google, będą miały lepsze wrażenia (zdobycie poszukiwanych treści ORAZ paska TOC).

Answer 3

Vitaliy i mawtex rozwiązały część "pytania o link do podstrony dokumentacji".

"Tworzenie trwałych linków, aby nie zmieniały się podczas regeneracji dokumentacji" część pytań jest rozwiązywana automatycznie, ponieważ utworzone nazwy plików HTML są domyślnie oparte na hashu nazwy tematu. To znaczy. Jeśli nie zmienisz części kodu, który dokumentujesz, użyjesz tej samej nazwy pliku.

Możesz zmienić sposób generowania nazw plików html, ale wszystkie podane metody są oparte na nazwie członka lub krzyżyku identyfikatora tematu, więc linki nie powinny być łamane, jeśli kod się nie zmienił.

Aby uzyskać więcej informacji, zobacz dokumentację narzędzia Sandcastle Help File Builder NamingMethod.