test

共通デスクトップ環境 プログラマーズ・ガイド (ヘルプ・システム編)

<abstract>

概要

ヘルプ・ボリュームの簡単な説明です。

形式

<metainfo>
   .
   .
   .
   <abstract>
   abstract text here ...
   <¥abstract>
   .
   .
   .
<¥metainfo>

概要はマークアップを認識しないアプリケーションが読んだり表示したりするため、概要のテキストにはヘルプタグ・マークアップを入れません。

<abstract> 要素は自動的に ID 文字列 _abstract に割り当てられます。設計者が定義した ID は割り当てられません。_abstractID は <link> 要素と共に使用できますが、<xref> 要素とは使用できません。

概要のテキストにはオプションの <head> があります。

例

次のマークアップは、ヘルプ・ボリュームの内容を簡単に記述しています。

<abstract>
Online help for the Application Manager Version 1.0.
<¥abstract>

注

要素を <metainfo> 要素内でリンクさせるときは、必ず type=Definition リンクにしてください。

次の例は概要をリンクさせる方法を示します。

<link hyperlink= "_abstract" type=Definition>
Choose this link for an abstract.<¥link>

関連項目