ruby-****@lists*****
ruby-****@lists*****
2003年 3月 30日 (日) 03:28:06 JST
------------------------- REMOTE_ADDR = 211.7.202.36 REMOTE_HOST = ------------------------- = 本サイトのドキュメントの書き方 ドキュメントはRDで記述します。詳しくは((<RDP|URL:http://helium.ruby-lang.org/~rubikitch/RDP.cgi?cmd=view&name=RD>))を参照してください。 ((<RWikiのも|URL:http://rwiki.jin.gr.jp/cgi-bin/rw-cgi.rb?cmd=view;name=RD%A4%CE%BD%F1%A4%AD%CA%FD>))わかりやすいです(他力本願(^^;))。 == Hiki/RD+拡張 === ModuleNames Hiki/RD+では、より簡易にRuby-GNOME2に関連するドキュメントを読み書きすることができるように、 クラスやメソッド名は自動的にリンクが生成されるようにしています。従って(('((<Hoge::Fuga>))'))と言った記述をする必要はありません。 ただし、これを有効活用するために（特にAPIリファレンスに言えるのですが）、以下のルールに従ってください。 * リンクする側 * Hoge::Foo - クラス名 * Hoge::FOO - 定数値 * Hoge::Foo#bar - インスタンスメソッド * Hoge::Foo.bar - クラスメソッド * Hoge.bar - モジュール関数 * リンクされる側 * クラスメソッド - "--- Hoge::Foo.new" * インスタンスメソッド - "--- bar" #メソッド名のみ 本機能を使うにはModuleNamesページにそのモジュールを記述しておきます。 === アンカー自動生成 アンカーの自動生成には、RD自体が持つ方法とHikiのInterWikiを拡張したInterWiki+機能を使うことができます。 ==== 引数から単純にアンカーを生成する方法 これは、通常のRDがサポートする形式です。 ((<URL:url>)) ((<name|URL:url>)) * name - そのリンク先の名称(省略可能。省略した場合はurlが名称として表示される) * url - URL 例： ((<URL:http://www.hoge.com/>)) ((<hoge|http://www.hoge.com/>)) これらは以下のような結果になります。 結果： <a href="http://www.hoge.com/">http://www.hoge.com/</a> <a href="http://www.hoge.com/">hoge</a> なお、URLが画像(jpg, jpeg, pngで終わるもの)はIMGタグに展開されます。 ==== InterWikiを使う方法 InterWikiとは要は外部へのリンクを簡単にできるようにするもので、((<Hiki>))自体が持つInterWikiと同様の機能です。あらかじめ、InterWikiNameというページにキーワードを登録しておき、keyに該当するデータを元にアンカーを生成します。 ((<name|key:option>)) * name - そのリンク先の名称(省略可能)。省略した場合はkeyが表示されます。 * key - キー(InterWikiNameのキーワード)。InterWikiNameのURLに展開されます。 * option - URLに追加する文字列(省略可能)。日本語を使いたい場合はURLエンコードするように設定します(defaultはなし、辞書ファイルにeuc/sjis/jisのいずれかを指定する)。 例： ((<Hiki>)) ((<bibo:20020329>)) ((<Linuxビボ〜ろく|bibo:20020329>)) 例えば、後述するInterWikiNameをそのまま利用したとすると以下のような結果になります。 結果： <a href="http://www.namaraii.com/hiki.cgi?">Hiki</a> <a href="http://ponx.s5.xrea.com/bibo/?date=20020329">bibo</a> <a href="http://ponx.s5.xrea.com/bibo/?date=20020329">Linuxビボ〜ろく</a> ==== InterWikiNameページの書き方 InterWikiNameページは (('[[keyword|url]]')) charset というフォーマットで書きます。 *[[Hiki|http://www.namaraii.com/hiki/hiki.cgi?]] euc *[[bibo|http://ponx.s5.xrea.com/bibo/?date=]] euc == APIリファレンスの書き方 他のAPIリファレンスの書き方に倣ってください。わからない部分はMLで聞くと(^^;)。 == その他 とりあえず、((<練習ページ>))で練習してみてください。 - ((<むとう>)) ------------------------- = 本サイトのドキュメントの書き方 ドキュメントはRDで記述します。詳しくは((<RDP|URL:http://helium.ruby-lang.org/~rubikitch/RDP.cgi?cmd=view&name=RD>))を参照してください。 ((<RWikiのも|URL:http://rwiki.jin.gr.jp/cgi-bin/rw-cgi.rb?cmd=view;name=RD%A4%CE%BD%F1%A4%AD%CA%FD>))わかりやすいです(他力本願(^^;))。 == Hiki/RD+拡張 === ModuleNames Hiki/RD+では、より簡易にRuby-GNOME2に関連するドキュメントを読み書きすることができるように、 クラスやメソッド名は自動的にリンクが生成されるようにしています。従って(('((<Hoge::Fuga>))'))と言った記述をする必要はありません。 ただし、これを有効活用するために（特にAPIリファレンスに言えるのですが）、以下のルールに従ってください。 * リンクする側 * Hoge::Foo - クラス名 * Hoge::FOO - 定数値 * Hoge::Foo#bar - インスタンスメソッド * Hoge::Foo.bar - クラスメソッド * Hoge.bar - モジュール関数 * リンクされる側 * クラスメソッド - "--- Hoge::Foo.new" * インスタンスメソッド - "--- bar" #メソッド名のみ 本機能を使うにはModuleNamesページにそのモジュールを記述しておきます。 === アンカー自動生成 アンカーの自動生成には、RD自体が持つ方法とHikiのInterWikiを拡張したInterWiki+機能を使うことができます。 ==== 引数から単純にアンカーを生成する方法 これは、通常のRDがサポートする形式です。 ((<URL:url>)) ((<name|URL:url>)) * name - そのリンク先の名称(省略可能。省略した場合はurlが名称として表示される) * url - URL 例： ((<URL:http://www.hoge.com/>)) ((<hoge|http://www.hoge.com/>)) これらは以下のような結果になります。 結果： <a href="http://www.hoge.com/">http://www.hoge.com/</a> <a href="http://www.hoge.com/">hoge</a> なお、URLが画像(jpg, jpeg, pngで終わるもの)はIMGタグに展開されます。 ==== InterWikiを使う方法 InterWikiとは要は外部へのリンクを簡単にできるようにするもので、((<Hiki>))自体が持つInterWikiと同様の機能です。あらかじめ、InterWikiNameというページにキーワードを登録しておき、keyに該当するデータを元にアンカーを生成します。 ((<name|key:option>)) * name - そのリンク先の名称(省略可能)。省略した場合はkeyが表示されます。 * key - キー(InterWikiNameのキーワード)。InterWikiNameのURLに展開されます。 * option - URLに追加する文字列(省略可能)。日本語を使いたい場合はURLエンコードするように設定します(defaultはなし、辞書ファイルにeuc/sjis/jisのいずれかを指定する)。 例： ((<Hiki>)) ((<bibo:20020329>)) ((<Linuxビボ〜ろく|bibo:20020329>)) 例えば、後述するInterWikiNameをそのまま利用したとすると以下のような結果になります。 結果： <a href="http://www.namaraii.com/hiki.cgi?">Hiki</a> <a href="http://ponx.s5.xrea.com/bibo/?date=20020329">bibo</a> <a href="http://ponx.s5.xrea.com/bibo/?date=20020329">Linuxビボ〜ろく</a> ちなみに、特殊な記号('/'など)を使う場合は"(ダブルクオート)で括ります。 ((<"Ruby/GLib">)) ==== InterWikiNameページの書き方 InterWikiNameページは (('[[keyword|url]]')) charset というフォーマットで書きます。 *[[Hiki|http://www.namaraii.com/hiki/hiki.cgi?]] euc *[[bibo|http://ponx.s5.xrea.com/bibo/?date=]] euc == APIリファレンスの書き方 他のAPIリファレンスの書き方に倣ってください。わからない部分はMLで聞くと(^^;)。 == その他 とりあえず、((<練習ページ>))で練習してみてください。 - ((<むとう>))
