ヘルプ

ヘルプにはオンラインヘルプとインラインヘルプの 2 種類があります。

オンラインヘルプは、ユーザーがマストヘッドの 「ヘルプ」 リンクをクリックしたときに別のウィンドウに表示されるコンテキスト依存の詳しいヘルプです。前回の操作を「コンテンツ区画」で行った場合は、現在「コンテンツ区画」に表示されているテンプレートで定義されているオンラインヘルプのドキュメントが表示されます。前回の操作をそれ以外の場所で行った場合は、一般的なオンラインヘルプが表示されます。page 要素の apt:onlineHelp 属性は、HTML ヘルプファイルをテンプレートに結合するために使用されます。この場合、たとえば次のように、ファイルの完全修飾パスとそのベース名を指定する必要があります。

<page apt:name="Proxy">
      apt:label="Proxy"
          <apt:onlineHelp="/StarSuite/Internet/proxy">

これは ./web/StarSuite/Internet/proxy.html を参照します。

HTML ファイルでは絶対パスと相対パスを使用できます。 HTML ファイルと一緒に images というディレクトリのイメージを配置する場合は、HTML ファイルで次のいずれかの注釈を使用できます。

• <img src="/StarSuite/Internet/images/image.gif">

• <img src="./images/image.gif">

インラインヘルプは、カテゴリ、ページ、プロパティの各ページに補足情報を提供する短いテキストです。インラインヘルプは category 要素では「コメント」列、page 要素ではページタイトルの下、 property 要素では設定オプションの下に表示されます。ヘルプテキストは、この category、 page、 property の 3 要素のいずれかの apt:inlineHelp 属性によって指定されます。たとえば、次のように入力します。

<property apt:name="HTTPProxy" 
          apt:label="HTTP Proxy"
          apt:inlineHelp="Specify no proxy (None) or a manually defined proxy (manual)."
          apt:dataPath="org.openoffice.Inet/Settings/ooInetHTTPProxyName"
          oor:type="xs:string"
</property>

ローカライズを円滑にするため、ラベルにリソースキーを与えておきます。