Share via

作業項目フィールドに対するヘルプ テキストの定義

  • [アーティクル]

更新 : 2011 年 1 月

ユーザーがフィールドに指定する内容を理解しやすいように、HELPTEXT 要素を使用して、フィールドにヘルプ テキストを関連付けることができます。 ユーザーが作業項目フォームのフィールドをポイントすると、ヘルプ テキストが表示されます。

<HELPTEXT>ToolTipText </HELPTEXT>

ToolTipText: 1 ～ 255 文字で構成されたテキスト文字列です。

フィールド名やフィールド名の種類とは異なり、ヘルプ テキストのスコープは、チーム プロジェクト内の特定の作業項目の種類となります。 そのため、同じフィールドのヘルプ テキストをチーム プロジェクトごとにカスタマイズできます。

HELPTEXT 要素は、FIELD (定義) 要素の子要素として 1 つだけ指定できます。 ヘルプ テキストを指定する方法の詳細については、「作業項目フォーム上の Web ページへのヘルプ テキスト、プロセス ガイダンス、Web コンテンツ、およびリンクの追加」を参照してください。

注意

ヘルプ テキストを追加すると、サーバー上に保持できるプロジェクトの数が減る可能性があります。 この問題が発生した場合は、ヘルプ テキストの量を減らすことでメタデータのサイズを大幅に小さくし、それによりスケーラビリティを向上することができます。 Team Foundation Server 上に何百ものプロジェクトを保持する必要がある場合は、作業項目の種類の定義 (XML ファイル) で使用するヘルプ テキストの量を制限するか、ヘルプ テキストをまったく使用しないようにします。

Title フィールドにヘルプ テキストを割り当てる方法を次の例に示します。

<FIELD refname="System.Title" name="Title" type="String">
<HELPTEXT>Enter a brief description of the work item.</HELPTEXT>
</FIELD>

参照

その他の技術情報

作業項目フィールドの定義

履歴の変更

日付

履歴

理由

2011 年 1 月

構文構造、およびヘルプ テキストを提供する別の方法が記載されたトピックへのリンクを追加。

情報の拡充