ホーム > DITAVAL

DITAVAL

FrameMaker での DITAval について、および FrameMaker でコンディショナル出力を生成するために DITAval を使用する方法について説明します。

FrameMaker では DITAVAL ファイルを使用してコンディショナル出力を生成します。 (エレメント属性を使用して)コンディショナルコンテンツを含む単一の文書を書き出します。

次に、DITAVAL ファイルを作成します。このファイルを使用してコンテンツを指定し、適用した属性に基づいて文書の出力バージョンを複数作成します。

DITAVAL を使用する DITA トピックの設定

DITAval を使用してコンディショナル属性をエレメントに適用するように DITA トピックをセットアップする方法について説明します。

エレメントに条件属性を適用することにより、DITA 文書内のエレメントをコンディショナルにすることができます。 この後、条件属性に基づいて、DITAVAL ファイルでエレメントを出力から除外するかエレメントを出力に含めるかを定義できます。

コンディショナルコンテンツを含む文書を作成する前に、出力の基準について計画する必要があります。 例えば、文書にコンディション適用のターゲットが管理者およびエンドユーザーであるコンテンツが含まれているとします。文書内で、コンテンツの対象読者に基づいて条件属性を適用します(「 条件属性のエレメントへの適用」)を参照。 次に、DITAVAL ファイルを作成します。このファイルを使用して、文書で定義した属性値に基づいて、含めるまたは除外するエレメントを指定します。詳しくは、「DITAVAL ファイルを作成してコンディショナル出力を作成する」を参照してください。

条件属性のエレメントへの適用

FrameMaker で DITA 文書内のエレメントにコンディショナル処理を実行するには、出力に含めるまたは出力から除外するエレメントを指定する必要があります。 文書内で、コンディショナル処理が必要なエレメントに次の 1 つ以上の条件属性を適用します。

audience:

例:管理者、作成者、またはエンドユーザー

platform:

例:Windows、MAC、または Linux

product:

例:FrameMaker、RoboHelp、または Captivate

otherprops:

この属性を使用して、文書のコンディショナル処理を有効化するために使用する必要のある他のプロパティを定義します。 いくつか例を示します。

delivery

例:プリント、PDF、または Web

model

ハッチバックまたはセダン

複数の属性をエレメントに適用できます。 例えば、@audience管理者)および @platformWindows)をエレメントに割り当てられます。複数の値を(スペースで区切って)単一の属性に追加することもできます。例えば、@platform="windows linux" を Windows および Linux の両方をターゲットとしているコンテンツに設定できます。

重要: 上記の属性は、DITAVAL を単一ソースのコンテンツに使用しているときに使用することを推奨します。 ただし、これらの属性のみの使用に制限されるわけではありません。 文書内で選択したエレメントに定義されている任意の属性を使用できます。

エレメントに条件属性を適用するには

  1. 文書の構造図でエレメントを選択します。

  2. 属性パネルを開きます(エレメント > 属性を編集)。

    次の 1 つ以上の属性を更新します。

    • audience

    • platform

    • product

    • otherprops

  3. コンディショナル処理が必要な文書内の各エレメントに上記の条件を指定します。

文書内の特定の要素に属性を適用した後、DITAVAL ファイルの設定方法に応じて、文書のコンテンツのコンディショナル出力を実行します。

DITAVAL ファイルを作成してコンディショナル出力を作成する

条件属性(audience、platform、product、otherprops)を使用してコンテンツを設定して FrameMaker がコンディショナル出力を実行するエレメントを定義した後、DITAVAL ファイルを作成する必要があります。 DITAVAL ファイルでは、「属性名」と「」のペアに基づいて、ドキュメントの条件処理を定義します。例えば、管理者を対象とするコンテンツは、エンドユーザーまたは作成者を対象とする出力コンテンツから除外するよう指定できます。

DITAVAL ファイルを作成するには:

  1. 新規 XML ダイアログを開きます(ファイル > 新規 > XML)。

  2. 構造化アプリケーション」セクションで、DITA_<version>_DITAVAL を選択し、「OK」をクリックします。

    DITAVAL ファイルの最上位のエレメントは <val> エレメントです。

    条件を定義するには、<prop> のエレメントを作成する必要があります。

  3. 1 つ以上の<prop>エレメントを追加するには、次の操作を実行します。

    エレメントパネル(表示 > パネル > エレメントカタログ)で<prop>エレメントをダブルクリックします。

    または Ctrl + 1 キーを押してスマートカタログを表示し、prop を選択して、Enter キーを押します。

    新規エレメントの属性ダイアログが表示されます。
    新規エレメントの属性ダイアログ
    エレメントカタログパネル内の新規エレメントの属性ダイアログ

  4. 新規エレメントの属性ダイアログでは、次の属性を指定することができます。

    @action

    指定した属性(@att、below)を出力に含めるか、出力から除外するかを選択します。

    @att

    文書内のエレメントに適用される条件属性の名前です。

    文書エレメントで定義されている属性名を正確に入力します。

    @val

    エレメントで定義された条件属性(@att)値。

    エレメント内の属性に指定した値を正確に入力します。

    例えば、条件出力のエレメントに @audience 属性を適用し、値を admin として設定します。DITAVAL ファイルで、prop エレメントの @attr フィールドに audience を入力する必要があります。また、val フィールドに、@admin を入力する必要があります。admin に設定された audience 属性を持つエレメントを除外するには、@actionexclude に指定します。

  5. 「エレメントを挿入」をクリックし、DITAVAL ファイルを保存します。

  6. .ditaval 拡張子を付けて文書を保存します。

コンディショナル出力の生成

FrameMaker で DITA トピックのコンディショナル出力を生成する方法について説明します。

このセクションでは、コンディショナルコンテンツを含む PDF 出力を生成する手順について使用事例とともに説明します。

注: このセクションで使用されるサンプルには、paragraph(p)タグ内のコンテンツのみが含まれています。 ただし、文書内の任意の DITA エレメントからコンディショナル出力を作成できます。
  1. 4 つの paragraph(<p>)で DITA トピックを作成します。

    1. 管理者のみ対象のコンテンツ

      @audience 属性を「admin」に設定します。

    2. 作成者のみ対象のコンテンツ

      @audience 属性を「author」に設定します。

    3. 管理者および作成者が対象のコンテンツ

      @ audience 属性を「admin author」に設定します。

    4. エンドユーザーと作成者が対象のコンテンツ

      @audience 属性を「end_user author」に設定します。

  2. 文書を保存します。

  3. 4 つの prop エレメントを持つ DITAVAL ファイルを作成します。

    1. @attr: audience

      @val: admin

      @action: include

    2. @attr:audience

      @val:author

      @action: exclude

    3. @attr:audience

      @val:end_user

      @action: exclude

    上記の DITAVAL は管理者をターゲットとするすべてのコンテンツを出力します。

  4. DITA マップを作成し、上記の文書を含めて、DITA マップを PDF として保存します(ファイル > PDF として保存)。

  5. 文書を保存ダイアログで、「DitaVal ファイルを確認」オプションを選択し、「保存」をクリックします。

    DITAVAL ファイルを選択ダイアログが現れます。

  6. 手順 4 で作成した DITAVAL ファイルを選択し、「選択」をクリックします。

    コンディションを適用」オプションは、すべてのコンテンツを出力します。ただし、DITAVAL ファイルで除外とマークされたコンテンツは、取り消し線で出力されます。このオプションは文書をレビューする場合に選択します。 例えば、このオプションを使用して、マークされているコンテンツが除外対象であることをレビューアーに示します。

  7. PDF 設定ダイアログで「設定」をクリックします。

出力 PDF ファイルは、文書に設定されている属性および対応する DITAVAL ファイルに基づいてコンテンツを含めたり除外したりします。