テンプレートファイルの書き方 1/2


「ウェブプロテクター for ベーシック認証」を使用するうえで、ユーザに表示する画面は重要な要素の一つでしょう。

ウェブサイトはそれぞれが大変個性的で、できれば全部のページを統一的なデザインにしたい、あるいはグループごとに統一的なデザインを使用したい、など、多様なニーズがあります。

そんな中、「ウェブプロテクター for ベーシック認証」のパスワード申し込み画面などが固定された画面レイアウトになっていると、ページ製作者としては、少し融通が利かないなあと思うこともあるでしょう。

そこで「ウェブプロテクター for ベーシック認証」では、ユーザが直接目にする画面については、テンプレートファイルを使ってそれらを表示するような仕組みになっています。予め最低限のレイアウトだけを整えたテンプレートファイルが既に用意されていますので、気にしないのであればそれをお使いいただき、「ウェブプロテクター for ベーシック認証」をご活用いただけます。

ところが、標準のテンプレートのデザインでは満足できないという方もいらっしゃるでしょう。そこで、それを自分の思い通りのテンプレートに作り替えて、「ウェブプロテクター for ベーシック認証」で利用することができます。

ここではそれらテンプレートファイルの編集の方法とルールを説明します。

テンプレートファイルの種類と保存場所


テンプレートファイルには、ウェブブラウザに表示するための画面を定義した「HTMLテンプレート」と、送信される電子メールの内容を定義した「メールテンプレート」の2種類があります。

HTMLテンプレートは拡張子が

.html
、 メールテンプレートは拡張子が
.txt
のファイルです。これらは [wpba/template/] ディレクトリにすべて保存されています。

編集の概要


HTMLテンプレートのファイルはただのHTMLファイルです。また、メールテンプレートのファイルはただのテキストファイルです。

したがってHTMLテンプレートの編集にはHTMLの知識が必要です。逆にHTMLが書けるとか、既にウェブサイトの製作に慣れている方にはそんなに問題なく編集ができるわけです。メールテンプレートはテキストファイルですから、メモ帳のようなエディタさえ使えれば問題なく編集できます。

基本的には普通のHTMLやテキストファイルを編集するようにこれらのテンプレートファイルも編集することができます。ただし、次の点に注意してください。

HTMLテンプレートにおけるフォーム部品の名前付けについて


パスワード申し込みフォームやパスワード・リマインダーの画面など、ユーザに何らかの入力を求める画面は、すべてHTMLのフォームの機能を用いています。各フォームにはテキストボックスやチェックボックスなどのコントロールを配置し、情報を受け取るための設定を記述していきます。

フォームの中に記述するテキストボックスやチェックボックスなどは部品とかコントロールと呼ばれます。それらの部品には個別の名前を着けることができます。「ウェブプロテクター for ベーシック認証」の各プログラムは、フォームの部品に個別に着けられた名前を元に、様々な処理を行っています。

したがって、フォームを書く際に部品の名前が決まったもの以外になってしまうと、うまく動作しなくなってしまいます。

HTMLテンプレートを編集する際は、次ページの対応表を参考にしながら、十分に気をつけて編集してください。

それさえ守っていただければ、あとはあなたの自由です。HTMLでできることは何でもやっちゃってください。

キーワードについて


テンプレート中には、特殊なキーワードを書き込むことで、そのキーワードをプログラムから取り出した各種の情報に置き換えることができます。

例えば、テンプレートファイル中にキーワードとして

::email::
と書いたとすると、
::email::
と書いた部分が websoft@niikest.com のようなメールアドレスに、表示される際変化します。

キーワードはいくつか種類がありますが、各テンプレートファイルごとに使えるキーワードが異なります。これは、それらのテンプレートが使われる場面でプログラム的に引き出し可能な情報が違ったり、そもそも本質的に必要と考えられる情報とそうでない情報が異なるからです。

分かりやすくいえば、申し込み確認の画面に氏名や住所などの情報を表示することは必要なことと考えられますが、パスワードを再発行したときにそうした情報を表示する必要性は皆無ですよね。だから、パスワード再発行用のテンプレートに、氏名や住所に置き換えるためのキーワードを用意するのは無駄なのです。

上記のことは、一部作者の主観が混じっています。したがって要望があれば使えるキーワードについては変更もできますから、もし何かあれば電子メールをください。連絡先はマニュアルのトップページに書いてあります。


テンプレートファイルの書き方 2/2
トップページへ