L


lastmod

Plugin type

Inline type

Importance

*

Synopsis

&lastmod( [PageName] );

Description

Display the time of last modification of the specified page

Parameters

PageName - the page name of which timestamp is displayed. If it is omitted, the current page is used.


links

Plugin type

Command type

Importance

** (for admin)

Synopsis
?plugin=links
Description

Update the cache maintaining page relationships. It doesn't have to be used in normal operations.

This plugin is necessary to restore cache integrity when the files storing the pages have been directly changed (for maintenance purposes).

Note

The admin password is required to use this plugin.


list

Plugin type

Command type

Importance

****

Synopsis
?cmd=list
Description

Display the list of pages


lookup

Plugin type

(Command type)

Block type

Importance

***

Synopsis
#lookup( interwikiname [,ボタン名 [,入力欄の初期値]] )
Description

記述した位置にテキスト入力欄とボタンを表示します。任意の文字列を入力してボタンを押すと、interwikinameと入力値から生成したURLへ移動します。これによって、検索エンジンにクエリを送信したり、番号をタイプするだけで該当するアーカイブにアクセスすることなどが可能になります。

URLの生成にはInterWikiを利用します。このプラグインが生成するURLは、以下のようなInterWikiと同じです。InterWikiNameのページに、あらかじめURLの生成に使用するInterWikiNameを設定しておく必要があります。

[[interwikiname:入力欄の値]]

入力欄が空欄(空文字列)のときは、ボタンを押しても動作しません。必ず何らかの文字列を入力する必要があります。

Parameters

interwikiname: InterWikiNameに設定した値の一つを指定します。

ボタン名: ボタンに表示するキャプションを指定します。省略時は'lookup'です。

入力欄の初期値: 初期値を指定したい場合に記入します。省略時は空文字列になります。

Constants

  • PLUGIN_LOOKUP_USAGE Parameters未指定時に表示されるヘルプ

ls

Plugin type

Block type

Importance

**

Synopsis
#ls( [title] )
Description

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

Parameters

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

Note

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


ls2

Plugin type

(Command type)

Block type

Importance

***

Synopsis
#ls2( [[パターン] [, { [title], [include], [reverse], [compact], [link] } [,linkの別名表示] ]] )
Description

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

Parameters

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

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

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

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

Constants

  • PLUGIN_LS2_ANCHOR_PREFIX 見出しアンカーのSynopsis
  • PLUGIN_LS2_ANCHOR_ORIGIN 見出しアンカーの開始番号
  • PLUGIN_LS2_LIST_COMPACT compactオプション省略時、見出しレベルを調整するか
Note

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

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

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



M


map

Plugin type

Command type

Importance

*

Synopsis
?plugin=map [&refer=PageName] [&reverse=true]
Description

サイトマップの様にページ間のリンク関係を一覧表示します。

指定したページを起点に、リンクで辿れるページを全てツリー状に表示します。

Parameters

Parametersには一覧表示方法のオプションを指定します。

  • &refer=PageName - 起点となるページを指定します。省略すると、サイトのトップページ(通常はFrontPage)が起点となります。
  • &reverse=true - どこへリンクしているかではなく、どこからリンクされているかを一覧表示します。 どこからもリンクされていないページは、画面の後半にまとめて表示されます。
Constants

  • PLUGIN_MAP_SHOW_HIDDEN 表示対象外のページをリストアップするかどうか

md5

Plugin type

Command type

Importance

*

Synopsis
?plugin=md5 &md5=文字列
Description

選択したパスワードの形式に応じて、pukiwiki.ini.php に保存する パスワード用文字列を出力します。

パスワードのフォーマットは以下の8種類の中から選択できます。 DESあるいはMD5アルゴリズムを利用したPHP crypt() および LDAP crypt *1、 MD5 アルゴリズムを利用したPHP md5()、LDAP MD5、およびLDAP SMD5(シードあり)、 SHA-1 アルゴリズムを利用したPHP sha()、LDAP SHA、および LDAP SSHA(シードあり)

Note

PukiWiki内で利用するパスワードは、パスワード文字列そのものの代わりに、 実際のパスワードから導出された文字列(セキュリティハッシュ)を保存することが可能です。
これは悪意ある者にpukiwiki.ini.phpの中身を覗き見られた場合に、 パスワードが安易に漏洩しない事を目的としたものです。

SHA-1 アルゴリズムを利用するためには、PHP 4.3.0 以降を使用するか mhash エクステンションを導入する必要があります。

プラグイン名に反してMD5以外のパスワードフォーマットも選択可能です。 これは従来、パスワードから導出したMD5ハッシュ値を利用していた経緯によるものです。

md5のプラグインを呼び出すURLの中にパスワードを含める利用方法は互換性のため残っていますが、推奨されません。

このプラグインは PKWK_SAFE_MODE ないし PKWK_READONLY の設定で無効化されます。


memo

Plugin type

(Command type)

Block type

Importance

*

Synopsis
#memo
Description

記述した位置に複数行入力欄とボタンを表示します。

ボタンを押下すると入力欄の記述内容を更新します。

Constants

  • MEMO_COLS 編集欄の表示桁数
  • MEMO_ROWS 編集欄の表示行数
Note

insertプラグインやarticleプラグインと似ていますが、入力した内容が入力欄の外へ出力されず、入力欄に留まる点が異なります。

個人用のメモ代わりにPukiWikiを利用している場合、未整理の情報を一時的に溜め込むのに便利です。


menu

Plugin type

Block type

Importance

****

Synopsis
#menu( PageName )
Description

デフォルトのスキンにて、ページの左側にメニュー用のページ(MenuBar)を表示するために内部的に使用されています。

任意のページでBlock typeとして使用すると、Parametersに指定したページをメニュー用ページに指定できます。
例えば通常はMenuBarを表示するサイトで、hogeというページだけはMenuBarの代わりにhogeMenuというページを表示したい場合、hogeというページに #menu(hogeMenu) と記述する事で実現できます。

ソース中のMENU_ENABLE_SUBMENU をTRUEとすると、表示中のページの上位階層のMenuBarか、同階層にあるMenuBarページをメニューとして表示するようになります。
例えば FrontPage, MenuBar, hoge, fuga, hoge/MenuBar, hoge/hoge というページが存在する場合は、FrontPage、fuga、MenuBar では MenuBar がメニューとして表示され、hoge, hoge/MenuBar, hoge/hogeでは hoge/MenuBar がメニューとして表示されます。

Parameters

メニュー用ページとして表示するPageNameを指定します。

Constants

  • MENU_ENABLE_SUBMENU サブメニューを使用するか
  • MENU_SUBMENUBAR サブメニューを使用する場合にメニューとして呼び出されるPageName。デフォルトは MenuBar。
Note

デフォルトのメニュー用ページをMenuBar以外のページとする場合は、pukiwiki.ini.php の $menubar を変更して下さい。



N


navi

Plugin type

Block type

Importance

**

Synopsis
#navi( [目次ページ] )
Description

DocBook風ナビゲーションバーを表示します。

目次となるページに下階層のページが存在する時、それら全てのページ(の先頭と末尾)に記述する事で Prev, Home, Next というリンクを表示します。これによって下階層のページを順に参照するのに便利になります。

Parameters

目次ページに順番に見て回るページの上階層にあたるページを指定します。

例えば hoge, hoge/1, hoge/2, hoge/3 というページが存在する場合、hoge/2に#navi(hoge)を記述するとhogeに移動するHomeというリンク、hoge/1に移動するPrevというリンク、hoge/3に移動するNextというリンクを表示します。

ページで最初に呼び出した場合はヘッダイメージのリンクを出力します。ページで2度目以降に呼び出された場合はフッタイメージのリンクを出力します。現在のページが目次ページである場合は対象となるページの一覧を表示します。

Constants

  • PLUGIN_NAVI_EXCLUSIVE_REGEX 除外するページを正規表現で指定する
  • PLUGIN_NAVI_LINK_TAGS <link>タグを出力するかどうか

new

Plugin type

Inline type

Importance

**

Synopsis
Synopsis1:
&new( [nodate] ){ 日付文字列 };
Synopsis2:
&new( [PageName] [,nolink] );
Description

指定した日時が最近であった場合、最近更新された事を強調表示します。日時の指定は直接日付時刻を記述する方法(Synopsis1)と、指定したページ(群)の最終更新日時を採用する方法(Synopsis2)の2通りがあります。

標準では5日以内の場合に New を、1日以内の場合に New! を表示します。期間や表示する文字列のパターンは設置者によってカスタマイズ可能です。

Parameters

Synopsis1:

日付文字列を指定した場合、その日時が規定の期間内であった場合に強調表示します。省略した場合はページの更新日時をチェックする記述であると見なされます。

  • nodate - 日付文字列を表示しません。省略時は表示します。

Synopsis2:

PageNameを指定した場合は、そのページの更新日時が規定の期間内であった場合に強調表示します。省略した場合は、プラグインを記述したそのページを指定したと見なします。

PageName末尾が/であった場合、そのPageNameで始まるページ群の中で最後の更新日時が規定の日付以内であった場合に強調表示します。

  • nolink - PageNameを表示しません。省略時はPageName(ページ群で指定した場合は最後に更新されたPageName)を表示します。
Constants

  • PLUGIN_NEW_DATE_FORMAT 表示フォーマット
Note

日付文字列はPHP関数:strtotimeが認識できるSynopsisである必要があります。


newpage

Plugin type

Command type

Block type

Importance

*****

Synopsis
?plugin=newpage &page=PageName &refer=関連PageName

#newpage( [PageName初期値] )

Description

ページを新規作成するか、新規作成するPageNameの入力欄を表示します。

Parameters

Command type:

パラメータには新規作成するページのオプションを指定します。

PageNameには新規作成するPageNameを指定します。省略時は新規作成するPageNameの入力するためのページを表示します。PageNameはエンコードされている必要があります。

関連PageNameにはリンク元のPageNameを指定します。新規作成するページの先頭に、ここで指定したページへのリンクが自動的に埋め込まれます。PageNameはエンコードされている必要があります。

Block type:

PageName初期値には新規作成するPageNameを入力する入力欄に初期表示する文字列を指定します。


nofollow

Plugin type

Block type

Importance

*

Synopsis

#nofollow

Description

記述したページが凍結されている場合、ヘッダーに「NOFOLLOW」「NOINDEX」オプションを追加させます。

これらのオプションは検索エンジンに対し「このページを無視して欲しい」と主張します。実際にどうなるのかは検索エンジン次第です。

Note

人間や、上記のオプションを無視するプログラムには効果がありません。


norelated

Plugin type

Block type

Importance

***

Synopsis
#norelated
Description

ページ下部に表示される関連ページのリンクを非表示にします。

Note

極端に多くのページからリンクされていて関連リンクの表示が目障りである場合などに利用します。



*1 crypt()関数の出力はシステムに依存するため、移植性が高くありません

Front page   Edit Freeze Diff Backup Upload Copy Rename Reload   New List of pages Search Recent changes   Help   RSS of recent changes
Last-modified: 2008-06-03 (Tue) 03:53:44 (3516d)