ホーム > DITA コンテンツ参照

DITA コンテンツ参照

構造化文書のコンテンツ参照について、およびそのコンテンツを使用して別の DITA トピックのコンテンツ参照を作成する方法について説明します。

コンテンツ参照(conref)は、DITA トピック内のコンテンツ(エレメント)または別の DITA トピックにある DITA マップへの参照を作成するために使用されます。 conref を使用すると、DITA トピック全体のコンテンツ(エレメント)を再利用できます。 conref は、エレメントに割り当てられたDITA ID 属性に基づいています。 これは、トピック内でエレメントの位置が変更されても、ID がそのままであれば参照はそのまま残ることを意味します。

直接参照を使用して、対象のトピックまたはエレメントを含む DITA トピック(.xml ファイル)を直接ポイントできます。または、間接参照を使用して、キースペースで定義されたキーにポイントできます。 詳しくは、「DITA 参照」を参照してください。

DITA エレメントカタログ内のほとんどすべてのエレメントに対して conref を作成できます。 DITA トピック の conref を作成することで、トピック全体を再利用可能にできます。また、<キーワード><pH> エレメントの conref を作成して、用語や単語も再利用できます。<>conref を作成するための唯一の必要条件は、エレメントに DITA ID 属性.

トピックを設定して conref を使用

FrameMaker で conref を使用するトピックを設定する方法について説明します。

DITA トピックで conref を作成するには、再利用するコンテンツ(エレメント)が含まれている DITA トピック(直接参照)または DITA マップ(間接参照)を最初に作成する必要があります。 例えば、表、番号リスト、画像を複数のトピック間で再利用するとします。 これらのエレメントはソーストピックに追加する必要があります。 間接参照を使用している場合、トピックは DITA マップに追加されます。 また、エレメントを再利用可能にするには、固有の ID をエレメントに割り当てる必要があります。DITA コンテンツを再利用可能にする方法についての詳細は、「 参照コンテンツの設定.

DITA Conref ダイアログ

トピックの設定方法を学び、FrameMaker で conref を使用するように、直接および間接 conref を FrameMaker の DITA コンテンツに追加するために、DITA conref ダイアログを使用する方法を学びます。

DITA Conref ダイアログを使用して、直接または間接 conref を DITA の内容に追加します。

DITA Conref ダイアログを開くには:

  • Conref > を挿入を選択します。

DITA Conref ダイアログ
DITA Conref ダイアログを使用して、直接または間接 conref を DITA コンテンツに追加

DITA Conref ダイアログを使用するには:

A(ターゲット/ファイル):

DITA 参照を使用して conref を挿入する場合はこのオプションを選びます。詳しくは、「conref の作成」を参照してください。

B(ターゲット/キー):

DITA 参照を使用して conref を挿入する場合はこのオプションを選びます。詳しくは、「DITA リンクを作成する」を参照してください。

C(ターゲット/両方):

直接または間接参照を使用してリンクを作成するには、このオプションを選択します。

D(ファイル/キー設定):

ターゲットがファイルに設定されている場合は、現在開いているトピックのリストから直接参照に使用する DITA トピックを選択します。また、現在開かれていないトピックを参照して選択することができます。

ターゲットがキーに設定されている場合、間接参照に使用するキーを選択します。DITA キースペースマネージャーダイアログを開くことも可能です。このダイアログでは、キースペースを作成現在のトピック向けにデフォルトのキースペースを設定します。

E(フィルターテキスト):

リンクを作成したい必要なトピックまたはキーを検索します。このスマート検索は、「フィルター」テキストボックスへの入力開始すると同時にエレメントをフィルターします。コンテンツはエレメントタグ、ID、またはテキスト(内容)に基づいてフィルターできます。

必要なトピックが見つかったら、リンクとして含めるエレメントを選択します。このリンクエレメントは別のトピックとの関係を定義します。

F(Conref 最終エレメント):

conref の一連のエレメントの最終エレメントとしてエレメントを選択します。 詳しくは、範囲内のエレメントに対する conref の作成を参照してください。

conref の使用

FrameMaker での conref の操作方法、conref の作成方法、および更新方法を参照してください。

DITA トピックまたはマップ内で DITA Conref ダイアログ.

この節では次のトピックを説明します。

conref の作成

現在のトピックまたはマップで DITA トピックまたはマップへの conref を作成するには、まず対象となる 参照コンテンツの設定 トピックまたはマップで

次に、対象となる DITA コンテンツへの直接的または間接的な参照を作成します。

  1. トピックまたはマップ上で conref を挿入する場所に挿入ポイントを配置します。

    トピック内の場所に conref を挿入するには、conref エレメントに関連する挿入ポイントを配置する必要があります。

    <li> (リスト項目)の conref エレメントは、 <ol> または <ul> リストに配置する必要があります。

    表の<行>は、<表>または <simpletable> に配置する必要があります。

    表の <エントリ>の場合は、表の <行>に挿入ポイントを配置することはできません。置き換える既存の <エントリ> を選択する必要があります。

  2. Conref > を挿入を選択します。

    DITA Conref ダイアログ が表示されます。

  3. リンクはターゲットコンテンツの直接参照または間接参照として追加できます。 詳しくは、DITA 参照を参照してください。

    ターゲットコンテンツへの直接参照を作成するには:

    1. ターゲットの「ファイル」オプションを選択し、参照トピックを含むファイルを選択します。

    2. 現在のトピックまたは現在開いているトピックから選択します。または、「参照」ボタンを使用して現在開いていないトピックを選択します。
    3. DITA トピックを選択すると、固有の ID が割り当てられるエレメントがエレメントリストに表示されます。

      固有の ID が割り当てられている、選択したエレメントタグの DITA トピックにあるエレメントが、エレメントリストに表示されます。エレメントに固有の ID が割り当てられていない場合、固有の ID をエレメントに割り当てるできます。

    4. 現在のトピックに conref として挿入するエレメントを選択します。

      このリストには、エレメントの ID とコンテンツ(テキストエレメントの場合)も表示されます。

    ソーストピックの conref エレメントに変更を行った場合、ソーストピックを保存してコンテナートピックを更新し、その更新を表示する必要があります。<>

    ターゲットコンテンツへの間接参照を作成するには:

    1. ターゲットの「キー」オプションを選択し、キースペースマネージャーをクリックします。

    2. DITA キースペースマネージャー ダイアログで、定義済みのキーリストからキーを選択し、 OKをクリックします。

      キー参照を追加する方法について詳しくは、 キースペースを使用した DITA キー参照の管理を参照してください。

      キーを選択すると、キースペースに含められる DITA トピックタイプがエレメントタグリストに表示されます。 詳しくは、 キースペースを作成を参照してください。

    3. エレメントタグを選択します。

      固有の ID が割り当てられている、選択したエレメントタグの DITA トピックにあるエレメントが、エレメントリストに表示されます。エレメントに固有の ID が割り当てられていない場合、固有の ID をエレメントに割り当てるできます。

    4. conref として挿入するエレメントを選択し、「OK」をクリックします。

  4. 「挿入」をクリックします。

範囲内のエレメントに対する conref の作成

範囲内のエレメントに conref を作成することができます。 例えば、 <p> (paragraph)エレメントがいくつかあって、それらを範囲内で参照するとします。すべての <p> エレメントに対し conref を 1 つ作成することができます。

注: 内容参照の範囲を指定するには、範囲内のエレメントが同じタイプである必要があります。 少なくとも開始エレメントと終了エレメントは固有の ID を持っている必要があります。
  1. その範囲内で最初のエレメントを選択するには、そのセクションの手順を行います。 conref の作成 ただし、 <「挿入」>はクリックしないでください。

  2. Conref 最終エレメントドロップダウンリストで、conref に含める範囲内で最終エレメントを選択します。

  3. 「挿入」をクリックします。

conref の更新

再利用可能なエレメントを別のトピックで参照した後にこれを更新する場合、アップデートを表示するにはトピックの conref を更新する必要があります。

トピックの conref を更新するには:

  1. 構造 > DITA > 参照を更新を選択します。

    DITA 参照を更新 ダイアログが表示されます。

  2. ファイル内のすべてのトピック参照を更新」を選択します。

  3. OK」をクリックします。

現在のトピックのすべての conref が更新されます。