上野家のホームページ - 資料室 : xpWiki/追加PluginManual/A-DA

[ 新規 | 一覧 | 検索 | 最新 | ヘルプ ]

[ 凍結 | 差分 | バックアップ | リロード ]

[ コメント(0) ]

ページ内コンテンツ

A
- addline
- AjaxChat
- ajaxtree
- areaedit
- aws
B
- block
C
- calendar9
- capture
- code
- conf
D
- deldel
PukiWiki　1.4 に同梱されているプラグインマニュアル及び凡例

A

addline

概要

ボタンやリンクを押すと、設定ページで指定した文字列を追加。
行単位の追加。インライン型は同じ行内での文字列単位で追加も可能。
ボタンやリンクの表記も変更可。

説明

画面のボタンを押すと、「：config/plugin/addline/設定」で、あらかじめ指定された文字列を追加します。
テーブルのフィールドを追加したりするのに便利です。自作プラグイン/attachref.inc.phpと一緒に使うと、画像ギャラリーっぽい雰囲気のページが作れます。

使用法: ブロック型プラグイン／インライン型プラグイン

引数の仕様

#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: インライン型の場合に、追加するのがリンクの前（左）か後（右）の指定

使用例

ブロック型

例えば、以下のように#addlineを用意すると、「add」ボタンを押す毎に、テーブルの下に設定に記載した内容が追加されていきます。任意の位置に添付＆参照できる自作プラグイン/attachref.inc.phpと組み合わせると、ほら何か楽しそうでしょ？
ページ内での記載例とボタンを２回押した結果

|&attachref(,zoom,90x90);|&attachref(,zoom,90x90);|&attachref(,zoom,90x90);|
|&attachref(,zoom,90x90);|&attachref(,zoom,90x90);|&attachref(,zoom,90x90);|
#addline(テーブル１,above)

「：config/plugin/addline/テーブル１」の内容

|&attachref(,zoom,90x90);|&attachref(,zoom,90x90);|&attachref(,zoom,90x90);|

インライン型

棒グラフ型簡易投票とか。

CENTER:「納豆は好きですか？」~
&addline(グラフ,before){【は　い】};▲&addline(グラフ,after){【いいえ】};~

「：config/plugin/addline/グラフ」の内容

&heart;

【表示例】

「納豆は好きですか？」
[heart]

【は　い】▲【いいえ】 [heart]

インライン型２

addline.inc.php.8からインライン型にもabove|below|up|downが指定できるようになりました。テーブル内に記述できるようになっただけでなく、クリックするリンクによって追加する行の内容を変えられます。下記は、[ハート追加]を１回、[リンク追加]を１回クリックした例。

|>|>|CENTER:~&addline(テーブル１,down){[リンク追加]};&addline(テーブル２,down){[ハート追加]};|
|&attachref(,zoom,90x90);|&attachref(,zoom,90x90);|&attachref(,zoom,90x90);|
|&heart;|&heart;|&heart;|

【表示例】

[リンク追加][ハート追加]
[添付]	[添付]	[添付]

「：config/plugin/addline/テーブル２」の内容

|&heart;|&heart;|&heart;|

ここ迄は自作プラグイン/addline.inc.phpより転載

nao-pon氏の追記より転載 pukiwiki:自作プラグイン/addline.inc.php を xpWiki用に調整したものです。原作者は sha さんです。

- オリジナルの addline の機能に「auth」オプションを追加してあります。「auth」オプションを指定すると、編集権限がないときは、「追加」ボタンが表示されず、実際の追加処理もキャンセルされます。「auth」オプションの指定方法は2種類あります。

- - 「auth」オプションのみ指定例: #addline([テンプレート],auth)
  - 「btn」オプションに併記して指定例: #addline([テンプレート],btn:追加:auth)

AjaxChat

ajaxtree

種別: ブロック型プラグイン

概要

ページの階層構造をツリーメニューとして表示します
現在参照しているページの付近だけを展開して表示します
JavaScript が使える場合は、クリックすることでメニューの折り畳み・展開ができます
MenuBar ページに #ajaxtree と書くだけで、手軽に設置できます

書式: #ajaxtree([タイトル])

プラグイン内設定

PLUGIN_AJAXTREE_CHECK_MTIME wiki ディレクトリの更新日時を利用して効率良くキャッシュを更新する (true, false のいずれか)
PLUGIN_AJAXTREE_COUNT_DESCENDANTS 階層下に含まれるページの数を表示
PLUGIN_AJAXTREE_TOP_DEFAULTPAGE FrontPage へのリンクはツリーの先頭に表示する (true, false のいずれか)
PLUGIN_AJAXTREE_HIDE_TOPLEVEL_LEAVES Help や MenuBar のような階層化されていないページは非表示にする (true, false のいずれか)
PLUGIN_AJAXTREE_NON_LIST 非表示にしたいページのリスト (正規表現)
PLUGIN_AJAXTREE_INCLUDE_LIST 非表示ページのうち例外的に表示したいページのリスト (正規表現)
PLUGIN_AJAXTREE_EXPAND_LIST 展開したいページのリスト (正規表現)

出所

Revulo さんの AjaxTree プラグイン PukiWiki/自作プラグイン/AjaxTree - Revulo's Laboratory 。ベースは、ajaxtree-1.2beta1 ですが、移植に際して若干修正を行っています。

備考

利用する場合は最初にTree データの初期化作業が必要です。管理ツールからプラグインキャッシュ初期化を行って下さい。
階層ノード内の並び順は、1.ページに設定したページ並び順, 2.ページ名で昇順となります。

areaedit

種別

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

機能概要: ページ内の指定領域のみを編集対象とするプラグイン

#areaeditと#areaedit(end)で囲まれたエリアだけが、編集の対象となります。その場合、[編集]リンクが右端に表示されます。
- - 例えば、#commentを#areaeditと#areaedit(end)で囲っておくと、コメントのみが編集対象になるので修正が容易になる。

書式

引数の仕様

#areaedit([start|end|btn:<ボタンの名前>|nofreeze|noauth|collect[:<page>]])
&areaedit([nofreeze|noauth|preview[:<num>]]){<編集文字列>};

引数の意味

<編集文字列>: 編集対象。
start: 範囲の開始。省略できる。
end: 範囲の終了。これを引数とする記述ごと省略すると、子要素のみが対象に。
btn:<name>: <name>をボタン名に変更。
nofreeze: ページが凍結されていても、その範囲は凍結されてないようにできる。
noauth: ページに編集権限がなくても、その範囲は権限があるようにできる。
collect: 同じページ内のインライン型の編集対象を収集する。
collect:<page>: <page>で指定したページ内で編集対象を収集する。
preview: インライン型に限り、編集時に編集対象の直前の空行や見出しから編集対象までを表示（99行分探索）。
preview:<num>: previewに続けて「:」と数字を書くと、空行や見出しを探す最大行数を指定できる。

つまり、ページが凍結されてなくて、かつ編集権限がなければ編集できないが、noauth, nofreezeを指定すると、その範囲において、それぞれの制限を受けなくすることができます。

使用例

インライン型
1. テーブルなどに記載できる。例えば下記のように記載する。すると、編集文字列の後ろに[e]リンクが出現する。これをクリックすると編集できる。
```
|&ref(http://pukiwiki.sourceforge.jp/image/pukiwiki.png);|&areaedit(){画像にコメント記入};|
```
  【表示例】（区別のため赤字で示した）
  
  画像にコメント記入[e]
2. 前の文字列とぴったりくっつくので、範囲の最初を区別したいときは、それが分かるように記載すること。後ろの方は[e]があるので範囲の終わりは分かる。ブラウザでJavascriptが有効な場合、マウスカーソルを合わせると対象範囲が色づく。
```
-好きな食べ物は&areaedit(){冷やし中華でない冷麺};です。
-好きな食べ物は「&areaedit(){冷やし中華でない冷麺};」です。
```
  【表示例】
  - 好きな食べ物は冷やし中華でない冷麺[e]です。
  - 好きな食べ物は「冷やし中華でない冷麺[e]」です。

もちろん、中括弧内{body}が空だったり、中括弧ごとが無かったりしても大丈夫。
編集権限が無いときは[x]が表示されクリックできない。凍結されているときは[uf]で凍結解除のリンクになる。
改行は&br;に変換される。
preview[:<num>]引数を付けておくと、編集時に編集対象行より前の部分（見出しや空行からの）が表示される。見ながら編集できる。

インライン型の編集対象を収集するブロック型プラグイン
1. 次のように記述すると、同じページ内(page1)に記述されたインライン型の編集対象を集めて展開する。以下は記載方法。
```
#areaedit(collect)
#areaedit(end)
```
2. あるページ(page1)にて、別のページ(page2)に記述されたインライン型の編集対象から収集する場合
```
#areaedit(collect:page2)
#areaedit(end)
```
  【表示例】（ただし実行後）
  [収集] page2
  1. 画像にコメント記入
  2. 冷やし中華でない冷麺
  3. 冷やし中華でない冷麺

[収集]ボタンが現れる。押すとインライン型の編集対象が展開される。既に記述がある場合には上書きされる。
【注意】#areaedit(end)が無い場合、次の空行までを対象範囲とするので、意識して空行を用意して置かないと、関係ない記述まで食い込んで上書きされてしまうことがある。#areaedit(end)の使用を推奨。
ここでも実験しています→「[[sha:areaedit.inc.php/test]]」

ブロック型ページ内の好みの位置に次のように記述してください。
1. 対象範囲を明示する場合
- #areaeditと#areaedit(end)に挟まれた範囲が編集対象に。
```
ここは編集対象外
#areaedit
  ここが編集対象
#areaedit(end)
ここは編集対象外
```
1. 終わりを明示しない場合（#areaedit(end)を省略）
- #areaeditから最初の空行までの範囲が編集対象に。
```
ここは編集対象外
#areaedit
  ここは編集対象
```

ここは編集対象外。上に空行があるから。

ページ内に複数埋め込んだ場合

#areaeditの後、#areaedit(end)が見つかる前に#areaeditが見つかった場合は、上記2.と同じ扱いとなる。

ここは編集対象外
#areaedit
   ここは１番目の編集対象
#areaedit(end)
ここは編集対象外。上にendがあるから。
#areaedit
   ここは２番目の編集対象

ここは編集対象外。上に空行があるから。
#areaedit
    ここは３番目異の編集対象
#areaedit(end)
ここは編集対象外。上にendがあるから。

コメント領域を編集対象にすると便利。

コメント部分を囲うと、コメントの修正が容易になる。

#areaedit
-テストです。こんな風にコメントを記入 -- [[sha]] SIZE(10){2003-08-12 (火) 04:26:11}
-#areaeditをコメントで入力しても無駄よん。 -- [[sha]] SIZE(10){2003-08-12 (火) 04:26:57}

#comment
#areaedit(end)

1. 「自作プラグイン/addline.inc.php」と組み合わせると便利便利。
  ボタンを押す度に編集領域を追加することができます。大項目を追加するときにボタン押せば、大項目のテンプレートを含んだ編集領域が用意されるので他の領域の影響を気にせず編集できるのがありがたいです。
- あるページに以下のようにaddlineプラグインを記載しておきます。追加ボタン[編集領域追加]が現れます。
```
#addline(領域編集,below,btn:[編集領域追加])
```
- このとき、設定ファイル（:config/plugin/addline/領域編集）に以下のようなテンプレートを用意します。
```
#areaedit
*　月　日の　食の献立
-
#areaedit(end)
```
- 例えば、ボタンを２回押してそれぞれ編集した様子を示したのが以下です（区別のために赤字で示しています）。お試しあれ。ちなみに、ここでも実験しています。覗いて見てください。→「[[sha:areaeditの実験２]]」

【表示例】

[編集領域追加]

[編集]

８月１３日朝食の献立

右上の[編集]リンクをクリックすると、以下の「８月１２日夕食の献立」とは別に編集エリアに表示されるので、その影響受けずに心理的にも気楽に編集出来ます。
[編集]

８月１２日夕食の献立

こんな風に編集できます。いろいろ…。

#areaedit(end)が無い場合は、子要素のみが編集対象。
インライン型もあるよ。&areaedit(){body};のbody部分が編集できる。
ページ内のインライン型で記述された編集対象を収集。
ページを凍結すれば、その部分のみ編集可能な場として提供できる。

補足説明

例えば、#commentを#areaeditと#areaedit(end)で囲っておくと、コメントのみが編集対象になるので修正が容易になる。
デフォルトでは、ページが凍結されていたり、ページに編集権限がないと、このプラグインもそれに従うが、引数で影響を受けないように指定出来る。
編集エリアに#areaeditを記載することはできない。自動的にコメントアウト「//」される。
#areaedit(end)が無い場合には、更に編集エリアに空行を記載することはできない。自動的にコメントアウト「//」が挿入される。
今回からインライン型のパーザーとして、make_link.phpのclass InlineConverterを利用してみた。PukiWikiがパージングするのと全く同じになるので検出ミスや対象間違いが防げるはず。

出所: 自作プラグイン/areaedit.inc.phpを参照 by nonn50

aws

機能概要

書式

#aws([Template name],[Search Index],[Keyword],[Node Number],[Sort Mode],[No Header])

オプション

表示例

#aws(w5_2,Books,xoops)

HTTP Error: 410

出所: PukiWikiMod に含まれていた Amazon の ECS 4.0 を使った #aws プラグインを移植

B

block

機能概要: 区分け、領域分けプラグイン(divタグで画面分割)
複数行引数に対応しています。

書式: #block([width][,left|center|right][,around][,font-size][,round]){{
表示する内容
}}

引数

width: 表示域の幅を % 又は px で指定します。

left center right: 左寄せ、センタリング、右寄せを指定します。width 指定をしないと無効になります。

around: 回り込み指定をします。

font-size: 表示フォントのサイズを % 又は px で指定します。

round: 表示域を角丸の枠で装飾します。

表示例

-
|
!
-
|
!

#block(left,width:50%,around){{
右の領域
}}
#block(left,width:50%,around){{
左の領域
}}
#clear

右の領域

左の領域

C

calendar9

機能概要: Ajax対応calendar2 互換スケジュール管理プラグイン

出所

狩野太郎氏の自作PukiWikiプラグイン

表示例

#calendar9(calendar9サンプル)

備考: xpWikiでの設定 ini設定に「Ajax編集の有効・無効スイッチ」を設けました。 default.ini.php(デフォルトON) と keitai.ini.php(デフォルトOFF) です。

/////////////////////////////////////////////////
// Ajax edit
$root->use_ajax_edit = 1;

capture

種別

マルチライン型ブロックプラグイン

重要度: ★★★★★

書式

#capture(key){{
内容
}}

概要: key をキーとして、あらかじめキャプチャしておき、あとで利用できるプラグインです。表の中に複数行に渡るブロックを表示したいときなどに、利用できます。

表示例

#capture(1){{
** vote のテスト
#vote(これはいい！,そうでもない)
まあ、こんな感じです。
}}
|表中|h
|#capture(1)|

表中

vote のテスト

まあ、こんな感じです。

code

機能概要: プログラムのソースコードの中に含まれるキーワードとコメントを色分けして表示

使い方

書式

#code[([言語名] {,[menu|nomenu], [number|nonumber], \
[outline|nooutline], [icon|noicon]}, ファイル名)|)]{{
ソースコード
}}

WIKI上に直接記述する場合

#code[(言語名,オプション)]{{
ソースコード
}}

ファイル取り込み

#code([言語名][,オプション],ファイル名)
#code([言語名][,オプション],URL)

こんな使い方もありました　By nonn50
```
#code(xpWiki開発日記/2008-04-05/moblog.inc.php)
```
表示例
File not found: "moblog.inc.php" at page "xpWiki開発日記/2008-04-05";
指定したファイルが無い場合は、当然表示されません。