[hack] 関数仕様
![[Add this entry to hatena bookmark]](http://b.st-hatena.com/images/entry-button/button-only.gif){kind=small}
(執筆中)
出力
変換系関数
&::yen($src)
| $src | (in) ^ エスケープ前文字列 |
| 戻り値 | ^ エスケープ後文字列 |
下記の変換を行う
- ^ → ^y
- TAB文字 → ^t
- 改行文字(LF) → ^n
- 復帰文字(CR) → ^r
&:deyen($src)
| $src | (in) ^ エスケープ前文字列 |
| 戻り値 | ^ エスケープ後文字列 |
下記の変換を行う
- ^y → ^
- ^t → TAB文字
- ^n → 改行文字(LF)
- ^r → 復帰文字(CR)
&::title2fname( $page [,$attachment] )
| $page | ページ名 |
| $attachment | 添付ファイル名 |
| 戻り値 | 物理ファイル名 |
- 引数が一つの時はページ本文のファイル名を返す。
- 引数二つの時は、添付ファイルの保存ファイル名を返す。
ファイルアクセス系関数
&::read_object( $title [,$attachment] )
| $title | ページ名 |
| $attachment | 添付ファイル名 |
| 戻り値 | そのページ(あるいは添付ファイル)の内容。 |
ページの本文(添付ファイル名がある場合は、添付ファイルの内容)を 一枚板の文字列として読み込む。
&::write_object( $title [,$attachment] , $value)
| $title | ページ名 |
| $attachment | 添付ファイル名 |
| $value or $$value | 出力内容(''の時、対象を削除する) |
| 戻り値 | 1 => ファイル作成 , 0=> ファイル削除 |
最後の引数の内容を、ページの本文(添付ファイル名がある場合は、添付ファイル) として、ファイルに出力する。 出力内容が ""(空) であり、かつ添付ファイルがない場合は、ファイルを削除する。
非汎用関数
&::print_page( {key=>value} )
(注意) 当関数は、wifky のバージョンによって、仕様が大きく変わる
| key | value |
|---|---|
| title | 表示するページの名前(htmlとは排他) |
| html | 表示するテキスト(titleと排他) |
| main | 定義されている ⇒ 本文部分である(サイドバーではない) |
| index | 定義されている ⇒ 見出しに #pNN などの ID を付ける |
| 戻り値 | 0:表示内容なし , 1:表示した |
ページ出力関数。ここでは文法解析は行わず、 以下の syntax_engine 呼び出しのための情報を用意する役割がメイン。
&::syntax_engine( \$html , \%s )
(注意) 1.3.2 では廃止
| $html | ソース文字列 |
| $s->{title} | ページタイトル |
| $s->{attachment}->{添付ファイル名※1}->{name} | 添付ファイル名※2 |
| $s->{attachment}->{添付ファイル名※1}->{url} | 添付ファイルへアクセスするための URL |
| $s->{attachment}->{添付ファイル名※1}→{tag} | 添付ファイルを表現する html タグ(<img> or <a>) |
| $s->{index} | 定義されている ⇒ 見出しに #pNN などの ID を付ける |
| $s->{main} | 定義されている ⇒ 本文部分である(サイドバーではない) |
| 戻り値 | なし |
※1 サニタイズ後のファイル名
※2 未サニタイズのファイル名
ページ出力の下請関数。文法を解釈して整形した結果を &puts を使って出力する。
|