ヘルプは開発中の最新版の機能も記述されています。
公開版のダウンロードでは実装されていない機能もあります。
PyukiWikiは YukiWikiをベースにして、PukiWikiのサブセットとして実装しています。
YukiWiki からの変更点。
- FrontPage をトップページにするように変更。frontpage.txt は使いません。
- MenuBar をメニューとして表示するように変更。
- css を PukiWikiの default.ja.css, print.ja.css を参照するように変更。
- [リロード] などの PukiWiki風 メニューを追加。
- 自動目次機能や、新規作成、一覧、差分、単語検索、RSS出力を plugin として実装。
- plugin機能を実装
現在サポートしているプラグインは
aname,
bugtrack,
color,
comment,
contents(YukiWiki),
counter,
diff(YukiWiki),
img,
include,
list(YukiWiki),
new(サブセット),
newpage(YukiWiki),
online,
recent,
rss10(YukiWiki),
ruby,
search,
size,
vote
プラグインの仕様
は pukiwiki.org を参照して下さい。
サブセット版は一部機能が未実装だったりします。YukiWikiはYukiWiki機能をそのままプラグイン化したものです。
基本的な整形ルールは YukiWiki 準拠ですが、pukiwiki 準拠の、以下の機能が拡張されています。
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 と表示されます。
PukiWikiから継承しているテキスト整形のルール
改行
エイリアス
[[エイリアス名>ページ名]]
- 行中のページ名形式の文字列の中で、>で2つの文字列を区切るとエイリアスになります。>の前にはエイリアス名を、>の後ろにはページ名を記述します。
エイリアスはPyukiWiki内のページ名とは別のエイリアス名で、指定したページへのリンクを貼ります。
文字飾り
- %2個ではさんだ部分は、
取り消し線になります。
- %3個ではさんだ部分は、挿入線になります。
左寄せ・センタリング・右寄せ
LEFT:インライン要素
CENTER:インライン要素
RIGHT:インライン要素
- 行頭でLEFT:、CENTER:、RIGHT:を記述すると、インライン要素が左寄せ、センタリング、右寄せされます。
コメント行
- 行頭で // を指定すると、コメント行になります。コメント行は出力されない行です。
箇条書き
- マイナス(+)を行頭に書くと、箇条書きになります。+ ++ +++ の3レベルがあります。
用語解説
- コロン(:)を行頭に書くと、用語と解説文が作れます。以下のようにします。
:用語|いろいろ書いた解説文
- 用語
- いろいろ書いた解説文
絵文字
- 文中に空白文字＋以下の文字（
は空白不要）で絵文字を表示します。
:) :D :p :d XD X( ;) ;( :( &heart;
絵文字
日時の埋め込み
- 文中に 2024-11-23 08:33:10 と記述すると、ページ保存時に現在の日時、時刻として埋め込まれます。
2004-04-27 → YYYY-MM-DD (Y:年, M:月, D:日)
13:18:21 → HH:mm (H:時, m:分)
日時のフォーマットは、wiki.cgi 内部のフォーマットを変更することで変更可能です。
YukiWikiから継承しているテキスト整形のルール
通常は入力した文字がそのまま出力されますが、
以下のルールに従ってテキスト整形を行うことができます。
基本ルール
- 連続した複数行は連結されます。
- 空行は段落の区切りとなります。
- 行頭がスペースで始まっていると、その段落は整形済みとして扱われます。
- HTMLのタグは書けません。
文字飾り
- シングルクォート2個ではさんだ部分は、ボールドになります。
- シングルクォート3個ではさんだ部分は、イタリックになります。
見出し
- アスタリスク(*)を行頭に書くと、大見出しになります。
- アスタリスク2個(**)を行頭に書くと、中見出しになります。
- アスタリスク3個(***)を行頭に書くと、小見出しになります。
-
見出しがあると自動的に目次が作られます。
箇条書き、水平線、引用文
- マイナス(-)を行頭に書くと、箇条書きになります。- -- --- の3レベルがあります。
- マイナス4個(----)を行頭に書くと、水平線になります。
- > を行頭に書くと、引用文が書けます。> >> >>> の3レベルがあります。
ハイパーリンク
用語解説
- コロン(:)を行頭に書くと、用語と解説文が作れます。以下のようにします。
:用語1:いろいろ書いた解説文1
:用語2:いろいろ書いた解説文2
:用語3:いろいろ書いた解説文3
- 用語1
- いろいろ書いた解説文1
- 用語2
- いろいろ書いた解説文2
- 用語3
- いろいろ書いた解説文3
テーブル
- コンマ(,)を行頭に書くと、テーブル(表)が作れます。以下のようにします。
, Wikiの名前 , 作者 , URL
,Wiki,Ward Cunningham,http://www.c2.com/
,YukiWiki,Hiroshi Yuki,http://www.hyuki.com/
,WalWiki,Makio Tsukamoto,http://digit.que.ne.jp/
バーベイタム機能
- --( と --) でくくられた行は書いたまま表示されますが、リンクや文字飾りは有効です(バーベイタム・ソフト)。
- ---( と ---) でくくられた行はリンクや文字飾りも無視されて書いたまま表示されます(バーベイタム・ハード)。
OpenWiki?から継承しているテキスト整形のルール
バーベイタム機能
- {{{ と }}} でくくられた行は書いたまま表示されます。
![[PyukiWiki]](./image/pyukiwiki.png "[PyukiWiki]")
