|
未分類プラグイン のバックアップ(No.5)
プラグインマニュアルプラグインマニュアルの凡例プラグインマニュアルは以下の形式で記述されています。 プラグイン名 種別
重要度 書式
概要 引数 プラグイン内設定 備考 Aadd 実行すると編集画面が表示されます。更新ボタンを押すと、指定した既存ページの末尾に編集欄で入力した内容が追加されます。種別 重要度 書式 引数 editが編集画面に既存のページ内容を表示するのに対し、addは常に編集画面が空となります。不用意に既存の入力内容を 備考 aname 指定した位置にアンカー(リンクの飛び先)を設定します。種別 ブロック型プラグイン 重要度 書式 #aname( アンカー名 [,{[super], [full], [noid]}, アンカー文字列] ) 概要 引数 super,full,noid でアンカーの出力方式を指定します。
アンカー文字列が指定された場合、指定した文字列に対してアンカーが出力されます。アンカーの存在を プラグイン内設定
備考 PukiWiki本体処理でanameプラグインを内部的に呼び出しているため、必ず組み込む必要があります。 article 指定した位置に簡易掲示板を設置します。種別 ブロック型プラグイン 重要度 書式 概要 プラグイン内設定
attach ページの添付ファイルの一覧を表示し、ファイル添付のための入力フォームを設置します。種別 ブロック型プラグイン 重要度 書式 概要 引数
プラグイン内設定
備考 プラグイン内設定の PLUGIN_ATTACH_MAX_FILESIZE を増やす場合は、php.iniの upload_max_filesize やApache の Bback 指定した位置に戻り先へのリンクを設置します。種別 重要度 書式 概要 引数 left、center、rightで表示位置を指定します。省略時はcenterになります。
0、1で水平線の有無を指定します。省略すると1になります。
戻り先はリンクを選択時の移動先となるURL、ページ名のいずれかで指定します。PLUGIN_BACK_ALLOW_PAGELINKがTRUEの場合のみページ名を指定可能です。 プラグイン内設定
backup 指定したページ、あるいは全体のバックアップ一覧を表示します。種別 重要度 書式 概要 指定したページ、あるいは全体のバックアップ一覧を表示します。 引数 プラグイン内設定
br 文章中で改行を行います。種別 インライン型プラグイン 重要度 書式 &br; 概要 段落やリスト、テーブル内など、行末の~による改行ではブロック要素を抜けてしまう個所で改行や空行の挿入するために用います。 プラグイン内設定
bugtrack種別 ブロック型プラグイン 重要度 ★★★★☆ (ソフト開発サイト) 書式 引数 カテゴリーにはバグの対象となりうる要素を指定します。省略時は入力欄となります。 プラグイン内設定
備考 bugtrack_list種別 重要度 ★★★★☆ (ソフト開発サイト) 書式 引数 備考 bugtrack_listプラグインの中からbugtrackプラグインを呼び出しているため、bugtrackプラグインがないと機能しません。 bugtrack_listプラグインは、tracker_listプラグインに比べて低機能ですが、リソース消費が少なく処理速度が速いというメリットがあります。この差はページ数の増加に比例して顕れる傾向があるため、使い分けが必要です。 Ccalendar、calendar_edit、calendar_read種別 重要度 書式 #calendar_edit( [{[ページ名], [年月]}] ) #calendar_read( [{[ページ名], [年月]}] ) 概要 カレンダーの日付を選択した場合に該当するページを編集状態、表示状態のどちらで開くかが３つのプラグインの違いです。 引数 年月は表示するカレンダーの西暦と月をyyyymmの形式で指定します。省略した場合は現在の年月になります。 備考 calendar_editプラグイン及びcalendar_readプラグインの中からcalendarプラグインを呼び出しているため、calendarプラグインがないと機能しません。 calendar_viewer種別 ブロック型プラグイン 重要度 書式 概要 引数 yyyy-mmを指定時、指定した年月のページを表示します。 数字を指定時、指定した件数分のページを表示します。 x*yを指定時、先頭より数えて x ページ目(先頭は0)から、y件づつ一覧表示します。x と yはいずれも数値です。 thisを指定時、今月のページを一覧表示します。 past、future、viewで表示するページの条件を指定します。省略/無指定時はpastとなります。
年月日の区切り文字は-や/などを指定します。省略した場合は-になります。 プラグイン内設定
備考 calendar2種別 ブロック型プラグイン 重要度 書式 概要 引数 yyyymmで表示するカレンダーの西暦と月を指定できます。省略時は当日の年月となります。 offを指定時、当日分ページを表示する機能は抑制されます。省略時は当日分のページを表示します。 備考 clear refプラグインのaroundオプションで有効となったテキスト回り込み指定を解除します。種別 重要度 書式 概要 備考 color 引数で指定したインライン要素(主に文章)の、文字色・背景色を指定します。種別 重要度 書式 概要 引数 文字色・背景色の両方を省略する事はできません。一方を省略した場合は省略した側の色の変更はされません。 プラグイン内設定
備考 comment コメントの入力用の入力欄を表示します。種別 ブロック型プラグイン 重要度 書式 概要 引数
プラグイン内設定
contents 設置したページ中の見出しの一覧を表示します。種別 重要度 書式 概要 counter 設置したページの参照回数を表示します。種別 インライン型プラグイン 重要度 書式 &counter( [total| today| yesterday] ); 概要 引数
プラグイン内設定
備考 Ddeleted 削除されたページの一覧を表示します。種別 重要度 書式 概要 引数 dirで削除の判定方法を指定します。省略時はbackupです。
備考 diff 指定したページの現在の内容と最後のバックアップ状態との差分を表示します。種別 重要度 書式 概要 引数 備考 dump 指定ディレクトリ内のファイルをまとめてtar(tar.gz, tgz)形式でバックアップ/リストアします。種別 重要度 書式 概要
プラグイン内設定
備考 DATA_DIRのリストアを行った場合は、linksプラグインで ページ間のリンク情報キャッシュを更新する必要があります。 Eedit 指定したページを編集します。種別 インライン型の記述では、ページ名は編集するページを指定します。省略時は設置したページです。 nolabel,noicon,ラベル名 でリンクの表示方法を指定します。
プラグイン内設定
Ffilelist ページの一覧を各ページが記録されているファイル名と共に表示します。種別 freeze 対象のページを凍結し、不用意に変更できないようにします。種別 備考 Hhr 文中に水平線を挿入します。種別 Iimg 添付ファイル以外の画像を表示するために開発されましたが、該当機能がrefプラグインに統合されたため、基本的に使用することはありません。過去との互換性のために残っています。種別 重要度 書式 right,r,left,l,clear,c で画像の表示位置とテキストの回りこみを指定します。省略時は left が指定されたとみなします。
プラグイン内設定
include 記述した位置に指定したページを挿入して、複数のページをあたかも１つのページであるかのように表示します。種別 重要度 書式 記述した位置に指定したページを挿入して、複数のページをあたかも１つのページであるかのように表示します。 引数 プラグイン内設定
includesubmenu 現在表示中のページによって、MenuBarに表示する内容を切り替える為に使用します。種別 重要度 書式 概要 表示中のページの下階層のSubMenuか、同階層にあるSubMenuページを挿入表示するプラグインです。 引数 insert 記述した位置に複数行入力欄とボタンを表示します。ボタンを押下すると入力欄に入力した内容をページに挿入します。種別 ブロック型プラグイン 重要度 書式 ボタンを押下すると入力欄に入力した内容をページに挿入します。 プラグイン内設定
備考 interwiki種別 重要度 書式 引数 Llastmod 指定したページの最終更新日時を表示します。種別 重要度 書式 概要 引数 links種別 重要度 書式 メンテナンス作業などでページが記録されているファイルを直接操作した場合にキャッシュとページの記述内容の整合性がとれなくなるため、実行する必要があります。 備考 list ページの一覧を表示します。種別 重要度 書式 lookup種別 ブロック型プラグイン 重要度 書式 URLの生成にはInterWikiを利用します。このプラグインが生成するURLは、以下のようなInterWikiと同じです。InterWikiNameのページに、あらかじめURLの生成に使用するInterWikiNameを設定しておく必要があります。 [[interwikiname:入力欄の値]] 入力欄が空欄(空文字列)のときは、ボタンを押しても動作しません。必ず何らかの文字列を入力する必要があります。 引数 ボタン名: ボタンに表示するキャプションを指定します。省略時は'lookup'です。 入力欄の初期値: 初期値を指定したい場合に記入します。省略時は空文字列になります。 プラグイン内設定
ls 記述したページより階層化されているページのページ名を一覧表示します。種別 重要度 書式 概要 引数 備考 ls2 指定したパターンで始まるページ名を一覧表示します。種別 ブロック型プラグイン 重要度 書式 引数 title,include,reverse,compact,link で表示方法を指定します。
linkの別名表示には、パラメータlinkを指定した際に表示される文字列の代わりの文字列を指定します。省略時は '...'で始まるページの一覧となります。 プラグイン内設定
備考
Mmarquee 流れる文字を表示します。表示するブラウザによっては正しく表示されないことがあります。http://wikiwiki.jp/sample/?%CE%AE%A4%EC%A4%EB%CA%B8%BB%FA
マニュアル#marquee(文字列,behavior,loop,背景色,文字色,文字サイズ); marqueeを表示します。表示するブラウザによっては正しく表示されないことがあります。 使用例【書式】 #marquee(スクロール表示); 【表示】 #marquee(端にぶつかると停止(slide),slide); 【表示】 #marquee(端から端までを往復(alternate),alternate); 【表示】 #marquee(ループ5回,,5); 【表示】 #marquee(ループ5回+文字色変更,,5,,red); 【表示】 #marquee(ループ5回+背景色変更,,5,pink); 【表示】 #marquee(文字サイズ20px,,,black,#aaffaa,20); 【表示】 関連リンクmap サイトマップの様にページ間のリンク関係を一覧表示します。種別 重要度 書式 指定したページを起点に、リンクで辿れるページを全てツリー状に表示します。 引数
プラグイン内設定
md5種別 重要度 書式 概要 パスワードのフォーマットは以下の8種類の中から選択できます。 DESあるいはMD5アルゴリズムを利用したPHP crypt() および LDAP crypt *1、 MD5 アルゴリズムを利用したPHP md5()、LDAP MD5、およびLDAP SMD5(シードあり)、 SHA-1 アルゴリズムを利用したPHP sha()、LDAP SHA、および LDAP SSHA(シードあり) 備考 SHA-1 アルゴリズムを利用するためには、PHP 4.3.0 以降を使用するか mhash エクステンションを導入する必要があります。 プラグイン名に反してMD5以外のパスワードフォーマットも選択可能です。 これは従来、パスワードから導出したMD5ハッシュ値を利用していた経緯によるものです。 md5のプラグインを呼び出すURLの中にパスワードを含める利用方法は互換性のため残っていますが、推奨されません。 このプラグインは PKWK_SAFE_MODE ないし PKWK_READONLY の設定で無効化されます。 memo 記述した位置に複数行入力欄とボタンを表示します。種別 ブロック型プラグイン 重要度 書式 ボタンを押下すると入力欄の記述内容を更新します。 プラグイン内設定
備考 個人用のメモ代わりにPukiWikiを利用している場合、未整理の情報を一時的に溜め込むのに便利です。 ブラウザによっては、複数行入力欄の右下角に入力欄の大きさを変更することができる「つまみ」が表示されます。 menu 任意のページでブロック型プラグインとして使用すると、引数に指定したページをメニュー用ページに指定できます。種別 重要度 書式 任意のページでブロック型プラグインとして使用すると、引数に指定したページをメニュー用ページに指定できます。 ソース中のMENU_ENABLE_SUBMENU をTRUEとすると、表示中のページの上位階層のMenuBarか、同階層にあるMenuBarページを 引数 プラグイン内設定
備考 Nnavi DocBook風ナビゲーションバーを表示します。種別 重要度 書式 目次となるページに下階層のページが存在する時、それら全てのページ（の先頭と末尾）に記述する事で Prev, Home, Next というリンクを表示します。これによって下階層のページを順に参照するのに便利になります。 引数 例えば hoge, hoge/1, hoge/2, hoge/3 というページが存在する場合、hoge/2に#navi(hoge)を記述するとhogeに移動するHomeというリンク、hoge/1に移動するPrevというリンク、hoge/3に移動するNextというリンクを表示します。 ページで最初に呼び出した場合はヘッダイメージのリンクを出力します。ページで２度目以降に呼び出された場合はフッタイメージのリンクを出力します。現在のページが目次ページである場合は対象となるページの一覧を表示します。 プラグイン内設定
new 指定した日時が最近であった場合、最近更新された事を強調表示します。種別 重要度 書式 書式1: 書式2: 標準では5日以内の場合に New を、１日以内の場合に New! を表示します。期間や表示する文字列のパターンは設置者によってカスタマイズ可能です。 引数 日付文字列を指定した場合、その日時が規定の期間内であった場合に強調表示します。省略した場合はページの更新日時をチェックする記述であると見なされます。
書式2: ページ名を指定した場合は、そのページの更新日時が規定の期間内であった場合に強調表示します。省略した場合は、プラグインを記述したそのページを指定したと見なします。 ページ名末尾が/であった場合、そのページ名で始まるページ群の中で最後の更新日時が規定の日付以内であった場合に強調表示します。
プラグイン内設定
備考 newpage ページを新規作成するか、新規作成するページ名の入力欄を表示します。種別 ブロック型プラグイン 重要度 書式 概要 引数 パラメータには新規作成するページのオプションを指定します。 ページ名には新規作成するページ名を指定します。省略時は新規作成するページ名の入力するためのページを表示します。ページ名はエンコードされている必要があります。 関連ページ名にはリンク元のページ名を指定します。新規作成するページの先頭に、ここで指定したページへのリンクが自動的に埋め込まれます。ページ名はエンコードされている必要があります。 ブロック型プラグイン: ページ名初期値には新規作成するページ名を入力する入力欄に初期表示する文字列を指定します。 norelated ページ下部に表示される関連ページのリンクを非表示にします。種別 重要度 書式 備考 Oonline 現在PukiWikiを参照している、おおよそのユーザー数を表示します。種別 インライン型プラグイン 重要度 書式 &online; 概要 ユーザー数は、プラグインを呼び出された時点で記録されたＩＰアドレスとタイムスタンプのうち、５分以内(変更可能)にアクセスのあったアドレスの数です。 プラグイン内設定
備考 Ppaint Javaアプレットで描いた絵を、そのページに添付します。※swikiでは動作しません。種別 ブロック型プラグイン 重要度 書式 ば科学的愛情 幅と高さに、デフォルトのキャンバスサイズを指定します。省略時は(80,60)となります（変更可能） プラグイン内設定
備考 pcomment 別のページにコメントを記録することができるcommentプラグインです。種別 ブロック型プラグイン 重要度 書式 引数 表示件数 は表示する最新コメントの数を指定します。第1レベルの番号なしリストだけをカウントします。省略すると、 noname,nodate,above,below,reply でコメントの表示方法、入力方法を指定します。
プラグイン内設定
備考 コメント記入後に表示されるページのタイトルに「(#pcommentを書いたページ)を更新しました」と表示されますが、 コメントを投稿しても、#pcommentが書かれたページは更新されないので、最終更新ページにはコメントを コメントとして相対参照([ [../] ]など)を用いた場合は、書いたページと書き込まれたページのどちらかで、 自動過去ログ化機能は PLUGIN_PCOMMENT_AUTO_LOG の件数 ＋ PLUGIN_PCOMMENT_NUM_COMMENTS popular 人気のある（参照回数の多い）ページの上位数件を表示します。種別 重要度 書式 引数 対象外ページには、表示対象外とするページを正規表現で指定します。例えば FrontPage や MenuBar などのページを一覧に表示させたくないときに使用します。 true, falseで、ページのカウント条件を指定します。省略時は false です。
プラグイン内設定
備考 Rrandom ランダムなページへのリンクを表示するプラグイン。種別 ブロック型プラグイン 重要度 書式 概要 表示するページの候補は設置したページの下階層のページです。 引数 備考 read 指定したページを表示します。該当ページが存在しない場合は編集状態で開き...種別 重要度 書式 概要 plugin=やcmd=が指定されていない場合に内部で暗黙に呼び出されるため、利用者が意識する機会は少ないです。 引数 recent 最近更新されたページのうち、最新の数件を表示します。種別 重要度 書式 引数 プラグイン内設定
ref '#attach'でページに添付されたファイルを指定位置に展開します。種別 インライン型プラグイン 重要度 書式 &ref( 添付ファイル名| ページ名/添付ファイル名| URL [,ページ名] {, [noicon], [noimg], [nolink], [zoom], [999x999], [999%] } [,タイトル] ); 概要 引数 ページ名にはファイルを添付したページをWikiNameかBracketNameで指定します。このオプションは最初(添付ファイル名の次)に記述してください。省略時は設置したページです。 パラメータにはファイルの展開方法を指定できます。
プラグイン内設定
備考 "ほげ"という別ページの添付ファイル"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)と似た記述ですが、添付ファイル名の次の引数が省略されているため、エラーにはなりません。 referer ページを照会した利用者の参照元URL(Referer)の一覧を表示します。種別 重要度 書式 概要 引数 sortでReferer一覧のソート順を指定します。
プラグイン内設定
備考 related 対象のページを参照しているページの一覧を表示します。種別 擬似ブロック型プラグイン 重要度 書式 #related 概要 引数 コマンドで実行時、ページ名に対象となるページを指定できます。省略した場合、トップページが指定されたとみなします。 rename 既存ページの名前を変更します。実行には管理者権限が必要です。種別 重要度 書式 ページの本文のほか、指定されたページ名の差分、バックアップ、添付ファイル、カウンターを一気にリネームします。 引数 実行結果は変換結果のページ（PLUGIN_RENAME_LOGPAGE で指定。標準は :RenameLog）に追記されます。 プラグイン内設定
備考 TrackBackやRefererの情報は更新されません。 リネーム対象のページが凍結されているかどうかはチェックしていません。 関連ページにリネーム対象の文字列が複数含まれているとおかしくなります。
ruby 文字列にルビをふります。種別 重要度 書式 引数 対象文字列にはルビがふられる文字列を指定します。 プラグイン内設定
備考 ルビに対応していないブラウザではルビをふる文字列の直後にルビが( )に入れられて表示されます。 Ssearch 検索文字列の入力フォームを表示し、 指定した文字列を含むページの検索を行います。種別 ブロック型プラグイン 重要度 書式 概要 引数
プラグイン内設定
setlinebreak 入力文章中の改行を改行とみなすかどうかの設定を行います。種別 重要度 書式 PukiWikiが入力文章中の改行をどのように扱うかはpukiwiki.ini内の$line_breakの設定内容によって変わります（下記参照）。
setlinebreakプラグインは該当ページの以降の行に関して、 $line_breakの設定に因らず改行をどのように扱うかを指定できるようになります。 引数
size 文字の大きさを指定します。種別 重要度 書式 概要 引数 文字列は文字の大きさを変更する文字列を指定します。 プラグイン内設定
source 指定したページの整形前のソースを表示します。種別 重要度 書式 概要 引数 横分割 include(splitinclude) それぞれのページ内容を3つまで横に並べて表示するプラグイン。 #splitinclude([ページ名１],[ページ名２],[ページ名３]) ページ名は,区切りで3つまで指定することができます。 ページ名は省略できません。 Ttb TrackBackの一覧を表示します。[#tb] 種別 重要度 書式 概要 POSTされた場合は他サイトからのTrackBackに反応します。 引数 &__modeには一覧表示方法を指定します。
プラグイン内設定
備考 template 既存のページをテンプレートとしてページを新規作成します。種別 重要度 書式 概要 ページの新規作成時の雛形とするページの読込み機能との差異は、テンプレートプラグインが雛形とする範囲(行単位)に選択できるのに対して、ページの新規作成で読み込むテンプレートは全文をテキストエリアにコピーする点にあります。 引数 プラグイン内設定
topicpath パンくずリスト(topicpath)と呼ばれる、ページの階層表現のユーザーインターフェースを提供するプラグイン。種別 重要度 書式 #topicpath パンくずリスト（Topic path）は現在参照しているウェブページの階層を表現するユーザーインターフェースです。例えばPukiWiki/ツアーというページに#topicpathと書くと、以下の様な表記に置き換わります。 [[Top>FrontPage]]/[[PukiWiki>PukiWiki]]/[[ツアー>PukiWiki/ツアー]] 基本的には以下の２通りの使い方を想定しています。 i.「ほげ/ふが/げほ」など、２～３階層以上の深いページでページの行き来をしやすくするために表示する
備考 ツールチップ(tooltip) マウスをあわせるとツールチップを表示します。&tooltip(単語){説明文};
と入力することでマウスをあわせるとツールチップを表示します。 利用例） Mercurialは分散型&tooltip(SCM){Source Code Management; バージョン管理システム};のひとつです。
と入力すると touchgraph TouchGraphWikiBrowser用のインデックスを作ります。種別 重要度 書式 tracker種別 ブロック型プラグイン 重要度 書式 概要 入力項目が固定されているbugtrackプラグインと機能は似ていますが、入力項目を簡単に変更できる点が違います。 入力項目の定義は:config/plugin/tracker/ 以下に所定の書式でテンプレートを作成することで設定できます。 引数 テンプレート名に続けてフォーム名 / リスト名を指定することができます。 ベースページ名はフォームから作成されるページの親階層となるページ名を指定します。省略時は設置したページとなります。 プラグイン内設定
テンプレート テンプレートは基本的に設置するtracker毎に１組（4ページ）作成します。
予約項目
tracker_list種別 ブロック型プラグイン 重要度 書式 概要 引数 ベースページ名はtrackerプラグインで指定したベースページ名と同じものを指定します。 第３項目には一覧表示のソートに使う項目およびソート順を指定します。ソート項目は :config/plugin/tracker/テンプレート名 のfield項目内の項目から選択して下さい。省略時はページ名となります。ソート順は、ASC*2、DESC*3、SORT_ASC*4、SORT_DESC*5 をコロン(:)の後に指定してください。また、セミコロン(;)で区切ることにより、複数のソート項目、ソート順を指定可能です。例えば、#tracker_list(,,state:SORT_ASC;priority:SORT_ASC;_real:SORT_DESC) と指定した場合は、項目ごとに (1) [state]を昇順 -> (2) [priority]を昇順 -> (3) [_real](実際のページ名)を降順、の優先順位でソートします。 表示上限は一覧表示するページ数の上限を指定します。省略時は全て表示されます。 Vvote 選択肢と投票数と投票ボタンが並んだ簡易投票フォームを表示します。種別 ブロック型プラグイン 重要度 書式 引数 備考 ※ページを凍結していても動作可能です。凍結した場合には各選択肢の投票数の編集は不可能になります。 使用例 Yyetlist まだ作られていないページを一覧表示します。種別 重要度 書式 まだ作られていないページとは、既存のページでWikiNameあるいはBracketNameで指定されていて、まだ作られていないページです。 備考 |
