sWiki マニュアル2 Wiki
[
ホーム
|
リロード
|
新規
]
サイト内検索
:
[
差分チェッカー
]
[
アップローダー
]
【楽天スーパーDEAL】毎日更新・最大50%ポイントバック!!(広告)
Tweet
未分類プラグイン
をテンプレートにして作成
開始行:
#contents
* プラグインマニュアル [#g4919d30]
** プラグインマニュアルの凡例 [#jce09f74]
プラグインマニュアルは以下の形式で記述されています。
''プラグイン名''
''種別''
プラグインがどのような方法で呼び出しを行えるかを示し...
-- コマンド - コマンド形式の呼び出しが可能であることを示...
-- ブロック型プラグイン - ブロック型プラグインでの呼び出...
-- インライン型プラグイン - インライン型プラグインでの呼...
-- 擬似ブロック型プラグイン - PukiWiki本体で実現されてい...
''重要度''
そのプラグインの一般的な利用頻度や有用性の目安を示し...
''書式''
プラグインでの引数指定方法です。引数の指定方法の表現...
-- [] - 省略可能で必要に応じて記述する箇所です。
-- | - |で区切られた複数の項目のうち、指定できるのは1つ...
-- {} - 中カッコ内のみ引数の指定順序が任意である事を示し...
''概要''
そのプラグインの機能概要です。
''引数''
引数の詳細な説明です。
''プラグイン内設定''
プラグインのソース中で定義されている定数の一覧です。...
''備考''
プラグインに関する参考情報です。
//--- --- --- ---
* A [#a_]
** add 実行すると編集画面が表示されます。更新ボタンを押...
''種別''
コマンド
''重要度''
★☆☆☆☆
''書式''
''?cmd=add'' &color(blue){&page=ページ名};
''概要''
実行すると編集画面が表示されます。更新ボタンを押すと...
''引数''
ページ名は省略できません。ページ名はエンコードされて...
#br
[[edit>未分類プラグイン#edit]]が編集画面に既存のペー...
変更する事がないため、単純に追記していくだけのページ...
#br
''備考''
もともとデフォルトのskinでメニューの「追加」として使...
** aname 指定した位置にアンカー(リンクの飛び先)を設定し...
''種別''
インライン型プラグイン
ブロック型プラグイン
#br
''重要度''
★★★★☆
#br
''書式''
''&aname('' &color(blue){アンカー名}; [,{[&color(...
#br
''#aname('' &color(blue){アンカー名}; [,{[&color(blue...
#br
''概要''
指定した位置にアンカー(リンクの飛び先)を設定します。
#br
''引数''
アンカー名の値がアンカーのフラグメント指定子に使用さ...
アンカー名には半角英字(大文字/小文字)が使用可能で...
#br
super,full,noid でアンカーの出力方式を指定します。
#br
-- &color(blue){super}; - アンカー文字列を上付き表示しま...
-- &color(blue){full}; - フラグメント指定子以外のURIを補...
--&color(blue){noid}; - アンカーにフラグメント指定子を出...
&br;
&color(blue){アンカー文字列};が指定された場合、指定し...
利用者に明示したい場合に利用します。省略時は空文字に...
#br
''プラグイン内設定''
#br
-- PLUGIN_ANAME_ID_MAX アンカー名に指定可能な文字列長の...
-- PLUGIN_ANAME_ID_REGEX アンカー名に指定可能な文字列の...
-- PLUGIN_ANAME_ID_MUST_UNIQUE 重複したアンカー名を利用...
&br;
''備考''
通常はインライン型プラグインとして使用します。2つのブ...
インラインプラグインとして記述できないため、ブロック...
#br
PukiWiki本体処理でanameプラグインを内部的に呼び出して...
** article 指定した位置に簡易掲示板を設置します。 [#arti...
''種別''
(コマンド)
ブロック型プラグイン
#br
''重要度''
★★★☆☆
#br
''書式''
''#article''
#br
''概要''
指定した位置に簡易掲示板を設置します。
#br
''プラグイン内設定''
#br
-- PLUGIN_ARTICLE_COLS テキストエリアのカラム数
-- PLUGIN_ARTICLE_ROWS テキストエリアの行数
-- PLUGIN_ARTICLE_NAME_COLS 名前テキストエリアのカラム数
-- PLUGIN_ARTICLE_SUBJECT_COLS 題名テキストエリアのカラ...
-- PLUGIN_ARTICLE_NAME_FORMAT 名前の挿入フォーマット
-- PLUGIN_ARTICLE_SUBJECT_FORMAT 題名の挿入フォーマット
-- PLUGIN_ARTICLE_INS 入力内容を入力欄の前後どちらに挿入...
-- PLUGIN_ARTICLE_COMMENT 書き込みの下に一行コメントを入...
-- PLUGIN_ARTICLE_AUTO_BR 改行を自動的変換するか
-- PLUGIN_ARTICLE_MAIL_AUTO_SEND 投稿内容のメール自動配...
-- PLUGIN_ARTICLE_MAIL_FROM 投稿内容のメール送信時の送信...
-- PLUGIN_ARTICLE_MAIL_SUBJECT_PREFIX 投稿内容のメール送...
-- $_plugin_article_mailto 投稿内容のメール自動配信先ア...
** attach ページの添付ファイルの一覧を表示し、ファイル添...
''種別''
(コマンド)
ブロック型プラグイン
''重要度''
★★★★★
#br
''書式''
''#attach('' [&color(blue){nolist};] [,&color(blue){n...
#br
''概要''
ページの添付ファイルの一覧を表示し、ファイル添付のた...
#br
''引数''
nolist, noform で表示内容を指定します。
#br
-- nolist - ページの添付ファイルの一覧を表示しません。省...
-- noform - ファイル添付のための入力フォームを表示しませ...
&br;
''プラグイン内設定''
#br
-- PLUGIN_ATTACH_MAX_FILESIZE ファイルアップロードの上限
-- PLUGIN_ATTACH_UPLOAD_ADMIN_ONLY 管理者だけが添付ファ...
-- PLUGIN_ATTACH_DELETE_ADMIN_ONLY 管理者だけが添付ファ...
-- PLUGIN_ATTACH_DELETE_ADMIN_NOBACKUP PLUGIN_ATTACH_DEL...
-- PLUGIN_ATTACH_PASSWORD_REQUIRE アップロード/削除時に...
-- PLUGIN_ATTACH_FILE_MODE アップロードされたファイルの...
-- PLUGIN_ATTACH_FILE_ICON アイコンイメージのファイル
-- PLUGIN_ATTACH_CONFIG_PAGE_MIME ダウンロード時のmime-t...
&br;
''備考''
デフォルトのskinのメニューの「添付」で呼び出されてい...
#br
プラグイン内設定の PLUGIN_ATTACH_MAX_FILESIZE を増や...
LimitRequestBodyなどPukiWiki以外での上限設定がある事...
#hr
//---
* B [#b_]
** back 指定した位置に戻り先へのリンクを設置します。 [#b...
''種別''
ブロック型プラグイン
#br
''重要度''
★☆☆☆☆
#br
''書式''
''#back('' [[&color(blue){表示文字列};] [,[&color(blu...
#br
''概要''
指定した位置に戻り先へのリンクを設置します。
#br
''引数''
表示文字列は省略すると「戻る」になります。
#br
left、center、rightで表示位置を指定します。省略時はce...
#br
-- left - リンクを左寄せで表示します。
-- center - リンクを中央寄せで表示します。
-- right - リンクを右寄せで表示します。
&br;
0、1で水平線の有無を指定します。省略すると1になります。
#br
-- 0 - 水平線を表示しません。
-- 1 - 水平線を表示します。
#br
&br;
戻り先はリンクを選択時の移動先となるURL、ページ名のい...
ページ名は「ページ名#anchor」の記述を行う事で移動先の...
PLUGIN_BACK_ALLOW_JAVASCRIPTがTRUEの場合のみ戻り先の...
戻り先を省略すると直前に参照していたページが戻り先に...
#br
''プラグイン内設定''
#br
-- PLUGIN_BACK_ALLOW_PAGELINK ページ名(+アンカー名)によ...
-- PLUGIN_BACK_ALLOW_JAVASCRIPT 戻り先の指定にJavaScript...
-- PLUGIN_BACK_USAGE エラー時に表示される使用方法
** backup 指定したページ、あるいは全体のバックアップ一覧...
''種別''
コマンド
#br
''重要度''
★★★★★
#br
''書式''
''?cmd=backup'' [&color(blue){&page=ページ名};]
#br
''概要''
#br
指定したページ、あるいは全体のバックアップ一覧を表示...
''引数''
ページ名を省略すると、PukiWiki全体のバックアップ一覧...
#br
''プラグイン内設定''
#br
-- PLUGIN_BACKUP_DISABLE_BACKUP_RENDERING バックアップデ...
** br 文章中で改行を行います。 [#br]
''種別''
ブロック型プラグイン
インライン型プラグイン
#br
''重要度''
★★☆☆☆
#br
''書式''
''#br''
#br
''&br;''
#br
''概要''
文章中で改行を行います。
#br
段落やリスト、テーブル内など、行末の~による改行ではブ...
#br
''プラグイン内設定''
#br
-- PLUGIN_BR_ESCAPE_BLOCKQUOTE 引用文中で利用した場合の...
-- PLUGIN_BR_TAG brプラグインが出力するタグ
** bugtrack [#bugtrack]
''種別''
(コマンド)
#br
ブロック型プラグイン
#br
''重要度''
★☆☆☆☆ (一般サイト)
#br
★★★★☆ (ソフト開発サイト)
''書式''
''#bugtrack('' [[&color(blue){ページ名};] [,&color(bl...
''概要''
バグ追跡システムの一部分であるバグレポートの入力フォ...
#br
''引数''
ページ名にはバグレポートとして作成されるページの親階...
通常、バグレポートには指定したページ名の子階層に自動...
#br
カテゴリーにはバグの対象となりうる要素を指定します。...
#br
''プラグイン内設定''
#br
-- PLUGIN_BUGTRACK_NUMBER_FORMAT バグレポートとして作成...
&br;
''備考''
ソフト開発サイトで重宝するプラグインです。もしバグ追...
** bugtrack_list [#bugtrack_list]
''種別''
ブロック型プラグイン
#br
''重要度''
★☆☆☆☆ (一般サイト)
#br
★★★★☆ (ソフト開発サイト)
#br
''書式''
''#bugtrack_list('' [&color(blue){ページ名};] '')''
''概要''
バグ追跡システムの一部分であるバグレポートの一覧表示...
#br
''引数''
ページ名にはバグレポートとして作成されるページの親階...
#br
''備考''
通常はbugtrackプラグインと並べて使用します。
#br
bugtrack_listプラグインの中からbugtrackプラグインを呼...
#br
bugtrack_listプラグインは、[[tracker_list>未分類プラ...
#hr
* C [#c_]
** calendar、calendar_edit、calendar_read [#calendar]
''種別''
ブロック型プラグイン
#br
''重要度''
★☆☆☆☆
#br
''書式''
''#calendar('' [{[&color(blue){ページ名};], [&color(b...
''#calendar_edit('' [{[&color(blue){ページ名};], [&co...
''#calendar_read('' [{[&color(blue){ページ名};], [&co...
#br
''概要''
指定した位置にカレンダーを設置します。カレンダー上でy...
#br
カレンダーの日付を選択した場合に該当するページを編集...
calendar_editとは編集状態で、calendar, calendar_read...
#br
''引数''
ページ名は編集/参照するカレンダーのページの上位ページ...
#br
年月は表示するカレンダーの西暦と月をyyyymmの形式で指...
''備考''
より高機能なcalendar2プラグインがあるため、あえてcale...
#br
calendar_editプラグイン及びcalendar_readプラグインの...
//---
** calendar_viewer [#calendar_viewer]
''種別''
(コマンド)
ブロック型プラグイン
#br
''重要度''
★★★☆☆
#br
''書式''
''#calendar_viewer('' &color(blue){ページ名};, &color...
#br
''概要''
calendarプラグインまたはcalendar2プラグインで作成され...
#br
''引数''
ページ名はcalendarプラグインまたはcalendar2プラグイン...
#br
yyyy-mmを指定時、指定した年月のページを表示します。
#br
数字を指定時、指定した件数分のページを表示します。
#br
x*yを指定時、先頭より数えて x ページ目(先頭は0)から、...
#br
thisを指定時、今月のページを一覧表示します。
#br
past、future、viewで表示するページの条件を指定します...
#br
-- past - 今日以前のページを表示します。
-- future - 今日以降のページを表示します。
-- view - 過去から未来へ一覧表示します。
&br;
年月日の区切り文字は-や/などを指定します。省略した場...
#br
''プラグイン内設定''
#br
-- PLUGIN_CALENDAR_VIEWER_USAGE エラー時に表示される使用...
-- PLUGIN_CALENDAR_VIEWER_DATE_FORMAT 日付の表示形式
&br;
''備考''
calendar2プラグインでは今日の日付の記事がない場合、記...
calendar_viewerはその弱点を補うために開発されたプラグ...
最新の記事を表示することができます。カレンダーそのも...
//---
** calendar2 [#calendar2]
''種別''
(コマンド)
ブロック型プラグイン
#br
''重要度''
★★★☆☆
#br
''書式''
''#calendar2('' [{[&color(blue){ページ名};|&color(blu...
#br
''概要''
指定した位置にカレンダーを設置します。表示月のとなりに表...
#br
''引数''
ページ名で表示するページの上位階層のページを指定でき...
#br
yyyymmで表示するカレンダーの西暦と月を指定できます。...
#br
offを指定時、当日分ページを表示する機能は抑制されます...
#br
''備考''
calender_editで作成したページはページ名/yyyymmddとな...
//---
** clear refプラグインのaroundオプションで有効となったテ...
''種別''
ブロック型プラグイン
#br
''重要度''
★☆☆☆☆
#br
''書式''
''#clear''
#br
''概要''
refプラグインのaroundオプションで有効となったテキスト...
#br
''備考''
imgプラグインのclearオプション指定時と処理内容は同等...
** color 引数で指定したインライン要素(主に文章)の、文字...
''種別''
インライン型プラグイン
#br
''重要度''
★★★★☆
#br
''書式''
''&color('' [&color(blue){文字色};] [,&color(blue...
#br
''概要''
引数で指定したインライン要素(主に文章)の、文字色・背...
#br
''引数''
文字色・背景色はそれぞれ色名(red、blueなど)、シャープ...
#br
文字色・背景色の両方を省略する事はできません。一方を...
#br
''プラグイン内設定''
#br
-- PLUGIN_COLOR_ALLOW_CSS 色の変更に(fontタグではなく)CS...
-- PLUGIN_COLOR_USAGE エラー時に表示される使用方法
-- PLUGIN_COLOR_REGEX 引数に指定できる色の正規表現
&br;
''備考''
以下、[[W3C勧告書>http://www.w3.org/TR/1999/REC-html4...
** comment コメントの入力用の入力欄を表示します。 [#comm...
''種別''
(コマンド)
ブロック型プラグイン
#br
''重要度''
★★★★★
#br
''書式''
''#comment('' {[&color(blue){above};], [&color(blue){...
#br
''概要''
コメントの入力用の入力欄を表示します。
#br
''引数''
コメントの挿入方法を引数で指定します。
#br
-- above - 入力したコメントがコメント入力欄の上に追加し...
-- below - 入力したコメントがコメント入力欄の下に追加し...
-- nodate - 挿入するコメントに、挿入時刻を付加しない(省...
-- noname - コメント記入者名の入力欄を非表示とします(省...
&br;
''プラグイン内設定''
#br
-- PLUGIN_COMMENT_DIRECTION_DEFAULT コメントを入力欄の前...
-- PLUGIN_COMMENT_SIZE_MSG コメントのテキストエリアの表...
-- PLUGIN_COMMENT_SIZE_NAME コメントの名前テキストエリア...
-- PLUGIN_COMMENT_FORMAT_MSG コメント欄の挿入フォーマット
-- PLUGIN_COMMENT_FORMAT_NAME 名前欄の挿入フォーマット
-- PLUGIN_COMMENT_FORMAT_NOW 時刻欄の挿入フォーマット
-- PLUGIN_COMMENT_FORMAT_STRING コメント内容全体の挿入フ...
//---
** contents 設置したページ中の見出しの一覧を表示します。 ...
''種別''
擬似ブロック型プラグイン
#br
''重要度''
★★★☆☆
#br
''書式''
''#contents''
#br
''概要''
設置したページ中の見出しの一覧を表示します。
//---
** counter 設置したページの参照回数を表示します。 [#coun...
''種別''
ブロック型プラグイン
#br
インライン型プラグイン
#br
''重要度''
★★★☆☆
''書式''
''#counter''
#br
''&counter('' [&color(blue){total};| &color(blue)...
#br
''概要''
設置したページの参照回数を表示します。
#br
''引数''
カウンタ表示方法として total, today, yesterday いずれ...
#br
-- total - そのページが参照された回数の総計を表示します。
-- today - そのページが参照された回数(当日分)を表示し...
-- yesterday - そのページが参照された回数(昨日分)を表...
&br;
''プラグイン内設定''
#br
-- PLUGIN_COUNTER_SUFFIX ページ参照回数を保持するデータ...
&br;
''備考''
すべてのページで参照回数を表示したい場合は、MenuBarや...
#hr
* D [#d_]
** deleted 削除されたページの一覧を表示します。 [#deleted]
''種別''
コマンド
#br
''重要度''
★★☆☆☆
#br
''書式''
''?plugin=deleted'' {[&color(blue){&dir=diff};| &colo...
#br
''概要''
削除されたページの一覧を表示します。
#br
''引数''
file=onを指定時、バックアップ(あるいは差分)のファイ...
#br
dirで削除の判定方法を指定します。省略時はbackupです。
#br
-- backup - バックアップが存在し、ページが存在しない時に...
''?plugin=deleted&dir=backup''
-- diff - 差分が存在し、ページが存在しない時に削除された...
''?plugin=deleted&dir=diff''
&br;
''備考''
公開Wikiの管理者にとっては誤操作や悪意をもった編集に...
//---
** diff 指定したページの現在の内容と最後のバックアップ状...
''種別''
コマンド
#br
''重要度''
★★★★★
#br
''書式''
''?cmd=diff'' &color(blue){&page=ページ名};
#br
''概要''
指定したページの現在の内容と最後のバックアップ状態と...
#br
''引数''
ページ名に変更差分を表示するページを指定します。ペー...
#br
''備考''
最後のバックアップ以外との差分を表示する場合は[[backu...
** dump 指定ディレクトリ内のファイルをまとめてtar(tar.gz...
''種別''
コマンド
#br
''重要度''
★☆☆☆☆
#br
''書式''
''?plugin=dump''
#br
''概要''
指定ディレクトリ内のファイルをまとめてtar(tar.gz, tgz...
バックアップ/リストアの実行には管理者パスワードが必要...
バックアップはファイル名をページ名に変換して取得する...
バックアップは取得するディレクトリを任意に指定する事...
リストアは該当ファイルの上書きによって行われます。 そ...
バックアップ/リストア対象として指定可能なディレクトリ...
#br
-- DATA_DIR (wiki/*.txt)
-- UPLOAD_DIR (attach/*)
-- BACKUP_DIR (backup/*)
&br;
''プラグイン内設定''
&br;
-- PLUGIN_DUMP_ALLOW_RESTORE リストアを許可するかどうか
-- PLUGIN_DUMP_FILENAME_ENCORDING ページ名をディレクトリ...
-- PLUGIN_DUMP_MAX_FILESIZE 最大アップロードサイズ(Kbyte)
-- PLUGIN_DUMP_DUMP バックアップ時にプラグイン内で利用す...
-- PLUGIN_DUMP_RESTORE リストア時にプラグイン内で利用す...
&br;
''備考''
PukiWikiが内部管理するファイルを直接取得/更新するとい...
#br
DATA_DIRのリストアを行った場合は、[[links>未分類プラ...
* E [#e_]
** edit 指定したページを編集します。 [#edit]
''種別''
コマンド
インライン型プラグイン
''重要度''
★★★★★
''書式''
''?cmd=edit'' &color(blue){&page=ページ名};
''&edit('' [&color(blue){ページ名}; {[,&color(blu...
''概要''
指定したページを編集します。
''引数''
コマンド型の記述では、ページ名に編集するページを指定...
インライン型の記述では、ページ名は編集するページを指...
nolabel,noicon,ラベル名 でリンクの表示方法を指定しま...
-- nolabel - 編集用リンクの文字列をnoicon 指定時は短縮表...
-- noicon - 編集用リンクに画像を表示しません。
-- ラベル名 - 編集用リンクの文字列として表示する文字列を...
''プラグイン内設定''
-- PLUGIN_EDIT_FREEZE_REGEX freezeプラグインを介さず、直...
*F [#f_]
** filelist ページの一覧を各ページが記録されているファイ...
''種別''
コマンド
''重要度''
★☆☆☆☆
''書式''
''?cmd=filelist''
''概要''
ページの一覧を各ページが記録されているファイル名と共...
''備考''
主として管理者がメンテナンス用途に使用します。
※表示するには管理者のパスワードが必要です。
** freeze 対象のページを凍結し、不用意に変更できないよう...
''種別''
コマンド
(ブロック型プラグイン)
''重要度''
★★★☆☆
''書式''
''?cmd=freeze'' &color(blue){&page=ページ名};
''#freeze''
''概要''
対象のページを凍結し、不用意に変更できないようにしま...
''引数''
ページ名には凍結するページを指定します。ページ名はエ...
ブロック型のfreezeプラグインはPukiWikiが内部的に利用...
''備考''
※実行の際に管理者パスワードを要求されます。
* H [#h_]
** hr 文中に水平線を挿入します。 [#hr]
''種別''
ブロック型プラグイン
''重要度''
★★☆☆☆
''書式''
''#hr''
''概要''
文中に水平線を挿入します。
''備考''
段落やリスト、テーブル内など、通常の水平線書式(----)...
* I [#i_]
** img 添付ファイル以外の画像を表示するために開発されま...
''種別''
ブロック型プラグイン
''重要度''
★☆☆☆☆
''書式''
''#img('' &color(blue){画像URL};[, &color(blue){right...
''概要''
添付ファイル以外の画像を表示するために開発されました...
''引数''
画像URLには表示する画像のURLを指定します。 画像にはjp...
right,r,left,l,clear,c で画像の表示位置とテキストの回...
-- right,r - 画像を右寄せで表示します。
-- left,l - 画像を右寄せで表示します。
-- clear,c - テキストの回りこみを解除します。内部的には ...
''プラグイン内設定''
-- PLUGIN_IMG_CLEAR clear指定時に出力するタグ
-- PLUGIN_IMG_USAGE 引数未指定時に表示されるヘルプ
** include 記述した位置に指定したページを挿入して、複数...
''種別''
ブロック型プラグイン
''重要度''
★★★☆☆
''書式''
#include( ページ名[,title|,notitle] )
''概要''
記述した位置に指定したページを挿入して、複数のページ...
''引数''
ページ名には挿入するページを指定します。
第2引数にnotitleを指定すると、ページ名の表示を抑制し...
''プラグイン内設定''
-- PLUGIN_INCLUDE_MAX 一度にインクルードできるページの最...
-- PLUGIN_INCLUDE_WITH_TITLE title,notitle を未指定時に...
-- PLUGIN_INCLUDE_USAGE 引数未指定時に表示されるヘルプ
** includesubmenu 現在表示中のページによって、MenuBarに...
''種別''
ブロック型プラグイン
#br
''重要度''
★★☆☆☆
#br
''書式''
''#includesubmenu('' [&color(blue){showpagename};] )
#br
''概要''
現在表示中のページによって、MenuBarに表示する内容を切...
#br
表示中のページの下階層のSubMenuか、同階層にあるSubMen...
#br
''引数''
showpagename を指定すると、挿入表示するページのページ...
//---
** insert 記述した位置に複数行入力欄とボタンを表示します...
''種別''
(コマンド)
ブロック型プラグイン
''重要度''
★☆☆☆☆
''書式''
''#insert''
''概要''
記述した位置に複数行入力欄とボタンを表示します。
ボタンを押下すると入力欄に入力した内容をページに挿入...
''プラグイン内設定''
-- INSERT_COLS 編集欄の表示幅
-- INSERT_ROWS 編集欄の表示行数
-- INSERT_INS 入力内容を入力欄の前後どちらに挿入するか
''備考''
ブラウザによっては、複数行入力欄の右下角に入力欄の大...
「つまみ」が表示されるかどうか?はブラウザによって異...
** interwiki [#interwiki]
''種別''
コマンド
''重要度''
★☆☆☆☆
''書式''
''?cmd=interwiki'' &color(blue){&page=InterWiki名};
''概要''
InterWikiを記述した際にPukiWikiが内部的に呼び出します...
''引数''
InterWiki名にはジャンプ先をInterWiki形式で指定します...
* L [#l_]
** lastmod 指定したページの最終更新日時を表示します。 [#...
''種別''
インライン型プラグイン
''重要度''
★☆☆☆☆
''書式''
''&lastmod('' [&color(blue){ページ名};] '');''
''概要''
指定したページの最終更新日時を表示します。
''引数''
ページ名には最終更新日時を表示したいページ名を指定し...
** links [#links]
''種別''
コマンド
#br
''重要度''
★★☆☆☆(管理者)
#br
''書式''
''?plugin=links''
''概要''
ページ間のキャッシュを更新します。通常使用する必要は...
#br
メンテナンス作業などでページが記録されているファイル...
#br
''備考''
実行の際に管理者パスワードを要求されます。
//---
** list ページの一覧を表示します。 [#list]
''種別''
コマンド
''重要度''
★★★★☆
''書式''
''?cmd=list''
''概要''
ページの一覧を表示します。
//---
** lookup [#lookup]
''種別''
(コマンド)
#br
ブロック型プラグイン
#br
''重要度''
★★★☆☆
#br
''書式''
''#lookup('' &color(blue){interwikiname}; [,&color(bl...
''概要''
記述した位置にテキスト入力欄とボタンを表示します。任...
#br
URLの生成にはInterWikiを利用します。このプラグインが...
#br
[[interwikiname:入力欄の値]]
入力欄が空欄(空文字列)のときは、ボタンを押しても動作...
#br
''引数''
interwikiname: InterWikiNameに設定した値の一つを指定...
#br
ボタン名: ボタンに表示するキャプションを指定します。...
#br
入力欄の初期値: 初期値を指定したい場合に記入します。...
#br
''プラグイン内設定''
#br
-- PLUGIN_LOOKUP_USAGE 引数未指定時に表示されるヘルプ
//---
** ls 記述したページより階層化されているページのページ名...
''種別''
ブロック型プラグイン
''重要度''
★★☆☆☆
''書式''
''#ls('' [&color(blue){title};] '')''
''概要''
記述したページより階層化されているページのページ名を...
''引数''
titleを指定した場合、ページ名に加えてタイトルを表示し...
''備考''
実際には、より高機能なls2を使用する機会が多いと思われ...
//---
** ls2 指定したパターンで始まるページ名を一覧表示します...
''種別''
(コマンド)
ブロック型プラグイン
''重要度''
★★★☆☆
''書式''
''#ls2('' [[&color(blue){パターン};] [, { [&color(blu...
''概要''
指定したパターンで始まるページ名を一覧表示します。
''引数''
パターンには表示するページ名の共通部分を指定します。...
title,include,reverse,compact,link で表示方法を指定し...
-- title - ページに含まれる見出し(*,**,***)の一覧を併記...
-- include - 下位層のページが#includeを使用していた場合...
-- reverse - ページの並び順を反転し、名前の降順に表示し...
-- compact - 見出しレベルを調整します。
-- link - #ls2を書いた位置に一覧を表示する代わりにリンク...
&br;
linkの別名表示には、パラメータlinkを指定した際に表示...
''プラグイン内設定''
-- PLUGIN_LS2_ANCHOR_PREFIX 見出しアンカーの書式
-- PLUGIN_LS2_ANCHOR_ORIGIN 見出しアンカーの開始番号
-- PLUGIN_LS2_LIST_COMPACT compactオプション省略時、見出...
''備考''
ls プラグインとの違いについて。
-- 階層化されたページの起点となるページが、lsでは記述した...
-- titleパラメータを指定した場合に、lsでは「ページの一行...
-- include, link という表示オプションが追加されています。
-- ページ名のソートには[[natcasesort()>http://www.php.net...
#hr
//---
* M [#m_]
** marquee 流れる文字を表示します。表示するブラウザによっ...
http://wikiwiki.jp/sample/?%CE%AE%A4%EC%A4%EB%CA%B8%BB%FA
|650|c
| ''Contents''|
|#contents|
*マニュアル [#zce17f93]
#marquee(文字列,behavior,loop,背景色,文字色,文字サイズ);
marqueeを表示します。表示するブラウザによっては正しく表示...
*使用例 [#ce5f5be4]
【書式】
#marquee(スクロール表示);
【表示】
#marquee(スクロール表示);
【書式】
#marquee(端にぶつかると停止(slide),slide);
【表示】
#marquee(端にぶつかると停止(slide),slide);
【書式】
#marquee(端から端までを往復(alternate),alternate);
【表示】
#marquee(端から端までを往復(alternate),alternate);
【書式】
#marquee(ループ5回,,5);
【表示】
#marquee(ループ5回,,5);
【書式】
#marquee(ループ5回+文字色変更,,5,,red);
【表示】
#marquee(ループ5回+文字色変更,,5,,red);
【書式】
#marquee(ループ5回+背景色変更,,5,pink);
【表示】
#marquee(ループ5回+背景色変更,,5,pink);
【書式】
#marquee(文字サイズ20px,,,black,#aaffaa,20);
【表示】
#marquee(文字サイズ20px,,,black,#aaffaa,20);
*関連リンク [#ie87edaa]
-[[自作プラグイン/marquee.inc.php - PukiWiki-official>puk...
-[[自作プラグイン/marquee.inc.php - teanan.homeip.net:htt...
** map サイトマップの様にページ間のリンク関係を一覧表示...
''種別''
コマンド
''重要度''
★☆☆☆☆
''書式''
''?plugin=map'' [&color(blue){&refer=ページ名};] [&co...
''概要''
サイトマップの様にページ間のリンク関係を一覧表示しま...
指定したページを起点に、リンクで辿れるページを全てツ...
''引数''
引数には一覧表示方法のオプションを指定します。
-- &refer=ページ名 - 起点となるページを指定します。省略...
-- &reverse=true - どこへリンクしているかではなく、どこ...
''プラグイン内設定''
-- PLUGIN_MAP_SHOW_HIDDEN 表示対象外のページをリストアッ...
** md5 [#md5]
''種別''
コマンド
#br
''重要度''
★☆☆☆☆
#br
''書式''
''?plugin=md5'' &color(blue){&md5=文字列};
#br
''概要''
選択したパスワードの形式に応じて、pukiwiki.ini.php に...
#br
パスワードのフォーマットは以下の8種類の中から選択でき...
#br
''備考''
PukiWiki内で利用するパスワードは、パスワード文字列そ...
これは悪意ある者にpukiwiki.ini.phpの中身を覗き見られ...
#br
SHA-1 アルゴリズムを利用するためには、PHP 4.3.0 以降...
#br
プラグイン名に反してMD5以外のパスワードフォーマットも...
#br
md5のプラグインを呼び出すURLの中にパスワードを含める...
#br
このプラグインは PKWK_SAFE_MODE ないし PKWK_READONLY の設...
//---
** memo 記述した位置に複数行入力欄とボタンを表示します。...
''種別''
(コマンド)
ブロック型プラグイン
''重要度''
★☆☆☆☆
''書式''
''#memo''
''概要''
記述した位置に複数行入力欄とボタンを表示します。
ボタンを押下すると入力欄の記述内容を更新します。
''プラグイン内設定''
-- MEMO_COLS 編集欄の表示桁数
-- MEMO_ROWS 編集欄の表示行数
''備考''
[[insert>未分類プラグイン#insert]]プラグインや[[artic...
個人用のメモ代わりにPukiWikiを利用している場合、未整...
#br
ブラウザによっては、複数行入力欄の右下角に入力欄の大...
「つまみ」が表示されるかどうか?はブラウザによって異...
** menu 任意のページでブロック型プラグインとして使用する...
''種別''
ブロック型プラグイン
''重要度''
★★★★☆
''書式''
''#menu('' &color(blue){ページ名}; '')''
''概要''
デフォルトのスキンにて、ページの左側にメニュー用のペ...
#br
任意のページでブロック型プラグインとして使用すると、...
例えば通常はMenuBarを表示するサイトで、hogeというペー...
hogeというページに #menu(hogeMenu) と記述する事で実現...
#br
ソース中のMENU_ENABLE_SUBMENU をTRUEとすると、表示中...
メニューとして表示するようになります。
例えば FrontPage, MenuBar, hoge, fuga, hoge/MenuBar, ...
FrontPage、fuga、MenuBar では MenuBar がメニューとし...
hoge/MenuBar がメニューとして表示されます。
''引数''
メニュー用ページとして表示するページ名を指定します。
''プラグイン内設定''
-- MENU_ENABLE_SUBMENU サブメニューを使用するか
-- MENU_SUBMENUBAR サブメニューを使用する場合にメニュー...
''備考''
デフォルトのメニュー用ページをMenuBar以外のページとす...
#hr
* N [#n_]
** navi DocBook風ナビゲーションバーを表示します。 [#navi]
''種別''
ブロック型プラグイン
''重要度''
★★☆☆☆
''書式''
''#navi('' [&color(blue){目次ページ};] '')''
''概要''
DocBook風ナビゲーションバーを表示します。
目次となるページに下階層のページが存在する時、それら...
''引数''
目次ページに順番に見て回るページの上階層にあたるペー...
例えば hoge, hoge/1, hoge/2, hoge/3 というページが存...
ページで最初に呼び出した場合はヘッダイメージのリンク...
''プラグイン内設定''
-- PLUGIN_NAVI_EXCLUSIVE_REGEX 除外するページを正規表現...
-- PLUGIN_NAVI_LINK_TAGS <link>タグを出力するかどうか
** new 指定した日時が最近であった場合、最近更新された事...
''種別''
インライン型プラグイン
''重要度''
★★☆☆☆
''書式''
#br
''書式'''1:'''''
''&new('' [&color(blue){nodate};] ''){'' &color(b...
#br
''書式'''2:'''''
''&new('' [&color(blue){ページ名};] [,&color(blue...
''概要''
指定した日時が最近であった場合、最近更新された事を強...
標準では5日以内の場合に New を、1日以内の場合に New!...
''引数''
''書式'''1:'''''
日付文字列を指定した場合、その日時が規定の期間内であ...
-- nodate - 日付文字列を表示しません。省略時は表示します。
#br
''書式'''2:'''''
ページ名を指定した場合は、そのページの更新日時が規定...
ページ名末尾が/であった場合、そのページ名で始まるペー...
-- nolink - ページ名を表示しません。省略時はページ名(ペ...
''プラグイン内設定''
-- PLUGIN_NEW_DATE_FORMAT 表示フォーマット
''備考''
日付文字列は[[PHP関数:strtotime>http://jp2.php.net/ma...
** newpage ページを新規作成するか、新規作成するページ名...
''種別''
コマンド
ブロック型プラグイン
''重要度''
★★★★★
''書式''
''?plugin=newpage'' &color(blue){&page=ページ名}; &co...
''#newpage('' [&color(blue){ページ名初期値};] '')''
''概要''
ページを新規作成するか、新規作成するページ名の入力欄...
''引数''
コマンド''':'''
パラメータには新規作成するページのオプションを指定し...
#br
ページ名には新規作成するページ名を指定します。省略時...
#br
関連ページ名にはリンク元のページ名を指定します。新規...
#br
ブロック型プラグイン''':'''
#br
ページ名初期値には新規作成するページ名を入力する入力...
** norelated ページ下部に表示される関連ページのリンクを...
''種別''
ブロック型プラグイン
''重要度''
★★★☆☆
''書式''
''#norelated''
''概要''
ページ下部に表示される関連ページのリンクを非表示にし...
''備考''
極端に多くのページからリンクされていて関連リンクの表...
#hr
//---
* O [#o_]
** online 現在PukiWikiを参照している、おおよそのユーザー...
''種別''
ブロック型プラグイン
インライン型プラグイン
''重要度''
★★☆☆☆
''書式''
''#online''
''&online;''
''概要''
現在PukiWikiを参照している、おおよそのユーザー数を表...
ユーザー数は、プラグインを呼び出された時点で記録され...
''プラグイン内設定''
-- PLUGIN_ONLINE_TIMEOUT タイムアウトの秒数
-- PLUGIN_ONLINE_USER_LIST ユーザー情報を保存するファイル
-- PLUGIN_ONLINE_LIST_REGEX ユーザー情報取得用の正規表現
''備考''
ユーザー数のカウントはページ単位でなく、設置されたPuk...
* P [#p_]
** paint Javaアプレットで描いた絵を、そのページに添付し...
''種別''
(コマンド)
ブロック型プラグイン
''重要度''
★☆☆☆☆
''書式''
''#paint('' [&color(blue){幅};] [,&color(blue){高さ};...
''概要''
Javaアプレットで描いた絵を、そのページに添付します。
[[ば科学的愛情>http://www.geocities.co.jp/SiliconVall...
幅と高さに、デフォルトのキャンバスサイズを指定します...
''プラグイン内設定''
-- 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.ja...
//---
** pcomment 別のページにコメントを記録することができるco...
''種別''
(コマンド)
ブロック型プラグイン
''重要度''
★★★☆☆
''書式''
''#pcomment(''{ [&color(blue){コメント記録ページ};], ...
''概要''
別のページにコメントを記録することができるcommentプラ...
ラジオボタンを表示し、指定した部分にコメントを付ける...
''引数''
コメント記録ページ にはコメントを記録するページ名を指...
PLUGIN_PCOMMENT_PAGE で指定されたページにコメントが記...
指定したページが存在しなくても、最初にコメントを追加...
#br
表示件数 は表示する最新コメントの数を指定します。第1...
pcommentのデフォルト件数(通常10件。 PLUGIN_PCOMMENT_N...
表示件数は コメント記録ページ より後に指定して下さい...
コメント記録ページ に空白を指定します。(例: #pcommen...
#br
noname,nodate,above,below,reply でコメントの表示方法...
-- noname - 名前の入力欄を表示しません。
-- nodate - 日付を挿入しません。
-- above - 挿入したコメントをフォームの上に表示します。...
-- below - 挿入したコメントをフォームの下に表示します。...
-- reply - コメントの頭にラジオボタンを表示します。ある...
&br;
''プラグイン内設定''
&br;
-- PLUGIN_PCOMMENT_PAGE ページ名のデフォルト(%sに$vars['p...
-- 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ペー...
-- PLUGIN_PCOMMENT_TIMESTAMP コメントページのタイムスタン...
&br;
''備考''
更新が衝突したときは、予期せぬ場所にコメントが挿入さ...
aboveまたはbelowの設定にしたがって 一番前か一番後ろに...
#br
コメント記入後に表示されるページのタイトルに「(#pcomm...
実際に更新されたのはコメントを記録するページです。
#br
コメントを投稿しても、#pcommentが書かれたページは更新...
記録したページだけが更新として表示されます。
#br
コメントとして相対参照([ [../] ]など)を用いた場合は、...
意図したとおりに変換されない可能性があります。
#br
自動過去ログ化機能は PLUGIN_PCOMMENT_AUTO_LOG の件数 ...
の件数分のコメントを投稿した時に作動します。
//---
** popular 人気のある(参照回数の多い)ページの上位数件...
''種別''
ブロック型プラグイン
''重要度''
★★☆☆☆
''書式''
''#popular('' [[&color(blue){件数};] [,[&color(blue){...
''概要''
人気のある(参照回数の多い)ページの上位数件を表示し...
''引数''
件数には一覧の数を指定して下さい。省略時はPLUGIN_POPU...
対象外ページには、表示対象外とするページを正規表現で...
true, falseで、ページのカウント条件を指定します。省略...
-- true - 今日参照のあった回数順でページを表示します。
-- false - 通算の参照回数順でページを表示します。
&br;
''プラグイン内設定''
#br
-- PLUGIN_POPULAR_DEFAULT 件数未指定時の件数
&br;
''備考''
[[counter>未分類プラグイン#counter]]プラグインのカウ...
カウントの対象外となります。全てのページにcounterプラ...
counterプラグインをMenubarやスキンに設置するのが一般...
#hr
//---
* R [#r_]
** random ランダムなページへのリンクを表示するプラグイン...
''種別''
(コマンド)
#br
ブロック型プラグイン
#br
''重要度''
★☆☆☆☆
#br
''書式''
''#random('' [&color(blue){メッセージ};] '')''
#br
''概要''
ランダムなページへのリンクを表示するプラグイン。
#br
表示するページの候補は設置したページの下階層のページ...
#br
''引数''
メッセージにはリンクに表示する文字列を指定します。省...
備考
ブラウザの再読み込み対策はしていません。リロードされるた...
** read 指定したページを表示します。該当ページが存在しな...
''種別''
コマンド
#br
''重要度''
★★★★★
#br
''書式''
''?cmd=read'' &color(blue){&page=ページ名};
#br
''概要''
指定したページを表示します。該当ページが存在しない場...
#br
plugin=やcmd=が指定されていない場合に内部で暗黙に呼び...
#br
''引数''
ページ名には表示したいページ名を指定します。ページ名...
** recent 最近更新されたページのうち、最新の数件を表示し...
''種別''
ブロック型プラグイン
#br
''重要度''
★★★★★
#br
''書式''
''#recent('' [&color(blue){件数};] '')''
''概要''
最近更新されたページのうち、最新の数件を表示します。
#br
''引数''
件数には表示件数を指定します。省略時はプラグイン内設...
#br
''プラグイン内設定''
#br
-- PLUGIN_RECENT_DEFAULT_LINES 件数未指定時の件数
-- PLUGIN_RECENT_CACHE RecentChangesのキャッシュの場所
-- PLUGIN_RECENT_USAGE 引数未指定時に表示されるヘルプ
** ref '#attach'でページに添付されたファイルを指定位置に...
''種別''
ブロック型プラグイン
インライン型プラグイン
#br
''重要度''
★★★★☆
#br
''書式''
''#ref('' &color(blue){添付ファイル名};| &color(blue)...
#br
&ref( &color(blue){添付ファイル名};| &color(blue)...
#br
''概要''
'[[#attach>未分類プラグイン#attach]]'でページに添付さ...
#br
''引数''
添付ファイル名にはページに添付したファイル名を指定し...
#br
ページ名にはファイルを添付したページをWikiNameかBrack...
#br
パラメータにはファイルの展開方法を指定できます。
#br
-- left|center|right - 表示時の位置を指定します。省略時...
-- wrap|nowrap - テーブルタグで囲む/囲まないの指定を行い...
-- around - テキストの回り込みを可能とします。省略時は回...
-- noicon - ファイルが画像以外の場合に表示されるアイコン...
-- noimg - ファイルが画像の場合に画像を展開しないように...
-- nolink - 元ファイルへのリンクを張らないようにします。...
-- zoom - 縦横比を保持します。省略時はサイズ指定に従いま...
-- 999x999 - サイズを指定します(幅x高さ)。省略時は拡大率...
-- 999% - サイズを指定(拡大率)します。省略時は100%です、
-- タイトル - 上記以外のパラメータは画像の代替文字列、リ...
&br;
''プラグイン内設定''
#br
-- 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 添付ファイルの画像表示で UPL...
&br;
''備考''
aroundで行った回り込み指定を解除するには clearプラグ...
#br
"ほげ"という別ページの添付ファイル"fuga.jpg"をインラ...
#br
(1) &ref(ほげ/fuga.jpg);
(2) &ref(fuga.jpg,[[ほげ]]);
上記2通りの記述のうち、(2)の記述方式は旧バージョンと互換...
いずれの記述方法であっても一般的な動作は同じですが、いわ...
(1) [[&ref(ほげ/fuga.jpg,nolink,ウェブ名);>ウェブのURL]]
(2) [[&ref(fuga.jpg,[[ほげ]],nolink,ウェブ名);>ウェブの...
(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)はエラーとなり...
(7) &ref(fuga.jpg);
(7)は(6)と似た記述ですが、添付ファイル名の次の引数が省略...
** referer ページを照会した利用者の参照元URL(Referer)の...
''種別''
コマンド
#br
''重要度''
★★★☆☆
#br
''書式''
''?plugin=referer'' [&color(blue){&page=ページ名};] [...
#br
''概要''
ページを照会した利用者の参照元URL(Referer)の一覧を表...
#br
''引数''
ページ名にはRefererを表示するページ名を指定します。ペ...
#br
sortでReferer一覧のソート順を指定します。
#br
-- 0d - 最終更新日時(新着順)
-- 0a - 最終更新日時(日付順)
-- 1d - 初回登録日時(新着順)
-- 1a - 初回登録日時(日付順)
-- 2d - カウンタ(大きい順)
-- 2a - カウンタ(小さい順)
-- 3 - Referer
&br;
''プラグイン内設定''
#br
-- CONFIG_REFERER 無視するURIを指定したページ
&br;
''備考''
pukiwiki.ini.php で、Refererを使用する設定($referer =...
** related 対象のページを参照しているページの一覧を表示...
''種別''
コマンド
#br
擬似ブロック型プラグイン
#br
''重要度''
★★★☆☆
#br
''書式''
''?plugin=related'' [&color(blue){&page=ページ名};]
#br
''#related''
''概要''
対象のページを参照しているページの一覧を表示します。
#br
''引数''
ブロック型で実行時、設置したページが対象となります。
#br
コマンドで実行時、ページ名に対象となるページを指定で...
** rename 既存ページの名前を変更します。実行には管理者権...
''種別''
コマンド
#br
''重要度''
★★★☆☆
#br
''書式''
''?plugin=rename'' [&color(blue){&refer=ページ名};]
''概要''
既存ページの名前を変更します。実行には管理者権限が必...
#br
ページの本文のほか、指定されたページ名の差分、バック...
#br
''引数''
ページ名には変更するページの名前を指定します。省略時...
#br
実行結果は変換結果のページ(PLUGIN_RENAME_LOGPAGE で...
#br
''プラグイン内設定''
#br
-- PLUGIN_RENAME_LOGPAGE ページ名の変換結果を出力するペ...
''備考''
ページ内のリンクの書き換えは行ないません。yetlistなど...
#br
TrackBackやRefererの情報は更新されません。
#br
リネーム対象のページが凍結されているかどうかはチェッ...
#br
関連ページにリネーム対象の文字列が複数含まれていると...
#br
-- たとえば、hogeおよびhoge/hogeという二つのページがあっ...
** ruby 文字列にルビをふります。 [#ruby]
''種別''
インライン型プラグイン
#br
''重要度''
★☆☆☆☆
#br
''書式''
''&ruby('' &color(blue){ルビ}; ''){'' &color(blue...
''概要''
文字列にルビをふります。
#br
''引数''
ルビには表示するルビを指定します。
#br
対象文字列にはルビがふられる文字列を指定します。
#br
''プラグイン内設定''
#br
-- PLUGIN_RUBY_USAGE 引数未指定時に表示されるヘルプ
&br;
''備考''
XHTML 1.1のルビに対応したブラウザでないと、ルビとして...
#br
ルビに対応していないブラウザではルビをふる文字列の直...
#hr
//---
* S [#s_]
** search 検索文字列の入力フォームを表示し、 指定した文...
''種別''
コマンド
#br
ブロック型プラグイン
#br
''重要度''
★★★★★
#br
''書式''
''?cmd=search''{ [&color(blue){&word=検索文字列};] [&...
''#search''
#br
''概要''
検索文字列の入力フォームを表示し、 指定した文字列を含...
#br
''引数''
パラメータには検索条件を指定します。
#br
-- word - 検索する文字列を指定します。省略時は検索条件を...
-- type - 'OR' 指定時、OR検索を行います。省略時はAND検索...
&br;
''プラグイン内設定''
&br;
-- PLUGIN_SEARCH_DISABLE_GET_ACCESS GETメソッドによる検...
-- PLUGIN_SEARCH_MAX_LENGTH 検索する文字列として指定可能...
- ''#search 検索フォーム設置例示''
#search
** setlinebreak 入力文章中の改行を改行とみなすかどうかの...
''種別''
ブロック型プラグイン
''重要度''
★☆☆☆☆
''書式''
''#setlinebreak('' [&color(blue){on};|&color(blue){of...
''概要''
入力文章中の改行を改行とみなすかどうかの設定を行いま...
PukiWikiが入力文章中の改行をどのように扱うかはpukiwik...
|BGCOLOR(#D0D6DF):入力文章|BGCOLOR(#D0D6DF):$line_break=0...
|BGCOLOR(#EFF4FF):|BGCOLOR(#EFF4FF):|BGCOLOR(#EFF4FF):|c
|文章1&br;文章2|文章1文章2|文章1&br;文章2|
setlinebreakプラグインは該当ページの以降の行に関して...
''引数''
パラメータには以降の改行の扱いを指定します。 パラメー...
--on - 以降の文章で段落内の改行を改行とみなします($line_...
--off - 以降の文章で改行を無視します($line_break=0と同様...
--default - 改行の扱いをそのサイトの$line_break設定に戻...
** size 文字の大きさを指定します。 [#size]
''種別''
インライン型プラグイン
#br
''重要度''
★★★☆☆
#br
''書式''
''&size('' &color(blue){ピクセル数値}; ''){'' &co...
#br
''概要''
文字の大きさを指定します。
#br
''引数''
ピクセル数値には文字の大きさを指定します。
#br
文字列は文字の大きさを変更する文字列を指定します。
#br
''プラグイン内設定''
#br
-- PLUGIN_SIZE_MAX 引数として指定可能な最大文字サイズ
-- PLUGIN_SIZE_MIN 引数として指定可能な最小文字サイズ
-- PLUGIN_SIZE_USAGE 引数未指定時に表示されるヘルプ
** source 指定したページの整形前のソースを表示します。 [...
''種別''
コマンド
#br
''重要度''
★☆☆☆☆
#br
''書式''
''?cmd=source'' &color(blue){&page=ページ名};
#br
''概要''
指定したページの整形前のソースを表示します。
#br
''引数''
ページ名にはソースを表示するページ名を指定します。ペ...
#hr
//---
** 横分割 include(splitinclude) それぞれのページ内容を3...
''#splitinclude(''[&color(blue){ページ名1};],[&color...
と指定することで、それぞれのページ内容を横に並べて表示す...
ページ名は,区切りで3つまで指定することができます。
閲覧者にとって読み込み権限のあるページのみ動作します。
#br
ページ名は省略できません。
* T [#t_]
** tb TrackBackの一覧を表示します。 [#mdc27273]
[#tb]
''種別''
コマンド
#br
''重要度''
★☆☆☆☆
#br
''書式''
''?plugin=tb'' &color(blue){&tb_id=TrackBackID &__mod...
#br
''概要''
TrackBackの一覧を表示します。
#br
POSTされた場合は他サイトからのTrackBackに反応します。
#br
''引数''
&tb_idには表示対象ページのTrackBackIDを指定します。
#br
&__modeには一覧表示方法を指定します。
#br
-- view - 人間が見やすい形式で表示します。
-- rss - RSS形式で表示します。
&br;
''プラグイン内設定''
#br
-- PLUGIN_TB_LANGUAGE TrackBackのRSSで出力する言語
-- PLUGIN_TB_ERROR エラー時の返り値
-- PLUGIN_TB_NOERROR エラーなし時の返り値
&br;
''備考''
pukiwiki.ini.php で、TrackBackを使用する設定($trackba...
** template 既存のページをテンプレートとしてページを新規...
''種別''
コマンド
#br
''重要度''
★★★★☆
#br
''書式''
''?plugin=template'' &color(blue){&refer=テンプレート...
#br
''概要''
既存のページをテンプレートとしてページを新規作成しま...
#br
ページの新規作成時の雛形とするページの読込み機能との...
#br
''引数''
テンプレートページには雛形とするページを指定します。...
#br
''プラグイン内設定''
#br
-- MAX_LEN 雛形の開始/終了位置を指定する欄で表示される...
#aname(topicpath)
** topicpath パンくずリスト(topicpath)と呼ばれる、ページ...
''種別''
インライン型プラグイン
ブロック型プラグイン
''重要度''
★☆☆☆☆
''書式''
&topicpath;
#topicpath
''概要''
パンくずリスト(topicpath)と呼ばれる、ページの階層表現...
パンくずリスト(Topic path)は現在参照しているウェブ...
[[Top>FrontPage]]/[[PukiWiki>PukiWiki]]/[[ツアー>PukiWik...
基本的には以下の2通りの使い方を想定しています。
i.「ほげ/ふが/げほ」など、2~3階層以上の深いページ...
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_DEF...
** ツールチップ(tooltip) マウスをあわせるとツールチップ...
&tooltip(単語){説明文};
と入力することでマウスをあわせるとツールチップを表示しま...
利用例)
Mercurialは分散型&tooltip(SCM){Source Code Management; ...
と入力すると
Mercurialは分散型&tooltip(SCM){Source Code Management; バ...
と表示します。
** touchgraph TouchGraphWikiBrowser用のインデックスを作...
''種別''
コマンド
#br
''重要度''
★☆☆☆☆
#br
''書式''
''?plugin=touchgraph''
''概要''
TouchGraphWikiBrowser用のインデックスを作ります。
** tracker [#tracker]
''種別''
(コマンド)
#br
ブロック型プラグイン
#br
''重要度''
★★★★☆
#br
''書式''
''#tracker('' [&color(blue){定義名};] [,&color(blue){...
#br
''概要''
[[bugtrack>未分類プラグイン#bugtrack]]プラグインのよ...
#br
入力項目が固定されている[[bugtrack>未分類プラグイン#b...
FAQ,BBS,書評,TODOリストなど使い道はアイディア次第...
#br
入力項目の定義は:config/plugin/tracker/ 以下に所定の...
[[bugtrack>未分類プラグイン#bugtrack]]プラグイン互換...
#br
''引数''
定義名は #tracker(hoge) のようにtrackerのテンプレート...
#br
テンプレート名に続けてフォーム名 / リスト名を指定する...
ひとつのテンプレートに複数のフォーム形式 / リストフォ...
例えば、#tracker(hoge/form_alternative) とすれば
:config/plugin/tracker/hoge/form_alternative の内容を...
#tracker_list(hoge/list_alternative) とすれば :config...
#br
ベースページ名はフォームから作成されるページの親階層...
#br
''プラグイン内設定''
#br
-- TRACKER_LIST_EXCLUDE_PATTERN tracker_listで表示しない...
-- TRACKER_LIST_SHOW_ERROR_PAGE 項目の取り出しに失敗した...
&br;
''テンプレート''
#br
テンプレートは基本的に設置するtracker毎に1組(4ペー...
#br
-- :config/plugin/tracker/hoge
hogeテンプレートの項目の内容を記述します。
&br;
-- :config/plugin/tracker/hoge/form
入力フォームの項目とレイアウトを記述します。
&br;
-- :config/plugin/tracker/default/page
入力した内容をページ化する際のフォーマットを記述します。
&br;
-- :config/plugin/tracker/hoge/list
tracker_listで表示するリストのレイアウトを記述します。テ...
&br;
''予約項目''
#br
-- form で使用できる予約項目
--- [_name] : 記事を記録するページ名を入力するフィールド...
--- [_submit] : [追加]ボタンを表示。
-- page / list で使用できる予約項目
--- [_date] : 投稿日時。
--- [_page] : 実際に生成したページ名。ブラケットが付く。
--- [_refer] : #trackerを置いたページ。
--- [_base] : ページのプレフィクス。 tracker()/tracker_li...
--- [_name] : formの [_name] の内容そのもの。記事を記録す...
--- [_real] : 実際に生成したページ名から、[_refer] + '/'...
・formに [_name] フィールドがない。
・[_name] が空か、ページ名として無効な文字を含む。
・[_refer] / [_name] という名前のページがすでに存在する。
-- list で使用できる予約項目
--- [_update] : ページの最終更新日時。
--- [_past] : 最終更新日時からの経過。
** tracker_list [#tracker_list]
''種別''
(コマンド)
#br
ブロック型プラグイン
#br
''重要度''
★★★★☆
#br
''書式''
''#tracker_list('' [&color(blue){定義名};] [,[&color(...
#br
''概要''
[[tracker>未分類プラグイン#tracker]]プラグインで作成...
#br
''引数''
定義名は[[tracker>未分類プラグイン#tracker]]プラグイ...
省略時は :config/plugin/tracker/default が指定された...
#br
ベースページ名は[[tracker>未分類プラグイン#tracker]]...
[[tracker>未分類プラグイン#tracker]]プラグインでベー...
省略時は設置したページとなります。
#br
第3項目には一覧表示のソートに使う項目およびソート順...
#br
表示上限は一覧表示するページ数の上限を指定します。省...
#hr
//---
* V [#v_]
** vote 選択肢と投票数と投票ボタンが並んだ簡易投票フォー...
''種別''
コマンド
#br
ブロック型プラグイン
#br
''重要度''
★★☆☆☆
#br
''書式''
''#vote('' &color(blue){選択肢1};[&color(blue){選択肢...
''概要''
選択肢と投票数と投票ボタンが並んだ簡易投票フォームを...
#br
''引数''
選択肢1~nに投票項目を指定します。投票項目に続けて半...
#br
''備考''
''各選択肢の投票数''は編集によって容易に改竄できるた...
#br
※ページを凍結していても動作可能です。凍結した場合には...
#br
''使用例''
#vote( 選択肢1[選択肢1の投票数] [[0],選択肢2[選択肢2の投...
#hr
//---
* Y [#y_]
** yetlist まだ作られていないページを一覧表示します。 [#...
''種別''
コマンド
#br
''重要度''
★★☆☆☆
#br
''書式''
''?plugin=yetlist''
''概要''
まだ作られていないページを一覧表示します。
#br
まだ作られていないページとは、既存のページでWikiName...
#br
''備考''
自分以外の誰かがページを書くかもしれないという点は非...
終了行:
#contents
* プラグインマニュアル [#g4919d30]
** プラグインマニュアルの凡例 [#jce09f74]
プラグインマニュアルは以下の形式で記述されています。
''プラグイン名''
''種別''
プラグインがどのような方法で呼び出しを行えるかを示し...
-- コマンド - コマンド形式の呼び出しが可能であることを示...
-- ブロック型プラグイン - ブロック型プラグインでの呼び出...
-- インライン型プラグイン - インライン型プラグインでの呼...
-- 擬似ブロック型プラグイン - PukiWiki本体で実現されてい...
''重要度''
そのプラグインの一般的な利用頻度や有用性の目安を示し...
''書式''
プラグインでの引数指定方法です。引数の指定方法の表現...
-- [] - 省略可能で必要に応じて記述する箇所です。
-- | - |で区切られた複数の項目のうち、指定できるのは1つ...
-- {} - 中カッコ内のみ引数の指定順序が任意である事を示し...
''概要''
そのプラグインの機能概要です。
''引数''
引数の詳細な説明です。
''プラグイン内設定''
プラグインのソース中で定義されている定数の一覧です。...
''備考''
プラグインに関する参考情報です。
//--- --- --- ---
* A [#a_]
** add 実行すると編集画面が表示されます。更新ボタンを押...
''種別''
コマンド
''重要度''
★☆☆☆☆
''書式''
''?cmd=add'' &color(blue){&page=ページ名};
''概要''
実行すると編集画面が表示されます。更新ボタンを押すと...
''引数''
ページ名は省略できません。ページ名はエンコードされて...
#br
[[edit>未分類プラグイン#edit]]が編集画面に既存のペー...
変更する事がないため、単純に追記していくだけのページ...
#br
''備考''
もともとデフォルトのskinでメニューの「追加」として使...
** aname 指定した位置にアンカー(リンクの飛び先)を設定し...
''種別''
インライン型プラグイン
ブロック型プラグイン
#br
''重要度''
★★★★☆
#br
''書式''
''&aname('' &color(blue){アンカー名}; [,{[&color(...
#br
''#aname('' &color(blue){アンカー名}; [,{[&color(blue...
#br
''概要''
指定した位置にアンカー(リンクの飛び先)を設定します。
#br
''引数''
アンカー名の値がアンカーのフラグメント指定子に使用さ...
アンカー名には半角英字(大文字/小文字)が使用可能で...
#br
super,full,noid でアンカーの出力方式を指定します。
#br
-- &color(blue){super}; - アンカー文字列を上付き表示しま...
-- &color(blue){full}; - フラグメント指定子以外のURIを補...
--&color(blue){noid}; - アンカーにフラグメント指定子を出...
&br;
&color(blue){アンカー文字列};が指定された場合、指定し...
利用者に明示したい場合に利用します。省略時は空文字に...
#br
''プラグイン内設定''
#br
-- PLUGIN_ANAME_ID_MAX アンカー名に指定可能な文字列長の...
-- PLUGIN_ANAME_ID_REGEX アンカー名に指定可能な文字列の...
-- PLUGIN_ANAME_ID_MUST_UNIQUE 重複したアンカー名を利用...
&br;
''備考''
通常はインライン型プラグインとして使用します。2つのブ...
インラインプラグインとして記述できないため、ブロック...
#br
PukiWiki本体処理でanameプラグインを内部的に呼び出して...
** article 指定した位置に簡易掲示板を設置します。 [#arti...
''種別''
(コマンド)
ブロック型プラグイン
#br
''重要度''
★★★☆☆
#br
''書式''
''#article''
#br
''概要''
指定した位置に簡易掲示板を設置します。
#br
''プラグイン内設定''
#br
-- PLUGIN_ARTICLE_COLS テキストエリアのカラム数
-- PLUGIN_ARTICLE_ROWS テキストエリアの行数
-- PLUGIN_ARTICLE_NAME_COLS 名前テキストエリアのカラム数
-- PLUGIN_ARTICLE_SUBJECT_COLS 題名テキストエリアのカラ...
-- PLUGIN_ARTICLE_NAME_FORMAT 名前の挿入フォーマット
-- PLUGIN_ARTICLE_SUBJECT_FORMAT 題名の挿入フォーマット
-- PLUGIN_ARTICLE_INS 入力内容を入力欄の前後どちらに挿入...
-- PLUGIN_ARTICLE_COMMENT 書き込みの下に一行コメントを入...
-- PLUGIN_ARTICLE_AUTO_BR 改行を自動的変換するか
-- PLUGIN_ARTICLE_MAIL_AUTO_SEND 投稿内容のメール自動配...
-- PLUGIN_ARTICLE_MAIL_FROM 投稿内容のメール送信時の送信...
-- PLUGIN_ARTICLE_MAIL_SUBJECT_PREFIX 投稿内容のメール送...
-- $_plugin_article_mailto 投稿内容のメール自動配信先ア...
** attach ページの添付ファイルの一覧を表示し、ファイル添...
''種別''
(コマンド)
ブロック型プラグイン
''重要度''
★★★★★
#br
''書式''
''#attach('' [&color(blue){nolist};] [,&color(blue){n...
#br
''概要''
ページの添付ファイルの一覧を表示し、ファイル添付のた...
#br
''引数''
nolist, noform で表示内容を指定します。
#br
-- nolist - ページの添付ファイルの一覧を表示しません。省...
-- noform - ファイル添付のための入力フォームを表示しませ...
&br;
''プラグイン内設定''
#br
-- PLUGIN_ATTACH_MAX_FILESIZE ファイルアップロードの上限
-- PLUGIN_ATTACH_UPLOAD_ADMIN_ONLY 管理者だけが添付ファ...
-- PLUGIN_ATTACH_DELETE_ADMIN_ONLY 管理者だけが添付ファ...
-- PLUGIN_ATTACH_DELETE_ADMIN_NOBACKUP PLUGIN_ATTACH_DEL...
-- PLUGIN_ATTACH_PASSWORD_REQUIRE アップロード/削除時に...
-- PLUGIN_ATTACH_FILE_MODE アップロードされたファイルの...
-- PLUGIN_ATTACH_FILE_ICON アイコンイメージのファイル
-- PLUGIN_ATTACH_CONFIG_PAGE_MIME ダウンロード時のmime-t...
&br;
''備考''
デフォルトのskinのメニューの「添付」で呼び出されてい...
#br
プラグイン内設定の PLUGIN_ATTACH_MAX_FILESIZE を増や...
LimitRequestBodyなどPukiWiki以外での上限設定がある事...
#hr
//---
* B [#b_]
** back 指定した位置に戻り先へのリンクを設置します。 [#b...
''種別''
ブロック型プラグイン
#br
''重要度''
★☆☆☆☆
#br
''書式''
''#back('' [[&color(blue){表示文字列};] [,[&color(blu...
#br
''概要''
指定した位置に戻り先へのリンクを設置します。
#br
''引数''
表示文字列は省略すると「戻る」になります。
#br
left、center、rightで表示位置を指定します。省略時はce...
#br
-- left - リンクを左寄せで表示します。
-- center - リンクを中央寄せで表示します。
-- right - リンクを右寄せで表示します。
&br;
0、1で水平線の有無を指定します。省略すると1になります。
#br
-- 0 - 水平線を表示しません。
-- 1 - 水平線を表示します。
#br
&br;
戻り先はリンクを選択時の移動先となるURL、ページ名のい...
ページ名は「ページ名#anchor」の記述を行う事で移動先の...
PLUGIN_BACK_ALLOW_JAVASCRIPTがTRUEの場合のみ戻り先の...
戻り先を省略すると直前に参照していたページが戻り先に...
#br
''プラグイン内設定''
#br
-- PLUGIN_BACK_ALLOW_PAGELINK ページ名(+アンカー名)によ...
-- PLUGIN_BACK_ALLOW_JAVASCRIPT 戻り先の指定にJavaScript...
-- PLUGIN_BACK_USAGE エラー時に表示される使用方法
** backup 指定したページ、あるいは全体のバックアップ一覧...
''種別''
コマンド
#br
''重要度''
★★★★★
#br
''書式''
''?cmd=backup'' [&color(blue){&page=ページ名};]
#br
''概要''
#br
指定したページ、あるいは全体のバックアップ一覧を表示...
''引数''
ページ名を省略すると、PukiWiki全体のバックアップ一覧...
#br
''プラグイン内設定''
#br
-- PLUGIN_BACKUP_DISABLE_BACKUP_RENDERING バックアップデ...
** br 文章中で改行を行います。 [#br]
''種別''
ブロック型プラグイン
インライン型プラグイン
#br
''重要度''
★★☆☆☆
#br
''書式''
''#br''
#br
''&br;''
#br
''概要''
文章中で改行を行います。
#br
段落やリスト、テーブル内など、行末の~による改行ではブ...
#br
''プラグイン内設定''
#br
-- PLUGIN_BR_ESCAPE_BLOCKQUOTE 引用文中で利用した場合の...
-- PLUGIN_BR_TAG brプラグインが出力するタグ
** bugtrack [#bugtrack]
''種別''
(コマンド)
#br
ブロック型プラグイン
#br
''重要度''
★☆☆☆☆ (一般サイト)
#br
★★★★☆ (ソフト開発サイト)
''書式''
''#bugtrack('' [[&color(blue){ページ名};] [,&color(bl...
''概要''
バグ追跡システムの一部分であるバグレポートの入力フォ...
#br
''引数''
ページ名にはバグレポートとして作成されるページの親階...
通常、バグレポートには指定したページ名の子階層に自動...
#br
カテゴリーにはバグの対象となりうる要素を指定します。...
#br
''プラグイン内設定''
#br
-- PLUGIN_BUGTRACK_NUMBER_FORMAT バグレポートとして作成...
&br;
''備考''
ソフト開発サイトで重宝するプラグインです。もしバグ追...
** bugtrack_list [#bugtrack_list]
''種別''
ブロック型プラグイン
#br
''重要度''
★☆☆☆☆ (一般サイト)
#br
★★★★☆ (ソフト開発サイト)
#br
''書式''
''#bugtrack_list('' [&color(blue){ページ名};] '')''
''概要''
バグ追跡システムの一部分であるバグレポートの一覧表示...
#br
''引数''
ページ名にはバグレポートとして作成されるページの親階...
#br
''備考''
通常はbugtrackプラグインと並べて使用します。
#br
bugtrack_listプラグインの中からbugtrackプラグインを呼...
#br
bugtrack_listプラグインは、[[tracker_list>未分類プラ...
#hr
* C [#c_]
** calendar、calendar_edit、calendar_read [#calendar]
''種別''
ブロック型プラグイン
#br
''重要度''
★☆☆☆☆
#br
''書式''
''#calendar('' [{[&color(blue){ページ名};], [&color(b...
''#calendar_edit('' [{[&color(blue){ページ名};], [&co...
''#calendar_read('' [{[&color(blue){ページ名};], [&co...
#br
''概要''
指定した位置にカレンダーを設置します。カレンダー上でy...
#br
カレンダーの日付を選択した場合に該当するページを編集...
calendar_editとは編集状態で、calendar, calendar_read...
#br
''引数''
ページ名は編集/参照するカレンダーのページの上位ページ...
#br
年月は表示するカレンダーの西暦と月をyyyymmの形式で指...
''備考''
より高機能なcalendar2プラグインがあるため、あえてcale...
#br
calendar_editプラグイン及びcalendar_readプラグインの...
//---
** calendar_viewer [#calendar_viewer]
''種別''
(コマンド)
ブロック型プラグイン
#br
''重要度''
★★★☆☆
#br
''書式''
''#calendar_viewer('' &color(blue){ページ名};, &color...
#br
''概要''
calendarプラグインまたはcalendar2プラグインで作成され...
#br
''引数''
ページ名はcalendarプラグインまたはcalendar2プラグイン...
#br
yyyy-mmを指定時、指定した年月のページを表示します。
#br
数字を指定時、指定した件数分のページを表示します。
#br
x*yを指定時、先頭より数えて x ページ目(先頭は0)から、...
#br
thisを指定時、今月のページを一覧表示します。
#br
past、future、viewで表示するページの条件を指定します...
#br
-- past - 今日以前のページを表示します。
-- future - 今日以降のページを表示します。
-- view - 過去から未来へ一覧表示します。
&br;
年月日の区切り文字は-や/などを指定します。省略した場...
#br
''プラグイン内設定''
#br
-- PLUGIN_CALENDAR_VIEWER_USAGE エラー時に表示される使用...
-- PLUGIN_CALENDAR_VIEWER_DATE_FORMAT 日付の表示形式
&br;
''備考''
calendar2プラグインでは今日の日付の記事がない場合、記...
calendar_viewerはその弱点を補うために開発されたプラグ...
最新の記事を表示することができます。カレンダーそのも...
//---
** calendar2 [#calendar2]
''種別''
(コマンド)
ブロック型プラグイン
#br
''重要度''
★★★☆☆
#br
''書式''
''#calendar2('' [{[&color(blue){ページ名};|&color(blu...
#br
''概要''
指定した位置にカレンダーを設置します。表示月のとなりに表...
#br
''引数''
ページ名で表示するページの上位階層のページを指定でき...
#br
yyyymmで表示するカレンダーの西暦と月を指定できます。...
#br
offを指定時、当日分ページを表示する機能は抑制されます...
#br
''備考''
calender_editで作成したページはページ名/yyyymmddとな...
//---
** clear refプラグインのaroundオプションで有効となったテ...
''種別''
ブロック型プラグイン
#br
''重要度''
★☆☆☆☆
#br
''書式''
''#clear''
#br
''概要''
refプラグインのaroundオプションで有効となったテキスト...
#br
''備考''
imgプラグインのclearオプション指定時と処理内容は同等...
** color 引数で指定したインライン要素(主に文章)の、文字...
''種別''
インライン型プラグイン
#br
''重要度''
★★★★☆
#br
''書式''
''&color('' [&color(blue){文字色};] [,&color(blue...
#br
''概要''
引数で指定したインライン要素(主に文章)の、文字色・背...
#br
''引数''
文字色・背景色はそれぞれ色名(red、blueなど)、シャープ...
#br
文字色・背景色の両方を省略する事はできません。一方を...
#br
''プラグイン内設定''
#br
-- PLUGIN_COLOR_ALLOW_CSS 色の変更に(fontタグではなく)CS...
-- PLUGIN_COLOR_USAGE エラー時に表示される使用方法
-- PLUGIN_COLOR_REGEX 引数に指定できる色の正規表現
&br;
''備考''
以下、[[W3C勧告書>http://www.w3.org/TR/1999/REC-html4...
** comment コメントの入力用の入力欄を表示します。 [#comm...
''種別''
(コマンド)
ブロック型プラグイン
#br
''重要度''
★★★★★
#br
''書式''
''#comment('' {[&color(blue){above};], [&color(blue){...
#br
''概要''
コメントの入力用の入力欄を表示します。
#br
''引数''
コメントの挿入方法を引数で指定します。
#br
-- above - 入力したコメントがコメント入力欄の上に追加し...
-- below - 入力したコメントがコメント入力欄の下に追加し...
-- nodate - 挿入するコメントに、挿入時刻を付加しない(省...
-- noname - コメント記入者名の入力欄を非表示とします(省...
&br;
''プラグイン内設定''
#br
-- PLUGIN_COMMENT_DIRECTION_DEFAULT コメントを入力欄の前...
-- PLUGIN_COMMENT_SIZE_MSG コメントのテキストエリアの表...
-- PLUGIN_COMMENT_SIZE_NAME コメントの名前テキストエリア...
-- PLUGIN_COMMENT_FORMAT_MSG コメント欄の挿入フォーマット
-- PLUGIN_COMMENT_FORMAT_NAME 名前欄の挿入フォーマット
-- PLUGIN_COMMENT_FORMAT_NOW 時刻欄の挿入フォーマット
-- PLUGIN_COMMENT_FORMAT_STRING コメント内容全体の挿入フ...
//---
** contents 設置したページ中の見出しの一覧を表示します。 ...
''種別''
擬似ブロック型プラグイン
#br
''重要度''
★★★☆☆
#br
''書式''
''#contents''
#br
''概要''
設置したページ中の見出しの一覧を表示します。
//---
** counter 設置したページの参照回数を表示します。 [#coun...
''種別''
ブロック型プラグイン
#br
インライン型プラグイン
#br
''重要度''
★★★☆☆
''書式''
''#counter''
#br
''&counter('' [&color(blue){total};| &color(blue)...
#br
''概要''
設置したページの参照回数を表示します。
#br
''引数''
カウンタ表示方法として total, today, yesterday いずれ...
#br
-- total - そのページが参照された回数の総計を表示します。
-- today - そのページが参照された回数(当日分)を表示し...
-- yesterday - そのページが参照された回数(昨日分)を表...
&br;
''プラグイン内設定''
#br
-- PLUGIN_COUNTER_SUFFIX ページ参照回数を保持するデータ...
&br;
''備考''
すべてのページで参照回数を表示したい場合は、MenuBarや...
#hr
* D [#d_]
** deleted 削除されたページの一覧を表示します。 [#deleted]
''種別''
コマンド
#br
''重要度''
★★☆☆☆
#br
''書式''
''?plugin=deleted'' {[&color(blue){&dir=diff};| &colo...
#br
''概要''
削除されたページの一覧を表示します。
#br
''引数''
file=onを指定時、バックアップ(あるいは差分)のファイ...
#br
dirで削除の判定方法を指定します。省略時はbackupです。
#br
-- backup - バックアップが存在し、ページが存在しない時に...
''?plugin=deleted&dir=backup''
-- diff - 差分が存在し、ページが存在しない時に削除された...
''?plugin=deleted&dir=diff''
&br;
''備考''
公開Wikiの管理者にとっては誤操作や悪意をもった編集に...
//---
** diff 指定したページの現在の内容と最後のバックアップ状...
''種別''
コマンド
#br
''重要度''
★★★★★
#br
''書式''
''?cmd=diff'' &color(blue){&page=ページ名};
#br
''概要''
指定したページの現在の内容と最後のバックアップ状態と...
#br
''引数''
ページ名に変更差分を表示するページを指定します。ペー...
#br
''備考''
最後のバックアップ以外との差分を表示する場合は[[backu...
** dump 指定ディレクトリ内のファイルをまとめてtar(tar.gz...
''種別''
コマンド
#br
''重要度''
★☆☆☆☆
#br
''書式''
''?plugin=dump''
#br
''概要''
指定ディレクトリ内のファイルをまとめてtar(tar.gz, tgz...
バックアップ/リストアの実行には管理者パスワードが必要...
バックアップはファイル名をページ名に変換して取得する...
バックアップは取得するディレクトリを任意に指定する事...
リストアは該当ファイルの上書きによって行われます。 そ...
バックアップ/リストア対象として指定可能なディレクトリ...
#br
-- DATA_DIR (wiki/*.txt)
-- UPLOAD_DIR (attach/*)
-- BACKUP_DIR (backup/*)
&br;
''プラグイン内設定''
&br;
-- PLUGIN_DUMP_ALLOW_RESTORE リストアを許可するかどうか
-- PLUGIN_DUMP_FILENAME_ENCORDING ページ名をディレクトリ...
-- PLUGIN_DUMP_MAX_FILESIZE 最大アップロードサイズ(Kbyte)
-- PLUGIN_DUMP_DUMP バックアップ時にプラグイン内で利用す...
-- PLUGIN_DUMP_RESTORE リストア時にプラグイン内で利用す...
&br;
''備考''
PukiWikiが内部管理するファイルを直接取得/更新するとい...
#br
DATA_DIRのリストアを行った場合は、[[links>未分類プラ...
* E [#e_]
** edit 指定したページを編集します。 [#edit]
''種別''
コマンド
インライン型プラグイン
''重要度''
★★★★★
''書式''
''?cmd=edit'' &color(blue){&page=ページ名};
''&edit('' [&color(blue){ページ名}; {[,&color(blu...
''概要''
指定したページを編集します。
''引数''
コマンド型の記述では、ページ名に編集するページを指定...
インライン型の記述では、ページ名は編集するページを指...
nolabel,noicon,ラベル名 でリンクの表示方法を指定しま...
-- nolabel - 編集用リンクの文字列をnoicon 指定時は短縮表...
-- noicon - 編集用リンクに画像を表示しません。
-- ラベル名 - 編集用リンクの文字列として表示する文字列を...
''プラグイン内設定''
-- PLUGIN_EDIT_FREEZE_REGEX freezeプラグインを介さず、直...
*F [#f_]
** filelist ページの一覧を各ページが記録されているファイ...
''種別''
コマンド
''重要度''
★☆☆☆☆
''書式''
''?cmd=filelist''
''概要''
ページの一覧を各ページが記録されているファイル名と共...
''備考''
主として管理者がメンテナンス用途に使用します。
※表示するには管理者のパスワードが必要です。
** freeze 対象のページを凍結し、不用意に変更できないよう...
''種別''
コマンド
(ブロック型プラグイン)
''重要度''
★★★☆☆
''書式''
''?cmd=freeze'' &color(blue){&page=ページ名};
''#freeze''
''概要''
対象のページを凍結し、不用意に変更できないようにしま...
''引数''
ページ名には凍結するページを指定します。ページ名はエ...
ブロック型のfreezeプラグインはPukiWikiが内部的に利用...
''備考''
※実行の際に管理者パスワードを要求されます。
* H [#h_]
** hr 文中に水平線を挿入します。 [#hr]
''種別''
ブロック型プラグイン
''重要度''
★★☆☆☆
''書式''
''#hr''
''概要''
文中に水平線を挿入します。
''備考''
段落やリスト、テーブル内など、通常の水平線書式(----)...
* I [#i_]
** img 添付ファイル以外の画像を表示するために開発されま...
''種別''
ブロック型プラグイン
''重要度''
★☆☆☆☆
''書式''
''#img('' &color(blue){画像URL};[, &color(blue){right...
''概要''
添付ファイル以外の画像を表示するために開発されました...
''引数''
画像URLには表示する画像のURLを指定します。 画像にはjp...
right,r,left,l,clear,c で画像の表示位置とテキストの回...
-- right,r - 画像を右寄せで表示します。
-- left,l - 画像を右寄せで表示します。
-- clear,c - テキストの回りこみを解除します。内部的には ...
''プラグイン内設定''
-- PLUGIN_IMG_CLEAR clear指定時に出力するタグ
-- PLUGIN_IMG_USAGE 引数未指定時に表示されるヘルプ
** include 記述した位置に指定したページを挿入して、複数...
''種別''
ブロック型プラグイン
''重要度''
★★★☆☆
''書式''
#include( ページ名[,title|,notitle] )
''概要''
記述した位置に指定したページを挿入して、複数のページ...
''引数''
ページ名には挿入するページを指定します。
第2引数にnotitleを指定すると、ページ名の表示を抑制し...
''プラグイン内設定''
-- PLUGIN_INCLUDE_MAX 一度にインクルードできるページの最...
-- PLUGIN_INCLUDE_WITH_TITLE title,notitle を未指定時に...
-- PLUGIN_INCLUDE_USAGE 引数未指定時に表示されるヘルプ
** includesubmenu 現在表示中のページによって、MenuBarに...
''種別''
ブロック型プラグイン
#br
''重要度''
★★☆☆☆
#br
''書式''
''#includesubmenu('' [&color(blue){showpagename};] )
#br
''概要''
現在表示中のページによって、MenuBarに表示する内容を切...
#br
表示中のページの下階層のSubMenuか、同階層にあるSubMen...
#br
''引数''
showpagename を指定すると、挿入表示するページのページ...
//---
** insert 記述した位置に複数行入力欄とボタンを表示します...
''種別''
(コマンド)
ブロック型プラグイン
''重要度''
★☆☆☆☆
''書式''
''#insert''
''概要''
記述した位置に複数行入力欄とボタンを表示します。
ボタンを押下すると入力欄に入力した内容をページに挿入...
''プラグイン内設定''
-- INSERT_COLS 編集欄の表示幅
-- INSERT_ROWS 編集欄の表示行数
-- INSERT_INS 入力内容を入力欄の前後どちらに挿入するか
''備考''
ブラウザによっては、複数行入力欄の右下角に入力欄の大...
「つまみ」が表示されるかどうか?はブラウザによって異...
** interwiki [#interwiki]
''種別''
コマンド
''重要度''
★☆☆☆☆
''書式''
''?cmd=interwiki'' &color(blue){&page=InterWiki名};
''概要''
InterWikiを記述した際にPukiWikiが内部的に呼び出します...
''引数''
InterWiki名にはジャンプ先をInterWiki形式で指定します...
* L [#l_]
** lastmod 指定したページの最終更新日時を表示します。 [#...
''種別''
インライン型プラグイン
''重要度''
★☆☆☆☆
''書式''
''&lastmod('' [&color(blue){ページ名};] '');''
''概要''
指定したページの最終更新日時を表示します。
''引数''
ページ名には最終更新日時を表示したいページ名を指定し...
** links [#links]
''種別''
コマンド
#br
''重要度''
★★☆☆☆(管理者)
#br
''書式''
''?plugin=links''
''概要''
ページ間のキャッシュを更新します。通常使用する必要は...
#br
メンテナンス作業などでページが記録されているファイル...
#br
''備考''
実行の際に管理者パスワードを要求されます。
//---
** list ページの一覧を表示します。 [#list]
''種別''
コマンド
''重要度''
★★★★☆
''書式''
''?cmd=list''
''概要''
ページの一覧を表示します。
//---
** lookup [#lookup]
''種別''
(コマンド)
#br
ブロック型プラグイン
#br
''重要度''
★★★☆☆
#br
''書式''
''#lookup('' &color(blue){interwikiname}; [,&color(bl...
''概要''
記述した位置にテキスト入力欄とボタンを表示します。任...
#br
URLの生成にはInterWikiを利用します。このプラグインが...
#br
[[interwikiname:入力欄の値]]
入力欄が空欄(空文字列)のときは、ボタンを押しても動作...
#br
''引数''
interwikiname: InterWikiNameに設定した値の一つを指定...
#br
ボタン名: ボタンに表示するキャプションを指定します。...
#br
入力欄の初期値: 初期値を指定したい場合に記入します。...
#br
''プラグイン内設定''
#br
-- PLUGIN_LOOKUP_USAGE 引数未指定時に表示されるヘルプ
//---
** ls 記述したページより階層化されているページのページ名...
''種別''
ブロック型プラグイン
''重要度''
★★☆☆☆
''書式''
''#ls('' [&color(blue){title};] '')''
''概要''
記述したページより階層化されているページのページ名を...
''引数''
titleを指定した場合、ページ名に加えてタイトルを表示し...
''備考''
実際には、より高機能なls2を使用する機会が多いと思われ...
//---
** ls2 指定したパターンで始まるページ名を一覧表示します...
''種別''
(コマンド)
ブロック型プラグイン
''重要度''
★★★☆☆
''書式''
''#ls2('' [[&color(blue){パターン};] [, { [&color(blu...
''概要''
指定したパターンで始まるページ名を一覧表示します。
''引数''
パターンには表示するページ名の共通部分を指定します。...
title,include,reverse,compact,link で表示方法を指定し...
-- title - ページに含まれる見出し(*,**,***)の一覧を併記...
-- include - 下位層のページが#includeを使用していた場合...
-- reverse - ページの並び順を反転し、名前の降順に表示し...
-- compact - 見出しレベルを調整します。
-- link - #ls2を書いた位置に一覧を表示する代わりにリンク...
&br;
linkの別名表示には、パラメータlinkを指定した際に表示...
''プラグイン内設定''
-- PLUGIN_LS2_ANCHOR_PREFIX 見出しアンカーの書式
-- PLUGIN_LS2_ANCHOR_ORIGIN 見出しアンカーの開始番号
-- PLUGIN_LS2_LIST_COMPACT compactオプション省略時、見出...
''備考''
ls プラグインとの違いについて。
-- 階層化されたページの起点となるページが、lsでは記述した...
-- titleパラメータを指定した場合に、lsでは「ページの一行...
-- include, link という表示オプションが追加されています。
-- ページ名のソートには[[natcasesort()>http://www.php.net...
#hr
//---
* M [#m_]
** marquee 流れる文字を表示します。表示するブラウザによっ...
http://wikiwiki.jp/sample/?%CE%AE%A4%EC%A4%EB%CA%B8%BB%FA
|650|c
| ''Contents''|
|#contents|
*マニュアル [#zce17f93]
#marquee(文字列,behavior,loop,背景色,文字色,文字サイズ);
marqueeを表示します。表示するブラウザによっては正しく表示...
*使用例 [#ce5f5be4]
【書式】
#marquee(スクロール表示);
【表示】
#marquee(スクロール表示);
【書式】
#marquee(端にぶつかると停止(slide),slide);
【表示】
#marquee(端にぶつかると停止(slide),slide);
【書式】
#marquee(端から端までを往復(alternate),alternate);
【表示】
#marquee(端から端までを往復(alternate),alternate);
【書式】
#marquee(ループ5回,,5);
【表示】
#marquee(ループ5回,,5);
【書式】
#marquee(ループ5回+文字色変更,,5,,red);
【表示】
#marquee(ループ5回+文字色変更,,5,,red);
【書式】
#marquee(ループ5回+背景色変更,,5,pink);
【表示】
#marquee(ループ5回+背景色変更,,5,pink);
【書式】
#marquee(文字サイズ20px,,,black,#aaffaa,20);
【表示】
#marquee(文字サイズ20px,,,black,#aaffaa,20);
*関連リンク [#ie87edaa]
-[[自作プラグイン/marquee.inc.php - PukiWiki-official>puk...
-[[自作プラグイン/marquee.inc.php - teanan.homeip.net:htt...
** map サイトマップの様にページ間のリンク関係を一覧表示...
''種別''
コマンド
''重要度''
★☆☆☆☆
''書式''
''?plugin=map'' [&color(blue){&refer=ページ名};] [&co...
''概要''
サイトマップの様にページ間のリンク関係を一覧表示しま...
指定したページを起点に、リンクで辿れるページを全てツ...
''引数''
引数には一覧表示方法のオプションを指定します。
-- &refer=ページ名 - 起点となるページを指定します。省略...
-- &reverse=true - どこへリンクしているかではなく、どこ...
''プラグイン内設定''
-- PLUGIN_MAP_SHOW_HIDDEN 表示対象外のページをリストアッ...
** md5 [#md5]
''種別''
コマンド
#br
''重要度''
★☆☆☆☆
#br
''書式''
''?plugin=md5'' &color(blue){&md5=文字列};
#br
''概要''
選択したパスワードの形式に応じて、pukiwiki.ini.php に...
#br
パスワードのフォーマットは以下の8種類の中から選択でき...
#br
''備考''
PukiWiki内で利用するパスワードは、パスワード文字列そ...
これは悪意ある者にpukiwiki.ini.phpの中身を覗き見られ...
#br
SHA-1 アルゴリズムを利用するためには、PHP 4.3.0 以降...
#br
プラグイン名に反してMD5以外のパスワードフォーマットも...
#br
md5のプラグインを呼び出すURLの中にパスワードを含める...
#br
このプラグインは PKWK_SAFE_MODE ないし PKWK_READONLY の設...
//---
** memo 記述した位置に複数行入力欄とボタンを表示します。...
''種別''
(コマンド)
ブロック型プラグイン
''重要度''
★☆☆☆☆
''書式''
''#memo''
''概要''
記述した位置に複数行入力欄とボタンを表示します。
ボタンを押下すると入力欄の記述内容を更新します。
''プラグイン内設定''
-- MEMO_COLS 編集欄の表示桁数
-- MEMO_ROWS 編集欄の表示行数
''備考''
[[insert>未分類プラグイン#insert]]プラグインや[[artic...
個人用のメモ代わりにPukiWikiを利用している場合、未整...
#br
ブラウザによっては、複数行入力欄の右下角に入力欄の大...
「つまみ」が表示されるかどうか?はブラウザによって異...
** menu 任意のページでブロック型プラグインとして使用する...
''種別''
ブロック型プラグイン
''重要度''
★★★★☆
''書式''
''#menu('' &color(blue){ページ名}; '')''
''概要''
デフォルトのスキンにて、ページの左側にメニュー用のペ...
#br
任意のページでブロック型プラグインとして使用すると、...
例えば通常はMenuBarを表示するサイトで、hogeというペー...
hogeというページに #menu(hogeMenu) と記述する事で実現...
#br
ソース中のMENU_ENABLE_SUBMENU をTRUEとすると、表示中...
メニューとして表示するようになります。
例えば FrontPage, MenuBar, hoge, fuga, hoge/MenuBar, ...
FrontPage、fuga、MenuBar では MenuBar がメニューとし...
hoge/MenuBar がメニューとして表示されます。
''引数''
メニュー用ページとして表示するページ名を指定します。
''プラグイン内設定''
-- MENU_ENABLE_SUBMENU サブメニューを使用するか
-- MENU_SUBMENUBAR サブメニューを使用する場合にメニュー...
''備考''
デフォルトのメニュー用ページをMenuBar以外のページとす...
#hr
* N [#n_]
** navi DocBook風ナビゲーションバーを表示します。 [#navi]
''種別''
ブロック型プラグイン
''重要度''
★★☆☆☆
''書式''
''#navi('' [&color(blue){目次ページ};] '')''
''概要''
DocBook風ナビゲーションバーを表示します。
目次となるページに下階層のページが存在する時、それら...
''引数''
目次ページに順番に見て回るページの上階層にあたるペー...
例えば hoge, hoge/1, hoge/2, hoge/3 というページが存...
ページで最初に呼び出した場合はヘッダイメージのリンク...
''プラグイン内設定''
-- PLUGIN_NAVI_EXCLUSIVE_REGEX 除外するページを正規表現...
-- PLUGIN_NAVI_LINK_TAGS <link>タグを出力するかどうか
** new 指定した日時が最近であった場合、最近更新された事...
''種別''
インライン型プラグイン
''重要度''
★★☆☆☆
''書式''
#br
''書式'''1:'''''
''&new('' [&color(blue){nodate};] ''){'' &color(b...
#br
''書式'''2:'''''
''&new('' [&color(blue){ページ名};] [,&color(blue...
''概要''
指定した日時が最近であった場合、最近更新された事を強...
標準では5日以内の場合に New を、1日以内の場合に New!...
''引数''
''書式'''1:'''''
日付文字列を指定した場合、その日時が規定の期間内であ...
-- nodate - 日付文字列を表示しません。省略時は表示します。
#br
''書式'''2:'''''
ページ名を指定した場合は、そのページの更新日時が規定...
ページ名末尾が/であった場合、そのページ名で始まるペー...
-- nolink - ページ名を表示しません。省略時はページ名(ペ...
''プラグイン内設定''
-- PLUGIN_NEW_DATE_FORMAT 表示フォーマット
''備考''
日付文字列は[[PHP関数:strtotime>http://jp2.php.net/ma...
** newpage ページを新規作成するか、新規作成するページ名...
''種別''
コマンド
ブロック型プラグイン
''重要度''
★★★★★
''書式''
''?plugin=newpage'' &color(blue){&page=ページ名}; &co...
''#newpage('' [&color(blue){ページ名初期値};] '')''
''概要''
ページを新規作成するか、新規作成するページ名の入力欄...
''引数''
コマンド''':'''
パラメータには新規作成するページのオプションを指定し...
#br
ページ名には新規作成するページ名を指定します。省略時...
#br
関連ページ名にはリンク元のページ名を指定します。新規...
#br
ブロック型プラグイン''':'''
#br
ページ名初期値には新規作成するページ名を入力する入力...
** norelated ページ下部に表示される関連ページのリンクを...
''種別''
ブロック型プラグイン
''重要度''
★★★☆☆
''書式''
''#norelated''
''概要''
ページ下部に表示される関連ページのリンクを非表示にし...
''備考''
極端に多くのページからリンクされていて関連リンクの表...
#hr
//---
* O [#o_]
** online 現在PukiWikiを参照している、おおよそのユーザー...
''種別''
ブロック型プラグイン
インライン型プラグイン
''重要度''
★★☆☆☆
''書式''
''#online''
''&online;''
''概要''
現在PukiWikiを参照している、おおよそのユーザー数を表...
ユーザー数は、プラグインを呼び出された時点で記録され...
''プラグイン内設定''
-- PLUGIN_ONLINE_TIMEOUT タイムアウトの秒数
-- PLUGIN_ONLINE_USER_LIST ユーザー情報を保存するファイル
-- PLUGIN_ONLINE_LIST_REGEX ユーザー情報取得用の正規表現
''備考''
ユーザー数のカウントはページ単位でなく、設置されたPuk...
* P [#p_]
** paint Javaアプレットで描いた絵を、そのページに添付し...
''種別''
(コマンド)
ブロック型プラグイン
''重要度''
★☆☆☆☆
''書式''
''#paint('' [&color(blue){幅};] [,&color(blue){高さ};...
''概要''
Javaアプレットで描いた絵を、そのページに添付します。
[[ば科学的愛情>http://www.geocities.co.jp/SiliconVall...
幅と高さに、デフォルトのキャンバスサイズを指定します...
''プラグイン内設定''
-- 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.ja...
//---
** pcomment 別のページにコメントを記録することができるco...
''種別''
(コマンド)
ブロック型プラグイン
''重要度''
★★★☆☆
''書式''
''#pcomment(''{ [&color(blue){コメント記録ページ};], ...
''概要''
別のページにコメントを記録することができるcommentプラ...
ラジオボタンを表示し、指定した部分にコメントを付ける...
''引数''
コメント記録ページ にはコメントを記録するページ名を指...
PLUGIN_PCOMMENT_PAGE で指定されたページにコメントが記...
指定したページが存在しなくても、最初にコメントを追加...
#br
表示件数 は表示する最新コメントの数を指定します。第1...
pcommentのデフォルト件数(通常10件。 PLUGIN_PCOMMENT_N...
表示件数は コメント記録ページ より後に指定して下さい...
コメント記録ページ に空白を指定します。(例: #pcommen...
#br
noname,nodate,above,below,reply でコメントの表示方法...
-- noname - 名前の入力欄を表示しません。
-- nodate - 日付を挿入しません。
-- above - 挿入したコメントをフォームの上に表示します。...
-- below - 挿入したコメントをフォームの下に表示します。...
-- reply - コメントの頭にラジオボタンを表示します。ある...
&br;
''プラグイン内設定''
&br;
-- PLUGIN_PCOMMENT_PAGE ページ名のデフォルト(%sに$vars['p...
-- 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ペー...
-- PLUGIN_PCOMMENT_TIMESTAMP コメントページのタイムスタン...
&br;
''備考''
更新が衝突したときは、予期せぬ場所にコメントが挿入さ...
aboveまたはbelowの設定にしたがって 一番前か一番後ろに...
#br
コメント記入後に表示されるページのタイトルに「(#pcomm...
実際に更新されたのはコメントを記録するページです。
#br
コメントを投稿しても、#pcommentが書かれたページは更新...
記録したページだけが更新として表示されます。
#br
コメントとして相対参照([ [../] ]など)を用いた場合は、...
意図したとおりに変換されない可能性があります。
#br
自動過去ログ化機能は PLUGIN_PCOMMENT_AUTO_LOG の件数 ...
の件数分のコメントを投稿した時に作動します。
//---
** popular 人気のある(参照回数の多い)ページの上位数件...
''種別''
ブロック型プラグイン
''重要度''
★★☆☆☆
''書式''
''#popular('' [[&color(blue){件数};] [,[&color(blue){...
''概要''
人気のある(参照回数の多い)ページの上位数件を表示し...
''引数''
件数には一覧の数を指定して下さい。省略時はPLUGIN_POPU...
対象外ページには、表示対象外とするページを正規表現で...
true, falseで、ページのカウント条件を指定します。省略...
-- true - 今日参照のあった回数順でページを表示します。
-- false - 通算の参照回数順でページを表示します。
&br;
''プラグイン内設定''
#br
-- PLUGIN_POPULAR_DEFAULT 件数未指定時の件数
&br;
''備考''
[[counter>未分類プラグイン#counter]]プラグインのカウ...
カウントの対象外となります。全てのページにcounterプラ...
counterプラグインをMenubarやスキンに設置するのが一般...
#hr
//---
* R [#r_]
** random ランダムなページへのリンクを表示するプラグイン...
''種別''
(コマンド)
#br
ブロック型プラグイン
#br
''重要度''
★☆☆☆☆
#br
''書式''
''#random('' [&color(blue){メッセージ};] '')''
#br
''概要''
ランダムなページへのリンクを表示するプラグイン。
#br
表示するページの候補は設置したページの下階層のページ...
#br
''引数''
メッセージにはリンクに表示する文字列を指定します。省...
備考
ブラウザの再読み込み対策はしていません。リロードされるた...
** read 指定したページを表示します。該当ページが存在しな...
''種別''
コマンド
#br
''重要度''
★★★★★
#br
''書式''
''?cmd=read'' &color(blue){&page=ページ名};
#br
''概要''
指定したページを表示します。該当ページが存在しない場...
#br
plugin=やcmd=が指定されていない場合に内部で暗黙に呼び...
#br
''引数''
ページ名には表示したいページ名を指定します。ページ名...
** recent 最近更新されたページのうち、最新の数件を表示し...
''種別''
ブロック型プラグイン
#br
''重要度''
★★★★★
#br
''書式''
''#recent('' [&color(blue){件数};] '')''
''概要''
最近更新されたページのうち、最新の数件を表示します。
#br
''引数''
件数には表示件数を指定します。省略時はプラグイン内設...
#br
''プラグイン内設定''
#br
-- PLUGIN_RECENT_DEFAULT_LINES 件数未指定時の件数
-- PLUGIN_RECENT_CACHE RecentChangesのキャッシュの場所
-- PLUGIN_RECENT_USAGE 引数未指定時に表示されるヘルプ
** ref '#attach'でページに添付されたファイルを指定位置に...
''種別''
ブロック型プラグイン
インライン型プラグイン
#br
''重要度''
★★★★☆
#br
''書式''
''#ref('' &color(blue){添付ファイル名};| &color(blue)...
#br
&ref( &color(blue){添付ファイル名};| &color(blue)...
#br
''概要''
'[[#attach>未分類プラグイン#attach]]'でページに添付さ...
#br
''引数''
添付ファイル名にはページに添付したファイル名を指定し...
#br
ページ名にはファイルを添付したページをWikiNameかBrack...
#br
パラメータにはファイルの展開方法を指定できます。
#br
-- left|center|right - 表示時の位置を指定します。省略時...
-- wrap|nowrap - テーブルタグで囲む/囲まないの指定を行い...
-- around - テキストの回り込みを可能とします。省略時は回...
-- noicon - ファイルが画像以外の場合に表示されるアイコン...
-- noimg - ファイルが画像の場合に画像を展開しないように...
-- nolink - 元ファイルへのリンクを張らないようにします。...
-- zoom - 縦横比を保持します。省略時はサイズ指定に従いま...
-- 999x999 - サイズを指定します(幅x高さ)。省略時は拡大率...
-- 999% - サイズを指定(拡大率)します。省略時は100%です、
-- タイトル - 上記以外のパラメータは画像の代替文字列、リ...
&br;
''プラグイン内設定''
#br
-- 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 添付ファイルの画像表示で UPL...
&br;
''備考''
aroundで行った回り込み指定を解除するには clearプラグ...
#br
"ほげ"という別ページの添付ファイル"fuga.jpg"をインラ...
#br
(1) &ref(ほげ/fuga.jpg);
(2) &ref(fuga.jpg,[[ほげ]]);
上記2通りの記述のうち、(2)の記述方式は旧バージョンと互換...
いずれの記述方法であっても一般的な動作は同じですが、いわ...
(1) [[&ref(ほげ/fuga.jpg,nolink,ウェブ名);>ウェブのURL]]
(2) [[&ref(fuga.jpg,[[ほげ]],nolink,ウェブ名);>ウェブの...
(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)はエラーとなり...
(7) &ref(fuga.jpg);
(7)は(6)と似た記述ですが、添付ファイル名の次の引数が省略...
** referer ページを照会した利用者の参照元URL(Referer)の...
''種別''
コマンド
#br
''重要度''
★★★☆☆
#br
''書式''
''?plugin=referer'' [&color(blue){&page=ページ名};] [...
#br
''概要''
ページを照会した利用者の参照元URL(Referer)の一覧を表...
#br
''引数''
ページ名にはRefererを表示するページ名を指定します。ペ...
#br
sortでReferer一覧のソート順を指定します。
#br
-- 0d - 最終更新日時(新着順)
-- 0a - 最終更新日時(日付順)
-- 1d - 初回登録日時(新着順)
-- 1a - 初回登録日時(日付順)
-- 2d - カウンタ(大きい順)
-- 2a - カウンタ(小さい順)
-- 3 - Referer
&br;
''プラグイン内設定''
#br
-- CONFIG_REFERER 無視するURIを指定したページ
&br;
''備考''
pukiwiki.ini.php で、Refererを使用する設定($referer =...
** related 対象のページを参照しているページの一覧を表示...
''種別''
コマンド
#br
擬似ブロック型プラグイン
#br
''重要度''
★★★☆☆
#br
''書式''
''?plugin=related'' [&color(blue){&page=ページ名};]
#br
''#related''
''概要''
対象のページを参照しているページの一覧を表示します。
#br
''引数''
ブロック型で実行時、設置したページが対象となります。
#br
コマンドで実行時、ページ名に対象となるページを指定で...
** rename 既存ページの名前を変更します。実行には管理者権...
''種別''
コマンド
#br
''重要度''
★★★☆☆
#br
''書式''
''?plugin=rename'' [&color(blue){&refer=ページ名};]
''概要''
既存ページの名前を変更します。実行には管理者権限が必...
#br
ページの本文のほか、指定されたページ名の差分、バック...
#br
''引数''
ページ名には変更するページの名前を指定します。省略時...
#br
実行結果は変換結果のページ(PLUGIN_RENAME_LOGPAGE で...
#br
''プラグイン内設定''
#br
-- PLUGIN_RENAME_LOGPAGE ページ名の変換結果を出力するペ...
''備考''
ページ内のリンクの書き換えは行ないません。yetlistなど...
#br
TrackBackやRefererの情報は更新されません。
#br
リネーム対象のページが凍結されているかどうかはチェッ...
#br
関連ページにリネーム対象の文字列が複数含まれていると...
#br
-- たとえば、hogeおよびhoge/hogeという二つのページがあっ...
** ruby 文字列にルビをふります。 [#ruby]
''種別''
インライン型プラグイン
#br
''重要度''
★☆☆☆☆
#br
''書式''
''&ruby('' &color(blue){ルビ}; ''){'' &color(blue...
''概要''
文字列にルビをふります。
#br
''引数''
ルビには表示するルビを指定します。
#br
対象文字列にはルビがふられる文字列を指定します。
#br
''プラグイン内設定''
#br
-- PLUGIN_RUBY_USAGE 引数未指定時に表示されるヘルプ
&br;
''備考''
XHTML 1.1のルビに対応したブラウザでないと、ルビとして...
#br
ルビに対応していないブラウザではルビをふる文字列の直...
#hr
//---
* S [#s_]
** search 検索文字列の入力フォームを表示し、 指定した文...
''種別''
コマンド
#br
ブロック型プラグイン
#br
''重要度''
★★★★★
#br
''書式''
''?cmd=search''{ [&color(blue){&word=検索文字列};] [&...
''#search''
#br
''概要''
検索文字列の入力フォームを表示し、 指定した文字列を含...
#br
''引数''
パラメータには検索条件を指定します。
#br
-- word - 検索する文字列を指定します。省略時は検索条件を...
-- type - 'OR' 指定時、OR検索を行います。省略時はAND検索...
&br;
''プラグイン内設定''
&br;
-- PLUGIN_SEARCH_DISABLE_GET_ACCESS GETメソッドによる検...
-- PLUGIN_SEARCH_MAX_LENGTH 検索する文字列として指定可能...
- ''#search 検索フォーム設置例示''
#search
** setlinebreak 入力文章中の改行を改行とみなすかどうかの...
''種別''
ブロック型プラグイン
''重要度''
★☆☆☆☆
''書式''
''#setlinebreak('' [&color(blue){on};|&color(blue){of...
''概要''
入力文章中の改行を改行とみなすかどうかの設定を行いま...
PukiWikiが入力文章中の改行をどのように扱うかはpukiwik...
|BGCOLOR(#D0D6DF):入力文章|BGCOLOR(#D0D6DF):$line_break=0...
|BGCOLOR(#EFF4FF):|BGCOLOR(#EFF4FF):|BGCOLOR(#EFF4FF):|c
|文章1&br;文章2|文章1文章2|文章1&br;文章2|
setlinebreakプラグインは該当ページの以降の行に関して...
''引数''
パラメータには以降の改行の扱いを指定します。 パラメー...
--on - 以降の文章で段落内の改行を改行とみなします($line_...
--off - 以降の文章で改行を無視します($line_break=0と同様...
--default - 改行の扱いをそのサイトの$line_break設定に戻...
** size 文字の大きさを指定します。 [#size]
''種別''
インライン型プラグイン
#br
''重要度''
★★★☆☆
#br
''書式''
''&size('' &color(blue){ピクセル数値}; ''){'' &co...
#br
''概要''
文字の大きさを指定します。
#br
''引数''
ピクセル数値には文字の大きさを指定します。
#br
文字列は文字の大きさを変更する文字列を指定します。
#br
''プラグイン内設定''
#br
-- PLUGIN_SIZE_MAX 引数として指定可能な最大文字サイズ
-- PLUGIN_SIZE_MIN 引数として指定可能な最小文字サイズ
-- PLUGIN_SIZE_USAGE 引数未指定時に表示されるヘルプ
** source 指定したページの整形前のソースを表示します。 [...
''種別''
コマンド
#br
''重要度''
★☆☆☆☆
#br
''書式''
''?cmd=source'' &color(blue){&page=ページ名};
#br
''概要''
指定したページの整形前のソースを表示します。
#br
''引数''
ページ名にはソースを表示するページ名を指定します。ペ...
#hr
//---
** 横分割 include(splitinclude) それぞれのページ内容を3...
''#splitinclude(''[&color(blue){ページ名1};],[&color...
と指定することで、それぞれのページ内容を横に並べて表示す...
ページ名は,区切りで3つまで指定することができます。
閲覧者にとって読み込み権限のあるページのみ動作します。
#br
ページ名は省略できません。
* T [#t_]
** tb TrackBackの一覧を表示します。 [#mdc27273]
[#tb]
''種別''
コマンド
#br
''重要度''
★☆☆☆☆
#br
''書式''
''?plugin=tb'' &color(blue){&tb_id=TrackBackID &__mod...
#br
''概要''
TrackBackの一覧を表示します。
#br
POSTされた場合は他サイトからのTrackBackに反応します。
#br
''引数''
&tb_idには表示対象ページのTrackBackIDを指定します。
#br
&__modeには一覧表示方法を指定します。
#br
-- view - 人間が見やすい形式で表示します。
-- rss - RSS形式で表示します。
&br;
''プラグイン内設定''
#br
-- PLUGIN_TB_LANGUAGE TrackBackのRSSで出力する言語
-- PLUGIN_TB_ERROR エラー時の返り値
-- PLUGIN_TB_NOERROR エラーなし時の返り値
&br;
''備考''
pukiwiki.ini.php で、TrackBackを使用する設定($trackba...
** template 既存のページをテンプレートとしてページを新規...
''種別''
コマンド
#br
''重要度''
★★★★☆
#br
''書式''
''?plugin=template'' &color(blue){&refer=テンプレート...
#br
''概要''
既存のページをテンプレートとしてページを新規作成しま...
#br
ページの新規作成時の雛形とするページの読込み機能との...
#br
''引数''
テンプレートページには雛形とするページを指定します。...
#br
''プラグイン内設定''
#br
-- MAX_LEN 雛形の開始/終了位置を指定する欄で表示される...
#aname(topicpath)
** topicpath パンくずリスト(topicpath)と呼ばれる、ページ...
''種別''
インライン型プラグイン
ブロック型プラグイン
''重要度''
★☆☆☆☆
''書式''
&topicpath;
#topicpath
''概要''
パンくずリスト(topicpath)と呼ばれる、ページの階層表現...
パンくずリスト(Topic path)は現在参照しているウェブ...
[[Top>FrontPage]]/[[PukiWiki>PukiWiki]]/[[ツアー>PukiWik...
基本的には以下の2通りの使い方を想定しています。
i.「ほげ/ふが/げほ」など、2~3階層以上の深いページ...
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_DEF...
** ツールチップ(tooltip) マウスをあわせるとツールチップ...
&tooltip(単語){説明文};
と入力することでマウスをあわせるとツールチップを表示しま...
利用例)
Mercurialは分散型&tooltip(SCM){Source Code Management; ...
と入力すると
Mercurialは分散型&tooltip(SCM){Source Code Management; バ...
と表示します。
** touchgraph TouchGraphWikiBrowser用のインデックスを作...
''種別''
コマンド
#br
''重要度''
★☆☆☆☆
#br
''書式''
''?plugin=touchgraph''
''概要''
TouchGraphWikiBrowser用のインデックスを作ります。
** tracker [#tracker]
''種別''
(コマンド)
#br
ブロック型プラグイン
#br
''重要度''
★★★★☆
#br
''書式''
''#tracker('' [&color(blue){定義名};] [,&color(blue){...
#br
''概要''
[[bugtrack>未分類プラグイン#bugtrack]]プラグインのよ...
#br
入力項目が固定されている[[bugtrack>未分類プラグイン#b...
FAQ,BBS,書評,TODOリストなど使い道はアイディア次第...
#br
入力項目の定義は:config/plugin/tracker/ 以下に所定の...
[[bugtrack>未分類プラグイン#bugtrack]]プラグイン互換...
#br
''引数''
定義名は #tracker(hoge) のようにtrackerのテンプレート...
#br
テンプレート名に続けてフォーム名 / リスト名を指定する...
ひとつのテンプレートに複数のフォーム形式 / リストフォ...
例えば、#tracker(hoge/form_alternative) とすれば
:config/plugin/tracker/hoge/form_alternative の内容を...
#tracker_list(hoge/list_alternative) とすれば :config...
#br
ベースページ名はフォームから作成されるページの親階層...
#br
''プラグイン内設定''
#br
-- TRACKER_LIST_EXCLUDE_PATTERN tracker_listで表示しない...
-- TRACKER_LIST_SHOW_ERROR_PAGE 項目の取り出しに失敗した...
&br;
''テンプレート''
#br
テンプレートは基本的に設置するtracker毎に1組(4ペー...
#br
-- :config/plugin/tracker/hoge
hogeテンプレートの項目の内容を記述します。
&br;
-- :config/plugin/tracker/hoge/form
入力フォームの項目とレイアウトを記述します。
&br;
-- :config/plugin/tracker/default/page
入力した内容をページ化する際のフォーマットを記述します。
&br;
-- :config/plugin/tracker/hoge/list
tracker_listで表示するリストのレイアウトを記述します。テ...
&br;
''予約項目''
#br
-- form で使用できる予約項目
--- [_name] : 記事を記録するページ名を入力するフィールド...
--- [_submit] : [追加]ボタンを表示。
-- page / list で使用できる予約項目
--- [_date] : 投稿日時。
--- [_page] : 実際に生成したページ名。ブラケットが付く。
--- [_refer] : #trackerを置いたページ。
--- [_base] : ページのプレフィクス。 tracker()/tracker_li...
--- [_name] : formの [_name] の内容そのもの。記事を記録す...
--- [_real] : 実際に生成したページ名から、[_refer] + '/'...
・formに [_name] フィールドがない。
・[_name] が空か、ページ名として無効な文字を含む。
・[_refer] / [_name] という名前のページがすでに存在する。
-- list で使用できる予約項目
--- [_update] : ページの最終更新日時。
--- [_past] : 最終更新日時からの経過。
** tracker_list [#tracker_list]
''種別''
(コマンド)
#br
ブロック型プラグイン
#br
''重要度''
★★★★☆
#br
''書式''
''#tracker_list('' [&color(blue){定義名};] [,[&color(...
#br
''概要''
[[tracker>未分類プラグイン#tracker]]プラグインで作成...
#br
''引数''
定義名は[[tracker>未分類プラグイン#tracker]]プラグイ...
省略時は :config/plugin/tracker/default が指定された...
#br
ベースページ名は[[tracker>未分類プラグイン#tracker]]...
[[tracker>未分類プラグイン#tracker]]プラグインでベー...
省略時は設置したページとなります。
#br
第3項目には一覧表示のソートに使う項目およびソート順...
#br
表示上限は一覧表示するページ数の上限を指定します。省...
#hr
//---
* V [#v_]
** vote 選択肢と投票数と投票ボタンが並んだ簡易投票フォー...
''種別''
コマンド
#br
ブロック型プラグイン
#br
''重要度''
★★☆☆☆
#br
''書式''
''#vote('' &color(blue){選択肢1};[&color(blue){選択肢...
''概要''
選択肢と投票数と投票ボタンが並んだ簡易投票フォームを...
#br
''引数''
選択肢1~nに投票項目を指定します。投票項目に続けて半...
#br
''備考''
''各選択肢の投票数''は編集によって容易に改竄できるた...
#br
※ページを凍結していても動作可能です。凍結した場合には...
#br
''使用例''
#vote( 選択肢1[選択肢1の投票数] [[0],選択肢2[選択肢2の投...
#hr
//---
* Y [#y_]
** yetlist まだ作られていないページを一覧表示します。 [#...
''種別''
コマンド
#br
''重要度''
★★☆☆☆
#br
''書式''
''?plugin=yetlist''
''概要''
まだ作られていないページを一覧表示します。
#br
まだ作られていないページとは、既存のページでWikiName...
#br
''備考''
自分以外の誰かがページを書くかもしれないという点は非...
ページ名: