スニペット"DocLister"：ページネーションの実装

ページネーション（ページ送り）を実装するには、&paginateパラメーターを使用します。
有効にした場合そのままでは表示されません。
表示するには[+pages+]というタグを使用します。

また、&displayパラメーターも同時に設定する必要があります。
&displayパラメーターは1ページ毎の表示件数を設定します。

構文

値 初期値 説明
有効／無効 offset 有効にするか無効にするか
offset ... 無効
pages ... 有効

サンプルコード

1つのリソースに複数のDocListerを実装している場合、干渉することがあります。
&idパラメーターを指定することで干渉しないようにすることができます。

&idパラメーターについてはDocListerの識別ページをご覧ください。

ページネーションはいくつかのオプションパラメーターがあります。

目次
  1. 外側の基本HTMLテンプレート
  2. 外側のクラス名
  3. ページ番号の基本HTMLテンプレート
  4. 現在のページ番号のHTMLテンプレート
  5. 前／次ページ移動ボタンを常に表示するかどうか
  6. 前ページ移動ボタンのHTMLテンプレート
  7. 次ページ移動ボタンのHTMLテンプレート
  8. 前ページ移動ボタンの無効化状態のHTMLテンプレート
  9. 次ページ移動ボタンの無効化状態のHTMLテンプレート
  10. 最初のページ移動ボタンのHTMLテンプレート
  11. 最後のページ移動ボタンのHTMLテンプレート
  12. 最初のページ移動ボタンの無効化状態のHTMLテンプレート
  13. 最後のページ移動ボタンの無効化状態のHTMLテンプレート
  14. ページ数が多いときの省略表現をするかどうか
  15. 省略表現のHTMLテンプレート
  16. 表示するページ番号の最大ページ数
  17. 使用可能なプレースホルダー

外側の基本HTMLテンプレート

外側の基本HTMLテンプレートを変更するには、&TplWrapPaginateパラメーターを使用します。

構文

値 初期値 説明
HTMLテンプレート @CODE:<div class="[+class+]">[+wrap+]</div> チャンク名 または HTML文字列。
HTMLは先頭に@CODE:を付けて指定する。

サンプルコード

外側のクラス名

外側の基本HTMLテンプレートで使用されるクラス名を変更するには、&PaginateClassパラメーターを使用します。
このパラメーターは[+class+]プレースホルダーで出力されます。

構文

値 初期値 説明
クラス名 pagination 設定するクラス名を指定。

サンプルコード

ページ番号の基本HTMLテンプレート

ページ番号の基本HTMLテンプレートを変更するには、&TplPageパラメーターを使用します。

構文

値 初期値 説明
HTMLテンプレート @CODE:<a href="[+link+]" class="page">[+num+]</a> チャンク名 または HTML文字列。
HTMLは先頭に@CODE:を付けて指定する。

サンプルコード

現在のページ番号のHTMLテンプレート

現在のページ番号のHTMLテンプレートを変更するには、&TplCurrentPageパラメーターを使用します。

構文

値 初期値 説明
HTMLテンプレート @CODE:<b class="current">[+num+]</b> チャンク名 または HTML文字列。
HTMLは先頭に@CODE:を付けて指定する。

サンプルコード

前／次ページ移動ボタンを常に表示するかどうか

前／次ページ移動ボタンを常に表示するかどうかを設定するには、&PrevNextAlwaysShowパラメーターを使用します。
常に表示しない場合、現在のページが最初のページであれば前ページ移動ボタンは表示されず、現在のページが最後のページであれば次のページ移動ボタンが表示されません。

構文

値 初期値 説明
有効／無効 0 有効にするか無効にするか。
0 ... 無効
1 ... 有効

サンプルコード

前ページ移動ボタンのHTMLテンプレート

前のページへ移動するボタンのHTMLテンプレートを変更するには、&TplPrevPパラメーターを使用します。

構文

値 初期値 説明
HTMLテンプレート @CODE:<a href="[+link+]">< [%paginate.prev%]</a> チャンク名 または HTML文字列。
HTMLは先頭に@CODE:を付けて指定する。

サンプルコード

次ページ移動ボタンのHTMLテンプレート

次のページへ移動するボタンのHTMLテンプレートを変更するには、&TplNextPパラメーターを使用します。

構文

値 初期値 説明
HTMLテンプレート @CODE:<a href="[+link+]">[%paginate.next%] ></a> チャンク名 または HTML文字列。
HTMLは先頭に@CODE:を付けて指定する。

サンプルコード

前ページ移動ボタンの無効化状態のHTMLテンプレート

前のページへ移動するボタンの無効化状態のHTMLテンプレートを変更するには、&TplPrevIパラメーターを使用します。
無効化状態のボタンは&PrevNextAlwaysShowパラメーターを有効にしている場合に表示されます。

構文

値 初期値 説明
HTMLテンプレート @CODE:< [%paginate.prev%] チャンク名 または HTML文字列。
HTMLは先頭に@CODE:を付けて指定する。

サンプルコード

次ページ移動ボタンの無効化状態のHTMLテンプレート

次のページへ移動するボタンの無効化状態のHTMLテンプレートを変更するには、&TplNextIパラメーターを使用します。
無効化状態のボタンは&PrevNextAlwaysShowパラメーターを有効にしている場合に表示されます。

構文

値 初期値 説明
HTMLテンプレート @CODE:[%paginate.next%] > チャンク名 または HTML文字列。
HTMLは先頭に@CODE:を付けて指定する。

サンプルコード

最初のページ移動ボタンのHTMLテンプレート

最初のページへ移動するボタンのHTMLテンプレートを変更するには、&TplFirstPパラメーターを使用します。

構文

値 初期値 説明
HTMLテンプレート チャンク名 または HTML文字列。
HTMLは先頭に@CODE:を付けて指定する。

サンプルコード

最後のページ移動ボタンのHTMLテンプレート

最後のページへ移動するボタンのHTMLテンプレートを変更するには、&TplLastPパラメーターを使用します。

構文

値 初期値 説明
HTMLテンプレート チャンク名 または HTML文字列。
HTMLは先頭に@CODE:を付けて指定する。

サンプルコード

最初のページ移動ボタンの無効化状態のHTMLテンプレート

最初のページへ移動するボタンの無効化状態のHTMLテンプレートを変更するには、&TplFirstIパラメーターを使用します。

構文

値 初期値 説明
HTMLテンプレート チャンク名 または HTML文字列。
HTMLは先頭に@CODE:を付けて指定する。

サンプルコード

最後のページ移動ボタンの無効化状態のHTMLテンプレート

最後のページへ移動するボタンの無効化状態のHTMLテンプレートを変更するには、&TplLastIパラメーターを使用します。

構文

値 初期値 説明
HTMLテンプレート チャンク名 または HTML文字列。
HTMLは先頭に@CODE:を付けて指定する。

サンプルコード

ページ数が多いときの省略表現をするかどうか

ページ数が多いときに最初のほう、あるいは最後のほうを残して中間のページ数を省略するかどうかを設定することができます。
&pageAdjacentsパラメーターを使用します。

構文

値 初期値 説明
設定値 4 次の値を設定することができる。
1 ... 前後に表示
2 ... 前後どちらかのみ表示
3 ... ※ 不明
4 ... 省略しない

サンプルコード

省略表現のHTMLは&TplDotsPageパラメーターで変更できます。

省略表現のHTMLテンプレート

&pageAdjacentsパラメーターが有効の時、省略として表現するHTMLのテンプレートを変更するには、&TplDotsPageパラメーターを使用します。

構文

値 初期値 説明
HTMLテンプレート @CODE:... チャンク名 または HTML文字列。
HTMLは先頭に@CODE:を付けて指定する。

サンプルコード

表示するページ番号の最大ページ数

表示するページ番号の最大ページ数を設定するには、&pageLimitパラメーターを使用します。
例えばページ数が10ページあった場合、&pageLimitパラメーターを5に設定すると、最大5ページまでしか表示されません。

構文

値 初期値 説明
最大ページ数 0 最大ページ数を指定する。

サンプルコード

使用可能なプレースホルダー

各パラメーターで使用可能なプレースホルダーは次の通りです。

プレースホルダー 説明 使用可能パラメーター／箇所
[+pages+]
[+idパラメーター.pages+]		 ページネーション全体を出力する。 [[DocLister]]と同じ並び
[+totalPages+]
[+idパラメーター.totalPages+]		 最大ページ数を出力する。 [[DocLister]]と同じ並び
または各パラメーター
[+current+]
[+idパラメーター.current+]		 現在のページ番号を出力する。 [[DocLister]]と同じ並び
または各パラメーター
[+from+]
[+idパラメーター.from+]		 リソースの一覧から表示しているリソースの開始番号を出力する。 [[DocLister]]と同じ並び
または各パラメーター
[+to+]
[+idパラメーター.to+]		 リソースの一覧から表示しているリソースの終了番号を出力する。 [[DocLister]]と同じ並び
または各パラメーター
[+count+]
[+idパラメーター.count+]		 リソースのアイテム数を出力する。 [[DocLister]]と同じ並び
または各パラメーター
[+isstart+]
[+idパラメーター.isstart+]		 現在のページが最初かどうか。
最初の場合は1、そうでなければ0を返す。		 [[DocLister]]と同じ並び
または各パラメーター
[+isstop+]
[+idパラメーター.isstop+]		 現在のページが最後かどうか。
最後の場合は1、そうでなければ0を返す。		 [[DocLister]]と同じ並び
または各パラメーター
[+wrap+] すべてのページ番号や前後の移動ボタンが出力される。 &TplWrapPaginate
[+class+] 外側HTMLとしてのクラス名を出力する。
クラス名は &PaginateClassパラメーターで変更可能。		 &TplWrapPaginate
[+link+] 各ページ番号の遷移パスを出力する。 &TplPage
&TplCurrentPage
&TplPrevP
&TplNextP
&TplPrevI
&TplNextI
[+num+] ページ番号を出力する。 &TplPage
&TplCurrentPage
&TplPrevP
&TplNextP
&TplPrevI
&TplNextI

CMS「Evolution CMS」逆引きリファレンス一覧へ戻る