Help/標準プラグイン
FreeStyleWikiLiteに標準で含まれているプラグインを紹介します。
「プラグイン」についての基礎知識
FreeStyleWikiには「プラグイン」というものがあり、Wikiの文章中に決められた「プラグイン構文」を書き込めば、様々な表示出力や機能を使う(ページに埋め込む)事が出来ます。
使い方はとても簡単で、前後が「{{」と「}}」で囲まれた所定のプラグイン構文を、文章中の表示させたいところに書くだけです。
プラグイン構文の書き方はプラグインそれぞれで異なりますが、基本的には以下の形になります。
{{プラグイン命令の単語}}
もしくは、
{{プラグイン命令の単語 指定したい引数}} 「命令の単語」+「半角空白」+「指定したい引数」 (複数の引数を指定出来る場合は「,」で「引数1,引数2,引数3」のように区切る)
プラグインには最初から用意されている「標準プラグイン」と、管理者が任意にCGIに追加拡張した「拡張プラグイン」があります。
また、プラグインは「インライン プラグイン」と「パラグラフ プラグイン」という形でも分けられます (厳密には「アクション プラグイン」等といったものもあるのですが、ここでは省きます)。
- インライン プラグイン
- 文章中のどこにでも書く事が出来る (ただしプラグイン構文の中にプラグイン構文を書くというのは出来ない)。一行に複数のプラグイン構文を書く事も出来る。プラグイン構文を書いても改行されない
- パラグラフ プラグイン
- 一行にプラグイン構文のみしか書けず、文章途中に書いたり、複数のプラグイン構文を並べて書いたり出来ない。改行を伴い、プラグイン構文を書くと自動的に改行される
使用可能なプラグイン
recent
内容
- パラグラフ プラグイン
- 更新日時順のページ一覧を出力します
- 引数で表示件数を指定できます (指定より数が少ない時もありますが気にしない(^^;))
構文
{{recent 表示件数(省略可)}} {{recent}} {{recent 表示件数}}
- 表示件数
- 表示させたい件数を指定。「省略時」=全ページリストアップ
例
{{recent 3}}
recentdays
内容
- パラグラフ プラグイン
- 更新されたページ一覧を更新日付毎に分けた形で出力します
- 引数で表示日数を指定できます
構文
{{recentdays 表示日数(省略可)}} {{recentdays}} {{recentdays 表示日数}}
- 表示日数
- 表示させたい日数を指定。「省略時」=最新の5日分をリストアップ
例
{{recentdays 2}}2009/09/20 2008/09/24
lastmodified
内容
- インライン プラグイン
- 構文を書いたページの最終更新日時を表示します
構文
{{lastmodified}}
例
{{lastmodified}}
最終更新時間:2008年07月07日 21時17分29秒
category
内容
- インライン プラグイン
- ページをカテゴライズ設定(カテゴリー分け)出来ます。複数書けば一つのページに複数のカテゴリーを関連づける事も可能です
- 表示されたカテゴリー名はリンクとなっていて、クリックする事で同じカテゴリーのページをリストアップ出来ます
- 引数でカテゴリ名を指定します
構文
{{category カテゴリー名}}
例
{{category ヘルプ}}
[カテゴリ:ヘルプ]
category_list
- パラグラフ プラグイン
- categoryプラグインで分類したページをカテゴリ毎一覧表示します (categoryプラグインを書いてないページはリストアップしない)
- 引数で表示するカテゴリを指定出来ます (指定したカテゴリーが含まれるページのみ表示)
- ページの増加に伴い、一覧の表示に時間がかかってしまう傾向にあり、キャッシュを利用するよう改造したものが既にあるので、いずれ公開する予定です
構文
{{category_list カテゴリー名(省略可)}}
{{category_list}} {{category_list カテゴリー名}}
- カテゴリー名
- 表示させたいカテゴリー名を指定。「省略時」=categoryプラグインが設置された全ページをカテゴリー分けしてリストアップ
例
{{category_list ヘルプ}}
ヘルプ
ref
内容
- インライン プラグイン
- ページに添付したファイルへのリンクを設置出来ます
- 引数でファイル名を指定します。添付出来るファイルサイズは通常128KB以内となっています (当サイトでは管理者改造により750KB以内)
構文
{{ref ファイル名}}
例
{{ref tenpu.txt}}
ref_image
内容
- パラグラフ プラグイン
- ページに添付した画像ファイルを表示します
- 引数で画像ファイル名を指定します (画像ファイル以外は表示しない)
構文
{{ref_image 画像ファイル名}}
例
{{ref_image contbyio.gif}}
ref_text
内容
- パラグラフ プラグイン
- ページに添付したテキストファイルを整形済テキストとして表示します。テキストファイルの内容をページに直接表示させたい場合等に使います
- 引数でテキストファイル名を指定します
構文
{{ref_text テキストファイル名}}
例
{{ref_text tenpu.txt}}
添付テスト用テキストです。 by IO
outline
内容
- パラグラフ プラグイン
- ページのアウトライン(見出しの目次)を表示します。ページ中に含まれる各見出しがツリー形式で表示され、クリックするとその見出しにジャンプします
構文
{{outline}}
例
{{outline}}
search
内容
- パラグラフ プラグイン
- Wiki内のキーワード検索をするためのフォームを設置します
構文
{{search}}
例
{{search}}