原文: ListPages Module
ListPagesModuleはサイト内のページの選択表示に幅広く使われる一般的なツールです。
ListPagesを使うにあたり下記の項目を複数もしくは全て設定する事ができます:
- 何のページを選択するか(サイト内、カテゴリ内、親ページ指定、タグ指定、データ指定、その他)
- ページの並び順(昇順、降順)
- 出力結果のブロック分け方法(ページ分け)
- 出力結果のWikidot文章での表示方法(モジュール内の定型書式指定)
- 選択結果のRSSフィード発行方法
ListPagesの一般的な構文は下記になります。
[[module ListPages arguments...]]
module body
[[/module]]
初期設定ではListPagesは現在のカテゴリ内にある参照可能なページを新しいものから古いもの順で出力します。
モジュール内には[[code]]および[[html]]を設置する事はできません。これらのタグがモジュール内に含まれている場合、モジュールは全く機能しません。
例
下記は作者と作成日の情報を付記した現カテゴリ内のページリストです。
[[module ListPages separate="no" limit="5"]]
%%title_linked%% - [[user %%created_by%%]] - %%created_at%%
[[/module]]
動作
NextPreviousPage Module - Anonymous - 29 Apr 2014, 18:36
PagesByTag Module - Anonymous - 29 Apr 2014, 18:36
Pages Module - Anonymous - 29 Apr 2014, 18:36
ChildPages Module - Anonymous - 29 Apr 2014, 18:36
MembershipByPassword Module - Anonymous - 29 Apr 2014, 18:36
凡例
旧版の引数はinMixedCaseと表記します。新版の引数はin_lower_caseと表記し、この様式はwikidot内でより機能的に使われます。日付はsomething_atと、ユーザーはsomeone_byとし、リンク先はsomefield_linkedとします。
ページ選択
あなたが選択したページを整理する為に以下のセレクターを1つもしくは複数選択します。これらのセレクターは追加規則を与えます。| 引数 | 意味 |
|---|---|
| pagetype | ページのタイプによる選択をします |
| category | カテゴリによる選択をします |
| tags | タグによる選択をします |
| parent | 親ページによる選択をします |
| link_to | リンク先による選択をします |
| created_at | ページ作成日による選択をします |
| updated_at | ページ更新日による選択をします |
| created_by | ページ作成者による選択をします |
| rating | 評価による選択をします |
| offset | ページのオフセットからのリスト開始位置 |
| range | ページ選択範囲 |
| name | ページ名による選択をします |
| fullname | ページのフルネームによる選択をします |
| _<data-form-field-name> | データフォーム内のフィールドの値による選択をします |
Page type セレクター:
- "normal" はページ名に下線がないページを意味します(初期値)
- "hidden" はページ名の下線から開始します
- "*" はページ名に下線があるものとないもの全て表示します
Category セレクター:
- "." は現カテゴリを意味します(初期値)
- "*" は全カテゴリを意味します
- 他、スペース/カンマ区切りによるカテゴリーリスト
- カテゴリーは追加式です(category OR category OR category)
- "-category"は指定したカテゴリーではないページを意味します(AND NOT)
- "%%category%%"は現ページと同じカテゴリを意味します(a_template page使用下ならば)
Tags セレクター:
- "-" は表示もしくは非表示問わず指定したタグを含まないページを意味します
- "=" は現ページの表示タグといくつか同じ表示タグを持つページを意味します
- "==" は現ページの表示タグ全てと完全に一致する表示タグを持つページを意味します
- 他、スペース / カンマ 区切りによるタグリスト
- タグは追加式です(tag OR tag OR tag)
- "-tag" は指定したタグを持たないページを意味します(AND NOT)
- "+tag" は指定したタグを必ず含むページを意味します(AND)
Parent page セレクター:
- "-" は親ページを持たないページを意味します
- "=" は現ページの兄弟ページを意味します(現ページと同一の親ページ)
- "-=" は現ページとは違う親ページを持つページを意味します
- "." は現ページの子ページを意味します(現ページが親ページ)
- 他、フルページネームを1つ指定できます
Outgoing links セレクター:
- 1つの存在するページへリンクが貼られているページを選択します
- 同時に"."は現在のページへのリンクが貼られているページを意味します
Creation date セレクター:
- "="は現在のページと同じ日に作られたページを意味します
- "yyyy"は制作年を指定します
- "yyyy.mm"は制作年月を指定します
- 必要に応じてき右記の記号を日付の前につける事ができます">","<","=","<=",">=","<>"(初期値"=")
- 日付はサイトが置かれている国の標準時刻ではなく現在の世界協定時刻(UTC,GMT)です
- "last n unit"もしくは"older than n unit"の'n'は整数(初期値1)です。またunitは"hours"(時間)、"day"(日)、"week"(週),"month"(月)を記入します
Update date selector:
- 日付はサイトが置かれている国の標準時刻ではなく現在の世界協定時刻(UTC,GMT)です
- "last n unit"もしくは"older than n unit"の'n'は整数(初期値1)です。またunitは"hours"(時間)、"day"(日)、"week"(週),"month"(月)を記入します
Author セレクター:
- "="は現在のページと同じ制作者に作られたページを意味します
- "-="は現在のページの作者以外によって作られたページを意味します
- そうでない場合、特定のユーザーネームを記入します
Rating セレクター:
- "n"は指定した数(n)と同数の評価を受けているページを意味します
- "-="は現在のページと同じ評価数のページを意味します
- 必要に応じてき右記の記号を評価数の前につける事ができます">","<","=","<=",">=","<>"(初期値"=")
注意: 複数のカテゴリーからページのリストを作成した際、複数のカテゴリーに+もしくは+/-の評価が付けられていてなおかつその他"stars"(サイトマネージャー参照)を持っている場合、ページの選択及び並び替えが正常に動作しない場合があります。リスト作成及び並び替えを同じratingモードを持つカテゴリーから行う事で解決策できます。
Offset セレクター:
- "n"は最初から数えてn番目のページを非表示にするという意味です(初期値0)
Range セレクター:
- "."は現在のページを意味します
- "before"は現在のページより上にあり、なおかつ現ページがインクルードされていないページを意味します(ページリストのソート後に動きます)
- "after"は現在のページより後のページを意味します(ページリストのソート後に動きます)
- "others"は現在のページ以外を意味します。
Name セレクター:
- カテゴリー名を除いたページ名を記入すると、特定のカテゴリーにある同名のページもしくはその他のカテゴリーにある同名のページを選択します。現在のページのdataform fieldを使う事ができます。
- "="は現在のページときっちり同名のページを意味します(現在のページとは違うカテゴリーを選択した時に初めて意味を成します)
- "s%"はページ名の最初が"s"等で始まる全てのページを意味し
- "s*"はページ名の最初が"s"で始まる全てのページを意味します
Fullname セレクター:
- 存在するページの(カテゴリー名を含めた)フルネームを記入すると、そのページを選択します(現在のページのdataform fieldを使う事ができます)。
Data Form selector:
- Data form内の値によってページを選択します
- 構文: _data-form-field-name="data-form-field-value"
- 例文: _gender="m" - はData Formの'gender' field'sにmの文字がある全てのページを意味します
ページの並び順
ページの並び順を指定する時に使います :| 引数 | 意味 |
|---|---|
| order | 並び方の基準を指定します |
並び方の基準:
- "property"は"そのプロパティによる昇順を意味します"
- "desc"が続いて書かれている場合は"降順"を意味します
- " desc desc"が続いて書かれている場合は"昇順"を意味し、この並び方はその他の並び順(未訳)
- 初期値は"created_at desc"です
optionally followed by " desc" meaning "descending"
optionally followed by " desc desc" meaning "ascending", which makes "desc" safe to add after any sort order
default is "created_at desc
| プロパティ | 意味 |
|---|---|
| name | ページ名によって並べます |
| fullname | カテゴリーとページ名によって並べます |
| title | ページタイトルによって並べます |
| created_by | ページの制作者名によって並べます |
| created_at | 制作日によって並べます |
| updated_at | 更新日によって並べます |
| size | ソースコード中の文字数によって並べます |
| rating | 評価数によって並べます |
| revisions | ページのリビジョンによって並べます |
| comments | コメント数によって並べます |
| random | ランダムに並び替えます。この並び方は60秒ごとに取得されるキャッシュによるものです |
| _data-form-field-name | data-formのfieldによって並べます |
例えば評価数の降順で並べる場合は
order="rating desc"
注意: 複数のカテゴリーからページのリストを作成した際、複数のカテゴリーに+もしくは+/-の評価が付けられていてなおかつその他"stars"(サイトマネージャー参照)を持っている場合、ページの選択及び並び替えが正常に動作しない場合があります。リスト作成及び並び替えを同じratingモードを持つカテゴリーから行う事で解決策できます。