iManager のカスタマイズ

注意: このページは、レンタルサーバー SPEEDEX VPS v2 の技術サポートです。
2009年6月現在、VPS v2 の新規オーダーを受けしておりますが、 VPS v3 の採用をお勧めします。
現在提供中のサービスについては SPEEDEX のメニューページを参照ください。
SPEEDEX VPS v1 サーバーご利用の場合は v1 サーバーサポートページを参照ください。
SPEEDEX VPS v3 サーバーご利用の場合は v3 サーバーサポートページを参照ください。
SPEEDEX OneDom サーバーご利用の場合は OneDom サーバーサポートページを参照ください。

The iManager のネーミング自体を希望のブランドに変更したり、ラベル名を変更することができます。SPEEDEX パートナー様固有のネーミングのツールとして、サブホスト顧客に提供できます。

iManager インストールディレクトリー構造

iManager をカスタマイズする前に、デフォルトの iManager インストールディレクトリー構造に慣れる必要があります。デフォルトでは iManager は、/www/htdocs/imanager ディレクトリー（これからは ~imanager と記述します）へインストールされます。この ~imanager ディレクトリーには、下記のファイルおよびサブディレクトリーがあります。

ABOUT	このファイル内容には、ソフトウェアー iManager の概要とその目的が記述されています。オリジナルソフトウェアのタイトル名 iManager はこのファイルに記載されています。このファイル内容は about.cgi スクリプトのメインウィンドウに表示されます。
VERSION	このファイルは、新バージョンが存在した場合、新バージョンを使うかどうかをプログラムが判定するための「バージョン認証 'current version identifier' 」、「リモートマスターサイト 'remote master site' 」を定義します。オリジナルのソフトウェアタイトル iManager と、オリジナルマスターサイト http://192.41.5.172/imanager/ への参照は、このファイルに含まれています。このファイル内容は主に about.cgi スクリプトによって使用されます。
label/	このディレクトリーは、内容と情報を提示するために iManager によって使われるヘッダーとフッターファイルを含んでいます。このサブディレクトリー内容詳細は下で説明しています。
strings/	このディレクトリーは複数の言語サブディレクトリーを含んでいます。それらの各言語サブディレクトリーには iManager が内容と情報を表示するために使う各言語の文章ファイルがあります。日本語のディレクトリー名は ja です。各言語ディレクトリー下の main ファイルにもオリジナルのソフトウェアタイトル iManager への参照が含まれています。

iManager を名称変更する

iManagerでは、プログラムが内容表示に使う、ヘッダーとフッターをカスタマイズすることで、iManager の名称を変更し SPEEDEX メンバー様固有のプログラム名称にしたり、ロゴを追加することができます。iManager が作成する各ページの構造は、下記の形式になります。


    

 [ header ]

---------------------

 [ dynamic content ]

---------------------

 [ footer ]

各ページのヘッダーとフッター部分は ~imanager/label/ サブディレクトリーにあるファイルに分けて保存されています。ヘッダーとフッターファイルが開かれ、一行ごとに読み取られ、ページ出力構成の一部分として表示されます。

iManagerには、「一般 generic」、「ヘルプ help」、「ログイン login」の3タイプのページがあります。ログインファイルはログインページのために使われ、ヘルプファイルは、ヘルプポップアップウィンドウのために使われ、一般ヘッダー・フッターファイルは他のすべてのページのために使用されます。各ページタイプ毎に、それぞれのヘッダーとフッターがあります。

generic_footer
help_footer
login_footer
generic_header
help_header
login_header

これら各ファイルのデフォルト版は ~imanager/label/default/ ディレクトリーにあります。将来の参照のために、これらのデフォルトファイルには手をつけず、~imanager/label/custom/ ディレクトリーに、カスタマイズしたファイルを保存しておくことをお勧めします。 hostname Subhost ディレクトリーを label ディレクトリーの下に作成することができますから、各 Subhost 専用に、これらの 6 ファイルを作成し、このディレクトリーに置くことができます。（~imanager/label/ にある 'mail.sorenson.org' ディレクトリーの例をご覧ください。）

iManager は、以下のような決められた順番でラベルヘッダーとフッターファイルを探します。

~imanager/label/{hostname}/[file]
~imanager/label/custom/[file]
~imanager/label/default/[file]

注意
iManagerが特定のヘッダーファイルまたは特定のフッターファイルを読む場合には、以下の様な、いくつかの特定のタグを検索します。



__TITLE__                         (ヘッダー専用)

__JAVASCRIPT__                    (ヘッダー専用)

__NAVIGATION_MENU__               (ヘッダーとフッター)

__ROOT_DIR__                      (ヘッダーとフッター)

__AUTH_CREDENTIALS__              (ヘッダーとフッター)

__TITLE_ タグと __JAVASCRIPT__ タグは、ヘッダーを解析するときに検索されます。__TITLE_ タグは iManager が作成するページのタイトルです。作成されたページが追加の JavaScript コードを含んでいる場合、そのコードは、 __JAVASCRIPT__ の場所に挿入するために、ラベルヘッダーファンクションに渡されます。通常、ヘッダーファイルは以下のような様式でストリングを読み込みます。



<html>

<head>

<title>__TITLE__</title>

__JAVASCRIPT__</head>

これがどのように機能するかの例は generic_header ファイルを見てください。

ラベルフッターとラベルヘッダーファンクションはどちらも __NAVIGATION_MENU__ を解析しますが、通常は、フッターだけに、このタグを挿入します。iManager は、この__NAVIGATION_MENU__ を作成されたページにふさわしいテキストナビゲーションメニューに置き換えます。下記がその例です。



<hr noshade>

<!-- begin navigation menu -->

__NAVIGATION_MENU__

<!-- end navigation menu -->

<p>

これがどのように機能するかの例は generic_footer ファイルを見てください。

__ROOT_DIR__ は、iManager に iManager のルートディレクトリーとして、どのディレクトリーを使うのかを示すためのものです。この指定は、Subhost が絶対 URL ではなく、相対 URL を使って iManager のリソースにリンクする場合不可欠です。次にあるのがその例です。

<img width="350" height="100" src="__ROOT_DIR__/graphics/entry.gif">

__AUTH_CREDENTIALS__ はヘッダーとフッターが表示される前に、スキャンされ、セッション認証ストリングに置き換えられます。フッターとヘッダーファイルの中にある iManager ウェイザードを参照するすべてのリンクに、このタグを入れなければなりません。以下の例を確認下さい。

<a href="__ROOT_DIR__/wizards/filemanager.cgi?__AUTH_CREDENTIALS__">File Manager Wizard</a>

詳しくは、~imanager/label/default/ ディレクトリーにある、 example ファイルを参考にしてください。このファイルには、完全な文脈で、これらの特別なタグの使用方法が記載されています。

iManager の名前変更
次のファイルにあるオリジナルタイトル iManager への参照を見つけ、入れ替えることで、iManager の名前変更を行うことができます。

~imanager/ABOUT
~imanager/VERSION
~imanager/strings/en/main
~imanager/strings/{other language subdirectories}/main

ルート ~imanager ディレクトリー (/www/htdocs/imanager ディレクトリー)を新しく選択した名前に変更した場合は、次のような URL で、名前変更された Virtual サーバの管理ツールにアクセスすることになります。

http://YOUR-DOMAIN.NAME/new_software_title/

SPEEDEX サポートポリシー