test

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

メタ情報トピックの作成

メタ情報セクションには、本の中に著作権に関するページがあるのと同様に、ボリューム・タイトル、著作権、商標、およびその他の注意事項などの情報が含まれています。

メタ情報セクションの 2 番目の使用法は、通常のトピック階層の一部ではないヘルプ・トピックを入力することです。これらの非階層トピックは、簡易ヘルプ・ダイアログ・ボックスにあるトピックをポップアップするカスタム定義のリンクを作成するのに有用です。

メタ情報セクションを作成するには

  1. 次のように <metainfo> タグを入力してセクションを始め、必須の副要素である <title> と <copyright> を入力します。

       <metainfo>

<title> Volume Title Here

<copyright>
Body of copyright topic here..
.
.

  2. 次のようにオプションの要素のどれかを入力します。

       <abstract>
Body of the abstract topic here.
Do not use any HelpTag markup within the abstract!

  3. 終了タグ <¥metainfo> を入力してセクションを終了します。

       .
.
.
<¥metainfo>
    注 -

    メタ情報セクションにある要素の中には、トピックのヘッダの前に <head> タグが必要なものもあります。

    <abstract> セクションを使用することをお勧めします。ヘルプ・ボリュームにアクセスするアプリケーションはこの情報を使用してボリュームの簡単な説明を行います。その抜粋は単純なテキスト・ウィンドウ (複数のフォントやグラフィック・フォーマットはサポートしていない) に表示される可能性があるので、ヘルプタグのマークアップを取り込まないようにしてください。

例

次の例は、一般的なメタ情報セクションです。

<metainfo>
  <title>  Report Master, Version 1.0

   <copyright>
     <otherhead> Report Master

     <image>
     Version 1.0
     &copy; Copyright Reports Incorporated 1995
     All rights reserved.
     <¥image>

   <abstract>
     This is the online help for the mythical Report Master
     application. This help includes a self-guided tutorial,
     a summary of common tasks, general concepts, and quick
     reference summaries.

 <¥metainfo>

<image> 要素は、設計者が入力した改行を維持するために使用されます。&copy; は著作権のシンボルを挿入します。

関連項目