SandBox: お砂場(練習ページ)です

教科書

携帯からの書き込み

インダス文明

モヘンジョ・ダロ

jgfjdgd*** 四大文明 [#k28ac390]

]gdfgfdfghf

ghghgfhgfhgfgjgjhgj

インダス川流域に広がるインダス文明は、紀元前四〇〇〇年頃に栄えた文明の一つです。

vvvvv

中見出し 1-2

用語1

いろいろ書いた解説文1と強調単語 *1 段落1段落1段落1段落1段落1段落1段落1段落1段落1段落1段落1段落1 段落1段落1段落1段落1段落1段落1段落1段落1段落1段落1段落1段落1 段落1段落1段落1段落1段落1段落1段落1段落1段落1段落1段落1段落1

用語2

いろいろ書いた解説文2 *2

用語3

いろいろ書いた解説文3 *3

大見出し 2

小見出し 2-1

小見出し 2-2

段落1段落1段落1段落1段落1段落1段落1段落1段落1段落1段落1段落1 段落1段落1段落1段落イタリック1段落1段落1段落1段落1段落1段落1段落1 段落1段落1段落1段落イタリックボールド1段落1段落1段落1段落1段落1

段落2段落2段落2段落2段落2段落2段落2段落2段落2段落2段落2段落2

段落2段落2段落2段落2段落2段落2段落2段落2段落2段落2段落2段落2

段落2段落2段落2段落2段落2段落2段落2段落2段落2段落2段落2段落2

レベル0レベル0レベル0レベル0レベル0レベル0

レベル1

レベル1

レベル1

レベル2

レベル2

レベル2

レベル3

• はろ1
  • はろ2 ろろろろ2
    • はろ3
  • はろ2
    • はろ3
  • はろ2
    • はろ3

      レベル3

      レベル3

      レベル3

日付

日付 &date;

• 日付 2004-08-16

date?

• 2004-08-16

時刻 &time;

• 時刻 07:29:03

time?

• 07:29:03

日時 &now;

• 日時 2004-08-16 (月) 07:30:27

now?

• 2004-08-16 (月) 07:29:03

リンク

URLやメールアドレスは自動的にリンクになります

• URL -- http://example.org/
• メールアドレス -- foo@example.org
• URLが各種画像ファイルであればそのまま表示します
  • 

その他の文字装飾

整形済みテキスト整形済みテキスト整形済みテキスト
整形済みテキスト整形済みテキスト整形済みテキスト

色の変更も可能なルール(COLOR(#993333))

サイズの変更も可能なルール(SIZE(10))

両方指定(SIZE(20)COLOR(#333399))

打ち消し線

左寄せ

nnnnnnnn

FrontPage

[ 単行本 ] XOOPS Cube Legacy デベロッパーズ・バイブル

XOOPS Cube Legacy デベロッパーズ・バイブル

このページは、ページを指定しない時に表示されます。

あなたのサイトに合わせ、自由に編集してください *1

練習ページ

• SandBox -- 編集をお試しください
• InterWikiSandBox -- InterWikiを試してみてください

PukiWikiについて

• PukiWiki -- PukiWikiのご紹介

ドキュメント

• ヘルプ -- PukiWikiで編集するには？
• テキスト整形のルール(詳細版)
• プラグインマニュアル

O

online

種別

ブロック型プラグイン

インライン型プラグイン

重要度

★★☆☆☆

書式

#online

&online;

概要

現在PukiWikiを参照している、おおよそのユーザー数を表示します。

ユーザー数は、プラグインを呼び出された時点で記録されたＩＰアドレスとタイムスタンプのうち、５分以内(変更可能)にアクセスのあったアドレスの数です。

プラグイン内設定

• PLUGIN_ONLINE_TIMEOUT　タイムアウトの秒数
• PLUGIN_ONLINE_USER_LIST　ユーザー情報を保存するファイル
• PLUGIN_ONLINE_LIST_REGEX　ユーザー情報取得用の正規表現

備考

ユーザー数のカウントはページ単位でなく、設置されたPukiWiki毎に行っているため、MenuBarなど頻繁に呼び出される場所に記述するかスキンに埋め込むのが普通です。

P

paint

種別

（コマンド）

ブロック型プラグイン

重要度

★☆☆☆☆

書式

#paint( [幅] [,高さ] )

概要

Javaアプレットで描いた絵を、そのページに添付します。

ば科学的愛情で配布されているBBSPainter.jarを使用しています。

幅と高さに、デフォルトのキャンバスサイズを指定します。省略時は(80,60)となります（変更可能）

プラグイン内設定

• PAINT_INSERT_INS　入力内容を先頭/末尾のどちらに挿入するか
• PAINT_DEFAULT_WIDTH　デフォルトの描画領域の幅
• PAINT_DEFAULT_HEIGHT　デフォルトの描画領域の高さ
• PAINT_MAX_WIDTH　描画領域の幅の上限
• PAINT_MAX_HEIGHT　描画領域の高さの上限
• PAINT_APPLET_WIDTH　アプレット領域の幅
• PAINT_APPLET_HEIGHT　アプレット領域の高さ
• PAINT_NAME_FORMAT　名前欄の挿入フォーマット
• PAINT_MSG_FORMAT　コメント欄の挿入フォーマット
• PAINT_NOW_FORMAT　時刻欄の挿入フォーマット
• PAINT_FORMAT　コメント内容全体の挿入フォーマット（メッセージあり）
• PAINT_FORMAT_NOMSG　コメント内容全体の挿入フォーマット（メッセージなし）

備考

PukiWikiのインストールディレクトリに上記BBSPainter.jarを入れるのを忘れないでください。このプラグインが何の役にも立たなくなります。

pcomment

種別

（コマンド）

ブロック型プラグイン

重要度

★★★☆☆

書式

#pcomment({ [コメント記録ページ], [表示件数], [noname], [nodate], [above], [below], [reply], [template:<STRING>], [cols:<DIGIT>], [multi:<DIGIT>], [emoji], [noemoji] }){{
<複数行引数>
}}

概要

別のページにコメントを記録することができるcommentプラグインです。設置した場所には最新のコメントだけを表示することができます。ラジオボタンを表示し、指定した部分にコメントを付けることもできます。

引数

コメント記録ページ にはコメントを記録するページ名を指定します(ページ名の前に"ディレクトリ名:"を付加することにより別ディレクトリのxpWikiを指定することもできます)。省略すると、pcommentプラグイン内の PLUGIN_PCOMMENT_PAGE で指定されたページにコメントが記録されます。デフォルトは [コメント/(設置したページ名)] です。指定したページが存在しなくても、最初にコメントを追加した時に作成します。

表示件数 は表示する最新コメントの数を指定します。第1レベルの番号なしリストだけをカウントします。省略すると、pcommentのデフォルト件数(通常10件。 PLUGIN_PCOMMENT_NUM_COMMENTS で変更可能)が表示されます。
表示件数は コメント記録ページ より後に指定して下さい。コメント記録ページを省略して 表示件数 を指定する場合は、 コメント記録ページ に空白を指定します。（例: #pcomment(,15)）

noname,nodate,above,below,reply でコメントの表示方法、入力方法を指定します。

• noname − 名前の入力欄を表示しません。
• nodate − 日付を挿入しません。
• above − 挿入したコメントをフォームの上に表示します。コメントは上が古く、下に向かって新しい順に並びます。
• below − 挿入したコメントをフォームの下に表示します。コメントは下が古く、上に向かって新しい順に並びます。
• reply − コメントの頭にラジオボタンを表示します。あるコメントに対するリプライが、そのコメントのラジオボタンをチェックすることで可能になります。
• template:<STRING> − <STRING> に挿入形式テンプレート名を指定します。(省略時: default)
• cols:<DIGIT> − <DIGIT> にメッセージ入力欄の幅を数値で指定します。(省略時: PLUGIN_PCOMMENT_SIZE_MSG の値)
• multi:<DIGIT> − <DIGIT> にメッセージ入力欄の行数を数値で指定します。1以上を指定すると入力欄は<textarea> になります。(省略時: 0)
• noemoji − 絵文字入力パットを非表示にします。(省略時: 絵文字パットを表示する)

プラグイン内設定

• PAGE　 ページ名のデフォルト(%sに$vars['page']が入る)
• NUM_COMMENTS　表示する(最新の)コメント数のデフォルト
• SIZE_NAME　 名前欄の表示桁数
• SIZE_MSG　 コメント欄の表示桁数
• DIRECTION_DEFAULT　入力内容を先頭/末尾のどちらに挿入するか
• FORMAT_NAME['<テンプレート名>']　名前欄の挿入フォーマット
• FORMAT_MSG['<テンプレート名>']　 コメント欄の挿入フォーマット
• FORMAT_NOW['<テンプレート名>']　 時刻欄の挿入フォーマット
• FORMAT_STRING　コメント内容全体の挿入フォーマット
• AUTO_LOG　自動過去ログ化を行う際の1ページあたりの件数(0で無効)
• TIMESTAMP　コメントページのタイムスタンプを更新せず、設置ページのタイムスタンプを更新するか
• TEMPLATE_DEFAULT　テンプレート名のデフォルト値
• NEW_PAGE_FORMAT　コメントページを新規作成する場合のページフォーマット。オートテンプレートに対応していますので、該当テンプレートページがある場合はそのページが使用されます。
• LOG_PAGE_FORMAT　過去ログページを新規作成する場合のページフォーマット。オートテンプレートに対応していますので、該当テンプレートページがある場合はそのページが使用されます。
• TWITTER['<対象ページ名>'] = array(
    'username' => '<TwitterのID>',
    'password' => '<Twitterのパスワード>',
    'enable_ids' => '<対象UID>',
    'enable_name_reg' => '<対象名前(入力値)>' );

備考

複数行引数に対応しています。入力されたテキストは、コメントページが抜き出した内容の先頭に挿入されWikiテキストとして評価されます。

更新が衝突したときは、予期せぬ場所にコメントが挿入されるのを防ぐため、リプライ先を指定して記入したコメントはaboveまたはbelowの設定にしたがって 一番前か一番後ろに追加されます。

コメント記入後に表示されるページのタイトルに「(#pcommentを書いたページ)を更新しました」と表示されますが、実際に更新されたのはコメントを記録するページです。

コメントとして相対参照([ [../] ]など)を用いた場合は、書いたページと書き込まれたページのどちらかで、意図したとおりに変換されない可能性があります。

自動過去ログ化機能は PLUGIN_PCOMMENT_AUTO_LOG の件数 ＋ PLUGIN_PCOMMENT_NUM_COMMENTS の件数分のコメントを投稿した時に作動します。

プラグイン内設定の TWITTER を指定すると、対象ページで該当するユーザーの投稿があった場合 Twitter API を用いて投稿します。

popular

種別

ブロック型プラグイン

重要度

★★☆☆☆

書式

#popular( [件数 [,対象外ページ [,today|yesterday|total [,集計対象の仮想階層ページ名 [,0|1] ] ] ] ] )

概要

人気のある（参照回数の多い）ページの上位数件を表示します。

引数

件数には一覧の数を指定して下さい。省略時はPLUGIN_POPULAR_DEFAULTに指定した件数です。

対象外ページには、表示対象外とするページを指定します。例えば FrontPage や MenuBar などのページを一覧に表示させたくないときに使用します。
また、"hoge/" とすると hoge の下層ページは集計されません。
複数ページを指定する場合は、"#" で区切って指定します。

today( or 1 or true), yesterday( or -1), total( or 0 or false)で、ページのカウント条件を指定します。省略時は total です。

• today − 今日参照のあった回数順でページを表示します。
• yesterday − 昨日参照のあった回数順でページを表示します。
• total − 通算の参照回数順でページを表示します。

集計対象の仮想階層ページ名を指定すると、その下位層のみを集計します。(ページ名の前に"ディレクトリ名:"を付加することにより別ディレクトリのxpWikiを指定することもできます)

5番目の引数に "1" を指定すると多階層のページ名の場合、階層部分を省略しページ名をコンパクトに表示します。

プラグイン内設定

• PLUGIN_POPULAR_DEFAULT　件数未指定時の件数

備考

counterプラグインのカウンター情報を利用しているので、counterプラグインを設置していないページはカウントの対象外となります。全てのページにcounterプラグインを設置するのは非効率であるため counterプラグインをMenubarやスキンに設置するのが一般的です。

R

random

種別

（コマンド）

ブロック型プラグイン

重要度

★☆☆☆☆

書式

#random( [メッセージ] )

概要

ランダムなページへのリンクを表示するプラグイン。

表示するページの候補は設置したページの下階層のページです。

引数

メッセージにはリンクに表示する文字列を指定します。省略時は 'press here.' となります。

備考

ブラウザの再読み込み対策はしていません。リロードされるたびにランダムな表示を繰り返します。

read

種別

コマンド

重要度

★★★★★

書式

?cmd=read &page=ページ名

概要

指定したページを表示します。該当ページが存在しない場合は編集状態で開き、ページ名がInterWikiであった場合は、その解決を行います。

plugin=やcmd=が指定されていない場合に内部で暗黙に呼び出されるため、利用者が意識する機会は少ないです。

引数

ページ名には表示したいページ名を指定します。ページ名はエンコードされている必要があります。

recent

種別

ブロック型プラグイン

重要度

★★★★★

書式

#recent( [パターン] [,件数] )

概要

指定したパターンで始まるページ名のうち、最新の数件を表示します。

引数

パターンには表示するページ名の共通部分を指定します。省略時は閲覧可能なすべてのページとなります。
また、「ディレクトリ名:ページパターン」と指定して同じシステム上の別のxpWikiの一覧表示をすることもできます。

件数には表示件数を指定します。省略時はプラグイン内設定で指定した値です。

プラグイン内設定

• PLUGIN_RECENT_DEFAULT_LINES　件数未指定時の件数
• PLUGIN_RECENT_CACHE　RecentChangesのキャッシュの場所
• PLUGIN_RECENT_USAGE　引数未指定時に表示されるヘルプ
• PLUGIN_RECENT_EXEC_LIMIT　１ページ中で実行可能な上限回数

ref

種別

ブロック型プラグイン

インライン型プラグイン

重要度

★★★★☆

書式

#ref( 添付ファイル名| ページ名/添付ファイル名| URL [,ページ名] {, [set], [left|center|right],[wrap|nowrap], [around], [noicon], [noimg], [nolink], [zoom], [999x999], [999%] } [,タイトル] )

&ref( 添付ファイル名| ページ名/添付ファイル名| URL [,ページ名] {, [noicon], [noimg], [nolink], [zoom], [999x999], [999%] } [,タイトル] );

概要

'#attach'でページに添付されたファイルを指定位置に展開します。添付ファイルが画像の場合は画像を表示し、それ以外の場合はダウンロード用のリンクを表示します。

引数

添付ファイル名にはページに添付したファイル名を指定します（省略時はエラーとなります）。別ページ名/添付ファイル名とする事で別ページの添付ファイルも指定できます。

ページ名にはファイルを添付したページをWikiNameかBracketNameで指定します。このオプションは最初(添付ファイル名の次)に記述してください。省略時は設置したページです。

パラメータにはファイルの展開方法を指定できます。

• set − setとし他のパラメータを指定するとそれ以降の ref の規定値とすることができます。
• left|center|right − 表示時の位置を指定します。省略時はleft(変更可)です。
• wrap|nowrap − テーブルタグで囲む/囲まないの指定を行います。省略時はnowrap(変更可)です。
• around − テキストの回り込みを可能とします。省略時は回り込みを行いません。
• noicon − ファイルが画像以外の場合に表示されるアイコンを表示しません。省略時は表示します。
• noimg − ファイルが画像の場合に画像を展開しないようにします。省略時は展開します。
• nolink − 元ファイルへのリンクを張らないようにします。省略時はリンクします。
• zoom − 縦横比を保持します。省略時はサイズ指定に従います。
• 999x999 − サイズを指定します(幅x高さ)。省略時は拡大率あるいは対象画像のサイズに従います。
• 999% − サイズを指定(拡大率)します。省略時は100%です、
• タイトル − 上記以外のパラメータは画像の代替文字列、リンクのタイトル属性として使用されます。ページ名やパラメータに見える文字列を使用するときは、#ref(hoge.png,,zoom)のようにタイトルの前にカンマを余分に入れます。

プラグイン内設定

• PLUGIN_REF_USAGE　引数未指定時に表示されるヘルプ
• PLUGIN_REF_IMAGE　マッチ時に指定ファイルを画像とみなす正規表現
• FILE_ICON　アイコンイメージのファイル
• PLUGIN_REF_DEFAULT_ALIGN　left,center,right省略時の表示位置
• PLUGIN_REF_WRAP_TABLE　wrap,nowrap省略時にテーブルタグで囲むか
• PLUGIN_REF_URL_GET_IMAGE_SIZE　URL指定時に画像サイズを取得するか
• PLUGIN_REF_DIRECT_ACCESS　添付ファイルの画像表示で UPLOAD_DIR のデータに直接アクセスするか

備考

aroundで行った回り込み指定を解除するには clearプラグイン、あるいはimgプラグインを使用して下さい。

"ほげ"という別ページの添付ファイル"fuga.jpg"をインラインプラグイン形式で参照する場合、下記２通りの記述方法が存在します。

(1) &ref(ほげ/fuga.jpg);
(2) &ref(fuga.jpg,[[ほげ]]);

上記２通りの記述のうち、(2)の記述方式は旧バージョンと互換性を維持するために用意されたもので、推奨される記述方式は(1)です。
いずれの記述方法であっても一般的な動作は同じですが、いわゆるバナー画像のように表示した画像が別ページへのリンクとなるよう以下の指定をした場合、

(1)  [[&ref(ほげ/fuga.jpg,nolink,ウェブ名);>ウェブのURL]]
(2)  [[&ref(fuga.jpg,[[ほげ]],nolink,ウェブ名);>ウェブのURL]]

(1)の記述方法は期待通りの動作をしますが、(2)の記述方法ではうまくリンクされません。
また、ほげというページに添付された画像を、そのページ内でパラメータを指定して（例えば半分の比率で）表示する場合、

(3)  &ref(./fuga.jpg,50%);
(4)  &ref(ほげ/fuga.jpg,50%);
(5)  &ref(fuga.jpg,[[ほげ]],50%);
(6)  &ref(fuga.jpg,50%);

(3)〜(5)は期待通りに同じ結果をしますが、(6)はエラーとなります。 これは(6)の書式が(2)の記述方式であるため、 添付ファイル名fuga.jpgの次の引数にページ名を期待するためです。

(7)  &ref(fuga.jpg);

(7)は(6)と似た記述ですが、添付ファイル名の次の引数が省略されているため、エラーにはなりません。

referer

種別

コマンド

重要度

★★★☆☆

書式

?plugin=referer [&page=ページ名] [&sort= 0d|0a| 1d|1a| 2d|2a| 3 ]

概要

ページを照会した利用者の参照元URL(Referer)の一覧を表示します。

引数

ページ名にはRefererを表示するページ名を指定します。ページ名はエンコードされている必要があります。省略時はRefererが記録されているページの一覧を表示します。

sortでReferer一覧のソート順を指定します。

• 0d − 最終更新日時(新着順)
• 0a − 最終更新日時(日付順)
• 1d − 初回登録日時(新着順)
• 1a − 初回登録日時(日付順)
• 2d − カウンタ(大きい順)
• 2a − カウンタ(小さい順)
• 3 − Referer

プラグイン内設定

• CONFIG_REFERER　無視するURIを指定したページ

備考

pukiwiki.ini.php で、Refererを使用する設定($referer = 1を指定)が行われている必要があります。

related

種別

コマンド

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

重要度

★★★☆☆

書式

?plugin=related [&page=ページ名]

#related

概要

対象のページを参照しているページの一覧を表示します。

引数

ブロック型で実行時、設置したページが対象となります。

コマンドで実行時、ページ名に対象となるページを指定できます。省略した場合、トップページが指定されたとみなします。

rename

種別

コマンド

重要度

★★★☆☆

書式

?plugin=rename [&refer=ページ名]

概要

既存ページの名前を変更します。実行には管理者権限が必要です。

ページの本文のほか、指定されたページ名の差分、バックアップ、添付ファイル、カウンターを一気にリネームします。

引数

ページ名には変更するページの名前を指定します。省略時はページ名の選択または正規表現置換用文字列入力画面が表示されます。

実行結果は変換結果のページ（PLUGIN_RENAME_LOGPAGE で指定。標準は :RenameLog）に追記されます。

プラグイン内設定

• PLUGIN_RENAME_LOGPAGE　ページ名の変換結果を出力するページ名

備考

ページ内のリンクの書き換えは行ないません。yetlistなどを駆使して対処してください。

TrackBackやRefererの情報は更新されません。

リネーム対象のページが凍結されているかどうかはチェックしていません。

関連ページにリネーム対象の文字列が複数含まれているとおかしくなります。

• たとえば、hogeおよびhoge/hogeという二つのページがあったときに、hogeページをfugaに(関連ページを含んで)リネームすると、hoge/hogeページの名前がfuga/fugaになってしまいます。

rss

種別

コマンド

重要度

★☆☆☆☆

書式

?plugin=rss [&ver=0.91| 1.0| 2.0]

概要

RecentChangesをRSSに変換して出力します。

引数

verで出力するRSSを指定します。省略時は0.91を出力します。

備考

RSSはサイトの要約を配信するために使われるXMLフォーマットです。RSS 1.0はRDF(Resource Description Framework)にもとづいたRSS 0.9の後継フォーマットです。RSS 0.91は RDFにもとづかないRSSの実装で、RSS 2.0は RSS 0.91および 0.92の後継フォーマットです。RSSという頭字語が何の略であるかは、それぞれ異なります。

RSS 0.9および1.0: RDF Site Summary

RSS 0.91および0.92: Rich Site Summary

RSS 2.0: Really Simple Syndication

rss10

種別

コマンド

重要度

★☆☆☆☆

書式

?cmd=rss10

概要

RecentChangesをRSS(RDF Site Summary)1.0に変換して出力します。

備考

rss10プラグインの機能はrssプラグインにマージされたため、 このプラグインは過去との互換性のためにのみ存在しています。 (将来的に削除される可能性があります)

このプラグインにアクセスすると、HTTPステータス・コード 301 (Moved Permanently)とともに、ver=1.0オプションを指定したrssプラグイン のURIへリダイレクトされます。

ruby

種別

インライン型プラグイン

重要度

★☆☆☆☆

書式

&ruby( ルビ ){ 対象文字列 };

概要

文字列にルビをふります。

引数

ルビには表示するルビを指定します。

対象文字列にはルビがふられる文字列を指定します。

プラグイン内設定

• PLUGIN_RUBY_USAGE　引数未指定時に表示されるヘルプ

備考

XHTML 1.1のルビに対応したブラウザでないと、ルビとして表示されません。IE5.5/6では表示できます。Netscape 7/MozillaではXHTML Ruby Supportを組み込めば表示できます。

ルビに対応していないブラウザではルビをふる文字列の直後にルビが( )に入れられて表示されます。

• Prev
  L-N
• Next
  S-U
• Home

テスト

ブラケットネームテスト

コモンズ

ページタイトルの－テスト－

タイトルに－を入れて文字化けしないかどうかのテスト こちらでは，きちんと入力されるが，自宅環境では，タイトルの－が?マークになってしまうのはなぜ？

insertプラグインの入力テスト

テスト。

#insert ならOKだけど #insert() だと NG になってた。

次回CVS更新で修正されます。

codeプラグイン実験

1 2 3 4 5 6 7 8 9 10 11 12 13 14

*a aaa **bb [#a2dacdfc] **TagCloud:Category** [#e5a37905] ***New *c ccc ***a -a --aa -b --bb -c

1 2 3 4 5 6

- | | !

#include <stdio.h> int main(void) { printf("Hello, world!"); return 0; }

テキスト整形のルール

通常は入力した文章がそのまま出力されます。

• HTMLのタグは効果がありません。書かれた文章はそのまま(「<font color="red">text</font>」といった形のまま)表示されます
• 段落と段落の区切りには空行をはさんで下さい。空行をはさまず、連続している複数の行は同じ段落と解釈されます (連結して表示されます)

これに加えて、特定のルールによるテキスト整形を行うことができます。以下では、プラグインについてはよく使われるものだけを簡略に説明しています。プラグインのオプションなど詳細な説明については PukiWiki/1.4/Manual/Plugin を参照してください。

ブロック要素

• ブロック要素は、インライン要素と他のブロック要素を子要素にすることができます。ただし、段落、見出し、水平線、#から始まるブロック要素は他のブロック要素を子要素にすることはできません。

• 空行はトップレベルのブロック要素の区切りになります。空行が現われると、すべてのブロック要素は終了します。

• ブロック要素は、他のブロック要素の子要素になることができます。
  • リスト構造と引用文は他のブロック要素を子要素にすることができます。子要素のブロック要素は親要素のレベルに従ってインデントされて表示されます。空行が現われるとブロック要素は終了します。
  • リスト構造と引用文のネストには3段階のレベルがありますが、リスト構造のレベルと引用文のレベルは独立しています。従って、リスト構造を引用文の子要素にする場合や引用文をリスト構造の子要素にする場合は、レベルを1段階増やさずに記述します。リスト構造を他のリスト構造の子要素にする場合や引用文を他の引用文の子要素にする場合は、レベルを1段階増やして記述します。
  • 他のブロック要素の子要素となっている引用文から脱出するとき、親のブロック要素を継続したい場合は行頭に<、<<、<<<を記述します。<で第1レベルの引用文から、<<で第2レベルの引用文から、<<<で第3レベルの引用文から脱出します。空行を記述すると引用文だけでなく親のブロック要素からも脱出します。

• ブロック要素となるプラグインは#〜の形式になっています。*1

段落

インライン要素

他のブロック要素を明示しない限り、段落となります。

~ インライン要素

行頭で ~ を指定した場合も段落になります。行頭書式の文字(~、-、+、:、>、|、#、//)を通常の文字として段落の先頭に書きたい場合は、行頭に~を記述して書くことができます。

• 段落の先頭は1文字分字下げされます。但し、番号なしリスト構造、番号付きリスト構造、引用文内の段落では字下げされません。定義リスト内の段落の先頭は1文字分字下げされます。
• 段落は、新たなブロック要素が現われるまで継続します。
• 段落は、他のブロック要素の子要素になることができます。
• 段落は、他のブロック要素を子要素にすることはできません。

引用文

> インライン要素

行頭で > を指定すると、引用文になります。引用文は >、>>、>>> の3レベルあります。

• 引用文の中は、ブロック要素を明示しない限り、段落となります。
• 引用文は、空行が現われるまで継続します。
• 引用文内の段落は、新たな引用文またはブロック要素が現われるまで継続します。
• 引用文は、他のブロック要素の子要素になることができます。他の引用文の子要素にする場合は、レベルを1段増やして記述します。リスト構造の子要素にする場合はレベルを1段増やさずに記述します。
• 引用文は、他のブロック要素を子要素にすることができます。引用文の子要素となるリスト構造はレベルを1段増やさずに記述します。
• リスト構造内の引用文から脱出する場合で、リスト構造を継続する場合は、<、<<、<<<を行頭に記述します。

リスト構造

- インライン要素

行頭で - を指定すると、番号なしリストになります。番号なしリストは -、--、--- の3レベルあります。

• 番号なしリストは、他のブロック要素の子要素になることができます。他のリスト構造の子要素にする場合は、レベルを1段増やして記述します。引用文の子要素にする場合は、レベルを増やさずに記述します。
• -の直後に ~を記述すると段落を子要素にすることができます。
• 番号なしリストは、リストの先頭がインライン要素または段落である場合に限り、リストの次の行に他のブロック要素を記述することで、他のブロック要素を子要素にすることができます。

+ インライン要素

行頭で + を指定すると、番号付きリストになります。番号付きリストは +、++、+++ の3レベルあります。

• 番号付きリストは、他のブロック要素の子要素になることができます。他のリスト構造の子要素にする場合は、レベルを1段増やして記述します。引用文の子要素にする場合は、レベルを増やさずに記述します。
• + の直後に ~ を記述すると段落を子要素にすることができます。
• 番号付きリストは、リストの先頭がインライン要素または段落である場合に限り、リストの次の行に他のブロック要素を記述することで、他のブロック要素を子要素にすることができます。

: 定義語 | 説明文

行頭を : で始め、| 記号で区切ると、定義リストになります。定義リストは :、::、::: の3段階あります。定義リストの定義語、説明文は省略することができます。複数の連続した定義リストを記述し、2つ目以降の定義語を省略することで1つの定義語に対する複数の説明文を記述することができます。

• 行中に | がないと定義リストにはなりません。
• 定義語・説明文は、インライン要素のみ記述することができます。
• 定義リストは、他のブロック要素の子要素になることができます。他のリスト構造の子要素にする場合は、レベルを1段増やして記述します。引用文の子要素にする場合は、レベルを増やさずに記述します。
• | の直後に ~ を記述すると段落を子要素にすることができます。
• 定義リストは、定義リストの次の行に他のブロック要素を記述することで、他のブロック要素を子要素にすることができます。

整形済みテキスト

行頭が半角空白で始まる行は整形済みテキストとなります。行の自動折り返しは行なわれません。

• 整形済みテキストは、他のブロック要素の子要素になることができます。
• 整形済みテキストは、他のブロック要素を子要素にすることができません。
• 整形済みテキストは、すべての子要素を文字列として扱います。

表組み

| インライン要素 | インライン要素 |

行頭から | でインライン要素を区切ることで表組みになります。

• 各要素の先頭に下記の記述子を指定できます。

  LEFT:
  CENTER:
  RIGHT:
  BGCOLOR(色):
  COLOR(色):
  SIZE(サイズ):

  • 要素の表示位置及び背景色・文字色・文字サイズ(px単位)を指定します。デフォルトは左寄せになります。

  表組みの	各セルの要素の配置に	関するサンプル
  左寄せ	センタリング	右寄せ
  右寄せ	左寄せ	センタリング

• セル内の行揃えは、１つ以上の空白(半角スペース)や "<" "=" ">" を使って表現することもできます。

  |           ~Table with alignment          |||h
  |         right|    center    |left          |
  |left          |         right|    center    |
  | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

|=~Table with alignment                    |||h
|>right        |=center       |<left         |
|<left         |>right        |=center       |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

• 行末にcを記述すると、書式指定行となります。書式指定行では、次の記述子が指定できます。

  LEFT:
  CENTER:
  RIGHT:
  BGCOLOR(色):
  COLOR(色):
  SIZE(サイズ):

  • 記述子の後ろに数値を記述すると、セル幅がpx単位で指定できます。

• 行末にhを記述すると、ヘッダ行(thead)になります。
• 行末にfを記述すると、フッタ行(tfoot)になります。
• セル内のインライン要素の先頭に~を付けると、ヘッダ(th)になります。
• 空白のセルは、左のセルと連結されます。(左に有効なセルがない時は、右のセルと連結します。)
• セル内に > を単独で記述すると右のセルと連結します(colspan)。
• セル内に < を単独で記述すると左のセルと連結します(colspan)。
• セル内に ~ または ^ を単独で記述すると上のセルと連結します(rowspan)。

• 表組みは、他のブロック要素の子要素になることができます。
• 表組みは、他のブロック要素を子要素にすることができません。

CSV形式の表組み

,データ,データ,…

行頭でカンマ(,)を記述し、インライン要素をカンマ区切りで記述すると表組みになります。

• インライン要素はダブルクォーテーション(")で囲むことができます。ダブルクォーテーションで囲むことで、カンマ(,)を含むインライン要素を記述できます。
• ダブルクォーテーション(")で囲んだデータの中で、ダブルクォーテーションを2つ("")続けることで、ダブルクォーテーション(")を含むインライン要素を記述できます。
• インライン要素の代わりにイコールを2つ(==)記述すると、colspanを意味します。
• インライン要素の左に1つ以上の半角空白文字を記述すると右寄せに、インライン要素の左右に1つ以上の半角空白文字を記述するとセンタリングになります。

• 表組みは、他のブロック要素の子要素になることができます。
• 表組みは、他のブロック要素を子要素にすることができません。

見出し

* インライン要素

行頭で * を記述すると、見出しになります。見出しは *、**、*** の3段階あります。

• 見出しは、他のブロック要素の子要素になることはできません。見出しが現われると他のブロック要素は終了します。
• 見出しは、他のブロック要素を子要素にすることはできません。

目次

#contents

行頭で #contents を記述すると、見出しに基づいて目次を作成します。一般的に #contents はページの最初のほうに記述します。

• 目次は、他のブロック要素の子要素になることができますが、トップレベルに設置することを前提に左マージンを設定してありますので、他のブロック要素の子要素にはしないでください。
• 目次は、他のブロック要素を子要素にすることはできません。

左寄せ・センタリング・右寄せ

LEFT:インライン要素
CENTER:インライン要素
RIGHT:インライン要素

行頭で LEFT:、 CENTER:、 RIGHT: を記述すると、インライン要素が左寄せ、センタリング、右寄せされます。

• LEFT:、CENTER:、RIGHT:は、他のブロック要素の子要素になることができます。
• LEFT:、CENTER:、RIGHT:は、他のブロック要素を子要素にすることができません。

水平線

---------------------------------------------

行頭で4つ以上の - を書くと水平線になります。

• 水平線は、他のブロック要素の子要素になることはできません。水平線が現われると他のブロック要素は終了します。
• 水平線は、他のブロック要素を子要素にすることはできません。

#hr

行頭で #hr を記述すると、区切り線になります。区切り線は上位のブロック要素の幅の60%の長さの水平線がセンタリングされて引かれます。

• 区切り線は、他のブロック要素の子要素になることができます。
• 区切り線は、他のブロック要素を子要素にすることはできません。

行間開け

#br

行頭で #br を記述すると、ブロック要素間またはブロック要素内で行間を開けることができます*2。

• 行間開けは、他のブロック要素の子要素になることができます。
• 行間開けは、他のブロック要素を子要素にすることはできません。

添付ファイル・画像の貼り付け

#ref(添付ファイル名)
#ref(ファイルのURL)

行頭で #ref を記述すると、添付ファイルまたは指定されたURLにあるファイルへのリンクを貼り付けることができます。ファイルが画像ファイルの場合は、その画像を表示します。

• #ref には、カンマで区切って下記のパラメタを指定できます。パラメタを省略した場合はデフォルト値となります。

  添付ファイルのページ

  • 添付ファイルが存在するページ名を指定します。デフォルトは現在のページです。
  • このパラメタを指定する場合は、添付ファイル名の次に記述します。

  left
  center
  right

  • ファイルへのリンク・画像を表示する位置を指定します。デフォルトではセンタリングされます。

  wrap
  nowrap

  • ファイルへのリンク・画像を枠で囲むかどうかを指定します。デフォルトは囲みません。

  around

  • テキストの回り込みを指定します。デフォルトでは回り込みを行ないません。

  nolink

  • デフォルトでは添付ファイルへのリンクが張られますが、nolinkを指定するとリンクを張りません。

  代替文字列

  • ファイル名の代わりに表示する文字列や画像の代替文字列を指定できます。指定しない場合は、ファイル名になります。
  • 代替文字列には文字列以外のインライン要素を含めることはできません。ページ名、文字列以外のインライン要素を記述しても文字列として扱われます。
  • このパラメタを指定する場合は、最後に記述します。

• #refは、他のブロック要素の子要素になることができます。
• #refは、他のブロック要素を子要素にすることはできません。

テキストの回り込みの解除

#clear

行頭で #clear を記述すると、 #ref で指定したテキストの回り込みを解除します。 #clear を指定しなくても、記事の末尾でテキストの回り込みが自動的に解除されます。

• #clearは、他のブロック要素の子要素になることができます。
• #clearは、他のブロック要素を子要素にすることができません。

フォーム

#comment

行頭で #comment を記述すると、コメントを挿入するためのフォームが埋め込まれます。

• #commentは、他のブロック要素の子要素になることができますが、トップレベルに設置することを前提に左マージンを設定してありますので、他のブロック要素の子要素にはしないでください。
• #commentは、他のブロック要素を子要素にすることはできません。

#pcomment

行頭で #pcomment を記述すると、コメントを挿入するためのフォームが埋め込まれます。 #comment とは異なり、コメントは別ページに記録されます。また、コメントに対するレスポンスを階層状に表示します。

• #pcommentは、他のブロック要素の子要素になることができますが、トップレベルに設置することを前提に左マージンを設定してありますので、他のブロック要素の子要素にはしないでください。
• #pcommentは、他のブロック要素を子要素にすることはできません。

#article

行頭で#articleを記述すると、簡易掲示板のフォームが埋め込まれます。

• #articleは、他のブロック要素の子要素になることができますが、トップレベルに設置することを前提に左マージンを設定してありますので、他のブロック要素の子要素にはしないでください。
• #articleは、他のブロック要素を子要素にすることはできません。

#vote(選択肢1,選択肢2,...)

行頭で #vote を記述すると、簡易投票フォームが埋め込まれます。

• 選択肢は文字列、ページ名、InterWiki、リンクを含めることができます。その他のインライン要素を含めることができません。
• #voteは、他のブロック要素の子要素になることができますが、トップレベルに設置することを前提に左マージンを設定してありますので、他のブロック要素の子要素にはしないでください。
• #voteは、他のブロック要素を子要素にすることはできません。

インライン要素

• インライン要素は、必ずブロック要素の子要素になっています。
  • 行頭書式でブロック要素を明示しない場合は、段落の子要素となります。
  • 行頭書式でブロック要素を明示した場合は、指定したブロック要素の子要素になります。

• 特定のインライン要素は、他のインライン要素を子要素にすることができます。
• インライン要素はブロック要素を子要素にすることはできません。
• インライン要素となるプラグイン及びユーザー定義は &〜; の形式になっています。
• インライン要素となるプラグインに対してオプションと子要素を指定する場合は、 &プラグイン名(オプション){子要素}; の形式になります。

文字列

文字列

文字列はインライン要素です。

• 文字列は、他のインライン要素の子要素になることができます。
• 文字列は、他のインライン要素を子要素にすることができません。

改行

インライン要素~

行末に~を書くと行末改行になります。行末改行はブロック要素内での改行になります。

• 行末改行の次の行の行頭書式は無効になり、文字列として扱われます。
• 行末改行は、他のインライン要素の子要素になることはできません。
• 行末改行は、他のインライン要素を子要素にすることはできません。
• 行末改行は、定義リストの定義語、表組みの要素、#で始まるブロック要素のパラメタの中では使用できません。

&br;

行中に &br; を書くと、そこで改行されます。行末の ~ と違い、定義リストの定義語や表組の要素、# で始まるブロック要素のパラメタの中でも使用できます。

• 行中改行は、他のインライン要素の子要素になることができます。
• 行中改行は、他のインライン要素を子要素にすることはできません。

強調・斜体

''インライン要素''

行中のインライン要素を '' ではさむと、インライン要素が 強調表示 になります。

• 強調は、他のインライン要素の子要素になることができます。
• 強調は、他のインライン要素を子要素にすることができます。

'''インライン要素'''

行中のインライン要素を ''' ではさむと、インライン要素が 斜体表示 になります。

• 斜体は、他のインライン要素の子要素になることができます。
• 斜体は、他のインライン要素を子要素にすることができます。

文字サイズ

&size(サイズ){インライン要素};

行中に &size を書くとインライン要素の文字サイズを指定することができます。サイズはピクセル単位(px)で指定します。例えば20を指定すると、20ピクセルの文字の大きさになります。

• 文字サイズは、他のインライン要素の子要素になることができます。
• 文字サイズは、他のインライン要素を子要素にすることができます。

文字色

&color(文字色,背景色){インライン要素};

行中に &color と書くとインライン要素の文字色と背景色を指定することができます。背景色は省略できます。

• 色の指定は、次のいずれかの形式で行ないます。
  • 色を意味するキーワード(red, blueなど)
  • #16進数6桁
  • #16進数3桁

• 文字色は、他のインライン要素の子要素になることができます。
• 文字色は、他のインライン要素を子要素にすることができます。

取消線

%%インライン要素%%

行中のインライン要素を%%ではさむと、インライン要素に取消線が付きます。

• 取消線は、他のインライン要素の子要素になることができます。
• 取消線は、他のインライン要素を子要素にすることができます。

注釈

((インライン要素))

行中でインライン要素を (( と )) ではさむと、注釈*3が作成され、行中に注釈へのリンクが貼られます。

• 注釈は、他のインライン要素の子要素になることができます。親要素は注釈文ではなく、注釈へのリンクに反映されます。
• 注釈は、他のインライン要素を子要素にすることができます。子要素は注釈文に反映されます。

添付ファイル・画像の貼り付け

&ref(添付ファイル名[,パラメタ]){代替文字列};
{{添付ファイル名[,パラメタ]|代替文字列}}

&ref(ファイルのURL[,パラメタ]){代替文字列};
{{ファイルのURL[,パラメタ]|代替文字列}}

行中で &ref または、{{ }} を記述すると、添付ファイルまたは指定されたURLにあるファイルへのリンクを貼り付けることができます。ファイルが画像ファイルの場合は、その画像を表示します。

• 添付ファイル名を省略すると、ファイルアップロードのためのリンクになります。そのリンクを使ってファイルをアップロードすると、そのリンク部分が添付したファイル表示に置換されます。
• &ref には、カンマで区切って下記のパラメタを指定できます。パラメタを省略した場合はデフォルト値となります。

  添付ファイルのページ

  • 添付ファイルが存在するページ名を指定します。デフォルトは現在のページです。
  • このパラメタを指定する場合は、添付ファイル名の次に記述します。
  • 添付ファイル名を "ページ名/添付ファイル名" とすることもできます。

  nolink

  • デフォルトでは添付ファイルへのリンクが張られますが、nolink を指定するとリンクを張りません。

  代替文字列

  • ファイル名の代わりに表示する文字列や画像の代替文字列を指定できます。指定しない場合は、ファイル名になります。
  • 代替文字列には文字列以外のインライン要素を含めることはできません。ページ名、文字列以外のインライン要素を記述しても文字列として扱われます。
  • このパラメタを指定する場合は、最後に記述します。

• &ref は、他のインライン要素の子要素になることができます。
• &ref は、他のインライン要素を子要素にはできません。

ルビ構造

&ruby(ルビ){インライン要素};

行中で &ruby を書くとインライン要素に対するルビをふることができます。ルビに対応していないブラウザではルビが本文中に ( と ) に囲まれて表示されます。

• ルビ構造のルビにはインライン要素を記述します。ただし、ルビの特性上、期待通りの表示になるとは限りません。
• ルビ構造は、他のインライン要素の子要素になることができます。
• ルビ構造は、他のインライン要素を子要素にすることができます。
• ルビ構造をルビ構造の子要素にはできません(ネストはできません)。
• 注釈内や文字サイズを小さくしている部分での使用は、ルビが判読できなくなるので避けてください。

アンカーの設定

&aname(アンカー名);
&aname(アンカー名){インライン要素};

行中で &aname を記述するとリンクのアンカーを設定することができます。リンクの飛び先にしたい位置に記述します。

• アンカー名は、半角アルファベットから始まる半角アルファベット・数字・ハイフン・アンダースコアからなる文字列を指定します。
• アンカー名の中には、全角文字や半角空白文字、半角記号を含めることはできません。
• アンカー設定は、他のインライン要素の子要素になることができます。
• アンカー設定は、他のインライン要素を子要素にすることができます。

カウンタ表示

&counter;
&counter(オプション);

行中で &counter を記述するとそのページにアクセスした人の数を表示することができます。

• &counter には次のオプションを指定できます。オプションを省略した場合はtotalが指定されたものとみなされます。

  today

  • 今日のアクセス数を表示します。

  yesterday

  • 昨日のアクセス数を表示します。

  total

  • アクセス総数を表示します。
• カウンタ表示は、他のインライン要素の子要素になることができます。
• カウンタ表示は、他のインライン要素を子要素にはできません。

オンライン表示

&online;

行中で &online を記述すると現在アクセス中の人数を表示することができます。

• オンライン表示は、他のインライン要素の子要素になることができます。
• オンライン表示は、他のインライン要素を子要素にはできません。

バージョン表示

&version;

行中で &version を記述するとPukiWikiのバージョンを表示することができます。

• バージョン表示は、他のインライン要素の子要素になることができます。
• バージョン表示は、他のインライン要素を子要素にはできません。

WikiName

WikiName

行中で、1つ以上の大文字→1つ以上の小文字→1つ以上の大文字→1つ以上の小文字の組合わせからなる半角//文字列はWikiNameになります。

• WikiNameの中には、全角文字や半角空白文字、記号、数字を含めることはできません。
• WikiNameは、PukiWiki内のページ名になります。すでに存在するページであればそのページへのリンクが自動的に貼られます。存在しない場合はWikiNameの後ろに?が自動的に付き、そのページを新規作成するためのリンクが貼られます。

• WikiNameは、他のインライン要素の子要素になることができます。
• WikiNameは、他のインライン要素を子要素にはできません。

ページ名

[[ぷきうぃき]]

行中で [[ と ]] で囲まれた文字列はページ名になります。

• ページ名の中には、全角文字、記号、数字、半角空白文字を含めることができます。
• ページ名の中には、"#&<> を含めることはできません。
• すでに存在するページであればそのページへのリンクが自動的に貼られます。存在しない場合はページ名の後ろに?が自動的に付き、そのページを新規作成するためのリンクが貼られます。

[[ページ名#アンカー名]]

• ページ名にアンカー名をつけることもできます。

• ページ名は、他のインライン要素の子要素になることができます。
• ページ名は、他のインライン要素を子要素にはできません。

InterWiki

[[InterWikiName:ページ名]]

行中のページ名形式の文字列の中で、: で2つの文字列を区切るとInterWikiになります。:の前にはInterWikiNameのページで定義したInterWikiNameを、: の後ろにはページ名を記述します。

[[InterWikiName:ページ名#アンカー名]]

• ページ名の後ろにアンカー名をつけることもできます。

• InterWikiNameの中には、全角文字を含めることができます。
• InterWikiNameの中には、半角空白文字を含めるができます。
• InterWikiは、他のインライン要素の子要素になることができます。
• InterWikiは、他のインライン要素を子要素にはできません。

リンク

[[リンク名:URL]]

行中のInterWikiNameの形式の文字列の中で、: の前に任意のリンク名を、: の後ろにURLを記述すると、そのリンク名でURLに対するリンクを貼ることができます。

• リンク名には、全角文字や半角空白文字を含めることができます。メールアドレスを指定する場合は、mailto:を書かずにアドレスだけを記述します。

http://www.example.com/
https://www.example.com/
ftp://ftp.example.com/
news://news.example.com/
foo@example.com

• 行中に直接、URLを記述した場合は自動的にそのURLに対するリンクが貼られます。

• 記述したURLが画像ファイルである場合は、その画像を表示します。

• リンクは、他のインライン要素の子要素になることができます。
• リンクは、他のインライン要素を子要素にはできません。

エイリアス

[[エイリアス名>ページ名]]

行中のページ名形式の文字列の中で、> で2つの文字列を区切るとエイリアスになります。 > の前にはエイリアス名を、> の後ろにはページ名を記述します。

エイリアスはPukiWiki内のページ名とは別のエイリアス名で、指定したページへのリンクを貼ります。

[[エイリアス名>ページ名#アンカー名]]
[[エイリアス名>#アンカー名]]

• ページ名にアンカー名を付け加えてアンカーへのリンクを貼ることができます。ページ名とアンカー名の間には#をつけます。カレントページのアンカーへリンクを貼る場合はページ名を省略することができます。

[[エイリアス名>http://www.example.com/]]
[[エイリアス名>https://www.example.com/]]
[[エイリアス名>ftp://ftp.example.com/]]
[[エイリアス名>news://news.example.com/]]
[[エイリアス名>foo@example.com]]
[[エイリアス名>InterWikiName:ページ名]]
[[エイリアス名>InterWikiName:ページ名#アンカー名]]

• エイリアスをURLやInterWikiと組み合わせることもできます。

[[エイリアス名:http://www.example.com/]]
[[エイリアス名:https://www.example.com/]]
[[エイリアス名:ftp://ftp.example.com/]]
[[エイリアス名:news://news.example.com/]]
[[エイリアス名:foo@example.com]]

• URLを指定する場合は、>の代わりに:も使用できます。

• エイリアス名の中には、全角文字を含めることができます。
• エイリアス名の中には、半角空白文字を含めることができます。
• 階層化されたページでは、ページ名を相対指定することができます。
• エイリアスは、他のインライン要素の子要素になることができます。
• エイリアスは、他のインライン要素を子要素にできます。

タブコード

&t;

行中で &t; と書くと、タブコードに置換されます。

通常、フォーム内ではキーボードからタブコードを直接入力できない*4ので、タブコードを入力したい位置に&t;を記述すると、保存時にタブコードに置換します。

• タブコードは、記事が書き込まれるときに置換されて記録されます。
• タブコードは、他のインライン要素の子要素になることができます。
• タブコードは、他のインライン要素を子要素にはできません。

ページ名置換文字

&page;
&fpage;

行中で &page; 及び &fpage; と書くと、編集中のページ名に置換されます。ページ名が階層化されたページで「hogehoge/hoge」となっている場合、 &page; は「hoge」に、 &fpage; は「hogehoge/hoge」に置換されます。階層化されていないページでは、 &page; も &fpage; も同じになります。

• ページ名置換文字は、記事が書き込まれるときに置換されて記録されます。
• ページ名置換文字は、他のインライン要素の子要素になることができます。
• ページ名置換文字は、他のインライン要素を子要素にはできません。

日時置換文字

&date;
&time;
&now;

• 行中で &date; と書くと、更新時の日付に置換されます
• 行中で &time; と書くと、更新時の時刻に置換されます
• 行中で &now; と書くと、更新時の日時に置換されます

date?
time?
now?

• PukiWiki 1.3系との後方互換性のために、 date?、 time?、 now? についても使用できるようにしてあります。

• &date;、 &time;、 &now;は、記事が書き込まれるときに置換されて記録されます。
• &date;、 &time;、 &now;は、他のインライン要素の子要素になることができます。
• &date;、 &time;、 &now;は、他のインライン要素を子要素にはできません。

&_date;
&_time;
&_now;

• 行中で &_date; と書くと、表示時の日付に置換されて出力されます。
• 行中で &_time; と書くと、表示時の時刻に置換されて出力されます。
• 行中で &_now; と書くと、表示時の日時に置換されて出力されます。

&lastmod;
&lastmod(ページ名);

• 行中で &lastmod; と書くと、そのページの最終更新日時に置換されて出力されます。
• ページ名を指定すると、その指定されたページの最終更新日時に置換されて出力されます。

• &_date;、 &_time;、 &_now;、 &lastmod;は、記事が表示されるときに置換されて出力されます。
• &_date;、 &_time;、 &_now;、 &lastmod;は、他のインライン要素の子要素になることができます。
• &_date;、 &_time;、 &_now;、 &lastmod;は、他のインライン要素を子要素にはできません。

文字参照文字

文字参照は、SGMLで定義されている文字参照文字(&copy;や&reg;など)のほか、下記の独自の文字参照文字が使用できます。

&heart;
⌣
&bigsmile;
&huh;
&oh;
&wink;
&sad;
&worried;

• 行中で&heart;と書くと、ハートマーク に置換されて出力されます。
• 行中で&smile;と書くと、 に置換されて出力されます。
• 行中で&bigsmile;と書くと、 に置換されて出力されます。
• 行中で&huh;と書くと、 に置換されて出力されます。
• 行中で&oh;と書くと、 に置換されて出力されます。
• 行中で&wink;と書くと、 に置換されて出力されます。
• 行中で&sad;と書くと、 に置換されて出力されます。
• 行中で&worried;と書くと、 に置換されて出力されます。

• 文字参照文字は、表示されるときに置換されます。
• 文字参照文字は、他のインライン要素の子要素になることができます。
• 文字参照文字は、他のインライン要素を子要素にはできません。

数値参照文字

&#10進数;
&#x16進数;

行中で &# と ; の間に10進数を、&#x と ;の間に16進数を書くと、Unicodeを数値参照して表示します。キーボードから直接入力できない文字やJIS第3水準・第4水準の文字などの表示に使用します。たとえば、内田百&#38290;と入力すると、内田百閒と表示されます。

• 数値参照文字は、表示されるときに置換されます。
• 数値参照文字は、他のインライン要素の子要素になることができます。
• 数値参照文字は、他のインライン要素を子要素にはできません。
• 16進数は半角小文字で指定する必要があります(XHTML 1.0 第2版から小文字に限定されました)。

その他

コメント行

// コメント

行頭で // を指定すると、コメント行になります。コメント行は出力されない行です。

• コメント行は、他の要素と無関係に行単位でどの位置にも記述できます。
• コメント行は、前後の他の要素に何ら影響を及ぼしません。

Table of contents

• L
  • lastmod
  • links
  • list
  • lookup
  • ls
  • ls2
• M
  • map
  • md5
  • memo
  • menu
• N
  • navi
  • new
  • newpage
  • nofollow
  • norelated

L

lastmod

種別

インライン型プラグイン

重要度

★☆☆☆☆

書式

&lastmod( [ページ名] );

概要

指定したページの最終更新日時を表示します。

引数

ページ名には最終更新日時を表示したいページ名を指定します。 省略時は設置したページとみなします。

links

種別

コマンド

重要度

★★☆☆☆（管理者）

書式

?plugin=links

概要

ページ間のキャッシュを更新します。通常使用する必要はありません。

メンテナンス作業などでページが記録されているファイルを直接操作した場合にキャッシュとページの記述内容の整合性がとれなくなるため、実行する必要があります。

備考

実行の際に管理者パスワードを要求されます。

list

種別

コマンド

重要度

★★★★☆

書式

?cmd=list

概要

ページの一覧を表示します。

lookup

種別

（コマンド）

ブロック型プラグイン

重要度

★★★☆☆

書式

#lookup( interwikiname [,ボタン名 [,入力欄の初期値]] )

概要

記述した位置にテキスト入力欄とボタンを表示します。任意の文字列を入力してボタンを押すと、interwikinameと入力値から生成したURLへ移動します。これによって、検索エンジンにクエリを送信したり、番号をタイプするだけで該当するアーカイブにアクセスすることなどが可能になります。

URLの生成にはInterWikiを利用します。このプラグインが生成するURLは、以下のようなInterWikiと同じです。InterWikiNameのページに、あらかじめURLの生成に使用するInterWikiNameを設定しておく必要があります。

[[interwikiname:入力欄の値]]

入力欄が空欄(空文字列)のときは、ボタンを押しても動作しません。必ず何らかの文字列を入力する必要があります。

引数

interwikiname: InterWikiNameに設定した値の一つを指定します。

ボタン名: ボタンに表示するキャプションを指定します。省略時は'lookup'です。

入力欄の初期値: 初期値を指定したい場合に記入します。省略時は空文字列になります。

プラグイン内設定

• • PLUGIN_LOOKUP_USAGE　引数未指定時に表示されるヘルプ

ls

種別

ブロック型プラグイン

重要度

★★☆☆☆

書式

#ls( [title] )

概要

記述したページより階層化されているページのページ名を一覧表示します。

引数

titleを指定した場合、ページ名に加えてタイトルを表示します。タイトルは各ページの一行目の内容を表示します。省略時はタイトルを表示しません。

備考

実際には、より高機能なls2を使用する機会が多いと思われます。

ls2

種別

（コマンド）

ブロック型プラグイン

重要度

★★★☆☆

書式

#ls2( [[パターン] [, { [title], [include], [reverse], [compact], [link] } [,linkの別名表示] ]] )

概要

指定したパターンで始まるページ名を一覧表示します。

引数

パターンには表示するページ名の共通部分を指定します。省略時は"設置したページ名/"となります。
また、「ディレクトリ名:ページパターン」と指定して同じシステム上の別のxpWikiの一覧表示をすることもできます。

title,include,reverse,compact,link で表示方法を指定します。

• • title − ページに含まれる見出し(*,**,***)の一覧を併記します。
  • include − 下位層のページが#includeを使用していた場合、includeしているページの一覧を表示します。
  • reverse − ページの並び順を反転し、名前の降順に表示します。省略すると名前の昇順に表示されます。
  • compact − 見出しレベルを調整します。
  • link − #ls2を書いた位置に一覧を表示する代わりにリンクを表示します。このリンクを選択すると別画面にページの一覧を表示するようにします。

linkの別名表示には、パラメータlinkを指定した際に表示される文字列の代わりの文字列を指定します。省略時は '...'で始まるページの一覧となります。

プラグイン内設定

• • PLUGIN_LS2_ANCHOR_PREFIX　見出しアンカーの書式
  • PLUGIN_LS2_ANCHOR_ORIGIN　見出しアンカーの開始番号
  • PLUGIN_LS2_LIST_COMPACT　compactオプション省略時、見出しレベルを調整するか

備考

ls プラグインとの違いについて。

• • 階層化されたページの起点となるページが、lsでは記述したページ固定だが、ls2ではパラメータで指定できます。
  • titleパラメータを指定した場合に、lsでは「ページの一行目」が表示されるが、ls2では「見出しの一覧」を表示します。
  • include, link という表示オプションが追加されています。

ページ名のソートにはnatcasesort()を使っているため、昇順の場合、半角英数字よりも漢字の方が先に表示されます。

M

map

種別

コマンド

重要度

★☆☆☆☆

書式

?plugin=map [&refer=ページ名] [&reverse=true]

概要

サイトマップの様にページ間のリンク関係を一覧表示します。

指定したページを起点に、リンクで辿れるページを全てツリー状に表示します。

引数

引数には一覧表示方法のオプションを指定します。

• • &refer=ページ名 − 起点となるページを指定します。省略すると、サイトのトップページ(通常はFrontPage)が起点となります。
  • &reverse=true − どこへリンクしているかではなく、どこからリンクされているかを一覧表示します。 どこからもリンクされていないページは、画面の後半にまとめて表示されます。

プラグイン内設定

• • PLUGIN_MAP_SHOW_HIDDEN　表示対象外のページをリストアップするかどうか

md5

種別

コマンド

重要度

★☆☆☆☆

書式

?plugin=md5 &md5=文字列

概要

選択したパスワードの形式に応じて、pukiwiki.ini.php に保存する パスワード用文字列を出力します。

パスワードのフォーマットは以下の8種類の中から選択できます。 DESあるいはMD5アルゴリズムを利用したPHP crypt() および LDAP crypt *1、 MD5 アルゴリズムを利用したPHP md5()、LDAP MD5、およびLDAP SMD5(シードあり)、 SHA-1 アルゴリズムを利用したPHP sha()、LDAP SHA、および LDAP SSHA(シードあり)

備考

PukiWiki内で利用するパスワードは、パスワード文字列そのものの代わりに、 実際のパスワードから導出された文字列(セキュリティハッシュ)を保存することが可能です。
これは悪意ある者にpukiwiki.ini.phpの中身を覗き見られた場合に、 パスワードが安易に漏洩しない事を目的としたものです。

SHA-1 アルゴリズムを利用するためには、PHP 4.3.0 以降を使用するか mhash エクステンションを導入する必要があります。

プラグイン名に反してMD5以外のパスワードフォーマットも選択可能です。 これは従来、パスワードから導出したMD5ハッシュ値を利用していた経緯によるものです。

md5のプラグインを呼び出すURLの中にパスワードを含める利用方法は互換性のため残っていますが、推奨されません。

このプラグインは PKWK_SAFE_MODE ないし PKWK_READONLY の設定で無効化されます。

memo

種別

（コマンド）

ブロック型プラグイン

重要度

★☆☆☆☆

書式

#memo

概要

記述した位置に複数行入力欄とボタンを表示します。

ボタンを押下すると入力欄の記述内容を更新します。

プラグイン内設定

• • MEMO_COLS　編集欄の表示桁数
  • MEMO_ROWS　編集欄の表示行数

備考

insertプラグインやarticleプラグインと似ていますが、入力した内容が入力欄の外へ出力されず、入力欄に留まる点が異なります。

個人用のメモ代わりにPukiWikiを利用している場合、未整理の情報を一時的に溜め込むのに便利です。

menu

種別

ブロック型プラグイン

重要度

★★★★☆

書式

#menu( ページ名 )

概要

デフォルトのスキンにて、ページの左側にメニュー用のページ(MenuBar)を表示するために内部的に使用されています。

任意のページでブロック型プラグインとして使用すると、引数に指定したページをメニュー用ページに指定できます。
例えば通常はMenuBarを表示するサイトで、hogeというページだけはMenuBarの代わりにhogeMenuというページを表示したい場合、hogeというページに #menu(hogeMenu) と記述する事で実現できます。

ソース中のMENU_ENABLE_SUBMENU をTRUEとすると、表示中のページの上位階層のMenuBarか、同階層にあるMenuBarページをメニューとして表示するようになります。
例えば FrontPage, MenuBar, hoge, fuga, hoge/MenuBar, hoge/hoge というページが存在する場合は、FrontPage、fuga、MenuBar では MenuBar がメニューとして表示され、hoge, hoge/MenuBar, hoge/hogeでは hoge/MenuBar がメニューとして表示されます。

引数

メニュー用ページとして表示するページ名を指定します。

プラグイン内設定

• • MENU_ENABLE_SUBMENU　サブメニューを使用するか
  • MENU_SUBMENUBAR　サブメニューを使用する場合にメニューとして呼び出されるページ名。デフォルトは MenuBar。

備考

デフォルトのメニュー用ページをMenuBar以外のページとする場合は、pukiwiki.ini.php の $menubar を変更して下さい。

N

navi

種別

ブロック型プラグイン

重要度

★★☆☆☆

書式

#navi( [目次ページ] )

概要

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

目次となるページに下階層のページが存在する時、それら全てのページ（の先頭と末尾）に記述する事で Prev, Home, Next というリンクを表示します。これによって下階層のページを順に参照するのに便利になります。

引数

目次ページに順番に見て回るページの上階層にあたるページを指定します。

例えば hoge, hoge/1, hoge/2, hoge/3 というページが存在する場合、hoge/2に#navi(hoge)を記述するとhogeに移動するHomeというリンク、hoge/1に移動するPrevというリンク、hoge/3に移動するNextというリンクを表示します。

ページで最初に呼び出した場合はヘッダイメージのリンクを出力します。ページで２度目以降に呼び出された場合はフッタイメージのリンクを出力します。現在のページが目次ページである場合は対象となるページの一覧を表示します。

プラグイン内設定

• • PLUGIN_NAVI_EXCLUSIVE_REGEX　除外するページを正規表現で指定する
  • PLUGIN_NAVI_LINK_TAGS　<link>タグを出力するかどうか

new

種別

インライン型プラグイン

重要度

★★☆☆☆

書式

書式1:

&new( [nodate] ){ 日付文字列 };

書式2:

&new( [ページ名] [,nolink] );

概要

指定した日時が最近であった場合、最近更新された事を強調表示します。日時の指定は直接日付時刻を記述する方法(書式1)と、指定したページ（群）の最終更新日時を採用する方法(書式2)の２通りがあります。

標準では5日以内の場合に New を、１日以内の場合に New! を表示します。期間や表示する文字列のパターンは設置者によってカスタマイズ可能です。

引数

書式1:

日付文字列を指定した場合、その日時が規定の期間内であった場合に強調表示します。省略した場合はページの更新日時をチェックする記述であると見なされます。

• • nodate − 日付文字列を表示しません。省略時は表示します。

書式2:

ページ名を指定した場合は、そのページの更新日時が規定の期間内であった場合に強調表示します。省略した場合は、プラグインを記述したそのページを指定したと見なします。

ページ名末尾が/であった場合、そのページ名で始まるページ群の中で最後の更新日時が規定の日付以内であった場合に強調表示します。

• • nolink − ページ名を表示しません。省略時はページ名（ページ群で指定した場合は最後に更新されたページ名）を表示します。

プラグイン内設定

• • PLUGIN_NEW_DATE_FORMAT　表示フォーマット

備考

日付文字列は[[PHP関数:strtotime]]が認識できる書式である必要があります。

newpage

種別

コマンド

ブロック型プラグイン

重要度

★★★★★

書式

?plugin=newpage &page=ページ名 &refer=関連ページ名

#newpage( [ページ名初期値] )

概要

ページを新規作成するか、新規作成するページ名の入力欄を表示します。

引数

コマンド:

パラメータには新規作成するページのオプションを指定します。

ページ名には新規作成するページ名を指定します。省略時は新規作成するページ名の入力するためのページを表示します。ページ名はエンコードされている必要があります。

関連ページ名にはリンク元のページ名を指定します。新規作成するページの先頭に、ここで指定したページへのリンクが自動的に埋め込まれます。ページ名はエンコードされている必要があります。

ブロック型プラグイン:

ページ名初期値には新規作成するページ名を入力する入力欄に初期表示する文字列を指定します。

nofollow

種別

ブロック型プラグイン

重要度

★☆☆☆☆

書式

#nofollow

概要

記述したページが凍結されている場合、ヘッダーに「NOFOLLOW」「NOINDEX」オプションを追加させます。

これらのオプションは検索エンジンに対し「このページを無視して欲しい」と主張します。実際にどうなるのかは検索エンジン次第です。

備考

人間や、上記のオプションを無視するプログラムには効果がありません。

norelated

種別

ブロック型プラグイン

重要度

★★★☆☆

書式

#norelated

概要

ページ下部に表示される関連ページのリンクを非表示にします。

備考

極端に多くのページからリンクされていて関連リンクの表示が目障りである場合などに利用します。

• Prev
  PukiWiki/1.4/Manual/Plugin/H-K
• Next
  PukiWiki/1.4/Manual/Plugin/O-R
• Home
  Up

• PukiWiki/1.4/Manual/Plugin/A-D
  • A
    • add
    • amazon
    • aname
    • article
    • attach
  • B
    • back
    • backup
    • br
    • bugtrack
    • bugtrack_list
  • C
    • calendar、calendar_edit、calendar_read
    • calendar_viewer
    • calendar2
    • clear
    • color
    • comment
    • contents
    • counter
  • D
    • deleted
    • diff
    • dump
• PukiWiki/1.4/Manual/Plugin/E-G
  • E
    • edit
  • F
    • filelist
    • freeze
• PukiWiki/1.4/Manual/Plugin/H-K
  • H
    • hr
  • I
    • img
    • include
    • includesubmenu
    • insert
    • interwiki
• PukiWiki/1.4/Manual/Plugin/L-N
  • L
    • lastmod
    • links
    • list
    • lookup
    • ls
    • ls2
  • M
    • map
    • md5
    • memo
    • menu
  • N
    • navi
    • new
    • newpage
    • nofollow
    • norelated
• PukiWiki/1.4/Manual/Plugin/O-R
  • O
    • online
  • P
    • paint
    • pcomment
    • popular
  • R
    • random
    • read
    • recent
    • ref
    • referer
    • related
    • rename
    • rss
    • rss10
    • ruby
• PukiWiki/1.4/Manual/Plugin/S-U
  • S
    • search
    • server
    • setlinebreak
    • showrss
    • size
    • source
    • stationary
  • T
    • tb
    • template
    • topicpath
    • touchgraph
    • tracker
    • tracker_list
  • U
    • unfreeze
    • update_entities
• PukiWiki/1.4/Manual/Plugin/V-Z
  • V
    • version
    • versionlist
    • vote
  • Y
    • yetlist

プラグインマニュアルの凡例

プラグインマニュアルは以下の形式で記述されています。

プラグイン名

種別

プラグインがどのような方法で呼び出しを行えるかを示します。複数の呼び出し方法をもつプラグインも存在します。

• コマンド − コマンド形式の呼び出しが可能であることを示します。内部的に呼び出されるため、説明を省いている場合はカッコで括られています。
• ブロック型プラグイン − ブロック型プラグインでの呼び出しが可能である事を示します。
• インライン型プラグイン − インライン型プラグインでの呼び出しが可能である事を示します。
• 擬似ブロック型プラグイン − PukiWiki本体で実現されている機能であることを示します。記述方式がブロック型プラグインと同じであるため、便宜上プラグインのマニュアルに含めています。

重要度

そのプラグインの一般的な利用頻度や有用性の目安を示します。さほど重要でない場合は ★☆☆☆☆ が、重要なプラグインの場合は ★★★★★ です。

書式

プラグインでの引数指定方法です。引数の指定方法の表現のため、下記の記述書式を使っています。

• [] − 省略可能で必要に応じて記述する箇所です。
• | − |で区切られた複数の項目のうち、指定できるのは１つである事を示します。
• {} − 中カッコ内のみ引数の指定順序が任意である事を示します。

概要

そのプラグインの機能概要です。

引数

引数の詳細な説明です。

プラグイン内設定

プラグインのソース中で定義されている定数の一覧です。引数で変更できない詳細なカスタマイズが可能となります。

備考

プラグインに関する参考情報です。