Reference
DITA Reference トピックでは、プログラミング言語やアプリケーションプログラミングインタフェース (API) のコマンドなど、特定のテーマまたは製品の標準的な機能について説明します。DITA Reference トピックは、レシピ、カタログ、参考文献一覧など、一定の形式で表される特定のテーマに関する情報です。
Reference には、以下のプライマリタグが含まれます。
• reference - このタグに、ほかのすべてのタグが囲まれます。
• title - トピックの主題
• shortdesc - トピックの概要または短い説明
• prolog - 作成者、著作権、索引語など、さまざまなタイプのメタデータ。
• refbody - トピックの実際のコンテンツが含まれます。
通常、Reference は 1 つまたは複数のセクション、表、リストにまとめられています。これらは任意の順序で配置できます。以下に Reference 本文内のプライマリタグを示します。
◦ section - 1 つの参照にグループ化するコンテンツのコンテナ
◦ refsyn - 構文または類似の情報
◦ properties - 参照のテーマに関連付けられたプロパティのリストで、通常は表として表示されます。
◦ example - 参照情報を説明またはサポートする例
refbody タグには標準の DITA 表も含めることができます。
• related-links - 関連情報への相互参照リンクが含まれます。
これらのタグの多くはオプションであるため、必要なタグだけを選んで使用します。