プラグイン使用方法/lsx

プラグインの本家がなくなったので魚拓
lsxは今も有用であり、製作者様の過去の努力に敬意を表します。
出典：https://jpngamerswiki.com/?28106a88ba

ページをリストアップするプラグイン ls.inc.php の拡張です。ls2.inc.php の拡張でもありそれの拡張であった旧 ls2_1.inc.php の拡張でもあります。

相対パス的表示。
階層的リスト表示。
階層指定。
表示件数指定
pukiwiki.ini.php で設定する $non_list の利用。
正規表現によるページのフィルタ
正規表現による除外ページ指定
更新日時表示
New 表示
更新日時によるソート
link オプション消去
複数ページ include

オプション名=bool なオプションは共通して、 オプション名, オプション名=true, オプション名=on でそのオプションが有効になり、オプション名=false, オプション名=off で無効になります。
prefix=文字列
リストするページ名の接頭辞。
省略時はカレントページ+"/"が指定されたことになる。
また / を指定した場合はすべてのページにマッチする。
相対指定(例えば Plugin ページにおける ./lsx.inc.php/ = Plugin/lsx.inc.php/)も可能。

num=数字
表示件数指定。正数は前からＮ件目、負数は後ろからＮ件目の意味。

num=1:10 で先頭１件目から１０件目までの意味。num=-10:-1 で後ろ１０件目から後ろ１件目までの意味。num=2: で先頭２件目から最後までの意味。

num=5+2 で先頭５件目から、そこから２件先まで(5,6,7)の意味。

depth=数字
下位階層指定。数字の指定は num と同じ書式。

hierarchy=bool
階層的リスト表示。デフォルトで有効。

tree=leaf|dir
末端ページ(leaf)、またはその逆(dir)のようなものを表示する。デフォルトは単純に無効。tree=dir は DOS コマンドの tree のようなニュアンス。

備考:ようなものなので、ページ名を意識して付けていない場合効果は薄いでしょう。

sort=name|date|reading
ソートの方法。name はページ名によるソート。date は更新日付(上が最新)によるソート。デフォルトは name。reading は「読み」によるソート。

備考:sort=date の場合、hierarchy は強制的に off になります。

備考:「読み」の設定は:config/PageReadingで行います。kakasi または chasen を用いた漢字の読みカナ自動設定は dev:PukiWiki/1.4/マニュアル/一覧表示の五十音順分類参照。

reverse=bool
逆順にソートする

non_list=bool
pukiwiki.ini.php で定義される $non_list によるリスト排除。デフォルトで有効。

except=正規表現
リストしないページを正規表現にて指定。prefixを取り除いたページ名で判定。

ヒント： マッチングには mbstring が利用可能な場合 mb_eregをそうでない場合 eregを使用します。
except=Test|sample → Test または sample を含むページを除く。

filter=正規表現
ページパターンをさらに正規表現で限定する。prefixを取り除いたページ名で判定。
prefix=/ (全ての意味) にしてこちらだけを使うのもあり。

ヒント： マッチングには mbstring が利用可能な場合 mb_eregをそうでない場合 eregを使用します。

date=bool
更新日付をページ名の横に表示。

new=bool
更新日付に対してNew!も表示。

備考:設定を再利用するため new プラグインを使用しています。

contents=(オプション)
ページ内の見出しもリストする。

備考:内部で contentsx プラグインを使用しているので、詳しいオプションは ../contentsxを参照してください。オプションを複数指定する場合は contents=(num=1,depth=1) のようにできます。contents=(num=1,depth=(1,2)) のように入れ子もできます*1。

include=(オプション)
ページを include する

備考：この場合ページリストは中止され、include だけされます。

備考：内部で includex プラグインを使用しています。詳しいオプションは ../includexを参照してください。オプションを複数指定する場合は include=(num=1:10,title=off) のようにできます

linkstr=relative|absolute|basename|title|headline
リンク文字列を制御できます。

relative で相対パス的文字列表示（デフォルト）。

absolute で絶対パス的文字列表示（ls2の動作）。

basename でページ階層化機能でのベース名部分、例：Note/Plugin/lsx.inc.php -> lsx.inc.php。

title で各ページの TITLE: 行で指定された文字列。

headline で各ページの第一見出し。

備考：title と headline は ../contentsxを使用します。インストールしておいてください。TITLE: とは PukiWiki Plus! において HTML のタイトル<title></title> を設定する書式です。

link=page|anchor|off
リンク形式。link=page は通常通りページへのリンク。link=anchor は #lsx(include) 用。取り込んだページタイトルへのアンカー。link=off はリンクしない。

ベータ機能
tag=文字列
/tag.inc.php で付けたタグを指定。tag=タグ１^タグ２ とすることで、共通ページを（積集合 ∩ のイメージ）、tag=タグ１-タグ２ とすることで差ページ(差集合のイメージ)をリスト

備考：hierarchy, prefix は強制的に off になります。ベータ機能です。たぶん将来的には別のプラグインに移送されます。

アルファ機能
newpage=on|except

on で新規作成ページのみを、except で新規作成ページ以外をリスト。デフォルトでは単純に無効。

備考：backup ファイルが作成されているかどうかで新規かどうかを判断しています。

next
num オプションで件数を制限した場合に、次の５件、前の５件を表示するためのリンクを表示する

以下のページ群があったとする。
test
test/a
test/a/aa
test/a/aa/aaa
test/a/bb/bbb
test/c/cc/ccc

test というページで記述したものとする。[] はリンクの意。

[a]
[aa]
[aaa]
bb
[bbb]
c
cc
[ccc]

[a]
[aa]
[aaa]
bb
[bbb]
c
cc
[ccc]

[a]
[a/aa]
[a/aa/aaa]
[a/bb/bbb]
[c/cc/ccc]

[a/aa/aaa]
[a/bb/bbb]
[c/cc/ccc]

[a]
[aa]
bb
c
cc

[a]

[a]
[aa]

a (←注目)
[aa]
[aaa]
bb
[bbb]
c
cc
[ccc]

[a]
[aa]

a
bb
[bbb]
c
cc
[ccc]

[a]
[aa]
bb
[bbb]

[a]
[aa]
bb
[bbb]

[a] 2004-10-10 (日) 23:03:05
[aa] 2004-11-30 (金) 12:11:43
[aaa] 2004-03-03 (月) 16:04:05
bb
[bbb] 2004-12-26 (水) 23:55:55
c
cc
[ccc] 2004-10-11 (月) 01:02:04

[a/bb/bbb] 2004-12-26 (水) 23:55:55 New
[a/aa] 2004-11-30 (金) 12:11:43
[c/cc/ccc] 2004-10-11 (月) 01:02:04
[a] 2004-10-10 (日) 23:03:05
[a/aa/aaa] 2004-03-03 (月) 16:04:05

[a/bb/bbb] New
[a/aa]
[c/cc/ccc]
[a]
[a/aa/aaa]

[a]
見出し
[aa]
見出し

の結果が出力される。