Come creare collegamenti simili a MSDN nel sito Web della documentazione di Sandcastle?

Question

Ho generato una documentazione del sito Web del mio progetto con Sandcastle. Questo sito Web utilizza i frame, quindi quando clicco su alcuni siti il ​​mio URL nel browser non cambia.

Mi piacerebbe avere l'URL modificato nel browser quando sfoglio la documentazione del sito Web generata con Sandcastle. Perché? Perché vorrei collegare a sottopagine concrete di documentazione da altre parti del mio ambiente di sviluppo.

E altro ancora vorrei avere questo collegamento permanente. Quindi, quando generi ancora una volta documentazione dalla nuova versione del mio progetto, i collegamenti non cambieranno in modo che non avrò bisogno di cambiare tutti i link in nuovi.

È possibile e come farlo?

Answer 1

Al fine di creare collegamenti a pagine secondarie corrette specifiche di documentazione si possono utilizzare richiesta simile:? $ DOCUMENTATION_ROOT $/Index.aspx topic = html/$ topic_id $ htm

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

Answer 2

Se si aggiunge il codice qui sotto in cima SplitScreen.js il browser "iniettare" la cornice TOC e concentrarsi sul contenuto si è collegato direttamente al (usando il trucco Vitaly Shibaev mostrato).

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

Questo codice funziona che la documentazione è posta alla radice del tuo sito web - se lo avete in una sottocartella è necessario espandere su "/ argomento?" E togliere la parte sottocartella dalla parte del percorso.

Con questa modifica è possibile utilizzare i "collegamenti diretti". Mi aspetto anche che le persone che ti trovano tramite Google ottengano un'esperienza migliore (ottenendo il contenuto cercato e la barra del sommario).

Answer 3

Vitaliy e mawtex hanno risolto la parte "come collegare alla sottopagine della documentazione" della domanda.

Il "creare collegamenti permanenti in modo che non cambino quando si rigenera la documentazione" una parte delle domande viene risolta automaticamente, poiché i nomi di file HTML creati sono basati su un hash del nome dell'argomento per impostazione predefinita. Cioè Se non si modifica la parte del codice che si sta documentando, verrà utilizzato lo stesso nome file.

È possibile modificare il modo in cui vengono generati i nomi di file html, ma tutti i metodi dati si basano sul nome del membro o su un hash dell'ID argomento, pertanto i collegamenti non dovrebbero interrompersi se il codice non è stato modificato.

Vedere la documentazione di Sandcastle Help File Builder NamingMethod per ulteriori informazioni.