このページは PukiWiki Plus!で追加されたプラグインのマニュアルです。
addline
- 種別
- (コマンド)
ブロック型プラグイン
インライン型プラグイン
- 重要度
- ★★☆☆☆
- 書式
- #addline(
[設定名] {, [above|below|up|down|btn:[ボタン名]|ltext:[左テキスト]|rtext:[右テキスト]]}
)
&addline(
[設定名] {, [before|after|above|below|up|down]}
){
[リンク名]
};
- 引数
- 設定名: 「:config/plugin/addline/設定名」の指定
- above|below|up|down: #comment と同じで、追加するのがボタンの上か下かの指定
- btn: submitボタンに付ける名前
- ltext,rtext: submitボタンの左右につけるテキスト
- before,after: インライン型の場合に、追加するのがリンクの前(左)か後(右)の指定
- 概要
- ボタンやリンクを押すと、設定ページで指定した文字列を行単位でします。
インライン型は同じ行内での文字列単位で追加も可能。
ボタンやリンクの表記も変更可。
- 作者
- sha
adsense
- 種別
- (コマンド)
ブロック型プラグイン
- 重要度
- ★☆☆☆☆
- 書式
- #adsense(
[999x999] {, [text|image]}
)
- 概要
- Google AdSense 広告を表示します。表示サイズは推奨サイズを入れてください。
- 引数
- パラメータには広告サイズを指定できます。
- 999x999 − サイズを指定します(幅x高さ)。省略時はデフォルトのサイズに従います。
- プラグイン内設定
- GOOGLE_ACCOUNT AdSenseのアカウントを記述します。
- GOOGLE_DEF_W サイズが取得できないときのデフォルトサイズ(幅)
- GOOGLE_DEF_H サイズが取得できないときのデフォルトサイズ(高さ)
- GOOGLE_DEF_TYPE デフォルトの場合の表示タイプ
- 備考
- Google Adsense は JavaScriptを使用します。
- 作者
- みこ(Miko's Cafeterrace)
attachref
- 種別
- (コマンド)
ブロック型プラグイン
- 重要度
- ★★☆☆☆
- 書式
- &attachref(
[添付ファイル名] [, {refの引数 }{, button }]}
){
[ボタン名]
};
- 引数
- button − <form></form>のsubmitボタン表示。デフォルトでは[添付]文字列によるリンク表示。リンクもボタンも、表示する文字列は<ボタン名>で変更可。
- 概要
- 添付ファイルが存在しているときは ref と同じ動作をします。添付ファイルが存在していないときは画面に [添付] リンクが存在して、それを押すと、アップロードフォーマットが出現して、そこでファイルをアップロードすると、[添付]リンクのあった場所に&ref(...);してくれます。
- 作者
- sha
backup
- 種別
- (コマンド)
ブロック型プラグイン
- 重要度
- ★★★★★
- 書式
- #backup(
{[source|nowdiff|visualdiff]}
{, [nolabel|label]}
)
- 概要
- ページの更新履歴を表示します。また、ブロック型プラグインの場合は履歴のコンボボックスを表示して選択すると、その差分を表示します。(コマンド型の差分については PukiWiki/1.4/マニュアル/プラグイン/bを参照してください。)
- 引数
- ブロック型プラグインのパラメータには表示方法を指定できます。
- source − 選択した履歴のソースを表示する機能を持つコンボボックスを表示します。
- nowdiff − 選択した履歴と現在のソース差分を表示する機能を持つコンボボックスを表示します。
- visualdiff − 選択した履歴と現在のソース差分をビジュアル表示する機能を持つコンボボックスを表示します。
- nolabel − コンボボックスのラベルを非表示にします。
- label − コンボボックスのラベルを表示します。(現在は "Version:" です。)
- 備考
- JavaScriptを使用します。
- 作者
- みこ(Miko's Cafeterrace)
button
- 種別
- インライン型プラグイン
- 重要度
- ★☆☆☆☆
- 書式
- &button(
[ボタン名]
);
- 概要
- プッシュボタンを表示します。ボタンを教えても何も動作はありません。主に操作マニュアルなどで使用します。
- 作者
- reimy
code
r0.5.0 用マニュアル
概要
プログラムのソースコードの中に含まれるキーワードとコメントを色分けして表示します。
- 種別
- コマンド
ブロックプラグイン
対応言語は
アセンブリ言語(gas, Renesus H8/300, Z80),
Ada, Altera HDL, ASP/VBS(Microsoft VBScript Web Content), AviSynth, AWK,
BASIC, bash, C/C++, C#, CSS, D, Delphi, Fortran
gnuplot ,Haskell, Hercles, HSP, HTML, Java, JSP(Java Server Pages), JavaScript, Lisp,
Matlab, MS-DOS, Octave, Pascal, Perl, PHP, PL/I, Prolog, PostScript,
PukiWiki, Python, Ruby, Scheme, Scilab, SQL, TeX, Tcl,
Visual Basic, Verilog HDL, VHDL
です
(アルファベット順)。
このプラグインの開発関係者
ダウンロード
http://briefcase.yahoo.co.jp/sky20050724/
内のcode_0_5_0
インストール
使い方
書式
#code[([言語名] {,[menu|nomenu], [number|nonumber], [outline|nooutline], [icon|noicon]}, ファイル名)|)]{{
ソースコード
}}
?plugin=code &page=ページ名
言語名
指定可能な"言語名"は次の表に挙げたものです。
大文字・小文字は問いません。
省略した場合はプラグインで予め設定された言語でハイライトされます。
デフォルトではハイライトされません。
"言語名"とプログラム言語の対応は以下のようになっています。
プログラム言語 | Ada? | AWK? | BASIC? | bash? | C/C++? | C#? | D? | Delphi? | Fortran? | Haskell? |
"言語名"(引数名) | Ada | AWK | BASIC | bash | C | Csharp | D | Delphi | fortran | haskell |
| | | | | | | | | | |
プログラム言語 | HSP? | Java? | JSP? | JavaScript? | Lisp? | MS-DOS? | Pascal? | Perl? | php? | PL/I? |
"言語名"(引数名) | HSP | java | jsp | javascript | Lisp | dosbatch | Pascal | Perl | php | PLI |
| | | | | | | | | | |
プログラム言語 | Prolog? | PostScript? | Python? | Ruby? | Scheme? | TCL? | Visual Basic? | ASP/VBS? | | SQL? |
"言語名"(引数名) | prolog | ps | Python | Ruby | Scheme | tcl | vb | vbscript | | SQL |
| | | | | | | | | | |
言語 | diff? | make? | | | | | | | | |
"言語名"(引数名) | diff | make | | | | | | | | |
| | | | | | | | | | |
プログラム言語 | AviSynth? | gnuplot? | Matlab? | Octave? | Scilab? | | | | | |
"言語名"(引数名) | avisynth | gnuplot | Matlab | octave | Scilab | | | | | |
| | | | | | | | | | |
プログラム言語 | Altera HDL | Verilog HDL? | VHDL? | Hercules | | アセンブラ(gas) | アセンブラ H8/300 | | アセンブラ Z80 | |
"言語名"(引数名) | AHDL | Verilog | VHDL | hercules | | asm | asmh8300 | | asmz80 | |
| | | | | | | | | | |
言語 | Apatch-ANT? | CSS? | HTML? | PukiWiki? | TeX? | | | | | |
"言語名"(引数名) | ant | CSS | HTML | PukiWiki | TeX | | | | | |
ページに記述
#code[(言語名, オプション)]{{
ソースコード
}}
ファイル取り込み
#code([言語名] [,オプション],ファイル名)
#code([言語名] [,オプション],URL)
デフォルトではURLによる指定を禁止しています。
オプション
オプションは複数指定する事が出来ます。
順序は問いません。
オプションは無くても動作します。その場合はデフォルトの動作になります。
- menu / nomenu
- アウトライン制御*1メニューの表示
- number / nonumber
- 行番号の表示
- outline / nooutline
- アウトラインモード*2。
- icon / noicon
- ファイル名の先頭のアイコン
- link / nolink
- オートリンク
それぞれ no が付く場合は無効。
付かない場合は有効です。
初期状態では全てのオプションが有効になっています。
デフォルトの状態を変更するにはファイル code.inc.php の
11行以降の部分のdefine文を変更して下さい。
- 言語を変更する場合は11行目の"pre"を引数に利用可能な言語名に変更して下さい。
- オプションの設定を変更するにはTRUEに
なっている部分をFALSEに変更して下さい。
define("PLUGIN_CODE_LANGUAGE", 'pre'); // 標準言語
// 標準設定
define("PLUGIN_CODE_NUMBER", TRUE); // 行番号
define("PLUGIN_CODE_OUTLINE", TRUE); // アウトライン
define("PLUGIN_CODE_MENU", TRUE); // メニューの表示/非表示;
define("PLUGIN_CODE_FILE_ICON", TRUE); // 添付ファイルにダウンロードアイコンを付ける
コマンド
コマンドとしてURLを指定して呼び出します。
http://pukiwiki.example.com/index.php?cmd=code&page=FrontPage
「http://pukiwiki.example.com/index.php」はPukiWikiが設置されたURL、
「&page=」の後の「FrontPage」はページ名を指定して下さい。
ちょっと便利に
InterWikiNameのページに次のような項目を作ります。
[./?cmd=code&page= code] euc
InterWikiNameで次のように指定するとハイライト表示されたソースへのリンクが出来ます。
[[code:FrontPage]]
参考 : dev:PukiWiki/1.4/ちょっと便利に/ソース表示アンカーを設置する
備考
ライセンス : GPL
PHPのハイライトはHTMLファイルに埋め込まれているのでCSSでは定義できません。
アウトラインモード
JavaScriptを使用します。(r0.3.1では tree でした)
NetScape4系列では動作しません。
アウトラインモードが有効な言語は
AWK, C/C++, CSS, C#, D, HSP, Java, JavaScript, JSP, Lisp, MS-DOS, Perl, PL/I, PostScript, Scheme, SQL, TCL
です。
引用元
次の2つのサイトにあったハイライトを元にしています。
このPluginに関する質問はこのページでお願いします。
現行版はコードが別の物に置き換わっています。
それぞれのサイトで尋ねないようにしてください。
サンプル
サンプル表示
pre
- 種別
ブロックプラグイン
- 書式
#pre{{
文章
}}
#pre(ファイル名)
- 概要
- 整形済出力(pre)
- 備考
- code.inc.phpのオプション
ダウンロード
http://briefcase.yahoo.co.jp/sky20050724/
内のcode_0_5_0
pre.inc.phpはcodeに同梱されています。
インストール
- code.inc.phpをインストール?します。
- code_0_5_0.tgz内の plugin/pre.inc.phpを
プラグインディレクトリ (デフォルトで pukiwiki/plugin) に置きます。
使い方
書式
#pre[(,[color, background-color], [number|nonumber], [soft|hard], [icon|noicon], [begin-end|begin...end]}, ファイル名)|)]{{
ソースコード
}}
ページに記述
#pre[(オプション)]{{
ソースコード
}}
ファイル取り込み
#pre([オプション],ファイル名)
#pre([オプション],URL)
デフォルトではURLによる指定を禁止しています。
オプション
オプションは複数指定する事が出来ます。
順序は問いません。
オプションは無くても動作します。その場合はデフォルトの動作になります。
- number / nonumber
- 行番号の表示
- icon / noicon
- ファイル名の先頭のアイコン
- soft
- インライン展開有効
- hard
- インライン展開をしないでそのまま表示
それぞれ no が付く場合は無効。
付かない場合は有効です。
注意:verbatim / noverbatim のオプションはインライン展開を抑制するオプション名としては
相応しくないと思いますのでYukiWIkiのバーベイタム
に合わせて hard / softに変更しました。
デフォルトの状態を変更するにはファイル pre.inc.php
のdefineを変更して下さい。
- オプションの設定を変更するにはfalseに
なっている部分をtrueに変更して下さい。
// 標準設定
define("PLUGIN_PRE_NUMBER", false); // 行番号
define('PLUGIN_PRE_VERBATIM', true); // インライン展開をしない
define('PLUGIN_PRE_FILE_ICON', true); // 添付ファイルにダウンロードアイコンを付ける
読み込み範囲指定
読み込み範囲を指定する方法は次の2つがあります。
開始行-終了行
開始行...終了行
- 例
- 3行から10行までは次のように入力します。
3-10
3...10
色指定
文字色と背景色を変更するにはCSSで指定可能な色を入力してください。
始めに入力された色が文字色、2番目に入力された色が背景色として設定されます。
lastmod
- 種別
- (コマンド)
インライン型プラグイン
- 重要度
- ★★☆☆☆
- 書式
- &lastmod(
[{[ページ名]}]
);
- 概要
- 該当するページの最終更新日時を表示します。ページ名を省略すると、現在表示しているページの最終更新日時を表示します。
- 備考
- 本来は、このプラグインは本家の「整形ルール」に記述されているのですが、未だに実装されていないので、Plus!で実装しています。
- 作者
- みこ(miko's cafeterrace)
mediaplayer
- 種別
- (コマンド)
ブロック型プラグイン
- 重要度
- ★☆☆☆☆
minicalendar
- 種別
- (コマンド)
ブロック型プラグイン
- 重要度
- ★★★☆☆
- 書式
- #minicalendar(
[{[ページ名|*],
[yyyymm],
[off]}]
)
- 概要
指定した位置にカレンダーを設置します。表示月のとなりに表示されたリンク(<< および >>)を選択することで先月/次月分のカレンダーを表示できます。カレンダー上でyyyy/mm/ddという日付を選択すると、ページ名/yyyy-mm-ddというページを表示できます。当日分のページが作成されていた場合、カレンダーの右隣に当日分のページ内容を表示します。
- 引数
ページ名で表示するページの上位階層のページを指定できます。ページ名を省略すると設置したページのページとなります。ページ名に*を指定すると上位階層のページはなし(表示するページ名がyyyy-mm-dd)となります。
yyyymmで表示するカレンダーの西暦と月を指定できます。省略時は当日の年月となります。
offを指定時、当日分ページを表示する機能は抑制されます。省略時は当日分のページを表示します。
- 備考
calender_editで作成したページはページ名/yyyymmddとなり、calender2で作成したページはページ名/yyyy-mm-ddとなるため、注意が必要です。
- 作者
- みこ(miko's cafeterrace)
minicalendar_viewer
- 種別
- (コマンド)
ブロック型プラグイン
- 重要度
- ★★★☆☆
- 書式
- #minicalendar_viewer(
ページ名,
yyyy-mm|
n|
x*y|
this
[,[past|pastex|future|futureex|view]
[,年月日表示の区切り文字]]
)
- 概要
calendarプラグイン、calendar2プラグイン、minicalendarプラグインで作成されたページを指定した位置に表示します。
- 引数
ページ名はcalendarプラグインまたはcalendar2プラグインを設置しているページの名前を指定します。ページ名はWikiNameまたはBracketNameで指定します。
yyyy-mmを指定時、指定した年月のページを表示します。
数字を指定時、指定した件数分のページを表示します。
x*yを指定時、先頭より数えて x ページ目(先頭は0)から、y件づつ一覧表示します。x と yはいずれも数値です。
thisを指定時、今月のページを一覧表示します。
past、pastex、future、futureex、viewで表示するページの条件を指定します。省略/無指定時はpastとなります。
- past − 今日以前のページを表示します。
- pastex − 今日以前のページを表示します。(今日を含みません)
- future − 今日以降のページを表示します。
- futureex − 今日以降のページを表示します。(今日を含みません)
- view − 過去から未来へ一覧表示します。
年月日の区切り文字は-や/などを指定します。省略した場合は-になります。
- 備考
minicalendarプラグインでは今日の日付の記事がない場合、記事を表示しないため、午前0時になったとたんに記事が表示されなくなるという弱点がありました。minicalendar_viewerはその弱点を補うために開発されたプラグインです。minicalendar_viewは、日付が変わっても最新の記事を表示することができます。カレンダーそのものの表示はminicalendar(off)で行ないます。
- 作者
- みこ(miko's cafeterrace)
msearch
- 種別
- コマンド
- 重要度
- ★★★☆☆
- 書式
./?plugin=msearch&site=<site>&type=<type>&order=<order>&word=<word>
- 概要
- メニューバー(画面左)を非表示にします。
- 備考
- 複数のPukiWikiサイトを一度に検索し、その結果をマージして表示します。
検索結果は、ファイルの経過時間順(デフォルト)を最新のものから順に表示します。
- 作者
- sha
nomenubar
- 種別
- ブロック型プラグイン
- 重要度
- ★☆☆☆☆
- 書式
- #nomenubar
- 概要
- メニューバー(画面左)を非表示にします。
- 備考
- メニューバーを隠してでも画面を広く使いたい場合や、メニューバー(画面左)表示が目障りである場合などに利用します。
- 作者
- みこ(miko's cafeterrace)
nosidebar
- 種別
- ブロック型プラグイン
- 重要度
- ★☆☆☆☆
- 書式
- #nomenubar
- 概要
- サイドバー(画面右)を非表示にします。
- 備考
- サイドバー(画面右)を隠してでも画面を広く使いたい場合や、サイドバー(画面右)表示が目障りである場合などに利用します。
- 作者
- みこ(miko's cafeterrace)
null
- 種別
- インライン型プラグイン
- 重要度
- ★☆☆☆☆
- 書式
- &null{
[文字列]
};
- 概要
- 文字列はすべてコメント扱いとなり表示されなくなります。
partedit
- 種別
- ブロック型プラグイン
- 重要度
- ★★☆☆☆
- 書式
- #partedit(
[ on | off | default ]
)
- 引数
引数 | 説明 | 省略時 |
on | 見出し編集を有効にします | default |
off | 見出し編集を無効にします | default |
default | 見出し編集をサイト初期値にします | |
- 概要
- 見出し編集の有効・無効は見出しアイコン(鉛筆マーク)で判別できます。
qrcode
- 種別
- (コマンド)
インライン型プラグイン
- 重要度
- ★☆☆☆☆
- 書式
- &qrcode(
サイズ,訂正方法,バージョン,分割数
){
[バーコード化する文字列]
};
- 引数
引数 | 説明 | 省略時 |
サイズ | バーコードの最小ピクセル | 1 |
訂正方法 | 訂正コードのレベルです(N/M/H/Q) | M |
バージョン | 使用するQRコードのバージョン(1〜10) | 0(自動判別) |
分割数 | 連結機能を使用する場合の分割数 | 1(分割しない) |
文字列 | バーコード化する文字列 | 省略不可 |
- 概要
- 指定した文字列のQRコードを作成します。QRコードはSHIFT-JISで記載されます。
- プラグイン内設定
- QRCODE_DATA_DIR qrcodeプラグインがデータファイルを置くディレクトリ
- 備考
- 上記 QRCODE_DATA_DIR に必ず qrcode データをいれるのを忘れないでください。このプラグインが何の役にも立たなくなります。
PukiWiki Plus!で添付しているプラグインです。(本家でも使用できます。)
- 作者
- みこ(Miko's Cafeterrace)
replace
- 種別
- コマンド
- 重要度
- ★★★☆☆
- 書式
- cmd=replace
- 概要
- 指定した文字列を置換します。大文字小文字(および記号)はすべて区別します。
- 備考
- 一応、PukiWikiのバックアップ機能を利用したバックアップはおこなっていますが、取り扱いに十分注意してください。また、不用意なミスを防ぐためにリリース時の管理者パスワードでは、このプラグインは使用できないようになっています。
- 作者
- みこ(miko's cafeterrace)
side
- 種別
- ブロック型プラグイン
- 重要度
- ★★★☆☆
- 書式
- #side(
ページ名
)
- 概要
デフォルトのスキンにて、ページの右側に右メニュー用のページ(SideBar)を表示するために内部的に使用されています。
任意のページでブロック型プラグインとして使用すると、引数に指定したページをメニュー用ページに指定できます。
例えば通常はSideBarを表示するサイトで、hogeというページだけはSideBarの代わりにhogeMenuというページを表示したい場合、hogeというページに #side(hogeMenu) と記述する事で実現できます。
ソース中のSIDE_ENABLE_SUBMENU をTRUEとすると、表示中のページの上位階層のSideBarか、同階層にあるSideBarページをメニューとして表示するようになります。
例えば FrontPage, SideBar, hoge, fuga, hoge/SideBar, hoge/hoge というページが存在する場合は、FrontPage、fuga、MenuBar では SideBar がメニューとして表示され、hoge, hoge/SideBar, hoge/hogeでは hoge/SideBar がメニューとして表示されます。
- 引数
メニュー用ページとして表示するページ名を指定します。
- プラグイン内設定
- SIDE_ENABLE_SUBMENU サブメニューを使用するか
- SIDE_SUBMENUBAR サブメニューを使用する場合にメニューとして呼び出されるページ名。デフォルトは SideBar。
- 備考
デフォルトのメニュー用ページをSideBar以外のページとする場合は、pukiwiki.ini.php の $sidebar を変更して下さい。(通常は変更しないでください。)
- 作者
- みこ(miko's cafeterrace)
skin
- 種別
- ブロック型プラグイン
- 重要度
- ★★★☆☆
- 書式
- #skin(
スキン名
)
- 引数
- スキン名 ... SKIN_DIR(デフォルトは skin/)の中にあるスキン名(pukiwiki.skin.ja.php ならば pukiwiki がスキン名となる)
- 概要
- ページを表示するときのスキンを指定することができます。
- 作者
- みこ(miko's cafeterrace)
splitinclude
- 種別
- ブロック型プラグイン
- 重要度
- ★★★☆☆
- 書式
#splitinlcude([ページ名],[ページ名],[...])
- 概要
- 画面をn分割してページを表示します。主に等幅の段組として使用します。
sub
- 種別
- インライン型プラグイン
- 重要度
- ★★★☆☆
- 書式
&sub([文字列]);
- 内容
- 指定した文字列は下付き文字になります。
- 作者
- reimy
sup
- 種別
- インライン型プラグイン
- 重要度
- ★★★☆☆
- 書式
&sup([文字列]);
- 内容
- 指定した文字列は上付き文字になります。
- 作者
- reimy
tooltip
- 種別
- インライン型プラグイン
- 重要度
- ★★★★★(Plus!では必須)
- 書式
&tooltip(<term>){<definition>};
&tooltip(<term>);
- 引数
- <term>にマウスカーソルを合わせると、ツールチップとして説明が出現する。
- <term>が存在するページ名だった場合には、そのページへのリンクになる。
- 作者
- みこ featureing sha
vote2
- 種別
- ブロック型プラグイン
- 重要度
- ★★★☆☆
- 書式
- 作者
- sha