第 4 章 設計に関する推奨事項

アプリケーションのテンプレートを作成する前に、Configuration Manager で一元管理する設定オプションを決める必要があります。一番簡単な方法は、あらゆる設定オプションの可能性を含んだテンプレートを作成するアプローチですが、これでは不要なタスクが生じ、使用しないオプションまで Configuration Manager に表示されることになります。

ガイドライン

テンプレートの作成中にどのオプションを選ぶかは、対象とするアプリケーションによりますが、使用するオプションの目安として次のリストを参考にしてください。

• セキュリティを扱うオプション

• ロックダウンを扱うオプション

• ホスト、ポート、URL、パスなどのリソースを参照するオプション

• フォントや色などの企業イメージの定義に使用するオプション

カテゴリとページの具体的な名前は、テンプレートの作成者が自由に決めます。守るルールは次の 2 つだけです。

• 一意のパスを作成できるように、ツリーの全レベルで重複のない名前にする

• 最初のカテゴリで、アプリケーションとそのバージョンを識別する。たとえば、「StarSuite 6.0」のように指定する

apt:section 要素を選ぶか、 apt:page 要素を選ぶかは、次の 2 つの要件によって異なります。すなわち、1 ページ当たりの設定項目数を 6 つ以内に制限して、「コンテンツ区画」でのスクロールを避けます。また、既存の GUI を Configuration Manager の GUI にマッピングする場合は、アプリケーションの GUI を Configuration Manager の GUI にできるだけ正確にマッピングして、見た目の操作性を最適化する必要があります。この 2 つの要件が相反する場合は、後者を選んでください。Configuration Manager の GUI でアプリケーションの GUI を変えたい場合は、小さい変更にとどめます。

GUI に表示されるテキストはすべて見た目が一貫している必要があります。GUI の設計要素に表示するテキストには、次の大文字使用のガイドラインを適用してください。

• インラインヘルプとオンラインヘルプでは、文単位で大文字を使用する。常に大文字を使用する固有名詞、略語、頭字語がテキストに含まれている場合を除いて、各文の最初の文字だけを大文字にする

• 文中や文末に正しく句読点を入れる

• 完全な文でない長い句を用いるのを避ける。完全な文ではない句を用いる必要がある場合は、最後に句読点は不要

• ラベル、タイトル、チェックボックスのテキスト、メニュー、リスト項目などは大文字を見出し形式で使用する。見出し形式を適用するには、不定詞 (a、an、the)、接続詞 (and、or、but、so、yet、nor など)、および 3 文字以内の前置詞 (in など) を除いて、各単語の最初の文字を大文字にする。ただし、冒頭と末尾の単語はその品詞に関わらず常に最初を大文字にする

• ラベルの後にセミコロンを付けない

• アプリケーション内で一貫させる

一般に、パッケージには必要なものが揃っていますが、次の 2 つの例外があります。他のパッケージのリソースを再利用できます(「ローカライズ」を参照)。また、他のパッケージのチューザ定義を apt:extendsChooser 属性で再利用できます (「基本データ要素 : property、value、constraints」を参照)。この種の参照は慎重に使い、多用しないでください。他のパッケージを参照すると、そのパッケージと依存関係が生じますが、依存しているパッケージが Configuration Manager のすべてのインストールに含まれているとは限りません。

Configuration Manager は、インストールされている全パッケージを走査してリソースを回復しようとするため、リソースキーはパッケージ内だけではなく他のパッケージと比べた場合も一意のものでなければなりません。カテゴリ階層を使用してローカルのリソースキーに接頭辞を付けるか、Java のパッケージ構造に似た構造や製品名を使うなど、独自の階層的接頭辞を作成します。

オンラインヘルプは、標準パッケージに付属の HTML ファイルに似た設計にする必要があります。ブラウザの検出と CCS の定義が正しく行われるように、次の行を含めます。

<script type="text/javascript" src="/com_sun_web_ui/js/browserVersion.js">
</script>
<script type="text/javascript" src="/com_sun_web_ui/js/stylesheet.js">
/com_sun_web_ui/js/stylesheet.js"></script>

タイトルのレイアウトには、"help-header-1"、 "help-header-2"、および "help-header-3" のスタイルを使用します。