SandcastleのドキュメントWebサイトでMSDNのようなリンクを作成する方法は？

Question

SandcastleでのプロジェクトのWebサイトドキュメントを生成しました。このWebサイトはフレームを使用しているため、ブラウザでURLが変更されないサイトをクリックしても、

Sandcastleで生成されたWebサイトのドキュメントを参照するときに、ブラウザーでURLを変更したいと思います。どうして？開発者環境の他の部分からドキュメントの具体的なサブページにリンクしたいので。

さらに、このリンクを永続的にしたいと思います。したがって、プロジェクトの新しいバージョンからもう一度ドキュメントを生成しても、リンクは変更されないため、すべてのリンクを新規に変更する必要はありません。

これは可能ですか？これを達成する方法は？

Answer 1

ドキュメントの特定のサブページへの正しいリンクを作成するには、同様のリクエストを使用できます：$ 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 http://www.ewoodruff.us/の代わりにshfbdocs / html / 8dcbb69b-7a1a-4049-8e6b-2bf344efbbc9.htm

Answer 2

以下のコードを SplitScreen.js の先頭に追加すると、ブラウザは「インジェクト」します; TOCフレームを作成し、直接リンクしたコンテンツに集中します（Vitaly Shibaevが示したトリックを使用）。

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

このコードは、ドキュメントがWebサイトのルートに配置されている場合に機能します。サブフォルダーにドキュメントがある場合は、「/？topic」を展開する必要があります。そして、サブフォルダ部分をパス名部分から削除します。

この変更では、「ダイレクトリンク」を使用できます。また、Googleであなたを見つけた人がより良い体験を得られると期待しています（彼らが検索したコンテンツと目次バーを取得します）。

Answer 3

Vitaliy および mawtex は解決しました質問の「ドキュメントサブページへのリンク方法」の部分。

「ドキュメントの再生成時にリンクが変更されないように、リンクを永続的にする」作成されたhtmlファイル名はデフォルトでトピック名のハッシュに基づいているため、質問の一部は自動的に解決されます。つまり文書化するコードの一部を変更しない場合、同じファイル名が使用されます。

htmlファイル名の生成方法は変更できますが、指定されたすべてのメソッドはメンバー名またはトピックIDのハッシュに基づいているため、コードが変更されていなくてもリンクは壊れません。

Sandcastle Help File Builderの詳細については、NamingMethod のドキュメントを参照してください。