[ top ] [ prev ] [ up ] [ next ]
Last-Modified:
Ruby Ring
[ prev ]
[ list ]
[ home ]
[ next ]
Pi の書式
- シンプルかつエレガントかつ実用的なデザインになってます。( ほんまにゆいよん? )
お気楽度では RD にも優る。と,私は思っているのだが,あなたはどうであろうか。
この文書の Pi は spec.pi だ。
- 普通
-
普通の文章は普通に出ます。
改行したら改行します。
- インデントしたらインデントします。
降りても問題なし。
- 段落
-
大見出し
中見出し
小見出し
備考
文句
ぐち
- 箇条書き
-
- 定義
-
- 用語
-
説明
- 埋め込み
-
: そのまま
p 1
rb_intern('initialize');
- 修飾
-
%n:...%
という形式を使う。中で %
を使いたいときには %%
と書けばよい。
等幅
-
%c:等幅%
結構ひんぱんに使う。*.txt
や c:\apollo
のように。
- 斜体
-
%v:斜体%
引数の変数を表したりするのに使う。 v
- 強調
-
%s:強調%
太字になる。うりゃ
- link
-
%href:http://www.moriq.com/ link%
URLとラベルを指定できる。ラベルは省略可。空白で区切る。
- include
-
%i:i.dat%
これじゃよくわからないが,別ファイルの内容をそのまま埋め込める。
- eval
-
%e:'eval'%
これも見た目わからないが,Ruby コードの評価結果を埋め込める。
最終更新時刻 Thu Oct 23 18:25:33 東京 (標準時) 2003 とか。
- ラベル
-
このラベルのようにインデントせずに定義した用語はラベルになる。
Ruby拡張ライブラリのリファレンスではメソッド名がこれにあたる。
ラベルは最初の '('
なければ最初の '{'
これもなければ最初の ' '
までの文字列 ( を strip
したもの ) とする。
- リンク
-
- Class#method
-
Class#method
別ページのラベルにリンク
- Class
-
Class#
別ページにリンク
- method
-
#method
文書の中でリンク
- method (foo) { }
-
method というラベルがあるので
#method
で飛んでこれる。
- 文書構造
-
nav.dat
というファイルを置くことで,フッタとヘッダにナビゲート用のリンク [ top ] [ prev ] [ up ] [ next ] が付く。
index ../index
Component
Control
Button
Rect
- この例では,以下のようにリンクが付く。
nav.dat
を置いたディレクトリの全ての文書において [ top ] は index.html
( 最上段左端の記述 index
) を指す。
index.html
での [ up ] は ../index.html
( 右隣の記述 ../index
) を指す。そのほかの文書では [ up ] は ( 右隣に記述がないので ) ツリーの親ノードを指す。例えば,Button.html
の [ up ] は Control.html
を指す。
- [ prev ] は1行上に書いてあるノードを指す。
- [ next ] は1行下に書いてあるノードを指す。
日本語で書くと難しそうだけど,要は書いた通りにツリーを辿れるわけだ。
- 文書情報
-
どこに書いても ok 。ただしインデントは不可。
- title
-
title:
文書名
- author
-
author: YOSHIDA Kazuhiro
著者名
- mailto
-
mailto: moriq@moriq.com
連絡先
- header
-
header:
Last-Modified: %e:Time.now.strftime('%%D')%
%i:rubyring.htm%
end
- ヘッダ。どこに書いても良いが,先頭に書くべき。
- footer
-
footer:
はらへった
うぐぅ
end
- フッタ。どこに書いても良いが,最後に書くべき。
はらへった
うぐぅ
[ top ] [ prev ] [ up ] [ next ]