template - 利用可能なテンプレートタグの解説

# NAME

template - 利用可能なテンプレートタグの解説

# SYNOPSYS

# DESCRIPTION

テンプレートシステムはほとんど全ての掲示板のデザインを変更することが出来ます。 ここでは利用可能なテンプレートのタグを解説します。

全てのテンプレートで利用可能なタグはImg0ch::Templateを参照してください。 また、テンプレートの使用例は通常使用されるテンプレート/_template/default またはtDiary互換テンプレート/_template/typeを参照してください。

これを読む前にHTML::Template (ClearSilverの場合ClearSilver)の ドキュメントに目を通すべきでしょう。

このドキュメントはHTML::Templateの例を使用していますが、ClearSilverの場合 <TMPL_VAR NAME="FOOBAR">を<?cs var:FOOBAR ?>に変更する必要があります。

# t_confirm.htで利用可能なタグ

t_confirm.htはスレッド作成の確認に利用されるテンプレートです。

## <TMPL_VAR NAME="Name">

フォームから入力された名前欄をそのまま表示します。

## <TMPL_VAR NAME="Mail">

フォームから入力されたメール欄をそのまま表示します。

## <TMPL_VAR NAME="Comment">

フォームから入力された本文をそのまま表示します。

## <TMPL_VAR NAME="Subject">

フォームから入力されたサブジェクト(スレッドのタイトル)をそのまま表示します。

# t_form.htで利用可能なタグ

t_form.htはスレッド作成のフォームに利用されるテンプレートです。

## <TMPL_VAR NAME="Banner">

告知欄を表示します。

## <TMPL_VAR NAME="HEAD">

ローカルルール(head.txtの内容)を表示します。

## <TMPL_VAR NAME="META">

メタデータ(meta.txtの内容)を表示します。

## <TMPL_VAR NAME="FOOT">

フッター(foot.txtの内容)を表示します。

# subback.htで利用可能なタグ

subback.htはsubback.htmlに利用されるテンプレートです。

## <TMPL_LOOP NAME="Threads">

それぞれのスレッドの位置SETTING.TXTのBBS_THREAD_NUMBER内に収まっている、 フロートされるスレッドの配列です。 <TMPL_LOOP NAME="Threads">のタグを拡張して利用する場合は <$zApp->inner_template_tag>メソッドを利用してください。

### <TMPL_VAR NAME="res">

スレッドの全レス数を表示します。

### <TMPL_VAR NAME="key">

スレッドのキーを表示します。

### <TMPL_VAR NAME="subject">

スレッドのサブジェクト(タイトル)を表示します。

### <TMPL_VAR NAME="index">

<TMPL_VAR NAME="count">に同じ。互換性のため利用可能になっています。

### <TMPL_VAR NAME="count">

スレッドの位置を表示します。

## <TMPL_VAR NAME="Banner">

告知欄を表示します。

# index.htで利用可能なタグ

index.htはindex.htmlに利用されるテンプレートです。

## <TMPL_LOOP NAME="Threads">

それぞれのスレッドの位置SETTING.TXTのBBS_THREAD_NUMBER内に収まっている、 フロートされるスレッドの配列です。 <TMPL_LOOP NAME="Threads">のタグを拡張して利用する場合は <$zApp->inner_template_tag>メソッドを利用してください。

### <TMPL_LOOP NAME="reses">

<TMPL_VAR NAME="Thread">に同じ。互換性のため利用可能になっています。

### <TMPL_LOOP NAME="Thread">

レスの内容の配列です。配列の数はBBS_CONTENTS_NUMBERになります。

#### <TMPL_VAR NAME="num">

<TMPL_VAR NAME="resno">に同じ。互換性のため利用可能になっています。

#### <TMPL_VAR NAME="resno">

現在のレス番号を表示します。

#### <TMPL_VAR NAME="isFirst">

現在のレス番号が1であるかどうかのフラグです。レス番号が1であれば真を返します。

#### <TMPL_VAR NAME="name">

現在のレスの名前欄を表示します。

#### <TMPL_VAR NAME="mail">

現在のレスのメール欄を表示します。

#### <TMPL_VAR NAME="date">

現在のレスの時刻およびIDを表示します。

#### <TMPL_VAR NAME="text">

現在のレスの本文を表示します。

### <TMPL_VAR NAME="key">

スレッドのキーを表示します。

### <TMPL_VAR NAME="subject">

スレッドのサブジェクト(タイトル)を表示します。

### <TMPL_VAR NAME="index">

スレッドの位置を表示します。

### <TMPL_VAR NAME="up">

前(上)のスレッドの位置を表示します。

### <TMPL_VAR NAME="down">

次(下)のスレッドの位置を表示します。

## <TMPL_LOOP NAME="Stored">

それぞれのスレッドの位置SETTING.TXTのBBS_THREAD_NUMBERの数を超えていてかつ BBS_MAX_MENU_THREADを超えていないスレッドの配列です。

### <TMPL_VAR NAME="res">

スレッドのレス数を表示します。

### <TMPL_VAR NAME="key">

スレッドのキーを表示します。

### <TMPL_VAR NAME="subject">

スレッドのサブジェクト(タイトル)を表示します。

### <TMPL_VAR NAME="index">

スレッドの位置を表示します。

## <TMPL_VAR NAME="SubBanner">

サブ告知欄を表示します。

## <TMPL_VAR NAME="Banner">

告知欄を表示します。

## <TMPL_VAR NAME="HEAD">

ローカルルール(head.txtの内容)を表示します。

## <TMPL_VAR NAME="META">

メタデータ(meta.txtの内容)を表示します。

## <TMPL_VAR NAME="FOOT">

フッター(foot.txtの内容)を表示します。

# i_index.htで利用可能なタグ

i_index.htは携帯用のindex.htmlに利用されるテンプレートです。 利用可能なタグは"index.htで利用可能なタグ"と同等ですが、以下のタグが追加で利用できます。

## <TMPL_VAR NAME="Count">

インデックスに表示可能なスレッド数を表示します。

## <TMPL_VAR NAME="CR">

\rを表示します。

## <TMPL_VAR NAME="Next">

BBS_THREAD_NUMBER + 1の数を表示します。

# redirect.htで利用可能なタグ

redirect.htは書き込み終了後に利用されるテンプレートです。

## <TMPL_VAR NAME="Banner">

告知欄を表示します。

## <TMPL_VAR NAME="RedirectWait">

書き込み終了後からindex.htmlに飛ぶまでに秒数を表示します。

# error.htで利用可能なタグ

error.htは書き込みエラーが発生したときに利用されるテンプレートです。 以下のタグ以外を拡張して利用する場合は`$zApp->error_template_tag`メソッドを 利用してください。

## <TMPL_VAR NAME="Host">

書き込みした人のホスト名を表示します。ホスト名が取得できない場合はIPアドレスで表示されます。

## <TMPL_VAR NAME="ShortErrorStr">

簡易なエラー内容を表示します。

## <TMPL_VAR NAME="LongErrorStr">

エラー内容を表示します。

## <TMPL_VAR NAME="Name">

フォームから入力された名前欄を表示します。

## <TMPL_VAR NAME="Mail">

フォームから入力されたメール欄を表示します。

## <TMPL_VAR NAME="Message">

フォームから入力された本文を表示します。

## <TMPL_VAR NAME="IsMobile">

アクセス元が携帯もしくはそれに相当するものなら1を、そうでない場合は0が設定されます。

# read.htで利用可能なタグ

read.htはread.cgiの表示に利用されるテンプレートです。

## <TMPL_LOOP NAME="ZThread">

<TMPL_VAR NAME="Thread">に同じ。互換性のため利用可能になっています。

## <TMPL_LOOP NAME="Thread">

レスの内容の配列です。

### <TMPL_VAR NAME="index">

<TMPL_VAR NAME="resno">に同じ。互換性のため利用可能になっています。

### <TMPL_VAR NAME="resno">

現在のレス番号を表示します。

### <TMPL_VAR NAME="name">

現在のレスの名前欄を表示します。

### <TMPL_VAR NAME="mail">

現在のレスのメール欄を表示します。

### <TMPL_VAR NAME="date">

現在のレスの時刻およびIDを表示します。

### <TMPL_VAR NAME="text">

現在のレスの本文を表示します。

## <TMPL_LOOP NAME="LinkStack">

100レスごとの開始位置と終了位置を格納した配列です。

### <TMPL_VAR NAME="start">

100レスごとの開始位置の数値を表示します。

### <TMPL_VAR NAME="end">

100レスごとの終了位置の数値を表示します。

## <TMPL_VAR NAME="90">

書き込み数が最大書き込み可能数の90%以上を超えた時は1、それ以外は0が設定されます。

## <TMPL_VAR NAME="95">

書き込み数が最大書き込み可能数の95%以上を超えた時は1、それ以外は0が設定されます。

## <TMPL_VAR NAME="100">

書き込み数が最大書き込み可能数を超えた時は1、それ以外は0が設定されます。

## <TMPL_VAR NAME="R90">

<TMPL_VAR NAME="90">に同じ。 ClearSilverで使用するために定義されています。

## <TMPL_VAR NAME="R95">

<TMPL_VAR NAME="95">に同じ。 ClearSilverで使用するために定義されています。

## <TMPL_VAR NAME="R100">

<TMPL_VAR NAME="100">に同じ。 ClearSilverで使用するために定義されています。

## <TMPL_VAR NAME="Banner">

告知欄を表示します。

## <TMPL_VAR NAME="DatKByteSize">

スレッドのdatの大きさをキロバイト単位で表示します。

## <TMPL_VAR NAME="NameByCookie">

Cookieに保存されている名前欄を表示します。保存されていなければ空文字列が設定されます。

注意：このディレクティブはクッキーの保存方法の変更により常に空文字列を返します。

## <TMPL_VAR NAME="NextStart">

「次」の開始位置の数値を表示します。

## <TMPL_VAR NAME="NextEnd">

「次」の終了位置の数値を表示します。

## <TMPL_VAR NAME="MailByCookie">

Cookieに保存されているメール欄を表示します。保存されていなければ空文字列が設定されます。

注意：このディレクティブはクッキーの保存方法の変更により常に空文字列を返します。

## <TMPL_VAR NAME="META">

メタデータ(meta.txtの内容)を表示します。

## <TMPL_VAR NAME="PrevStart">

「前」の開始位置の数値を表示します。

## <TMPL_VAR NAME="PrevEnd">

「前」の終了位置の数値を表示します。

## <TMPL_VAR NAME="ReadCGIURI">

read.cgiのURIを表示します。

## <TMPL_VAR NAME="ResCount">

現在のスレッドのレス数を表示します。

## <TMPL_VAR NAME="Subject">

現在のスレッドのサブジェクト(タイトル)を表示します。

# not_found.htで利用可能なタグ(read.cgi)

not_found.htはread.cgiおよびr.cgiのエラー表示に利用されるテンプレートです。

## <TMPL_LOOP NAME="ZThread">

レスの内容の配列です。

### <TMPL_VAR NAME="index">

現在のレス番号を表示します。

### <TMPL_VAR NAME="name">

現在のレスの名前欄を表示します。

### <TMPL_VAR NAME="mail">

現在のレスのメール欄を表示します。

### <TMPL_VAR NAME="date">

現在のレスの時刻およびIDを表示します。

### <TMPL_VAR NAME="text">

現在のレスの本文を表示します。

## <TMPL_VAR NAME="Archive">

過去ログのインデックスのリンクを表示します。

## <TMPL_VAR NAME="Banner">

告知欄を表示します。

## <TMPL_VAR NAME="DatByteSize">

スレッドのdatの大きさをバイト単位で表示します。

## <TMPL_VAR NAME="DatKByteSize">

スレッドのdatの大きさをキロバイト単位で表示します。

## <TMPL_VAR NAME="IsArchived">

読み込もうとしたスレッドが過去ログ化されていれば1を、そうでない場合は0が設定されます。

## <TMPL_VAR NAME="IsError">

スレッドの読み込み時にエラーがあったならば1を、そうでない場合は0が設定されます。

## <TMPL_VAR NAME="IsMobile">

アクセス元が携帯もしくはそれに相当するものなら1を、そうでない場合は0が設定されます。

## <TMPL_VAR NAME="IsPooled">

読み込もうとしたスレッドがプール状態にあれば1を、そうでない場合は0が設定されます。

## <TMPL_VAR NAME="Token1">

スレッドキーの0桁目から4桁目までの文字列を表示します。

## <TMPL_VAR NAME="Token2">

スレッドキーの0桁目から5桁目までの文字列を表示します。

## <TMPL_VAR NAME="ShortErrorStr">

簡易なエラー内容を表示します。

## <TMPL_VAR NAME="LongErrorStr">

エラー内容を表示します。

## <TMPL_VAR NAME="META">

メタデータ(meta.txtの内容)を表示します。

## <TMPL_VAR NAME="ReadCGIURI">

read.cgiのURIを表示します。

## <TMPL_VAR NAME="ResCount">

現在のスレッドのレス数を表示します。

# i_read.htで利用可能なタグ

i_read.htはr.cgiのレス表示に利用されるテンプレートです。 使用可能なタグは"i_read.htで利用可能なタグ"とほとんど同じですが、以下のタグが利用できません。

* <TMPL_LOOP NAME="LinkStack">
* <TMPL_VAR NAME="NextStart">
* <TMPL_VAR NAME="NextEnd">

以下はi_read.htで利用可能なタグです。

## <TMPL_VAR NAME="AAS">

AASを利用する状態であれば1を、そうでない場合は0が設定されます。 AASに関してはhttp://example.ddo.jp/aas/を参照してください。

## <TMPL_VAR NAME="AASBase">

AASに渡すためのパスを表示します。

## <TMPL_VAR NAME="Copy">

オプションに書き込みを写すフォーム表示を示す「c」が入っていれば1を、そうでない場合は0が設定されます。

## <TMPL_VAR NAME="CR">

\rを表示します。

## <TMPL_VAR NAME="Write">

オプションに書き込みフォーム表示を示す「w」が入っていれば1を、そうでない場合は0が設定されます。

## <TMPL_VAR NAME="RawOption">

r.cgiに渡されたオプションのパスを表示します。

# i_thread.htで利用可能なタグ

i_thread.htはr.cgiのスレッド表示に利用されるテンプレートです。 以下のタグ以外を拡張して利用する場合は`$zApp->thread_template_tag`メソッドを 利用してください。

## <TMPL_LOOP NAME="Threads">

スレッドの内容の配列です。

### <TMPL_VAR NAME="res">

スレッドのレス数を表示します。

### <TMPL_VAR NAME="key">

スレッドのキーを表示します。

### <TMPL_VAR NAME="subject">

スレッドのサブジェクト(タイトル)を表示します。

### <TMPL_VAR NAME="index">

スレッドの位置を表示します。

## <TMPL_VAR NAME="Banner">

告知欄を表示します。

## <TMPL_VAR NAME="Copy">

「写」が有効であれば1を、そうでない場合は0が設定されます。

## <TMPL_VAR NAME="CR">

\rを表示します。

## <TMPL_VAR NAME="From">

次のリンクを表示するためのスレッドの開始位置から100の数を足した数を表示します。

## <TMPL_VAR NAME="Next">

次のスレッドのリンクを表示するためのスレッドの開始位置から BBS_THREAD_NUMBERの数を足した数を表示します。

## <TMPL_VAR NAME="Prev">

前のスレッドのリンクを表示するためのスレッドの開始位置から BBS_THREAD_NUMBERの数を足した数を表示します。

## <TMPL_VAR NAME="Search">

検索で使われた単語を表示します。

## <TMPL_VAR NAME="Write">

オプションに書き込みフォーム表示を示す「w」が入っていれば1を、そうでない場合は0が設定されます。

# not_found.htで利用可能なタグ(r.cgi)

not_found.htはread.cgiおよびr.cgiのエラー表示に利用されるテンプレートです。 詳しくは"not_found.htで利用可能なタグ(read.cgi)"を参照してください。

# ufm.htで利用可能なタグ

ufm.htはimg0ch-ufm.cgiの表示に利用されるテンプレートです。

## <TMPL_VAR NAME="Banner">

告知欄を表示します。

## <TMPL_VAR NAME="KEY">

スレッドキーの値を出力します。

## <TMPL_VAR NAME="META">

メタデータ(meta.txtの内容)を表示します。

## <TMPL_VAR NAME="Password">

削除キーまたはダウンロードキーの値を出力します。

## <TMPL_VAR NAME="Removed">

削除キーを用いて削除されたなら1、そうでない場合は0が設定されます。

## <TMPL_VAR NAME="Failed">

削除キーの照合に失敗し、削除されなかった場合は1、そうでない場合は0が設定されます。

## <TMPL_VAR NAME="Resno">

アクセスされたときのレス番号の値を出力します。

## <TMPL_VAR NAME="Failed">

削除キーの照合に失敗し、削除されなかった場合は1、そうでない場合は0が設定されます。

## <TMPL_LOOP NAME="Threads">

subject.txtにある通りのスレッドの情報を格納した配列です。

### <TMPL_VAR NAME="res">

スレッドの全レス数を表示します。

### <TMPL_VAR NAME="key">

スレッドのキーを表示します。

### <TMPL_VAR NAME="subject">

スレッドのサブジェクト(タイトル)を表示します。

### <TMPL_VAR NAME="index">

<TMPL_VAR NAME="count">に同じ。互換性のため利用可能になっています。

### <TMPL_VAR NAME="count">

スレッドの位置を表示します。

### <TMPL_VAR NAME="selected">

ユーザーによってアクセスされた対象のスレッドなら1、そうでない場合は0が設定されます。

# SEE ALSO

Img0ch::Template

http://img0ch.sourceforge.jp

# AUTHOR

hkrn <hikarin at users dot sourceforge dot jp>

template - 利用可能なテンプレートタグの解説

# INDEX

- <TMPL_LOOP NAME="LinkStack">
- <TMPL_LOOP NAME="Stored">
- <TMPL_LOOP NAME="Thread">
- <TMPL_LOOP NAME="Threads">
- <TMPL_LOOP NAME="ZThread">
- <TMPL_LOOP NAME="reses">
- <TMPL_VAR NAME="100">
- <TMPL_VAR NAME="90">
- <TMPL_VAR NAME="95">
- <TMPL_VAR NAME="AAS">
- <TMPL_VAR NAME="AASBase">
- <TMPL_VAR NAME="Archive">
- <TMPL_VAR NAME="Banner">
- <TMPL_VAR NAME="CR">
- <TMPL_VAR NAME="Comment">
- <TMPL_VAR NAME="Copy">
- <TMPL_VAR NAME="Count">
- <TMPL_VAR NAME="DatByteSize">
- <TMPL_VAR NAME="DatKByteSize">
- <TMPL_VAR NAME="FOOT">
- <TMPL_VAR NAME="Failed">
- <TMPL_VAR NAME="From">
- <TMPL_VAR NAME="HEAD">
- <TMPL_VAR NAME="Host">
- <TMPL_VAR NAME="IsArchived">
- <TMPL_VAR NAME="IsError">
- <TMPL_VAR NAME="IsMobile">
- <TMPL_VAR NAME="IsPooled">
- <TMPL_VAR NAME="KEY">
- <TMPL_VAR NAME="LongErrorStr">
- <TMPL_VAR NAME="META">
- <TMPL_VAR NAME="Mail">
- <TMPL_VAR NAME="MailByCookie">
- <TMPL_VAR NAME="Message">
- <TMPL_VAR NAME="Name">
- <TMPL_VAR NAME="NameByCookie">
- <TMPL_VAR NAME="Next">
- <TMPL_VAR NAME="NextEnd">
- <TMPL_VAR NAME="NextStart">
- <TMPL_VAR NAME="Password">
- <TMPL_VAR NAME="Prev">
- <TMPL_VAR NAME="PrevEnd">
- <TMPL_VAR NAME="PrevStart">
- <TMPL_VAR NAME="R100">
- <TMPL_VAR NAME="R90">
- <TMPL_VAR NAME="R95">
- <TMPL_VAR NAME="RawOption">
- <TMPL_VAR NAME="ReadCGIURI">
- <TMPL_VAR NAME="RedirectWait">
- <TMPL_VAR NAME="Removed">
- <TMPL_VAR NAME="ResCount">
- <TMPL_VAR NAME="Resno">
- <TMPL_VAR NAME="Search">
- <TMPL_VAR NAME="ShortErrorStr">
- <TMPL_VAR NAME="SubBanner">
- <TMPL_VAR NAME="Subject">
- <TMPL_VAR NAME="Token1">
- <TMPL_VAR NAME="Token2">
- <TMPL_VAR NAME="Write">
- <TMPL_VAR NAME="count">
- <TMPL_VAR NAME="date">
- <TMPL_VAR NAME="down">
- <TMPL_VAR NAME="end">
- <TMPL_VAR NAME="index">
- <TMPL_VAR NAME="isFirst">
- <TMPL_VAR NAME="key">
- <TMPL_VAR NAME="mail">
- <TMPL_VAR NAME="name">
- <TMPL_VAR NAME="num">
- <TMPL_VAR NAME="res">
- <TMPL_VAR NAME="resno">
- <TMPL_VAR NAME="selected">
- <TMPL_VAR NAME="start">
- <TMPL_VAR NAME="subject">
- <TMPL_VAR NAME="text">
- <TMPL_VAR NAME="up">
- * <TMPL_LOOP NAME="LinkStack">
- * <TMPL_VAR NAME="NextEnd">
- * <TMPL_VAR NAME="NextStart">
- AUTHOR
- DESCRIPTION
- NAME
- SEE ALSO
- SYNOPSYS
- error.htで利用可能なタグ
- i_index.htで利用可能なタグ
- i_read.htで利用可能なタグ
- i_thread.htで利用可能なタグ
- index.htで利用可能なタグ
- not_found.htで利用可能なタグ(r.cgi)
- not_found.htで利用可能なタグ(read.cgi)
- read.htで利用可能なタグ
- redirect.htで利用可能なタグ
- subback.htで利用可能なタグ
- t_confirm.htで利用可能なタグ
- t_form.htで利用可能なタグ
- ufm.htで利用可能なタグ

template - 利用可能なテンプレートタグの解説