Manual/Plugin/J-R

Last-modified: 2013-11-04 (月) 15:55:01


J


K


L


lastmod

種別

インライン型プラグイン

重要度

★☆☆☆☆

書式

&lastmod(
[ページ名]
);

概要

指定したページの最終更新日時を表示します。

引数

ページ名には最終更新日時を表示したいページ名を指定します。
ページ名を相対指定する事が可能です。
省略時は設置したページとみなします。


links

種別

コマンド

重要度

★★☆☆☆（管理者）

書式
?plugin=links
概要

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

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

備考

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

PKWK_READONLY が有効の場合、このプラグインは全てのリクエストを無効とします。


list

種別

コマンド

重要度

★★★★☆

書式
?cmd=list
概要

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


lookup

種別

（コマンド）

ブロック型プラグイン

重要度

★★★☆☆

書式
#lookup(
interwikiname
[,ボタン名
[,入力欄の初期値]]
)
概要

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

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

[[interwikiname:入力欄の値]]

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

引数

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

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

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

プラグイン内設定

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


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を指定した際に表示される文字列の代わりの文字列を指定します。省略時は '...'で始まるページの一覧となります。

プラグイン内設定

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

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

  • 階層化されたページの起点となるページが、lsでは記述したページ固定だが、ls2ではパラメータで指定できます。
  • titleパラメータを指定した場合に、lsでは「ページの一行目」が表示されるが、ls2では「見出しの一覧」を表示します。
  • include, link という表示オプションが追加されています。
  • 機能が増えた分、ls2は処理が重くなる傾向があるので、置き換え可能ならばlsを使う方がいいかもしれません。

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


M


map

種別

コマンド

重要度

★☆☆☆☆

書式
?plugin=map
[&refer=ページ名]
[&reverse=true]
概要

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

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

引数

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

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

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


md5

種別

コマンド

重要度

★☆☆☆☆

書式
?plugin=md5
[&md5=文字列]
概要

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

パスワードのフォーマットは以下の8種類の中から選択できます。


DESあるいはMD5アルゴリズムを利用したPHP crypt() および LDAP crypt *1、


MD5 アルゴリズムを利用したPHP md5()、LDAP MD5、およびLDAP SMD5(シードあり)、


SHA-1 アルゴリズムを利用したPHP sha1()、LDAP SHA、および LDAP SSHA(シードあり)

備考

PukiWiki内で利用するパスワードは、パスワード文字列そのものの代わりに、
実際のパスワードから導出された文字列(セキュリティハッシュ)を保存することが可能です。


これは悪意ある者にpukiwiki.ini.phpの中身を覗き見られた場合に、
パスワードが安易に漏洩しない事を目的としたものです。

しかし、ネットワーク上でデータをやり取りするこのプラグインの利用時には、通信ログの閲覧や通信パケットの盗聴などによる情報の漏洩に注意しなければ、周囲にパスワードを教えてしまう事になってしまいます。


この為、PKWK_SAFE_MODE または PKWK_READONLY の設定が有効の場合、このプラグインは全てのリクエストを無効とします。

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

プラグイン名に反してMD5以外のパスワードフォーマットも選択可能です。


これは、過去のPukiWikiでpukiwiki.ini.php に保存するパスワードに使えた形式がPHP md5() のみであり、このプラグインがMD5 専用として生み出された経緯によるものです。

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


memo

種別

（コマンド）

ブロック型プラグイン

重要度

★☆☆☆☆

書式
#memo
概要

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

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

プラグイン内設定

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

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

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

PKWK_READONLY が有効の場合、このプラグインは既存データの表示のみを行い、その他のリクエストを無効とします。


menu

種別

ブロック型プラグイン

重要度

★★★★☆

書式
#menu(
ページ名
)
概要

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

任意のページでブロック型プラグインとして使用すると、引数に指定したページをメニュー用ページに指定できます。

例えば通常は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 がメニューとして表示されます。

引数

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

プラグイン内設定

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

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


N


navi

種別

ブロック型プラグイン

重要度

★★☆☆☆

書式
#navi(
[目次ページ]
)
概要

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

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

引数

目次ページに順番に見て回るページの上階層にあたるページを指定します。ページ名を相対指定する事が可能です。

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

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

プラグイン内設定

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


new

種別

インライン型プラグイン

重要度

★★☆☆☆

書式
書式1:
&new(
[nodate]
){
日付文字列
};
書式2:
&new(
[ページ名]
[,nolink]
);
概要

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

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

引数

書式1:

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

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

書式2:

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

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

  • nolink － ページ名を表示しません。省略時はページ名（ページ群で指定した場合は最後に更新されたページ名）を表示します。
プラグイン内設定

  • PLUGIN_NEW_DATE_FORMAT　表示フォーマット
備考

日付文字列はstrtotime()が認識できる書式である必要があります。


newpage

種別

コマンド

ブロック型プラグイン

重要度

★★★★★

書式
?plugin=newpage
&page=ページ名
&refer=関連ページ名

#newpage(
[ページ名初期値]
)

概要

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

PKWK_READONLY が有効の場合、このプラグインは全てのリクエストを無効とします。

引数

コマンド:

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

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

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

関連ページ名が指定されている場合、ページ名を相対指定する事が可能です。

ブロック型プラグイン:

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

プラグインを設置したページを関連ページとするので、入力欄に入力するページ名を相対指定する事が可能です。


nofollow

種別

ブロック型プラグイン

重要度

★☆☆☆☆

書式

#nofollow

概要

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

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

備考

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


norelated

種別

ブロック型プラグイン

重要度

★★★☆☆

書式
#norelated
概要

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

備考

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


O


online

種別

ブロック型プラグイン

インライン型プラグイン

重要度

★★☆☆☆

書式

#online

&online;

概要

現在PukiWikiを参照している、おおよそのユーザー数を表示します。

ユーザー数は、プラグインを呼び出された時点で記録されたＩＰアドレスとタイムスタンプのうち、５分以内(変更可能)にアクセスのあったアドレスの数です。

プラグイン内設定

  • PLUGIN_ONLINE_TIMEOUT　タイムアウトの秒数
  • PLUGIN_ONLINE_USER_LIST　ユーザー情報を保存するファイル
  • PLUGIN_ONLINE_LIST_REGEX　ユーザー情報取得用の正規表現
備考

ユーザー数のカウントはページ単位でなく、設置されたPukiWiki毎に行っているため、MenuBarなど頻繁に呼び出される場所に記述するかスキンに埋め込むのが普通です。


P


paint

種別

（コマンド）

ブロック型プラグイン

重要度

★☆☆☆☆

書式
#paint(
[幅]
[,高さ]
)
概要

Javaアプレットで描いた絵を、そのページに添付します。

ば科学的愛情で配布されているBBSPainter.jarを使用しています。

幅と高さに、デフォルトのキャンバスサイズを指定します。省略時は(80,60)となります（変更可能）

プラグイン内設定

  • PAINT_INSERT_INS　入力内容を先頭/末尾のどちらに挿入するか
  • PAINT_DEFAULT_WIDTH　デフォルトの描画領域の幅
  • PAINT_DEFAULT_HEIGHT　デフォルトの描画領域の高さ
  • PAINT_MAX_WIDTH　描画領域の幅の上限
  • PAINT_MAX_HEIGHT　描画領域の高さの上限
  • PAINT_APPLET_WIDTH　アプレット領域の幅
  • PAINT_APPLET_HEIGHT　アプレット領域の高さ
  • PAINT_NAME_FORMAT　名前欄の挿入フォーマット
  • PAINT_MSG_FORMAT　コメント欄の挿入フォーマット
  • PAINT_NOW_FORMAT　時刻欄の挿入フォーマット
  • PAINT_FORMAT　コメント内容全体の挿入フォーマット（メッセージあり）
  • PAINT_FORMAT_NOMSG　コメント内容全体の挿入フォーマット（メッセージなし）
備考

PukiWikiのインストールディレクトリに上記BBSPainter.jarを入れるのを忘れないでください。このプラグインが何の役にも立たなくなります。

画像ファイルの保存にattachプラグインを、表示にrefプラグインを使用します。

PKWK_READONLY が有効の場合、このプラグインは全てのリクエストを無効とします。


pcomment

種別

（コマンド）

ブロック型プラグイン

重要度

★★★☆☆

書式
#pcomment(
[コメント記録ページ] {
[,表示件数]
[,noname]
[,nodate]
[,above]
[,below]
[,reply]
})
概要

別のページにコメントを記録することができるcommentプラグインです。設置した場所には最新のコメントだけを表示することができます。ラジオボタンを表示し、指定した部分にコメントを付けることもできます。

引数

コメント記録ページ にはコメントを記録するページ名を指定します。ページ名を相対指定する事が可能です。省略すると、pcommentプラグイン内の PLUGIN_PCOMMENT_PAGE で指定されたページにコメントが記録されます。デフォルトは [コメント/(設置したページ名)] です。指定したページが存在しなくても、最初にコメントを追加した時に作成します。

表示件数 は表示する最新コメントの数を指定します。第1レベルの番号なしリストだけをカウントします。省略すると、pcommentのデフォルト件数(通常10件。 PLUGIN_PCOMMENT_NUM_COMMENTS で変更可能)が表示されます。

表示件数は コメント記録ページ より後に指定して下さい。コメント記録ページを省略して 表示件数 を指定する場合は、 コメント記録ページ に空白を指定します。（例: #pcomment(,15)）

noname,nodate,above,below,reply でコメントの表示方法、入力方法を指定します。

  • noname － 名前の入力欄を表示しません。
  • nodate － 日付を挿入しません。
  • above － 挿入したコメントをフォームの上に表示します。コメントは上が古く、下に向かって新しい順に並びます。
  • below － 挿入したコメントをフォームの下に表示します。コメントは下が古く、上に向かって新しい順に並びます。
  • reply － コメントの頭にラジオボタンを表示します。あるコメントに対するリプライが、そのコメントのラジオボタンをチェックすることで可能になります。
プラグイン内設定

  • PLUGIN_PCOMMENT_PAGE　 ページ名のデフォルト
    • %sが設置したページ名（$vars['page']）に置き換えられます
  • PLUGIN_PCOMMENT_NUM_COMMENTS　表示する(最新の)コメント数のデフォルト
  • PLUGIN_PCOMMENT_SIZE_NAME　 名前欄の表示桁数
  • PLUGIN_PCOMMENT_SIZE_MSG　 コメント欄の表示桁数
  • PLUGIN_PCOMMENT_DIRECTION_DEFAULT　入力内容を先頭/末尾のどちらに挿入するか
  • PLUGIN_PCOMMENT_FORMAT_NAME　名前欄の挿入フォーマット
  • PLUGIN_PCOMMENT_FORMAT_MSG　 コメント欄の挿入フォーマット
  • PLUGIN_PCOMMENT_FORMAT_NOW　 時刻欄の挿入フォーマット
  • PLUGIN_PCOMMENT_FORMAT_STRING　コメント内容全体の挿入フォーマット
  • PLUGIN_PCOMMENT_AUTO_LOG　自動過去ログ化を行う際の1ページあたりの件数(0で無効)
  • PLUGIN_PCOMMENT_TIMESTAMP　コメントページのタイムスタンプを更新せず、設置ページのタイムスタンプを更新するか
備考

ページ名の一番最初または最後以外に:（半角のコロン）がページ名に含まれていると、無効なページ名としてエラーとなります。このため、:で始まるページにpcommentプラグインを設置する場合、デフォルトの [コメント/(設置したページ名)] では記録ページを作成することができません。テンプレート専用のページとしないのであれば、コメント記録ページを指定する必要があります。

更新が衝突したときは、予期せぬ場所にコメントが挿入されるのを防ぐため、リプライ先を指定して記入したコメントはaboveまたはbelowの設定にしたがって 一番前か一番後ろに追加されます。

コメント記入後に表示されるページのタイトルに「(#pcommentを書いたページ)を更新しました」と表示されますが、実際に更新されたのはコメントを記録するページです。

コメントを投稿しても、#pcommentが書かれたページは更新されないので、最終更新ページにはコメントを記録したページだけが更新として表示されます。（PLUGIN_PCOMMENT_TIMESTAMP の設定を、無効にしている場合）

コメントとして相対参照([ [../] ]など)を用いた場合は、書いたページと書き込まれたページのどちらかで、意図したとおりに変換されない可能性があります。

自動過去ログ化機能は、コメントを投稿された時に第1レベルの番号なしリストの数が PLUGIN_PCOMMENT_AUTO_LOG の件数 ＋ PLUGIN_PCOMMENT_NUM_COMMENTS の件数以上になると作動します。その際、第1レベルの番号なしリストの数が最新の記述から PLUGIN_PCOMMENT_NUM_COMMENTS の件数分になるようにコメント記録ページに残し、残りを [(設置したページ名)/(ログno.)] のページに移します。

PKWK_READONLY が有効の場合、このプラグインは既存データの表示のみを行い、その他のリクエストを無効とします。


popular

種別

ブロック型プラグイン

重要度

★★☆☆☆

書式
#popular(
[[件数]
[,[対象外ページ]
[,true|false]
]]
)
概要

人気のある（参照回数の多い）ページの上位数件を表示します。

引数

件数には一覧の数を指定して下さい。省略時はPLUGIN_POPULAR_DEFAULTに指定した件数です。

対象外ページには、表示対象外とするページを正規表現で指定します。例えば FrontPage や MenuBar などのページを一覧に表示させたくないときに使用します。

true, falseで、ページのカウント条件を指定します。省略時は false です。

  • true － 今日参照のあった回数順でページを表示します。
  • false － 通算の参照回数順でページを表示します。
プラグイン内設定

  • PLUGIN_POPULAR_DEFAULT　件数未指定時の件数
備考

counterプラグインのカウンター情報を利用しているので、counterプラグインを設置していないページはカウントの対象外となります。全てのページにcounterプラグインを設置するのは非効率であるため counterプラグインをMenubarやスキンに設置するのが一般的です。


Q


R


random

種別

（コマンド）

ブロック型プラグイン

重要度

★☆☆☆☆

書式
#random(
[メッセージ]
)
概要

ランダムなページへのリンクを表示するプラグイン。

表示するページの候補は設置したページの下階層のページです。

引数

メッセージにはリンクに表示する文字列を指定します。省略時は 'press here.' となります。

備考

ブラウザの再読み込み対策はしていません。リロードされるたびにランダムな表示を繰り返します。


read

種別

コマンド

重要度

★★★★★

書式
?cmd=read
&page=ページ名
概要

指定したページを表示します。

該当ページが存在しない時、ページ名がInterWikiであった場合はinterwikiプラグインで解決を行い、有効なページ名であった場合はeditプラグインで編集画面を呼びだします。

PKWK_SAFE_MODE が有効な場合、InterWikiの処理は行いません。

plugin=やcmd=が指定されていない場合に内部で暗黙に呼び出されるため、利用者が意識する機会は少ないです。

引数

ページ名には表示したいページ名を指定します。ページ名はエンコードされている必要があります。


recent

種別

ブロック型プラグイン

重要度

★★★★★

書式
#recent(
[件数]
)
概要

最近更新されたページのうち、最新の数件を表示します。

引数

件数には表示件数を指定します。省略時はプラグイン内設定で指定した値です。

プラグイン内設定

  • PLUGIN_RECENT_DEFAULT_LINES　件数未指定時の件数
  • PLUGIN_RECENT_CACHE　RecentChangesのキャッシュの場所
  • PLUGIN_RECENT_USAGE　引数未指定時に表示されるヘルプ
  • PLUGIN_RECENT_EXEC_LIMIT　１ページ中で実行可能な上限回数


ref

種別

ブロック型プラグイン

インライン型プラグイン

重要度

★★★★☆

書式

#ref(
ページ名/添付ファイル名|
添付ファイル名[,ページ名]|
URL
{,
[left|center|right],
[wrap|nowrap],
[around],
[noicon],
[noimg],
[nolink],
[zoom],
[999x999],
[999%]
}
[,タイトル]
)

&ref(
ページ名/添付ファイル名|
添付ファイル名[,ページ名]|
URL
{,
[noicon],
[noimg],
[nolink],
[zoom],
[999x999],
[999%]
}
[,タイトル]
);

概要

'#attach'でページに添付されたファイルを指定位置に展開します。添付ファイルが画像の場合は画像を表示し、それ以外の場合はダウンロード用のリンクを表示します。

引数

添付ファイル名にはページに添付したファイル名を指定します（省略時はエラーとなります）。別ページ名/添付ファイル名とする事で別ページの添付ファイルも指定できます。ページ名を相対指定する事が可能です。

ページ名にはファイルを添付したページをWikiNameかBracketNameで指定、または相対指定します。このオプションは最初(添付ファイル名の次)に記述してください。省略時は設置したページです。

パラメータにはファイルの展開方法を指定できます。

  • left|center|right － 表示時の位置を指定します。省略時はleft(変更可)です。
  • wrap|nowrap － テーブルタグで囲む/囲まないの指定を行います。省略時はnowrap(変更可)です。
  • around － テキストの回り込みを可能とします。省略時は回り込みを行いません。
  • noicon － ファイルが画像以外の場合に表示されるアイコンを表示しません。省略時は表示します。
  • noimg － ファイルが画像の場合に画像を展開しないようにします。省略時は展開します。
  • nolink － 元ファイルへのリンクを張らないようにします。省略時はリンクします。
  • zoom － 縦横比を保持します。省略時はサイズ指定に従います。
  • 999x999 － サイズを指定します(幅x高さ)。省略時は拡大率あるいは対象画像のサイズに従います。
  • 999% － サイズを指定(拡大率)します。省略時は100%です、
  • タイトル － 上記以外のパラメータは画像の代替文字列、リンクのタイトル属性として使用されます。ページ名やパラメータに見える文字列を使用するときは、#ref(hoge.png,,zoom)のようにタイトルの前にカンマを余分に入れます。
プラグイン内設定

  • PLUGIN_REF_USAGE　引数未指定時に表示されるヘルプ
  • PLUGIN_REF_IMAGE　マッチ時に指定ファイルを画像とみなす正規表現
  • FILE_ICON　アイコンイメージのファイル
  • PLUGIN_REF_DEFAULT_ALIGN　left,center,right省略時の表示位置
  • PLUGIN_REF_WRAP_TABLE　wrap,nowrap省略時にテーブルタグで囲むか
  • PLUGIN_REF_URL_GET_IMAGE_SIZE　URL指定時に画像サイズを取得するか
  • PLUGIN_REF_DIRECT_ACCESS　添付ファイルの画像表示で UPLOAD_DIR のデータに直接アクセスするか
備考

PKWK_DISABLE_INLINE_IMAGE_FROM_URI が有効の場合、「URLであるかのように見えるURIによって、外部の画像をインライン表示させようとする行為」が無効化されます。

aroundで行った回り込み指定を解除するには clearプラグイン、あるいはimgプラグインを使用して下さい。

"ほげ"という別ページの添付ファイル"fuga.jpg"をインラインプラグイン形式で参照する場合、下記２通りの記述方法が存在します。

(1) &ref(ほげ/fuga.jpg);
(2) &ref(fuga.jpg,[[ほげ]]);

上記２通りの記述のうち、(2)の記述方式は旧バージョンと互換性を維持するために用意されたもので、推奨される記述方式は(1)です。

いずれの記述方法であっても一般的な動作は同じですが、いわゆるバナー画像のように表示した画像が別ページへのリンクとなるよう以下の指定をした場合、

(1)  [[&ref(ほげ/fuga.jpg,nolink,ウェブ名);>ウェブのURL]]
(2)  [[&ref(fuga.jpg,[[ほげ]],nolink,ウェブ名);>ウェブのURL]]
(1)の記述方法は期待通りの動作をしますが、(2)の記述方法ではうまくリンクされません。

また、ほげというページに添付された画像を、そのページ内でサイズ指定用パラメータを設定して（例えば半分の比率で）表示する場合、 
(3)  &ref(./fuga.jpg,50%);
(4)  &ref(ほげ/fuga.jpg,50%);
(5)  &ref(fuga.jpg,[[ほげ]],50%);
(6)  &ref(fuga.jpg,50%);
(3)～(5)は期待通りに同じ結果をしますが、(6)はエラーとなります。

これは(6)の書式が(2)の記述方式と同じであるため、添付ファイル名fuga.jpgの次の引数にページ名を期待するためです。 
(7)  &ref(fuga.jpg);
(7)は(6)と似た記述ですが、添付ファイル名の次の引数が省略されているため、エラーにはなりません。


related

種別

コマンド

擬似ブロック型プラグイン

重要度

★★★☆☆

書式

?plugin=related
[&page=ページ名]

#related

概要

対象のページを参照しているページの一覧を表示します。

引数

ブロック型で実行時、設置したページが対象となります。

コマンドで実行時、ページ名に対象となるページを指定できます。省略した場合、トップページが指定されたとみなします。


rename

種別

コマンド

重要度

★★★☆☆

書式
?plugin=rename
[&refer=ページ名]
概要

既存ページの名前を変更します。実行には管理者権限が必要です。

ページの本文のほか、指定されたページ名の差分、バックアップ、添付ファイル、カウンターを一気にリネームします。

引数

ページ名には変更するページの名前を指定します。省略時はページ名の選択または正規表現置換用文字列を入力する画面が表示されます。

ページ名を指定した場合は、その文字列で始まる関連ページもリネームするかを選択できます。

無効な正規表現によるエラーを防止するために、正規表現のメタ文字は全て無効化され、通常の文字列として扱います。

実行結果は変換結果のページ（PLUGIN_RENAME_LOGPAGE で指定。標準は :RenameLog）に追記されます。

プラグイン内設定

  • PLUGIN_RENAME_LOGPAGE　ページ名の変換結果を出力するページ名
備考

ページ内のリンクの書き換えは行ないません。yetlistなどを駆使して対処してください。

リネーム対象のページが凍結されているかどうかはチェックしていません。

関連ページにリネーム対象の文字列が複数含まれているとおかしくなります。

  • たとえば、hogeおよびhoge/hogeという二つのページがあったときに、hogeページをfugaに(関連ページを含んで)リネームすると、hoge/hogeページの名前がfuga/fugaになってしまいます。

    PKWK_READONLY が有効の場合、このプラグインは全てのリクエストを無効とします。


rss

種別

コマンド

重要度

★☆☆☆☆

書式

?plugin=rss
[&ver=0.91|
1.0|
2.0]

概要

RecentChangesをRSSに変換して出力します。

引数

verで出力するRSSを指定します。省略時は0.91を出力します。

備考

RSSはサイトの要約を配信するために使われるXMLフォーマットです。RSS 1.0はRDF(Resource Description Framework)にもとづいたRSS 0.9の後継フォーマットです。RSS 0.91は RDFにもとづかないRSSの実装で、RSS 2.0は RSS 0.91および 0.92の後継フォーマットです。RSSという頭字語が何の略であるかは、それぞれ異なります。

RSS 0.9および1.0: RDF Site Summary

RSS 0.91および0.92: Rich Site Summary

RSS 2.0: Really Simple Syndication


rss10

種別

コマンド

重要度

★☆☆☆☆

書式

?cmd=rss10

概要

RecentChangesをRSS(RDF Site Summary)1.0に変換して出力します。

備考

rss10プラグインの機能はrssプラグインにマージされたため、
このプラグインは過去との互換性のためにのみ存在しています。
(将来的に削除される可能性があります)

このプラグインにアクセスすると、HTTPステータス・コード 301
(Moved Permanently)とともに、ver=1.0オプションを指定したrssプラグイン
のURIへリダイレクトされます。


ruby

種別

インライン型プラグイン

重要度

★☆☆☆☆

書式
&ruby(
ルビ
){
対象文字列
};
概要

文字列にルビをふります。

引数

ルビには表示するルビを指定します。

対象文字列にはルビがふられる文字列を指定します。

プラグイン内設定

  • PLUGIN_RUBY_USAGE　引数未指定時に表示されるヘルプ
備考

XHTML 1.1のルビに対応したブラウザでないと、ルビとして表示されません。IE5.5/6では表示できます。Netscape 7/MozillaではXHTML Ruby Supportを組み込めば表示できます。

ルビに対応していないブラウザではルビをふる文字列の直後にルビが( )に入れられて表示されます。


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