¿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 utiliza 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 vincular a subpáginas concretas de documentación de otras partes de mi entorno de desarrollador.

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

¿Es esto posible y cómo lograrlo?

Answer 1

Para crear enlaces correctos a subpáginas específicas de documentación, puede utilizar una solicitud similar: $ DOCUMENTATION_ROOT $ / Index.aspx? topic = html / $ TOPIC_ID $ .htm

Por ejemplo. 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 agrega el siguiente código en la parte superior de SplitScreen.js , el navegador "inyectará" el marco TOC y enfóquese en el contenido al que se vinculó directamente (usando el truco que mostró Vitaly Shibaev).

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

Este código funciona, la documentación se encuentra en la raíz de su sitio web; si lo tiene en una subcarpeta, debe expandirlo en " /? topic " y elimine la parte de la subcarpeta de la parte del nombre de ruta.

Con este cambio, puede usar 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 buscaron Y la barra de TOC).

Answer 3

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

La " hacer que los enlaces sean permanentes para que no cambien cuando se regenera 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, utilizará el mismo nombre de archivo.

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

Vea <> href = "http://www.ewoodruff.us/shfbdocs/Index.aspx?topic=html/c18d6cb6-e4e4-4944-84ee-f867aa6cfb0d.htm" rel = "nofollow noreferrer "> Documentación de NamingMethod para más información.