ホーム > DITA マップ

DITA マップ

DITA マップについて、および FrameMaker で DITA マップを使用する方法について説明します。

DITA マップを使用すると、DITA トピックを階層構造に編成できます。 その後、異なる出力形式を使用し、編成した内容の出力を作成できます。


DITA マップを使用して、階層構造内の DITA トピックを編成する

DITA 出力の生成について詳しくは、「DITA の公開」を参照してください。

DITA マップを使用して、間接参照に使用可能なキースペースを作成することもできます。

詳しくは、「キースペースを使用した DITA キー参照の管理」を参照してください。

DITA マップの仕様を参照してください。

DITA マップを作成する

FrameMaker で DITA マップを作成する方法について説明します。

  1. ファイル > 新規 > DITA > <map>を選択します。

    または、ファイル > 新規 > XMLを選択します。新規 XML ダイアログで、「DITA」タブに移動し、マップを選択します。

  2. デフォルトでは、DITA マップはリソースマネージャーで開かれます。

    リソースマネージャーを使用して、次の操作を行うことができます。

    • DITA マップにトピックを挿入する

    • DITA マップを保存する

    • ドキュメント表示に切り替えて、DITA マップコンテンツを表示します。

  3. 構造図エレメントパネルなどの FrameMaker ツールを使用して、DITA マップを使用できます。

  4. また、関係テーブルを DITA マップに含めることもできます。

    詳しくは、DITA 関係テーブルを参照してください。

topicref エレメントの DITA マップへの挿入

DITA マップに topicref エレメントを挿入する方法について説明します。

エレメントカタログで topicref エレメントを使用することにより、トピックを DITA マップに追加できます。 <>リソースマネージャー「子を挿入」を使用することにより、トピックを追加することもできます。

FrameMaker は DITA マップに挿入できる次の <topicref> エレメントをサポートしています。

DITA マップ

dita、トピック、概念、タスク、参照、用語集エントリ、用語集グループなどのトピックを特定します。 topicref エレメントには他の topicref エレメントを含めて階層構造を作成することもできます。

topicref elements で仕様を参照してください。

mapref

書式の属性が「ditamap」に設定された <topicref> エレメントと同等の convenience エレメントです。

mapref エレメントで仕様を参照してください。

topicset

DITA マップおよびその他の topicset エレメントで再利用可能な topicref エレメントのセットです。<>

topicset エレメントで仕様を参照してください。

keydef

キーの定義に使用される convenience エレメントです。出力にコンテンツは含まれず、目次にタイトルは含まれず、リンクやその他の関係は定義されないため、topicref エレメントの使用時に他に影響を与えません。<>

keydef エレメントで仕様を参照してください。

topicsetref

topicset エレメントを参照します。<>

topicsetref エレメントで仕様を参照してください。

DITA マップに <topicref> エレメントを挿入するには:

  1. 構造図の map エレメントのルートレベルに挿入ポイントを置きます。

  2. 構造 > DITA > Topicref を挿入を選択します。

  3. topicref、mapref、topicset、または keydef を選択すると、エレメントを挿入ダイアログが現れます。

    エレメントを挿入ダイアログを使用してエレメントを DITA マップに挿入
    エレメントを挿入ダイアログを使用してエレメントを DITA マップに挿入

  4. 挿入した topicref をキー参照として使用するには、キーの名前を入力します。

    詳しくは、キースペースを使用した DITA キー参照の管理を参照してください。

  5. HRef」ボックスで、参照するトピックの場所を入力します。または、「参照」をクリックして移動し、トピックを選択します。トピックが直接参照として追加されます。

    または、現在のトピックにキースペースを定義している場合は、KeyRef ドロップダウンリストでキー参照を選択できます。トピックは間接参照として追加されます。

    キー参照と間接参照について詳しくは、「キースペースを使用した DITA キー参照の管理」を参照してください。

DITA マップコンテンツの表示

FrameMaker を使用して DITA マップコンテンツを表示する方法、および topicref エレメントのプレビューを表示または非表示にする方法について説明します。

DITA マップに 1 つ以上の topicref エレメントを挿入すると、参照先トピックのコンテンツをドキュメント表示で参照できます。

参照先 DITA トピックは、FrameMaker で個別の文書として開くこともできます。

topicref エレメントコンテンツのプレビューの表示または非表示

  1. 単一の参照エレメントのコンテンツをプレビューするには、構造図で topicref エレメントを選択します。

    すべての参照エレメントのコンテンツをプレビューするには、トピック内の任意の場所をクリックします。ただし、エレメントが選択されていないことを確認してください。すべての topicref のコンテンツを表示するように求められます。また、参照される子のマップを表示することもできます。

  2. コンテンツをプレビューするには、構造 > DITA > Topicref を解決 > コンテンツを表示を選択します。

  3. プレビューを非表示にするには、構造 > DITA > Topicref を解決 > コンテンツを非表示を選択します。

ヒント: 単一のエレメントのプレビューを表示または非表示にするには、エレメントを右クリックし、Topicref を解決 > コンテンツを表示または Topicref を解決 > コンテンツを非表示を選択することもできます。
注:

DITA マップが子のマップへの参照を含む場合、DITA マップの「表示と非表示」オプションで、子のマップの参照されるトピックを表示または非表示にします。

ドキュメント表示で、FrameMaker は > を表示し、トピックが DITA マップの最上位トピックであることを示します。>> はトピックが DITA マップ内で第 2 レベルのトピックであるを示します。>>> はトピックが DITA マップ内で第 3 レベル(以降)であることを示します。

>、>>、および >>> で示されるトピックレベル
文書ウィンドウで >、>>、>>> で示されるトピックレベル

DITA マップで参照されるすべてのトピックを開く

DITA マップに 1 つ以上のトピックへの参照が含まれている場合、すべての参照先トピックを FrameMaker で開くことができます。

  1. DITA マップが選択されていることを確認します。

  2. Shift キーを押しながらファイル > Ditamap 内の全ファイルを開くを選択します。

    または DITA マップで、構造 > DITA > すべての Topicref を開くを選択します。

    すべてのトピック参照を閉じるには、Shift キーを押しながらファイル > Ditamap 内の全ファイルを閉じるを選択します。

注: 単一のトピックを開くには、DITA マップでトピックをダブルクリックします。

DITA マップの保存

FrameMaker で DITA マップを保存する方法について説明します

FrameMaker の「Ditamap を別名で保存」機能(ファイル > Ditamap を別名で保存)を使用すると、DITA マップを複数の出力に保存できます。DITA マップをブックとして保存するとき、フォルダー、グループなど、FrameMaker ブックの階層機能を利用できます。 ページ番号、目次など、FrameMaker ブックの機能を使用できます。

次の出力のリストは、特定の機能を提供します。

Composite Document <バージョン> (*.fm)

単一の独立した FrameMaker 文書ファイル(.fm)です。 文書には DITA マップのすべてのコンテンツが含まれています。 例えば、トピック参照が含まれています。 トピック参照は文書内に埋め込まれています。 つまり、トピックファイルに対する変更は統合文書には反映されません。 この文書を別の作成者と共有する場合、作成者に参照先トピック文書は必要ありません。 ただし、FrameMaker で使用可能な構造化ツールを使用して、統合文書を使用し続けることができます。

Book <バージョン> (*.book)

DITA マップは .book ファイルとして保存されます。このファイルには、ブック内の文書として各参照先トピックファイルが含まれています。

fm コンポーネントを含むブック <バージョン>

DITA マップは .book ファイルとして保存されます。参照先トピックファイルは .fm

ファイルとして変換されます。

DITA マップを統合文書として保存する場合、または FrameMaker コンポーネントを含むブックとして保存する場合は、DITAVAL コンディショナル出力機能を使用できます。 文書を保存ダイアログで「DitaVal ファイルを確認」オプションを選択した場合は、DITAVAL ファイルのプロンプトが表示されます。これを使用してコンディショナル出力を実行し、選択した出力形式でコンテンツを出力できます。 DITAVAL について詳しくは、DITAVALを参照してください。

重要: DITA マップのブックへの変換は一方通行です。 つまり、ブックに加えた変更を DITA マップに戻すことはできません。

DITA 参照

FrameMaker での DITA 参照について、および参照コンテンツの設定方法と DITA 参照の更新方法について説明します。

DITA 参照(DITA アドレス指定とも呼ばれます)は、DITA エレメント間および DITA エレメントと非 DITA リソース間に参照機能またはリンク機能を提供します。

DITA のコンテンツは DITA コンテンツ参照. 単一のソースコンテンツへの DITA 相互参照を使用して、DITA または非 DITA リソースへのリンクを作成します。 DITA リンクを使用して 関連コンテンツへのリンクを追加できます。

DITA 仕様は 2 つのタイプの参照を定義します。

直接参照(URI ベースのアドレス指定)

参照はターゲットを直接指して行われます。 例えば、FrameMaker では直接参照を使用して conref を作成するとき、DITA トピック(.xml ファイル)に移動して選択します。 同様に、DITA トピック(.xml ファイル)を直接指して、DITA リンクまたは DITA 相互参照を作成します。 直接参照では、参照またはリンクするコンテンツが含まれているファイルを作成者が明示的に選択する必要があります。 関連コンテンツが大量にある場合は面倒でわかりにくい作業になります。 直接参照は参照またはリンクする文書が少ない場合に適しています。

URI ベースの(直接)アドレス指定で仕様を参照してください。

間接参照(キーベースのアドレス指定)

参照はキーを使用して DITA マップレベルでグローバルに行われます。 例えば FrameMaker では間接参照を使用して conref を作成するとき、DITA トピックを直接指しません。 代わりに、 「キースペースを使用した DITA キー参照の管理」で定義されているキーを指します。 間接参照では、参照またはリンクを作成するときに作成者がユーザー定義のキーを選択する必要があります。 キースペースを設定するときは、明確に定義された記述によってキーに名前を付ける必要があります。 大量の関連コンテンツを使用してオーサリングを実行している場合は、間接参照を推奨します。

仕様については、キーベースのアドレス指定を参照してください

参照コンテンツの設定

DITA トピックで conref を作成するには、再利用するコンテンツ(エレメント)が含まれている DITA トピック(直接参照)または DITA マップ(間接参照)を最初に作成する必要があります。 例えば、表、番号リスト、画像を複数のトピック間で再利用するとします。 これらのエレメントはソーストピックに追加する必要があります。 間接参照を使用している場合、トピックは DITA マップに追加されます。 詳しくは、キースペースを使用した DITA キー参照の管理を参照してください。

エレメントを再利用可能にするには、エレメントに固有の ID を割り当てる必要があります。詳しくは、DITA ID 属性を参照してください。FrameMaker は conref エレメントを区別するためこの固有の ID を使用します。例えば、ソースエレメントを更新する場合、FrameMaker は更新する必要のあるコンテナートピック内のエレメントを固有の ID を使用して識別します。

DITA ID 属性

DIDA ID 属性は参照するコンテンツ(トピックまたはエレメント)を一意に識別する方法を提供します。

DITA トピックでは、別のトピックのエレメントに対する conref(DITA コンテンツ参照)または相互参照(相互参照)を作成するとき、エレメントに一意の ID を割り当てて使用することができます。 デフォルトでは、FrameMaker は次の場合にトピックに固有の ID を割り当てます。 DITA トピックの作成

ID 属性の仕様を参照してください。

固有の ID をエレメントに割り当てる

  1. 構造図でソーストピック内のエレメントを選択します。

  2. 構造 > ID をエレメントに割り当てを選択します。

    または、エレメントを右クリックし、ポップアップメニューから「ID をエレメントに割り当て」を選択します。

エレメントに ID が割り当てられているか確認するには、構造図でエレメントの右側にある矢印記号をクリックします。

entry(表セル)エレメントに割り当てられた固有の ID
固有の ID をエレメントに割り当てる

以前に ID が割り当てられていたエレメントに固有の ID を割り当てる場合、既存の ID を置き換えるように指示されます。

ID をエレメントのすべてのインスタンスに割り当てる

  1. ID を割り当てるエレメントのインスタンスを選択します。

  2. 構造 > ID をエレメントに割り当てを選択して、ID を割り当てダイアログを開きます。

    1. デフォルトでは、「ID をエレメントに割り当て」を選択する前に選択したエレメントがドロップダウンで選択されています。

    2. 特殊化を含める」を選択して、ID を選択したエレメントの特殊化に割り当てます。 DITA マップで作業している場合は、「Ditamap 内のトピック参照を開く」を選択して、ID を DITA マップのトピックで選択したエレメントのすべてのインスタンスに割り当てます。

    3. 複数のファイルを開いている場合は、「開いているすべてのファイル」を選択して、ID をすべての開いているファイルで選択したエレメントのすべてのインスタンスに割り当てます。

    4. 割り当て」をクリックします。

キースペースを使用した DITA キー参照の管理

DITA トピックでは、DITA トピックファイル(.xml)を指定することにより、コンテンツを直接参照できます。 例えば、DITA トピックの関連リンクセクションにリンクを追加する場合は、参照するトピックファイルを選択できます(「 関連コンテンツへのリンクを追加」を参照)。

ただし、DITA はコンテンツを間接的に参照するキーを使用するための仕様も提供します。 仕様については、キーベースのアドレス指定を参照してください。

キーを使用して、参照先コンテンツをどの程度間接的にするかを追加します。 キーを使用するとき、作成者はトピックファイルを直接参照しません。 作成者はキースペース(参照するユーザー定義のキーの集合)が提供されます。 キースペースは任意の数のトピックを内部的に参照します。 作成者は提供されたキースペース内のキーのみに集中できます。 また、キーはユーザーが定義するため、作成者がわかりやすい名前を適宜付けることができます。

The keydef エレメントは、キーマップを作成するために使用します。デフォルトでは DITA 出力にこれらのエレメントが生成されないためです。

キースペースを作成

キースペースは DITA マップを使用して作成されます。 DITA マップを作成してキースペースとして使用するには、keydef エレメントを DITA マップに追加する必要があります。

  1. DITA マップを作成する.

  2. < keydef> エレメントを DITA マップに追加します。 詳しくは、topicref エレメントの DITA マップへの挿入を参照してください。

    @keys 属性を使用して、キースペースの特定の keydef を識別します。 <keydef> エレメントにキー>属性は不可欠なため、新規エレメントの属性ダイアログまたはエレメントの挿入ダイアログの「キー名」フィールドで属性値を指定することができます。

    キースペースを使用している作成者はキー名のみを参照し、関連 DITA トピックを直接参照しません。 このため、参照先(基本)トピックコンテンツであることが明確なキー値を指定する必要があります。

  3. DITA マップを保存します。

キースペースの管理

DITA トピックでキー参照を使用するには、FrameMaker のオーサリング環境でコンテナキースペースを読み込みます。

  1. DITA キースペースマネージャーダイアログ(構造 > DITA > キースペースを管理)を開きます。

    DITA キースペースマネージャーダイアログ
    DITA キースペースマネージャーダイアログを使用してキースペースを管理

  2. キースペースドロップダウンリストから、キースペースとして定義されている DITA マップを選択します。 詳しくは、キースペースを作成を参照してください。

    デフォルトにより、常にリストの先頭にあるキーが選択されます。現在のセッションで開いている DITA マップは、キースペースドロップダウンリストに表示されます。キーの最初の数文字を入力してキースペースを検索できます。

    必要な DITA マップがリストから使用できない場合は、「キースペースを読み込む」をクリックし、DITA マップファイルを選択します。キースペースで定義されているキー参照が定義済みのキーリストに表示されます。

    現在の環境にキースペースを読み込んだ後にキースペース(DITA マップ)に変更を加える場合は、「再表示」のアイコンをクリックしてキー参照に加えた変更を表示します。

    「OK」をクリックすると、選択したキースペースが、開いているすべての DITA マップに適用されます。

    特定の文書に対して別のキースペースを選択するには、キースペースマネージャーを使用します。DITA 相互参照、DITA リンク、Conref の挿入など、複数の方法でキースペースを設定することができます。

DITA 参照の更新

次のいずれかの方法を使用して、DITA トピックまたはマップの参照を作成できます。

参照先コンテンツを更新する場合、現在のトピックの参照はすぐに更新されません。 例えば、DITA マップが特定のトピックを参照しているとき、トピックのタイトルが変更された場合、更新されたタイトルは DITA マップにすぐに表示されません。

選択したトピックまたはマップで参照を更新するには、DITA 参照を更新ダイアログを使用します。

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

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

    DITA 参照を更新ダイアログ
    DITA 参照を更新ダイアログを使用して、DITA 参照を更新します。

  2. 現在のトピックまたはマップ内の参照を更新するには、特定のオプションを選択して「OK」をクリックします。

参照を検索

文書内を検索したり、単一フォルダー内の複数のファイルを再帰的に検索したりして、conref、topicref、link、xref などのリンクを探すことができます。 デフォルトでは、参照の検索ダイアログボックスにおいて、現在のトピックおよびエレメントの ID が挿入されます(選択されている場合)。 通常、別の場所で参照されているエレメントを選択してから、このオプションを呼び出します。

  1. 構造 > DITA > 参照を検索を選択します。または、現在のエレメントの参照を検索するには、エレメント内を右クリックし、「参照を検索」を選択します。 エレメント ID が自動的に入力されます。

  2. 参照の検索ダイアログで、必要に応じてエレメントの ID を入力します。

  3. オプションとして、検索をキースペース内に限定するには、現在の文書のキースペースを選択します。

  4. 検索範囲を設定します。 フォルダーを選択した場合は、そのフォルダー内のすべてのファイル内にあるエレメントへの参照を再帰的に検索できます。

  5. 検索」をクリックします。