含まれる属性プロファイラ

このトピックは、セクションまたはタブのない単純なページ、ダイアログまたはその他のUIに使用します。ページ上のすべてのフィールドおよびオプションを説明する必要があります。

ヘルプ出力に正しく生成されるようにこのトピックを構成するには、次の手順を実行します。

1. Sect1要素を構成します。

   1. 状況依存トピックをSect1として作成します。

   2. 簡単な名詞句と見出し形式の文体を使用して、状況依存トピックにUIの名前を反映したタイトルを付けます。ページ・タイトルには総称名詞を含めます。たとえば、プリファレンス・ページ、プリファレンス・ダイアログ、編集ウィンドウ、リソース・カタログなどです。これが移行中のトピックの場合は、以前と同じタイトルを使用します。

   3. このトピックが目次に表示されないように、HelpTOC属性をTopicOnlyに設定します。

   4. UIの名前およびオプションで製品名が含まれるように、要素のサンプルOutputFileName属性を変更します。たとえば、製品がOracle XYZサーバーで、UIが「プリファレンス」ダイアログの場合、この属性の値をcs_pagename1.htmからcs_preferences.htmまたはxyz_cs_preferences.htmなどに変更します。

   5. ヘルプ・アイコン、ボタンまたはUIのtopicIDと一致するように、HelpTopicID属性を変更します。

      Sect1トピックのHelpTopicID属性の値として、エンジニアから提供されたtopicIDを使用します。ヘルプを別の形式から変換する場合は、既存のHelpTopicIDを使用します。または、自分でtopicIDをトピックに割り当ててから、その割り当てたtopicIDをエンジニアに提供することもできます。重要なのは、FrameMakerでトピックに割り当てるtopicIDが、開発によってUI、ヘルプ・アイコンまたはボタンに割り当てられているtopicIDと一致していることを確認することです。

2. 次のガイドラインに従って、InformalTable要素を構成します。

   1. 表のSummary属性とTitle属性を適宜変更します。

   2. HelpPara要素を使用して、ドキュメント化する必要があるUI内のすべての要素またはオプションを「要素」列に入力します。「要素」列では、UI要素を太字にしないでください。

   3. 「要素」列のテキストをインデントすることで、UI内に表示される要素をグループ化するには、HelpPara要素のRole属性を編集します。左マージンからテキストをインデントするには、「Level1」を選択します。UIに表示されるオプションの構成を反映するように、必要に応じてLevel1、Level2、Level3およびLevel4を使用して最大4レベルまでインデントを設定できます。

   4. 「説明」列では、HelpPara要素ではなくPara要素を使用します。この列ではテキストをインデントしません。オプションまたは要素を詳しく説明します。説明しているUI要素以外のUI要素を参照する場合は、Bold強調表示を使用します。コード・スニペットまたはコード参照を指定する場合は、Code強調表示を適用します。

   5. 「説明」列に、ドキュメント・ライブラリの管理者ガイド、開発者ガイドおよびユーザー・ガイドにある概念説明のトピックに移動するための「詳細」インライン・リンクを追加し、これらのブックにある個々のタスク・トピックに移動するための「方法」インライン・リンクを追加します。他の情報用のインライン・リンクは追加しないでください。かわりに、以下で説明するように、これらのその他のリンクは「関連トピック」見出しの下に追加します。

   6. 「詳細」リンクおよび方法リンクをブックに挿入するには、Xulink要素を使用し、属性値にはolink:DOCID (例: olink:ASADM11113)を入力します。リンク設定の詳細は、オンライン・ヘルプの標準のTopicID値の適用およびブックへのリンクの追加に関する項を参照してください。

   7. 「要素」列と「説明」列の両方で、以下で説明するように、必要に応じてインライン・グラフィックを追加します。インライン・グラフィックは控えめに使用し、UIの概要を示すためや画面上のラベルのない要素を定義するために必要である場合にのみ使用します。状況依存オンライン・ヘルプでは、アイコンとボタンは必須ではありません。

   8. インライン・グラフィックの高さは22ピクセルに制限されています。高さが22ピクセルを超えるイメージを挿入すると、OHW/OHJヘルプJARでイメージが縮小されて歪んで表示されるため、そのようなイメージは挿入しないでください。イメージの幅のピクセルには具体的な制限はありませんが、導入文の段落では、列の半分よりも広い幅のイメージを挿入する方が見栄えがよくなります。

3. インライン・グラフィックを挿入するには、次のガイドラインに従います。

   1. インライン・グラフィックを挿入する場所を選択します。

   2. 「要素」ウィンドウで、InlineGraphicを選択して「挿入」をクリックします。「新規要素の属性」ウィンドウが表示されます。

   3. AltText値を入力します。これは必須属性であり、テキストを入力しないとブックがエラーになります。「要素の挿入」をクリックします。「インポート」ダイアログが表示されます。

   4. グラフィック・フォルダからインポートするグラフィックを選択します。「インポート・グラフィックのスケーリング」ダイアログが表示されます。

   5. 72 dpiを選択します。「設定」をクリックします。グラフィックが挿入されます。

   6. [Space]キーを使用して、必要に応じてグラフィックの前後にスペースを1つ挿入し、イメージとテキストの間にスペースが1つ入るようにします。イメージとその前後のテキストの間には、(単語間のスペースと同様に)スペースが1つ必要です。行頭のイメージの前に余分なスペースを追加する必要はありません。

4. RelatedTopics要素およびリンクを含めるには、次のガイドラインに従います。

   1. RelatedTopics要素はSect1要素内の最後の要素であり、必須です。これはテンプレートに含まれているため、挿入する必要はありません。

   2. RelatedTopics要素の下で使用できる唯一の子要素は、Para要素です。RelatedTopics要素の下には、テンプレートにすでに存在しているものに加えて複数のPara要素を追加できます。

   3. 言及した技術がインラインの「方法」リンクと「詳細」リンクで説明されていない場合は、それらに関するトピックを追加します。

   4. ドキュメント・ライブラリ内の章またはSect1への相互参照を追加します。

   5. ブックにリンクを挿入するには、Xulink要素を使用し、属性値にはolink:DOCID (例: olink:ASADM11113)を入力します。リンク設定の詳細は、オンライン・ヘルプの標準のTopicID値の適用およびブックへのリンクの追加に関する項を参照してください。

含まれる属性プロファイラは、複数の属性があるレコードで、一方の属性値にもう一方の属性値が含まれることが多い属性のペアを検索します。しきい値オプションを使用して、一方の属性値にもう一方の属性値が含まれるレコードのパーセンテージに基づき、属性のペアに関連があるかどうかを判断します。

含まれる属性プロファイラは、関連がある属性、または関連がある必要がある属性を検索するために使用します。属性に強い関連性がある場合は、冗長な属性である可能性があります。

または、属性に関連があると考えられるが、その関係が壊れている場合、つまり、一方の列値は空白だが、もう一方の列値から導出できる場合もあります。

次の表に、構成オプションを示します。

構成	説明
入力	包含属性の関連性の調査対象にする属性を指定します。
オプション	なし。
含まれる属性のしきい値(%)	「次を含む」を使用して2つの属性を照合し、2つの属性に関連があるとみなされて結果に表示されるために必要な値の一致率を制御します。パーセントで指定します。デフォルト値は80%です。指定できる値は、50%以上、100%以下です。
大文字/小文字を区別しない	一方の属性値にもう一方の属性値が含まれるかどうかをチェックするときに、大文字と小文字の別を無視するかどうかを制御します。「はい」または「いいえ」を指定します。デフォルトはYesです。
出力	データ属性またはフラグ属性の出力を記述します。
データ属性	なし。
フラグ	なし。

含まれる属性プロファイラでは、統計を生成するためにレコードのバッチが必要です。つまり、属性のペアに意味のある関係があることを検出するには、完了まで実行される必要があります。したがって、データ・セット全体が処理されるまで結果が生成されないため、このプロセッサはリアルタイム・レスポンスが必要なプロセスには適していません。

リアルタイム・データ・ソースからのトランザクションのバッチに対して実行した場合、リーダー・プロセッサで構成されたコミット・ポイント(トランザクションまたは制限時間)に到達すると処理が終了します。

含まれる属性プロファイラでは、高頻度で一方の属性値にもう一方の属性値が含まれ、それぞれの値が関連しているパーセンテージが高い属性のペアについて、サマリー・ビューが表示されます。次の表に、最上位レベルのビューに表示される関連する属性の各ペアに関する統計を示します。

統計	説明
含まれる	関連する両方の属性の値が同じであるレコードの数。
含まれない	関連する属性の値が同じでないレコードの数。

「追加データ」ボタンをクリックすると、前述の統計が、分析対象レコードに対するパーセンテージとして表示されます。

属性のペアが完全に一致したレコードの数をドリルダウンすると、一致した各値の出現頻度の明細が表示されます。再度ドリルダウンすると、当該のレコードが表示されます。

あるいは、属性のペアが等しくないレコードの数をドリルダウンすると、当該のレコードが直接表示されます。属性の間に関係が存在する必要がある場合、それらのレコードでは関係が壊れています。

例

この例では、複数の属性の包含関係をチェックしています。EmailAddressにはFirstNameが含まれることが多いため、FirstName属性とEmailAddress属性の間に関係が検出されています。サマリー・データは次のとおりです。

フィールド1	フィールド2	含まれる(降順)	含まれない
EmailAddress	FirstName	1829	172

EmailAddress属性にFirstName属性が含まれる1829個のレコードをドリルダウンすると、次のビューに、関係が検出されたレコードの各ペアがすべて表示されます。

EmailAddress	FirstName	カウント
[e-mail]	LINDA	2
[e-mail]	PAUL	2
[e-mail]	SHEILA	2
[e-mail]	NORMAN	2
[e-mail]	TONY	2
[e-mail]	PAULINE	2
[e-mail]	ROWLAND	2
[e-mail]	JOHN	2
[e-mail]	TEST	2
EILEEN_BEARD@WILSONS_PENARTH.COM	EILEEN	1
[e-mail]	BRIGETTE	1
[e-mail]	MICHAEL	1
[e-mail]	JOYCE	1
[e-mail]	JOANNA	1
[e-mail]	MAHAJAN	1