PyukiWikiは YukiWikiをベースにして、PukiWikiのサブセットとして実装しています。
通常は入力した文字がそのまま出力されますが、
以下のルールに従ってテキスト整形を行うことができます。
基本ルール
- 連続した複数行は連結されます。
- 空行は段落の区切りとなります。
- 行頭がスペースで始まっていると、その段落は整形済みとして扱われます。
- HTMLのタグは書けません。
- 行末に~を書くと行末改行になります。
文字飾り
- シングルクォート2個ではさんだ部分は、ボールドになります。
- シングルクォート3個ではさんだ部分は、イタリックになります。
- %2個ではさんだ部分は、
取り消し線になります。
- %3個ではさんだ部分は、挿入線になります。
文字色
以下のように,文字色と背景色を指定できます.
&color(red){★ 無断転載は禁止 ★}; &color(#00ffff,#ff8080){こんにちは};
★ 無断転載は禁止 ★ こんにちは
見出し
- アスタリスク(*)を行頭に書くと、大見出しになります。
- アスタリスク2個(**)を行頭に書くと、中見出しになります。
- アスタリスク3個(***)を行頭に書くと、小見出しになります。
- 目次を作るときは,contentsプラグインを使います.
箇条書き、水平線、引用文
- マイナス(-)を行頭に書くと、番号なしリストになります。- -- --- の3レベルがあります。
- プラス(+)を行頭に書くと、番号付きリストになります。+ ++ +++ の3レベルがあります。
- マイナス4個(----)を行頭に書くと、水平線になります。
- > を行頭に書くと、引用文が書けます。> >> >>> の3レベルがあります。
左寄せ・センタリング・右寄せ
LEFT:インライン要素
CENTER:インライン要素
RIGHT:インライン要素
- 行頭でLEFT:、CENTER:、RIGHT:を記述すると、インライン要素が左寄せ、センタリング、右寄せされます。
ハイパーリンク
- http://www.hyuki.com/のようなURLは自動的にリンクになります。
- linkプラグインを使えば,URL以外を表示したリンクを作れます (よく使うプラグイン〜参照)
- YukiWikiのように大文字小文字を混ぜた英文字列を書くと、YukiWikiのページ名になります。ページ名にしたくない場合は,verbプラグインを使います(よく使うプラグイン〜参照)
- 二重の大かっこ でくくった文字列を書くと、YukiWikiのページ名になります。大かっこの中にはスペースを含めてはいけません。日本語も使えます。
エイリアス
[[エイリアス名>ページ名]]
- 行中のページ名形式の文字列の中で、>で2つの文字列を区切るとエイリアスになります。>の前にはエイリアス名を、>の後ろにはページ名を記述します。
エイリアスはPyukiWiki内のページ名とは別のエイリアス名で、指定したページへのリンクを貼ります。
以下のように使えば,ページ名と異なる表示("トップページ")ができます
[[トップページ>FrontPage]]
テーブル
- コンマ(,)を行頭に書くと、テーブル(表)が作れます。以下のようにします。
,No, Wikiの名前 , 作者 , URL
,RIGHT:1,Wiki,Ward Cunningham,http://www.c2.com/
,RIGHT:2,YukiWiki,Hiroshi Yuki,http://www.hyuki.com/
,RIGHT:3,WalWiki,Makio Tsukamoto,http://digit.que.ne.jp/
- RensaInfoの拡張機能
- テーブルでは,自動的に1行目は見出しスタイル,2行目以降の1列目はキー値用スタイルになります
用語解説
- コロン(:)を行頭に書くと、用語と解説文が作れます。以下のようにします。
:用語|いろいろ書いた解説文
:用語2:いろいろ書いた解説文
- 用語
- いろいろ書いた解説文
- 用語2
- いろいろ書いた解説文
脚注
((脚注))
文中には参照記号が表示され,脚注として記述した内容はページ下部に表示されます.
よく使うプラグインの使用例
&ref(bugtrack13a.png,60%,left)
※そのページに該当ファイルを添付済みであること.
&verb(SamplePage);をリンクにしたくない
SamplePageをリンクにしたくない
上付き,下付き
2^^2^^=4
2
2=4 と表示されます。
11001011__2__=0xa9
11001011
2=0xa9 と表示されます。
YukiWiki, PukiWiki との互換性を重視される方は sub, sup プラグインが用意されていますので、そちらを参照して下さい。
2&sup(2);=4
2
2=4 と表示されます。
11001011&sub(2);=0xa9
11001011
2=0xa9 と表示されます。
コメント行
- 行頭で // を指定すると、コメント行になります。コメント行は出力されない行です。
絵文字
- 文中に空白文字+以下の文字(
は空白不要)で絵文字を表示します。
:) :D :p :d XD X( ;) ;( :( &heart;
絵文字
日時の埋め込み
- 文中に &date; &time; と記述すると、ページ保存時に現在の日時、時刻として埋め込まれます。
2004-04-27 → YYYY-MM-DD (Y:年, M:月, D:日)
13:18:21 → HH:mm (H:時, m:分)
日時のフォーマットは、wiki.cgi 内部のフォーマットを変更することで変更可能です。
バーベイタム機能
- --( と --) でくくられた行は書いたまま表示されますが、リンクや文字飾りは有効です(バーベイタム・ソフト)。
- ---( と ---) でくくられた行はリンクや文字飾りも無視されて書いたまま表示されます(バーベイタム・ハード)。
OpenWikiから継承しているテキスト整形のルール
バーベイタム機能
- {{{ と }}} でくくられた行は書いたまま表示されます。