Comment créer des liens de type MSDN dans le site Web de documentation Sandcastle?

Question

J'ai généré une documentation de site Web sur mon projet avec Sandcastle. Ce site Web utilise des cadres. Ainsi, lorsque je clique sur des sites, mon URL dans le navigateur ne change pas.

J'aimerais que l'URL soit modifiée dans le navigateur lorsque je navigue dans la documentation du site Web générée avec Sandcastle. Pourquoi? Parce que je voudrais créer un lien vers des sous-pages concrètes de documentation d'autres parties de mon environnement de développement.

Et plus encore, j'aimerais que ces liens soient permanents. Ainsi, lorsque je générerai à nouveau de la documentation à partir de la nouvelle version de mon projet, les liens ne changeront pas, de sorte que je n'aurai pas besoin de changer tous les liens en nouveaux.

Est-ce possible et comment y parvenir?

Answer 1

Pour créer des liens corrects vers des sous-pages spécifiques de la documentation, vous pouvez utiliser une requête similaire: $ DOCUMENTATION_ROOT $ / Index.aspx? topic = html / $ TOPIC_ID $ .htm

E.g. http: // www. ewoodruff.us/shfbdocs/Index.aspx?topic=html/8dcbb69b-7a1a-4049-8e6b-2bf344efbbc9.htm au lieu de http://www.ewoodruff.us/ shfbdocs / html / 8dcbb69b-7a1a-4049-8e6b-2bf344efbbc9.htm

Answer 2

Si vous ajoutez le code ci-dessous en haut de SplitScreen.js , le navigateur va "injecter". cadre de la table des matières et concentrez-vous sur le contenu que vous avez lié directement (en utilisant le truc montré par Vitaly Shibaev).

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

Ce code fonctionne si la documentation est placée à la racine de votre site Web. Si vous l'avez dans un sous-dossier, vous devez développer " /? topic " et supprimez la partie sous-dossier de la partie chemin.

Avec ce changement, vous pouvez utiliser les "liens directs". Je m'attends également à ce que les internautes qui vous trouvent via Google obtiennent une meilleure expérience (obtention du contenu recherché ET de la barre des TOC).

Answer 3

Vitaliy et mawtex ont résolu la partie "comment lier à des sous-pages de documentation" de votre question.

La "création de liens permanents afin qu'ils ne changent pas lors de la régénération de la documentation" une partie de vos questions est résolue automatiquement, car les noms de fichiers HTML créés sont basés sur un hachage du nom de la rubrique par défaut. C'est à dire. Si vous ne modifiez pas la partie de votre code que vous documentez, le même nom de fichier sera utilisé.

Vous pouvez modifier la façon dont les noms de fichiers HTML sont générés, mais toutes les méthodes données sont basées sur le nom du membre ou sur un hachage de l'ID de la rubrique. Les liens ne doivent donc pas se rompre si le code n'a pas changé.

Voir le fichier d'aide du constructeur de fichiers Sandcastle NamingMethod documentation pour plus d'informations.