Help/Plugin/S
Last-modified:
search
- 種別
コマンド
- 重要度
★★★★★
- 書式
- ?cmd=search{
[&word=検索文字列]
[&type=OR]
}
- 概要
指定した文字列を含むページの検索を行います。
- 引数
パラメータには検索条件を指定します。
- word − 検索する文字列を指定します。省略時は検索条件を入力するページを表示します。
- type − 'OR' 指定時、OR検索を行います。省略時はAND検索をおこないます。
server
- 種別
ブロック型プラグイン
- 重要度
★☆☆☆☆
- 書式
- #server
- 概要
サーバーの情報(サーバー名、サーバーソフトウエア、サーバー管理者)を表示します。
setlinebreak
- 種別
ブロック型プラグイン
- 重要度
★☆☆☆☆
- 書式
- #setlinebreak(
[on|off|default]
) - 概要
入力文章中の改行を改行とみなすかどうかの設定を行います。
PukiWikiが入力文章中の改行をどのように扱うかはpukiwiki.ini内の$line_breakの設定内容によって変わります(下記参照)。
文章1
文章2文章1文章2 文章1
文章2文章1
文章2文章1文章2 文章1
文章2setlinebreakプラグインは該当ページの以降の行に関して、
$line_breakの設定に因らず改行をどのように扱うかを指定できるようになります。- 引数
パラメータには以降の改行の扱いを指定します。
パラメータが省略された場合、改行とみなすかどうかについての設定を逆転させます。- on − 以降の文章で段落内の改行を改行とみなします($line_break=1と同様)。
- off − 以降の文章で改行を無視します($line_break=0と同様)。
改行を行うためには行末にチルダを記述するか、
行中でbrプラグイン?を使用する必要があります。 - default − 改行の扱いをそのサイトの$line_break設定に戻します。
sh
- 種別
- ブロック型プラグイン
- 重要度
- ★★★★☆
- 書式
- #sh([言語]){{
シンタックスハイライトさせたいソースコード
}} - 概要
- ソースコードや文章などをSyntaxHilighterを用いて色分けします。他のプラグイン内でも使用されます。
- 作者
- Logue
showrss
- 種別
ブロック型プラグイン
- 重要度
★☆☆☆☆
- 書式
- #showrss(
RSSへのパス
[,[default|menubar|recent]
[,[キャッシュ生存時間]
[,1
]]]
) - 概要
指定されたRSSを取得し、一覧表示します。
ページの解釈毎にRSSの取得を行う為、頻繁に参照されるページでshowrssを使用される場合はキャッシュ機能を使うことをお勧めします。相手サイトの更新頻度に応じてキャッシュの生存時間を適宜設定して下さい。
- 引数
RSSへのパスにはRSSへのファイルパスやURLを指定します。
テンプレート名には取得したRSSの表示方法を指定します。省略時はdefault となります。
- default − 単純にページを列挙します。
- menubar − ページ名の前に黒丸をつけます。MenuBarなど、横幅に制限にある場合に便利です。
- recent − recentプラグインの出力のように、ページ名の前に黒丸をつけて更新日付が変わる毎に更新日付を出力します。
キャッシュ生存時間はキャッシュをクリアする期限(1時間単位)です。省略時、キャッシュ機能は無効となります。
第4引数はRSSを取得した日付を表示するかどうかを指定します。1を指定した場合は表示します。省略時は表示しません。
- プラグイン内設定
- SHOWRSS_VALUE_UNESCAPE RSS中の "< > &" などを 一旦 "< > &" に戻すか?
- SHOWRSS_VALUE_ESCAPE SHOWRSS_VALUE_UNESCAPEの変換後"< > &"などを"< > &"にするか?
- 備考
動作させるためにはPHP の xml extension が必要です。
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)
size
- 種別
インライン型プラグイン
- 重要度
★★★☆☆
- 書式
- &size(
ピクセル数値
){
文字列
} - 概要
文字の大きさを指定します。
- 引数
ピクセル数値には文字の大きさを指定します。
文字列は文字の大きさを変更する文字列を指定します。
source
- 種別
コマンド
- 重要度
★☆☆☆☆
- 書式
- ?cmd=source
&page=ページ名 - 概要
指定したページの整形前のソースを表示します。
- 引数
ページ名にはソースを表示するページ名を指定します。ページ名はエンコードされている必要があります。
span
- 種別
- ブロック型
:重要度
★★☆☆☆ - 書式
- #span(1~12)#ref(): ERROR: File not found: "..." at page "Help/Plugin/S"
- 概要
- rowとセットで使用します。ページの横幅を12分割してrowプラグイン内で呼び出されているspanプラグインの値が12になるようにしています。例えば、半分に分けたい場合、それぞれのspanの値は6になり、4分割にする場合は、3になります。もちろん、4,8のように片側だけ小さくして、反対側を大きくするといった指定方法も可能です。
splitinclude
- 種別
- ブロック型プラグイン
- 重要度
- ★★★☆☆
- 書式
#splitinlcude([ページ名],[ページ名],[...])
- 概要
- 画面をn分割してページを表示します。主に等幅の段組として使用します。
- 作者
- みこ
sub
- 種別
- インライン型プラグイン
- 重要度
- ★★★☆☆
- 書式
&sub{[文字列]};
- 内容
- 指定した文字列は下付き文字になります。
- 作者
- reimy
sup
- 種別
- インライン型プラグイン
- 重要度
- ★★★☆☆
- 書式
&sup{[文字列]};
- 内容
- 指定した文字列は上付き文字になります。
- 作者
- reimy