|
未分類プラグイン のバックアップ差分(No.2)
#contents * プラグインマニュアル [#g4919d30] ** プラグインマニュアルの凡例 [#jce09f74] プラグインマニュアルは以下の形式で記述されています。 ''プラグイン名'' ''種別'' プラグインがどのような方法で呼び出しを行えるかを示します。複数の呼び出し方法をもつプラグインも存在します。 -- コマンド － コマンド形式の呼び出しが可能であることを示します。内部的に呼び出されるため、説明を省いている場合はカッコで括られています。 -- ブロック型プラグイン － ブロック型プラグインでの呼び出しが可能である事を示します。 -- インライン型プラグイン － インライン型プラグインでの呼び出しが可能である事を示します。 -- 擬似ブロック型プラグイン － PukiWiki本体で実現されている機能であることを示します。記述方式がブロック型プラグインと同じであるため、便宜上プラグインのマニュアルに含めています。 ''重要度'' そのプラグインの一般的な利用頻度や有用性の目安を示します。さほど重要でない場合は ★☆☆☆☆ が、重要なプラグインの場合は ★★★★★ です。 ''書式'' プラグインでの引数指定方法です。引数の指定方法の表現のため、下記の記述書式を使っています。 -- [] － 省略可能で必要に応じて記述する箇所です。 -- | － |で区切られた複数の項目のうち、指定できるのは１つである事を示します。 -- {} － 中カッコ内のみ引数の指定順序が任意である事を示します。 ''概要'' そのプラグインの機能概要です。 ''引数'' 引数の詳細な説明です。 ''プラグイン内設定'' プラグインのソース中で定義されている定数の一覧です。引数で変更できない詳細なカスタマイズが可能となります。 ''備考'' プラグインに関する参考情報です。 *E [#qb9a8b1f] ** edit [#s906eb15] ''種別'' コマンド インライン型プラグイン ''重要度'' ★★★★★ ''書式'' ''?cmd=edit'' &color(blue){&page=ページ名}; ''&edit('' [&color(blue){ページ名}; {[,&color(blue){nolabel};] [,&color(blue){noicon};]}] ''){'' &color(blue){ラベル名}; ''};'' ''概要'' 指定したページを編集します。 ''引数'' コマンド型の記述では、ページ名に編集するページを指定します。ページ名はエンコードされていなければなりません。 インライン型の記述では、ページ名は編集するページを指定します。省略時は設置したページです。 nolabel,noicon,ラベル名 でリンクの表示方法を指定します。 -- nolabel － 編集用リンクの文字列をnoicon 指定時は短縮表記、未指定時は省略します。 -- noicon － 編集用リンクに画像を表示しません。 -- ラベル名 － 編集用リンクの文字列として表示する文字列を指定します。 ''プラグイン内設定'' -- PLUGIN_EDIT_FREEZE_REGEX freezeプラグインを介さず、直接入力されたfreezeを除去する正規表現 *F [#ud8720c5] ** filelist [#c2463541] ''種別'' コマンド ''重要度'' ★☆☆☆☆ ''書式'' ''?cmd=filelist'' ''概要'' ページの一覧を各ページが記録されているファイル名と共に表示します。 ''備考'' 主として管理者がメンテナンス用途に使用します。 ※表示するには管理者のパスワードが必要です。 ** freeze [#a8716326] ''種別'' コマンド （ブロック型プラグイン） ''重要度'' ★★★☆☆ ''書式'' ''?cmd=freeze'' &color(blue){&page=ページ名}; ''#freeze'' ''概要'' 対象のページを凍結し、不用意に変更できないようにします。 ''引数'' ページ名には凍結するページを指定します。ページ名はエンコードされている必要があります。コマンド型でfreezeプラグインを実行するとブロック型プラグインが凍結対象のページ先頭に挿入（凍結解除の場合は削除）されます。 ブロック型のfreezeプラグインはPukiWikiが内部的に利用するもので、基本的に利用者が意識する機会はありません。 ''備考'' ※実行の際に管理者パスワードを要求されます。 * H [#s65df7f8] ** hr [#bc59bded] ''種別'' ブロック型プラグイン ''重要度'' ★★☆☆☆ ''書式'' ''#hr'' ''概要'' 文中に水平線を挿入します。 ''備考'' 段落やリスト、テーブル内など、通常の水平線書式(----)ではブロックを抜けてしまう個所で水平線を挿入するために用います。リスト内など左右マージンが設定されている場合は、それを引き継ぎます。 * I [#s1dbc7fe] ** img [#l89113de] ''種別'' ブロック型プラグイン ''重要度'' ★☆☆☆☆ ''書式'' ''#img('' &color(blue){画像URL};[, &color(blue){right};| &color(blue){r};| &color(blue){left};| &color(blue){l};| &color(blue){clear};| &color(blue){c};,[ &color(blue){clear};| &color(blue){c}; ]] '')'' ''概要'' 添付ファイル以外の画像を表示するために開発されましたが、該当機能が''ref''プラグインに統合されたため、基本的に使用することはありません。過去との互換性のために残っています。 ''引数'' 画像URLには表示する画像のURLを指定します。 画像にはjpeg(jpg), gif, png のみ指定可能です。 right,r,left,l,clear,c で画像の表示位置とテキストの回りこみを指定します。省略時は left が指定されたとみなします。 -- right,r － 画像を右寄せで表示します。 -- left,l － 画像を右寄せで表示します。 -- clear,c － テキストの回りこみを解除します。内部的には right,r,left,l 以外は全てclearが選択されたと見なされます。 ''プラグイン内設定'' -- PLUGIN_IMG_CLEAR clear指定時に出力するタグ -- PLUGIN_IMG_USAGE 引数未指定時に表示されるヘルプ ** include [#n2b2fca6] ''種別'' ブロック型プラグイン ''重要度'' ★★★☆☆ ''書式'' #include( ページ名[,title|,notitle] ) ''概要'' 記述した位置に指定したページを挿入して、複数のページをあたかも１つのページであるかのように表示します。 ''引数'' ページ名には挿入するページを指定します。 第2引数にnotitleを指定すると、ページ名の表示を抑制します。titleはその逆です。 ''プラグイン内設定'' -- PLUGIN_INCLUDE_MAX 一度にインクルードできるページの最大数 -- PLUGIN_INCLUDE_WITH_TITLE title,notitle を未指定時に挿入時にページ名を表示するか・しないか -- PLUGIN_INCLUDE_USAGE 引数未指定時に表示されるヘルプ ** insert [#u8e89fa9] ''種別'' （コマンド） ブロック型プラグイン ''重要度'' ★☆☆☆☆ ''書式'' ''#insert'' ''概要'' 記述した位置に複数行入力欄とボタンを表示します。 ボタンを押下すると入力欄に入力した内容をページに挿入します。 ''プラグイン内設定'' -- INSERT_COLS 編集欄の表示幅 -- INSERT_ROWS 編集欄の表示行数 -- INSERT_INS 入力内容を入力欄の前後どちらに挿入するか ''備考'' ブラウザによっては、複数行入力欄の右下角に入力欄の大きさを変更することができる「つまみ」が表示されます。 「つまみ」が表示されるかどうか？はブラウザによって異なります。 ** interwiki [#f214b0c0] ''種別'' コマンド ''重要度'' ★☆☆☆☆ ''書式'' ''?cmd=interwiki'' &color(blue){&page=InterWiki名}; ''概要'' InterWikiを記述した際にPukiWikiが内部的に呼び出します。使用者が意識して使用する機会はありません。 ''引数'' InterWiki名にはジャンプ先をInterWiki形式で指定します。InterWiki名はエンコードされている必要があります。 *ツールチップ(tooltip) [#j4ac038c] &tooltip(単語){説明文}; と入力することでマウスをあわせるとツールチップを表示します。 利用例） Mercurialは分散型&tooltip(SCM){Source Code Management; バージョン管理システム};のひとつです。 と入力すると Mercurialは分散型&tooltip(SCM){Source Code Management; バージョン管理システム};のひとつです。 と表示します。 syo: * L [#f847b8e2] ** lastmod [#f55c3bcd] ''種別'' インライン型プラグイン ''重要度'' ★☆☆☆☆ ''書式'' ''&lastmod('' [&color(blue){ページ名};] '');'' ''概要'' 指定したページの最終更新日時を表示します。 ''引数'' ページ名には最終更新日時を表示したいページ名を指定します。 省略時は設置したページとみなします。 ** list [#gf6f8ba9] ''種別'' コマンド ''重要度'' ★★★★☆ ''書式'' ''?cmd=list'' ''概要'' ページの一覧を表示します。 //--- ** ls [#bbdede3b] ''種別'' ブロック型プラグイン ''重要度'' ★★☆☆☆ ''書式'' ''#ls('' [&color(blue){title};] '')'' ''概要'' 記述したページより階層化されているページのページ名を一覧表示します。 ''引数'' titleを指定した場合、ページ名に加えてタイトルを表示します。タイトルは各ページの一行目の内容を表示します。省略時はタイトルを表示しません。 ''備考'' 実際には、より高機能なls2を使用する機会が多いと思われます。 //--- ** ls2 [#c614720e] ''種別'' （コマンド） ブロック型プラグイン ''重要度'' ★★★☆☆ ''書式'' ''#ls2('' [[&color(blue){パターン};] [, { [&color(blue){title};], [&color(blue){include};], [&color(blue){reverse};], [&color(blue){compact};], [&color(blue){link};] } [,&color(blue){linkの別名表示};] ]] '')'' ''概要'' 指定したパターンで始まるページ名を一覧表示します。 ''引数'' パターンには表示するページ名の共通部分を指定します。省略時は"設置したページ名/"となります。 title,include,reverse,compact,link で表示方法を指定します。 -- title － ページに含まれる見出し(*,**,***)の一覧を併記します。 -- include － 下位層のページが#includeを使用していた場合、includeしているページの一覧を表示します。 -- reverse － ページの並び順を反転し、名前の降順に表示します。省略すると名前の昇順に表示されます。 -- compact － 見出しレベルを調整します。 -- link － #ls2を書いた位置に一覧を表示する代わりにリンクを表示します。このリンクを選択すると別画面にページの一覧を表示するようにします。 &br; linkの別名表示には、パラメータlinkを指定した際に表示される文字列の代わりの文字列を指定します。省略時は '' '...'で始まるページの一覧''となります。 ''プラグイン内設定'' -- PLUGIN_LS2_ANCHOR_PREFIX 見出しアンカーの書式 -- PLUGIN_LS2_ANCHOR_ORIGIN 見出しアンカーの開始番号 -- PLUGIN_LS2_LIST_COMPACT compactオプション省略時、見出しレベルを調整するか ''備考'' ls プラグインとの違いについて。 -- 階層化されたページの起点となるページが、lsでは記述したページ固定だが、ls2ではパラメータで指定できます。 -- titleパラメータを指定した場合に、lsでは「ページの一行目」が表示されるが、ls2では「見出しの一覧」を表示します。 -- include, link という表示オプションが追加されています。 -- ページ名のソートには[[natcasesort()>http://www.php.net/manual/ja/function.natcasesort.php]]を使っているため、昇順の場合、半角英数字よりも漢字の方が先に表示されます。 * M [#of4e90fd] ** map [#xc4ab2f0] ''種別'' コマンド ''重要度'' ★☆☆☆☆ ''書式'' ''?plugin=map'' [&color(blue){&refer=ページ名};] [&color(blue){&reverse=true};] ''概要'' サイトマップの様にページ間のリンク関係を一覧表示します。 指定したページを起点に、リンクで辿れるページを全てツリー状に表示します。 ''引数'' 引数には一覧表示方法のオプションを指定します。 -- &refer=ページ名 － 起点となるページを指定します。省略すると、サイトのトップページ(通常はFrontPage)が起点となります。 -- &reverse=true － どこへリンクしているかではなく、どこからリンクされているかを一覧表示します。 どこからもリンクされていないページは、画面の後半にまとめて表示されます。 ''プラグイン内設定'' -- PLUGIN_MAP_SHOW_HIDDEN 表示対象外のページをリストアップするかどうか ** memo [#a2a30e49] ''種別'' （コマンド） ブロック型プラグイン ''重要度'' ★☆☆☆☆ ''書式'' ''#memo'' ''概要'' 記述した位置に複数行入力欄とボタンを表示します。 ボタンを押下すると入力欄の記述内容を更新します。 ''プラグイン内設定'' -- MEMO_COLS 編集欄の表示桁数 -- MEMO_ROWS 編集欄の表示行数 ''備考'' insertプラグインやarticleプラグインと似ていますが、入力した内容が入力欄の外へ出力されず、入力欄に留まる点が異なります。 個人用のメモ代わりにPukiWikiを利用している場合、未整理の情報を一時的に溜め込むのに便利です。 ブラウザによっては、複数行入力欄の右下角に入力欄の大きさを変更することができる「つまみ」が表示されます。 「つまみ」が表示されるかどうか？はブラウザによって異なります。 ** menu [#j260481c] ''種別'' ブロック型プラグイン ''重要度'' ★★★★☆ ''書式'' ''#menu('' &color(blue){ページ名}; '')'' ''概要'' デフォルトのスキンにて、ページの左側にメニュー用のページ(MenuBar)を表示するために内部的に使用されています。 #br 任意のページでブロック型プラグインとして使用すると、引数に指定したページをメニュー用ページに指定できます。 例えば通常はMenuBarを表示するサイトで、hogeというページだけはMenuBarの代わりにhogeMenuというページを表示したい場合、 hogeというページに #menu(hogeMenu) と記述する事で実現できます。 #br ソース中の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 [#z763474a] ** navi [#ve849cd2] ''種別'' ブロック型プラグイン ''重要度'' ★★☆☆☆ ''書式'' ''#navi('' [&color(blue){目次ページ};] '')'' ''概要'' 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 [#nf4072c4] ''種別'' インライン型プラグイン ''重要度'' ★★☆☆☆ ''書式'' #br ''書式'''1:''''' ''&new('' [&color(blue){nodate};] ''){'' &color(blue){日付文字列}; ''};'' #br ''書式'''2:''''' ''&new('' [&color(blue){ページ名};] [,&color(blue){nolink};] '');'' ''概要'' 指定した日時が最近であった場合、最近更新された事を強調表示します。日時の指定は直接日付時刻を記述する方法(書式1)と、指定したページ（群）の最終更新日時を採用する方法(書式2)の２通りがあります。 標準では5日以内の場合に New を、１日以内の場合に New! を表示します。期間や表示する文字列のパターンは設置者によってカスタマイズ可能です。 ''引数'' ''書式'''1:''''' 日付文字列を指定した場合、その日時が規定の期間内であった場合に強調表示します。省略した場合はページの更新日時をチェックする記述であると見なされます。 -- nodate － 日付文字列を表示しません。省略時は表示します。 #br ''書式'''2:''''' ページ名を指定した場合は、そのページの更新日時が規定の期間内であった場合に強調表示します。省略した場合は、プラグインを記述したそのページを指定したと見なします。 ページ名末尾が/であった場合、そのページ名で始まるページ群の中で最後の更新日時が規定の日付以内であった場合に強調表示します。 -- nolink － ページ名を表示しません。省略時はページ名（ページ群で指定した場合は最後に更新されたページ名）を表示します。 ''プラグイン内設定'' -- PLUGIN_NEW_DATE_FORMAT 表示フォーマット ''備考'' 日付文字列は[[PHP関数:strtotime>http://jp2.php.net/manual/ja/function.strtotime.php]]が認識できる書式である必要があります。 ** newpage [#h98605cc] ''種別'' コマンド ブロック型プラグイン ''重要度'' ★★★★★ ''書式'' ''?plugin=newpage'' &color(blue){&page=ページ名}; &color(blue){&refer=関連ページ名}; ''#newpage('' [&color(blue){ページ名初期値};] '')'' ''概要'' ページを新規作成するか、新規作成するページ名の入力欄を表示します。 ''引数'' コマンド''':''' パラメータには新規作成するページのオプションを指定します。 #br ページ名には新規作成するページ名を指定します。省略時は新規作成するページ名の入力するためのページを表示します。ページ名はエンコードされている必要があります。 #br 関連ページ名にはリンク元のページ名を指定します。新規作成するページの先頭に、ここで指定したページへのリンクが自動的に埋め込まれます。ページ名はエンコードされている必要があります。 #br ブロック型プラグイン''':''' #br ページ名初期値には新規作成するページ名を入力する入力欄に初期表示する文字列を指定します。 ** norelated [#q4ad2049] ''種別'' ブロック型プラグイン ''重要度'' ★★★☆☆ ''書式'' ''#norelated'' ''概要'' ページ下部に表示される関連ページのリンクを非表示にします。 ''備考'' 極端に多くのページからリンクされていて関連リンクの表示が目障りである場合などに利用します。 * O [#aa15689b] ** online [#ud7f1974] ''種別'' ブロック型プラグイン インライン型プラグイン ''重要度'' ★★☆☆☆ ''書式'' ''#online'' ''&online;'' ''概要'' 現在PukiWikiを参照している、おおよそのユーザー数を表示します。 ユーザー数は、プラグインを呼び出された時点で記録されたＩＰアドレスとタイムスタンプのうち、５分以内(変更可能)にアクセスのあったアドレスの数です。 ''プラグイン内設定'' -- PLUGIN_ONLINE_TIMEOUT タイムアウトの秒数 -- PLUGIN_ONLINE_USER_LIST ユーザー情報を保存するファイル -- PLUGIN_ONLINE_LIST_REGEX ユーザー情報取得用の正規表現 ''備考'' ユーザー数のカウントはページ単位でなく、設置されたPukiWiki毎に行っているため、MenuBarなど頻繁に呼び出される場所に記述するかスキンに埋め込むのが普通です。 #paint() * setlinebreak [#f9a4bad3] ''種別'' ブロック型プラグイン ''重要度'' ★☆☆☆☆ ''書式'' ''#setlinebreak('' [&color(blue){on};|&color(blue){off};|&color(blue){default};] '')'' ''概要'' 入力文章中の改行を改行とみなすかどうかの設定を行います。 PukiWikiが入力文章中の改行をどのように扱うかはpukiwiki.ini内の$line_breakの設定内容によって変わります（下記参照）。 |BGCOLOR(#D0D6DF):入力文章|BGCOLOR(#D0D6DF):$line_break=0;|BGCOLOR(#D0D6DF):$line_break=1;| |BGCOLOR(#EFF4FF):|BGCOLOR(#EFF4FF):|BGCOLOR(#EFF4FF):|c |文章１&br;文章２|文章１文章２|文章１&br;文章２| setlinebreakプラグインは該当ページの以降の行に関して、 $line_breakの設定に因らず改行をどのように扱うかを指定できるようになります。 ''引数'' パラメータには以降の改行の扱いを指定します。 パラメータが省略された場合、改行とみなすかどうかについての設定を逆転させます。 --on － 以降の文章で段落内の改行を改行とみなします($line_break=1と同様)。 --off － 以降の文章で改行を無視します($line_break=0と同様)。 改行を行うためには行末にチルダを記述するか、 行中で&color(blue){brプラグイン};を使用する必要があります。 --default － 改行の扱いをそのサイトの$line_break設定に戻します。 * topicpath [#u38e5eac] ''種別'' インライン型プラグイン ブロック型プラグイン ''重要度'' ★☆☆☆☆ ''書式'' &topicpath; #topicpath ''概要'' パンくずリスト(topicpath)と呼ばれる、ページの階層表現のユーザーインターフェースを提供するプラグイン。 パンくずリスト（Topic path）は現在参照しているウェブページの階層を表現するユーザーインターフェースです。例えば&color(blue){PukiWiki/ツアー};というページに#topicpathと書くと、以下の様な表記に置き換わります。 [[Top>FrontPage]]/[[PukiWiki>PukiWiki]]/[[ツアー>PukiWiki/ツアー]] 基本的には以下の２通りの使い方を想定しています。 i.「ほげ/ふが/げほ」など、２～３階層以上の深いページでページの行き来をしやすくするために表示する ii.スキンに組み込み、ページタイトル下のURLの代わりに全てのページで表示する ''プラグイン内設定'' -- PLUGIN_TOPICPATH_TOP_DISPLAY defaultpageを一番最初に表示するかどうか。 -- PLUGIN_TOPICPATH_TOP_LABEL $defaultpageに対するラベル -- PLUGIN_TOPICPATH_TOP_SEPARATOR 階層を区切るセパレータ -- PLUGIN_TOPICPATH_THIS_PAGE_DISPLAY 現在表示中のページに対するリンクを表示するかどうか -- PLUGIN_TOPICPATH_THIS_PAGE_LINK 現在表示中のページに対してリンクするかどうか ''備考'' スキンに組み込む場合は、pukiwiki.skin.php の SKIN_DEFAULT_DISABLE_TOPICPATH に 0を指定して下さい。 |
