PukiWiki/1.4/マニュアル/プラグイン/l

Sun, 09 Jan 2005 22:30:44 JST (5489d)

links †

種別

コマンド

重要度

★★☆☆☆(管理者)

書式
''?plugin=links''
概要

ページ間のキャッシュを更新します。通常使用する必要はありません。

メンテナンス作業などでページが記録されているファイルを直接操作した場合にキャッシュとページの記述内容の整合性がとれなくなるため、実行する必要があります。

備考

実行の際に管理者パスワードを要求されます。

list †

種別

コマンド

重要度

★★★★☆

書式
''?cmd=list''
概要

ページの一覧を表示します。

lookup †

種別

(コマンド)

ブロック型プラグイン

重要度

★★★☆☆

書式
''#lookup('' InterWikiName, ボタン名 [,初期値] '')''
概要

記述した位置に入力欄とボタンと表示し、ボタンを押下するとラベルと入力値から生成されたURLへジャンプします。

URLを生成するルールはInterWikiと同様です。無理にInterWikiの記述に直すと[[InterWikiName:入力欄に入力した値]]となります。

引数

InterWikiNameにはURLの生成に使用するInterWikiNameを指定します。

ボタン名にはボタンに表示するキャプションを指定します。

初期値には入力欄の初期値を指定します。省略時は空欄です。

ls †

種別

ブロック型プラグイン

重要度

★★☆☆☆

書式
''#ls('' [title] '')''
概要

記述したページより階層化されているページのページ名を一覧表示します。

引数

titleを指定した場合、ページ名に加えてタイトルを表示します。タイトルは各ページの一行目の内容を表示します。省略時はタイトルを表示しません。

備考

実際には、より高機能なls2を使用する機会が多いと思われます。

ls2 †

種別

(コマンド)

ブロック型プラグイン

重要度

★★★☆☆

書式
''#ls2('' [[パターン] [, { [title], [include], [reverse], [compact], [link] } [,linkの別名表示] ]] '')''
概要

指定したパターンで始まるページ名を一覧表示します。

引数

パターンには表示するページ名の共通部分を指定します。省略時は"設置したページ名/"となります。

title,include,reverse,compact,link で表示方法を指定します。

  • title − ページに含まれる見出し(*,**,***)の一覧を併記します。
  • include − 下位層のページが#includeを使用していた場合、includeしているページの一覧を表示します。
  • reverse − ページの並び順を反転し、名前の降順に表示します。省略すると名前の昇順に表示されます。
  • compact − 見出しレベルを調整します。
  • link − #ls2を書いた位置に一覧を表示する代わりにリンクを表示します。このリンクを選択すると別画面にページの一覧を表示するようにします。

linkの別名表示には、パラメータlinkを指定した際に表示される文字列の代わりの文字列を指定します。省略時は'' '...'で始まるページの一覧''となります。

プラグイン内設定

  • LS2_CONTENT_HEAD 見出しアンカーの書式
  • LS2_ANCHOR_ORIGIN 見出しアンカーの開始番号
  • LS2_LIST_COMPACT compactオプション省略時、見出しレベルを調整するか
備考

ls プラグインとの違いについて。

  • 階層化されたページの起点となるページが、lsでは記述したページ固定だが、ls2ではパラメータで指定できます。
  • titleパラメータを指定した場合に、lsでは「ページの一行目」が表示されるが、ls2では「見出しの一覧」を表示します。
  • include, link という表示オプションが追加されています。

ページ名のソートにはnatcasesort()を使っているため、昇順の場合、半角英数字よりも漢字の方が先に表示されます。