プラグインルール

ここでは、各々のプラグインが提供している、機能の概要、指定可能な引数、サポートする出力 方式などを記述します。

各プラグインについて

以下ではアルファベット順に各プラグインの記述をします。

br

改行を出力します。

タイプインライン
出力HTML
書式
&br;
備考特になし

calendar

カレンダーを出力します。

タイプブロック
出力HTML
書式
#calendar(ページ名)
備考ページ名は省略可能です。省略した場合には、このプラグインを呼び出しているページ名が利用されます。 このページ名に従い、各日付毎のページが作成された場合に「ページ名.yyyy-MM-dd」という名前になります。

calendar_viewer

指定されたカレンダーのコンテンツを出力します。

タイプブロック
出力HTML
書式
#calendar_viewer(ページ名,num|yyyyMM,past|future|view)
備考ページ名は省略可能です。省略した場合には、このプラグインを呼び出しているページ名が利用されます。 num は表示する件数の指定で、指定がなければ 10 件になります。また件数の変わりに表示する月を yyyyMM の形式で指定することも可能です。 past 及び future は現時点からみて、過去か未来かのどちらかのページの閲覧を指定可能です。 view は過去・未来に関わらず、指定された件数分、もしくは指定月分のデータを出力します。 デフォルトは past です。

calc

四則演算を計算して表示します。

タイプブロック
出力HTML
書式
&calc(+|-|*|/, 数値1, 数値2);
備考数値のところにインラインプラグインを使うことができる。通常は value プラグインなどと組み合わせて使います。

cform

カスタムフォームを表示します。

タイプブロック
出力HTML
書式
#cform(テーブル名, カスタムフォーム名, フォーム送信後のページ)
備考フォーム送信後のページを指定しなければ、フォーム送信後にフォーム表示ページに戻ります。

clear

テキストの回りこみを抑制します。

タイプブロック
出力HTML
書式
#clear
備考特になし

color

文字の色や、背景色を指定します。

タイプインライン
出力HTML
書式
&color(文字色、背景色){インライン要素};
備考 文字色は、アルファベットによる色指定、もしくは#で始まる16進数表現(RGB指定)が指定可能です。 背景色の指定は任意です。

contents

目次を出力します。目次の各項目は見出しで指定した内容です。

タイプブロック
出力HTML
書式
#contents
備考文章中のどこにでも記述は可能ですが、文章の先頭に配置する事をお奨めします。

counter

カウンタを表示します。

タイプブロック
出力HTML
書式
&counter(total|today|yesterday);
#counter(total|today|yesterday);
備考Tuigwaa のデータベースと連携します。

comment

ページにコメントを追加するフォームと既に受け付けたコメントを表示します。

タイプブロック
出力HTML
書式
#comment(表示する件数)
備考表示する件数はオプションです。初期値は10です。Tuigwaa のデータベースと連携します。

data

レコード指定ページで、カラムのデータを表示します。

タイプインライン
出力HTML
書式
&data(テーブル名、カラム名);
備考 レコード指定ページで使うことができます。 指定に関しては、編集ページの入力補助機能を利用することをお奨めします。

datalink

レコード指定ページ内で、さらにレコード指定ページへのリンクを表示します。

タイプインライン
出力HTML
書式
&datalink(テーブル名、ページ名、ラベル);
備考 ラベルを指定しなければ URL がそのまま表示されます。

datalist

指定されたテーブルの内容を含むページの繰り返しリストを出力します。

タイプブロック
出力HTML
書式
#datalist(テーブル名、ページ名、最大表示件数、フィルタ名)
備考 ページ名には繰り返し表示のテンプレートとなるページを指定し、テーブル名は繰り返し対象の テーブル名を指定します。 ページ名、テーブル名の省略は不可能です。 最大表示件数を指定した場合には、1ページ辺りに表示するデータ件数、フィルタ名は繰り返しの 前に適応するフィルタを指定します。 最大表示件数が省略された場合には、該当のデータ全件が表示されます。 最大表示件数と、フィルタ名は任意です。 指定に関しては、編集ページの入力補助機能を利用することをお奨めします。

date

Wikiデータ出力時の現在時刻を出力します。

タイプインライン
出力HTML
書式
&date;
備考出力形式は「yyyy/MM/dd」です。dataプラグインとのタイプミスに注意してください。

form

指定したテーブルに対するデータ入力フォームを出力します。

タイプブロック
出力HTML
書式
#form(テーブル名、ページ名)
備考 ページ名は、フォームの入力ボタンを押した際に戻ってくるページを指定します。 省略された場合には、現在のページに戻ってきます。 テーブル名の省略は不可能です。 指定に関しては、編集ページの入力補助機能を利用することをお奨めします。

edittable

カスタムフォームと組み合わせて、テーブルの特定カラムを一括編集することができます。

タイプブロック
出力HTML
書式
#edittable(テーブル名,フィルタ名,カスタムフォーム名)
備考 フィルタ名、遷移後のページは省略可能です。

email

e メール送信のためのフォームを表示します。

タイプブロック
出力HTML
書式
#email(eメール送信後のページ,送信するページ, テーブル名, フィルタ名)
備考 eメール送信は認証済みのユーザに限られています。

excellink

テーブルの内容を Excel でダウンロードするためのリンクが表示されます。

タイプブロック
出力HTML
書式
#excellink(テーブル名, フィルタ名)
備考 特になし

excelup

Excel や CSV ファイルをアップしてテーブルに一括データを挿入するためのフォームを表示する。

タイプインライン
出力HTML
書式
&excelup;
備考 特になし

fklink

レコード指定ページで関連データのためのレコード指定ページリンクを表示します。

タイプインライン
出力HTML
書式
&fklink(テーブル名,関連データカラム名,ページ名);
備考 特になし

folderlist

フォルダ一覧を表示します。

タイプブロック
出力HTML
書式
#folderlist
備考 特になし

fpage

現在のページ名を出力します。

タイプインライン
出力HTML
書式
&fpage;
備考 フォルダ込みのページ名を出力します。 ページ名のみを出力したい場合にはpageプラグインをご利用下さい。 デフォルトフォルダに格納されている場合、pageプラグインの出力と違いはありません。

gmap

グーグル地図を表示します。

タイプブロック
出力HTML
書式
#gmap(経度,緯度)
備考 経度、緯度の指定は難しいのでプラグイン補助を利用してください。 また、Google Map 用の key を plugin.properties ファイルに設定して下さい。

graph

グラフを表示します。

タイプブロック
出力HTML
書式
#graph(テーブル名,フィルタ名,bar|pie|line,幅)
備考 グラフの種類は bar 、幅は 300 が初期値。

include

他のページの内容をページをこの位置に出力します。

タイプブロック
出力HTML
書式
#include(ページ名)
備考 現在のページを指定することは出来ません。 また指定先のページがincludeプラグインを利用していた場合には、 そのページのincludeプラグインは無効になります。

interwiki

指定した URL にパラメータの値を挿入することが可能である

タイプインライン
出力HTML
書式
&interwiki;
&interwiki(サーバ名, パラメータ);
&interwiki(サーバ名, ラベル名, パラメータ, ....);
備考 interwiki プラグインを一度使用すると「tgw_plugin_interwiki」テーブルが自動的に生成されます。 そのテーブルでサーバ名、URL、エンコーディングのマッピングを管理します。 interwiki で引数を指定しなければ、そのテーブルへのデータ挿入画面が表示されます。

 Yahoo というサーバ名でURL をhttp://search.yahoo.co.jp/search?p= と登録した状態で 以下のようにプラグインを使うと、リンクが表示されます。それをクリックすると Yahoo を検索結果が閲覧できます。
  • &interwiki(Yahoo, test);
  •  

lastmod

Wikiデータの最終更新時刻を出力します。

タイプインライン
出力HTML
書式
&lastmod;
備考出力形式は「yyyy/MM/dd HH:mm:ss」です。

list

このプラグインが記載されているページ、もしくは引数に与えられている ページが位置するフォルダのリソース(ページもしくはフォルダ)をリスト表示します。

タイプブロック
出力HTML
書式
#list(ページ名)
備考ページ名が省略された場合はそのページが位置するフォルダのリソースを表示します。

navi

DocBook 風のナビゲーションを表示します。

タイプインライン
出力HTML
書式
#navi
備考特になし

newpage

印刷時にその位置で改ページを行います。

タイプインライン
出力HTML
書式
#newpage
備考特になし

now

Wikiデータ出力時の現在時刻を出力します。

タイプインライン
出力HTML
書式
&now;
備考出力形式は「yyyy/MM/dd HH:mm:ss (EEE)」です。

page

現在のページ名を出力します。

タイプインライン
出力HTML
書式
&page;
備考 ページ名のみを出力します。フォルダに格納されている場合でも、出力名は変わりません。 例えば「aaa/bbb」というページと「bbb」というページどちらでも、「bbb」と表示されます。 フォルダ名も込みで表示する際にはfpageプラグインをご利用下さい。

pageinfo

ページのバージョン情報、更新、日時、更新ユーザ、作成日時、作成ユーザを表示します。

タイプインライン
出力HTML
書式
&pageinfo;
備考 特になし

recent

最近更新されたページのリストを出力します。

タイプブロック
出力HTML
書式
#recent(件数)
備考件数を省略した場合には、デフォルトで10件表示されます。

ref

添付ファイルへの参照を出力します。指定されたファイルが画像の場合 (拡張子が、jpg,jpeg,gif,png,bmp) には、その画像を表示します。

タイプインライン、ブロック
出力HTML
書式
&ref(添付ファイル名、もしくはURL);
#ref(添付ファイル名、もしくはURL)
備考添付ファイル名、もしくはURLは省略不可能です。

rssreader

指定した RSS feed の内容を表示します。

タイプインライン、ブロック
出力HTML
書式
#rssreader
備考特になし。

size

文字のサイズをpx単位で指定します。

タイプインライン
出力HTML
書式
&size(サイズ){インライン要素};
備考 サイズは、数字による指定が可能です。サイズの省略は不可能です。

sform

検索フォームを表示します。

タイプインライン
出力HTML
書式
#sform(テーブル名,検索フォーム名,フォーム送信後のページ,最大件数,フィルタ)
備考 フォーム送信後ページが指定されていない場合は自分自身に飛びます。検索結果は、 table プラグインや datalist プラグインの引数で _SRESULT_ と指定することにより取得できます。

table

指定したテーブルの内容を表示します。

タイプブロック
出力HTML
書式
#table(テーブル名、フィルタ名、アクションフラグved, 詳細ページ名, 編集ページ名)
備考 テーブル名は必須です。フィルタ名、アクションフラグは省略可能です。 フィルタ名が指定された場合は、そのフィルタにマッチするデータのみ表示されます。 アクションフラグに v を含めば詳細ページ、 e で編集ページ、d で削除リンクが最終カラムに表示されます。詳細ページ名が指定されていない場合は "レコード名_詳細"、編集ページの場合はテーブルが表示されているページが選ばれます。 また、詳細ページ名や編集ページ名は、「ラベル:ページ名」とすることで、ページ名と違うリンクのラベルを 生成することができます。

tablefeed

テーブルの新規レコードを Feed で知らせるための URL を表示します。

タイプブロック
出力HTML
書式
#tablefeed(ページ名, テーブル名、フィルタ名)
備考 作成時間・更新時間のないテーブルに対してはこのプラグインは利用できません。

time

Wikiデータ出力時の現在時刻を出力します。

タイプインライン
出力HTML
書式
&time;
備考出力形式は「HH:mm:ss」です。

trackback

Trackback のためのリンクと Trackback を表示します。

タイプインライン
出力HTML
書式
#trackback(表示件数)
備考 表示件数はオプションです。初期値は 10 です。Tuigwaa の Database と連携します。

value

集計値を表示します。

タイプインライン
出力HTML
書式
&value(テーブル名, 集計値名);
備考特になし。

webalbum

Web アルバムを表示します。

タイプインライン
出力HTML
書式
#webalbum(カラム数)
備考カラム数はオプションです。初期値は 3です。WEB-DAV で一気に画像ファイルをアップすることが可能です。