問題タブ [maml]

職場では、ヘルプ ファイルの作成に Sandcastle を使用しています。しばらくの間 S​​andCastleGUI を使用しており、ヘルプ ファイルに追加のページを作成する方法を探しています。これらのページは、MAML と呼ばれる XML 形式で記述されています。唯一の問題は、これらのファイル形式に適したエディターが見つからなかったことです。

追加のドキュメント ページを作成および編集するための WYSIWYG エディタを探しています。

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

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

10. Some data

11. Other data

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

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

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

私は新しいライブラリに取り組んでおり、非常にうまく機能する SandCastle と共に API ドキュメントに XML コメントを使用しています。

しかし、概念、全体的なアーキテクチャ、動作するデモなど、クラス図などをカバーする追加のドキュメントを書く必要があります.

2 つのオプションがあります。

1. ウィキ エンジンを使用して、ドキュメンテーションをウィキ スタイルで記述します。
2. この目的のためと思われる MAML を使用します。

wiki を使用することは安全な解決策に思えます。なぜなら、利用可能な安定した人気のある無料のエンジンがたくさんあるからです。ただし、API と概念的なドキュメントは連携しません (クロスリンク、外観など)。MAML を使用することは学習曲線を意味し、それがどの程度成熟しているか、およびその利点/欠点は何かについてはわかりません。

この目的で MAML/Wiki を使用したことがありますか?また、何を学んだのでしょうか? あなたは私に何を提案しますか?

PowerShellコマンドレットヘルプファイルを生成するためのユーティリティを知っている人はいますか？手でそれをすることは少し退屈なようです...

私が見つけた場所：http：//blogs.msdn.com/powershell/archive/2007/09/01/new-and-improved-cmdlet-help-editor-tool.aspx

更新されたバージョンはありますか？モジュールを選択できません。バイナリモジュールがあります。

Powershell の Get-Help コマンドレットで使用する MAML ファイルを生成しています。それらを検証したいと思います。検証できるスキーマファイルがどこかにあるかどうか、誰か教えてもらえますか?

Sandcastle Help File Builderを使用していますが、「概念コンテンツ」に色付きのHTMLコードスニペットを含めたいと思います。これは可能ですか？もしそうなら、どのように？

<code>、<codeExample>、および<sampleCode language ="HTML"/>を試しました。

これまでのところ最良の結果は、サンプルHTMLをHTMLエンコードし、そのように.snippetsファイルに配置することです。

次に、.amlファイルでそれを参照します。

色付けしたいのですが、フォーマットを追加する方法がわかりません。

ドキュメントでメソッドを参照するときは、次のように記述します。M：MyClass.MyMethod（System.String）

拡張メソッドを参照する必要がある場合、どうすれば同じことができますか？

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

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

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

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

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

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

BuildAction を None にして、test.aml ファイルを Sandcastle プロジェクトに追加しました。

また、Content Layout.content ファイルを追加し、レイアウトに test.aml を追加しました。ヘルプ (Web サイト形式のみ) を作成すると、TOC にトピックが含まれていますが、コンテンツがありません。トピックをクリックしても何も起こらず、前のトピックのままです。

何か不足していますか、それとも SHFB の既知の問題/制限ですか?

SHFBのv1.9.4.0を使用しています。

反映されたコード セクションを (必ずしも) 含まないヘルプ システムを作成しようとしています。最新の Sandcastle Help File Builder を使用して、MAML XML ファイルのみを含めることは可能ですか?現在、私は

エラー BE0042: アセンブリまたは Visual Studio ソリューション/プロジェクト ファイルの形式で少なくとも 1 つのドキュメント ソースを指定する必要があります。