¿Cómo crear enlaces similares a MSDN en el sitio web de documentación de Sandcastle?

Question

He generado una documentación del sitio web de mi proyecto con Sandcastle. Este sitio web usa marcos así que cuando hago clic en los sitios, mi URL en el navegador no cambia.

Me gustaría cambiar la URL en el navegador cuando navego por la documentación del sitio web generada con Sandcastle. ¿Por qué? Porque me gustaría vincularme a subpáginas concretas de documentación de otras partes de mi entorno de desarrollador.

Y más me gustaría tener estos enlaces permanentes. Entonces cuando genero una vez más la documentación de la nueva versión de mi proyecto, los enlaces no cambiarán, así que no necesitaré cambiar todos los enlaces a nuevos.

¿Es esto posible y cómo lograr esto?

Answer 1

el fin de crear vínculos correctos a subpáginas específicas de documentación que puede usar petición similar:? $ DOCUMENTATION_ROOT $/Index.aspx topic = html/$ $ topic_id .htm

P. ej http://www.ewoodruff.us/shfbdocs/Index.aspx?topic=html/8dcbb69b-7a1a-4049-8e6b-2bf344efbbc9.htm en lugar de http://www.ewoodruff.us/shfbdocs/html/8dcbb69b-7a1a-4049-8e6b-2bf344efbbc9.htm

Answer 2

Si se agrega el siguiente código para la parte superior de SplitScreen.js el navegador "inyectar" el marco de la TDC y se centran en el contenido se conectó directamente a (usando el truco Vitaly Shibaev mostró).

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

Este código funciona sí la documentación se coloca en la raíz de su sitio web - si lo tiene en una sub-carpeta que tenga que ampliar el "/ tema?" Y quitar la parte subcarpeta de la parte del camino

Con este cambio puede utilizar los "enlaces directos". También espero que las personas que lo encuentren a través de Google obtengan una mejor experiencia (obteniendo el contenido que buscan Y la barra de TOC).

Answer 3

Vitaliy y mawtex han resuelto la parte de 'cómo unir a las subpáginas de documentación' de su pregunta.

"Hacer enlaces permanentes para que no cambien al regenerar la documentación" parte de sus preguntas se resuelve automáticamente, ya que los nombres de archivo html creados se basan en un hash del nombre del tema de forma predeterminada. Es decir. Si no cambia la parte de su código que está documentando, entonces usará el mismo nombre de archivo.

Puede cambiar la forma en que se generan los nombres de los archivos html, pero todos los métodos se basan en el nombre del miembro o hash del ID del tema, por lo que los enlaces no deberían romperse si el código no ha cambiado.

Consulte la documentación NamingMethod de Sandcastle Help File Builder para obtener más información.