レコード完全度プロファイラ

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

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

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と一致していることを確認することです。
次のガイドラインに従って、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でイメージが縮小されて歪んで表示されるため、そのようなイメージは挿入しないでください。イメージの幅のピクセルには具体的な制限はありませんが、導入文の段落では、列の半分よりも広い幅のイメージを挿入する方が見栄えがよくなります。
インライン・グラフィックを挿入するには、次のガイドラインに従います。
1. インライン・グラフィックを挿入する場所を選択します。
2. 「要素」ウィンドウで、InlineGraphicを選択して「挿入」をクリックします。「新規要素の属性」ウィンドウが表示されます。
3. AltText値を入力します。これは必須属性であり、テキストを入力しないとブックがエラーになります。「要素の挿入」をクリックします。「インポート」ダイアログが表示されます。
4. グラフィック・フォルダからインポートするグラフィックを選択します。「インポート・グラフィックのスケーリング」ダイアログが表示されます。
5. 72 dpiを選択します。「設定」をクリックします。グラフィックが挿入されます。
6. [Space]キーを使用して、必要に応じてグラフィックの前後にスペースを1つ挿入し、イメージとテキストの間にスペースが1つ入るようにします。イメージとその前後のテキストの間には、(単語間のスペースと同様に)スペースが1つ必要です。行頭のイメージの前に余分なスペースを追加する必要はありません。
RelatedTopics要素およびリンクを含めるには、次のガイドラインに従います。
1. RelatedTopics要素はSect1要素内の最後の要素であり、必須です。これはテンプレートに含まれているため、挿入する必要はありません。
2. RelatedTopics要素の下で使用できる唯一の子要素は、Para要素です。RelatedTopics要素の下には、テンプレートにすでに存在しているものに加えて複数のPara要素を追加できます。
3. 言及した技術がインラインの「方法」リンクと「詳細」リンクで説明されていない場合は、それらに関するトピックを追加します。
4. ドキュメント・ライブラリ内の章またはSect1への相互参照を追加します。
5. ブックにリンクを挿入するには、Xulink要素を使用し、属性値にはolink:DOCID (例: olink:ASADM11113)を入力します。リンク設定の詳細は、オンライン・ヘルプの標準のTopicID値の適用およびブックへのリンクの追加に関する項を参照してください。

レコード完全度プロファイラを使用すると、データがどの程度完全か(または不完全か)について概要を把握できます。レコードを構成する属性のうちデータが含まれる属性の数が示され、完全な属性の数に従ってレコードが集計されます。

レコード完全度プロファイラは、適切な情報を含めずに入力されたダミー・レコードを検出するために使用します。この場合、ユーザーは最小限の必須データのみを入力していることが多く、完全な有効レコードと比べてレコードの完全性は低くなります。

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

構成	説明
入力	完全性の分析に必要な任意の数の属性を指定します。
オプション	なし。
出力	データ属性またはフラグ属性の出力を記述します。
データ属性	なし。
フラグ	次のフラグが出力されます。 `PercentPopulated`: 選択した属性のうち移入済の属性のパーセンテージを示します。使用可能な値は0から100までの数値です。 `PopulatedAttributes`: 選択したすべての属性のうち移入済の属性の数を示します。使用可能な値は合計の数値に対する移入済の数値という形で示されます。

次の表に、このプロファイラによって生成される統計情報を示します。

統計	説明
レコード完全度%	検出された完全性の各パーセンテージ。分析対象の属性のうちnullではないと分析された属性のパーセンテージが計算されます。
完全属性	nullではない属性の数と、分析された属性の数。
一致するレコード	特定の完全性(%)に該当するレコードの数。

注意:

レコード完全度プロファイラは、各属性値がNullかNullでないかを評価します。空の文字列、スペースのみの値、その他の印刷不可能な文字を含む値は、デフォルトでリーダーでNull値に変換されます。これにより、各値に意味のあるデータが含まれるかどうかを示す一貫したビューが表示されます。ただし、このような非データ値がスナップショットまたはリーダーでNullに変換されない場合、これらは「完全」とみなされます。

例

この例では、レコード完全度プロファイラで顧客レコード表の4つの属性の完全性を評価し、次のサマリー結果を生成しています。

レコード完全度%	完全属性	一致するレコード
50.0	2/4	4
75.0	3/4	130
100.0	4/4	866

ドリルダウンすると、特定の完全性レベルのレコードが表示されます。たとえば、レコード完全性が75%以上のレコードを表示するには、サマリー・グリッド内の該当する行をドリルダウンします。

CU_NO	CU_ACCOUNT	敬称	性別	PercentPopulated	PopulatedAttributes
13815	00-23615-PB		M	75	3/4
13840	00-23631-JD	Miss		75	3/4
13913	00-23719-LR		M	75	3/4
13989	00-23817-LR	Ms		75	3/4
14130	00-23900-JD	Ms		75	3/4
14166	00-23945-LR	Mr		75	3/4