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

Question

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

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

Et plus encore je voudrais avoir ces liens permanents. Donc, quand je génère à nouveau une 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 vers de nouveaux.

Est-ce possible et comment y parvenir?

Answer 1

Afin de créer des liens corrects à des sous-pages spécifiques de la documentation que vous pouvez utiliser la même demande: $ DOCUMENTATION_ROOT $/Index.aspx topic = html/$ topic_id $ .htm

Par ex 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 » le cadre de table des matières et de se concentrer sur le contenu vous avez accédé directement (en utilisant l'astuce Vitaly Shibaev a montré).

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

Ce code fonctionne de la documentation est placé à la racine de votre site Web - si vous l'avez dans un sous-dossier que vous avez besoin de développer «/sujet? » Et enlever la partie sous-dossier de la pathname partie.

Avec cette modification, vous pouvez utiliser les "liens directs". Je m'attends également à ce que les gens qui vous trouvent via Google obtiennent une meilleure expérience (obtenir le contenu qu'ils ont recherché et la barre TOC).

Answer 3

Vitaliy et mawtex ont résolu la partie «comment lier à la sous-page de documentation» de votre question. La partie «Rendre permanent les liens afin qu'ils ne changent pas lors de la régénération de la documentation» est automatiquement résolue, puisque 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 changez pas la partie de votre code que vous documentez, il utilisera le même nom de fichier.

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 un hachage de l'ID de rubrique, les liens ne doivent donc pas être rompus si le code n'a pas changé.

Consultez la documentation NamingMethod de Sandcastle Help File Builder pour plus d'informations.