問題タブ [shfb]

する必要がある

1. Web サイト (HTML) である Sandcastle Help File Builder (SHFB) 出力を Media wiki 形式に変換する
2. 変換されたページを、設定した MediaWiki に直接転送/含める方法を見つけてください。

何か案は？ウェブサイトには 1000 ページ以上の HTML ファイルがあります (SHFB の出力)。

私は html2wiki コンバーターを使用することを考えました..これらの 1000 ページを wiki 形式に変換するスクリプトを探し回ることを考えることができました... (1) を処理できるスクリプトです。

しかし、パイプラインの最後の部分にまだブロックが残っています - 変換されたページを Wiki に直接フィードする方法は?

SandCastle Help FileBuilder1.8.0.1とそのMAMLコンテンツエディターを使用しています。

デフォルトの1以外の値から始まる順序付きリストが必要です。

10. Some data

11. Other data

私は次のことを試しましたが、OL要素のHTMLからのように機能しません。

どうすればこれを達成できますか？

サンドキャッスルスタイルでどのファイルを変更する必要があるか誰かが知っていますか？

Sandcastle Helpfile Builder で chm を作成するときに、xmldoc ブロック内のリストを順序付きリストとしてレンダリングするにはどうすればよいですか?

以下は機能しません。

私が解決しようとしている特定のケースでは、リストは <summary/> 要素内にあります。

私のプロジェクトでは、SandcastleとSandcastle HelpFileBuilderを使用してドキュメントを生成しています。

カスタマイズされたバージョンのscript_manifold.jsを使用して、ページ間でユーザーの言語設定を保持します（デフォルトバージョンでは、ページごとに言語設定がリセットされます）。

現在、スクリプトはSandcastle \ statement \ VS2005\scriptsフォルダーにあります。

Sandcastleのインストールを台無しにすることなく、このスクリプトをカスタムバージョンでオーバーライドする方法はありますか？つまり、ソースコードとともにソース管理にチェックインされるファイルを作成し、そのファイルをデフォルトのSandcastleファイルの代わりにSHFBで使用することはできますか？

概念的なドキュメントに Sandcastle を使用しており、ドキュメントを非 CHM または HTML 形式、つまり印刷物で提供したいクライアントがいます。Word や PDF など、メールに簡単に添付できるものです。ユースケースには通常、トピックを送信したい人が含まれます。

私たちができる最善の方法は、HTML を表示しているときに CHM ビューアーから印刷するか、Chrome から PDF に出力することです。これらには、アンカー要素のクリックが削除されたり、画像が白黒になったりするなどの問題があります。

Codeplex の SHFB ディスカッションには、既知の代替手段がないことを示すスレッドがあります - http://shfb.codeplex.com/discussions/260489。より多くの入力と可視性を得ることを期待して、ここに質問を再投稿しています。

私は、Sandcastle で作成されている技術文書に、いくつかの概念文書を書くことに取り組んでいます。

良い例やリンクはあまりありませんが、MAML のコツをつかみ始めています。これを見て理解するための優れたリソースを誰かが持っているなら、私はそれを感謝します。

私は、概念的なドキュメントがドキュメント ソースのいくつかの型を参照するようにしたいと考えていました。コード内にもあるドキュメントにリンクする ">Type のような単純なものを配置する方法はありますか?

編集：私は初めてなので、これは私にとって大きな問題でした。

コード項目にリンクする最良の方法は、エンティティ ウィンドウから取得することです。エンティティ ウィンドウを開くには、ウィンドウ > エンティティ参照に移動します。ここから、適切なタイプ/メソッド/プロパティを見つけて、結果からコードにドラッグできます。

MAML リファレンス ガイドは、Sandcastle Styles のダウンロード ( http://sandcastlestyles.codeplex.com/ ) に含まれており、フォーマット方法の学習に非常に役立ちます。

Sandcastle Help File Builder を使用してライブラリのヘルプ ファイルを作成しています。このライブラリには、同じコード ベースから構築された 3 つのバージョン (.NET、Silverlight、および Windows Phone 7) があります。

ヘルプ ファイル ページの下部にあるメソッド名とバージョン情報の横にプラットフォーム アイコンを追加したいと考えています。以下のスクリーンショットのようなもの。このような情報をヘルプ ファイルに追加するにはどうすればよいですか?

解決策を見つけるために多くのことをグーグルで検索しましたが、何かが足りないようです。

ほとんどの記事では、ビルド ファイル ( TfsBuild.proj) を変更する必要があると書かれています。しかし、そのファイルがどこにも見つかりません。もう少しグーグルで調べてみると、TFS2010 で新しいビルド モデルに置き換えられたことがわかりますか?

SHFBの公式ドキュメントには次のように書かれています：

ビルド ファイルを変更します。この例では、毎日のビルドを使用してドキュメントを生成します。

どのファイルとどのように言及されていません。

Sandcastle Helpfile Builder を使用してドキュメントも生成するように TFS Build Server を構成する方法について、誰か親切で光を当てることができますか?

多くの内部インターフェイスを実装するクラスがありますが、この情報は読者にとって無関係であるため、ドキュメントの読者がクラスがこれらすべての内部インターフェイスを実装していることを確認できないようにしたいと考えています。

たとえば、次のクラスがあるとします。

ドキュメンテーション リーダーが MyPublicClass を次のように認識できるようにします。

SandcastleまたはSHFBでこれを達成することは可能ですか?どのように?

ありがとうございました！