lablab.jp （日本語版）

XOOPS Cube Legacy 2.1 (XC 2.1) は管理画面でヘルプビューアを実装しました。もともと$modversion['help']はXOOPS2で予約されていました。しかし、それは何処にも使用されませんでした。XC2.1では、開発者はヘルプドキュメントをモジュールに添付することができ、そして、ユーザはコントロールパネル上で直接そのドキュメントを読むことができます。

ドキュメントの添付方法

ヘルプドキュメントをあなたのモジュールに添付しましょう。 初めに、$modversion['help']にインデックスファイル名を書いてください。このファイルは、ユーザがコントロールパネルのサイドメニューでヘルプをクリックしたときに、最初に表示されるページです。私は今回、それを"help.html"と命名します。

次に実際の"help.html"を language/english の中に作成してください。そうです、ヘルプビューアはマルチリンガルドキュメントに対応しています。もしあなたが、フランス語、スペイン語その他のドキュメントを持ちたいのであれば、それぞれの言語ディレクトリ内に同名のファイルを作ってください。

最後に、ドキュメントを書きましょう！

別のページにリンクする方法

ヘルプドキュメントはPHPによって表示されます。ヘルプのURLはPHPアプリケーションのページのアドレスになるため、相対リンクで（ヘルプ内の）他のページにリンクすることは困難です。

しかし、ヘルプドキュメントは純粋なSmartyによってロードされ表示されます。そして、特別なSmartyのプラグインはURLに関するいくつかの問題を解決してくれます。 helpurl は、ヘルプビューアのみで使用されるSmartyモディファイアです。

他のページへリンクするために、ヘルプドキュメント内で次のようなURLを書いてください。

<a href="<{'page2.html'|helpurl}>">The detail of functions</a>

ドキュメントで画像を使う方法

同様の原因で、ヘルプドキュメント内で画像を（相対リンクで）使うことができません。この問題を解決するためにSmartyモディファイアのhelpimageを使うべきです。

画像ファイルを language/****/helpimages ディレクトリに配置してください。キャプチャーイメージは各言語の文字を含むため、ヘルプビューアは、ドキュメントと同様にマルチリンガルなイメージファイルに対応しています。それから img タグを次のように書いてください:

<img src="<{'screenshot01.jpg'|helpimage}>" alt="..." />

イメージ・ファイルがユーザが指定した言語のディレクトリに存在していないなら、モディファイアはenglishディレクトリからデフォルトのイメージ・ファイルを手に入れようとします。 したがって、あなたは大量のイメージ・ファイルをすべての言語のために作成する必要はありません。

規則

私たちは、ヘルプのために特別なCSSを準備する計画を立てています。開発は原則そのCSSに従ってください。 現在のヘルプビューアの外観は調整されていません。デザイナーは、XC2.1アルファー4でCSSをクールに調整して、その規則を発表するでしょう。