執筆者募集

下の「Link」で参照されるページにRubyリファレンスマニュアルの記述が不完 全な部分が含まれています。

あなたの記述をみんな待ってます。よろしくお願いします。

RDというフォーマットで書きます。

執筆の心得

1. できるだけリンクを張る。(ただし同じ言葉に対してのリンクはうるさくなら ないように)

   • リンクの張り方

     String

     ((<String>))
     

     String#gsub

     ((<String#gsub|String/gsub>))
     

     gsub

     ((<String/gsub>))
     

     mailread

     ((<mailread>))
     

     Mail.new

     ((<mailread/Mail.new>))
     

     net/http

     ((<"net/http">))
     

     <URL:http://www.ruby-lang.org/ja/man/>

     ((<URL:http://www.ruby-lang.org/ja/man/>))
     

     Rubyリファレンスマニュアル

     ((<Rubyリファレンスマニュアル|URL:http://www.ruby-lang.org/ja/man/>))
     

     縦棒「|」を含むリンク

     ((<"縦棒「|」を含むリンク"|URL:http://www.ruby-lang.org/ja/man/>))
     

     [ruby-src:sample/sieve.rb]

     ((<"ruby-src:sample/sieve.rb">))
     

2. 記述を追加したいが内容に関していまいち自信がなかったりする場合、以下の いずれかの方法で問い合わせる
   • footnote に ((- これであってる？-)) などと書く
   • マニュアル執筆編集に関する議論をするためのメーリングリスト rubyist@freeml.com(参加方法, アーカイブ) に確認する。
   • 広くRubyコミュニティと議論したい場合は ruby-list ML に 「この記述怪しいんですが…。」などと問い合わせる。
   • MLに参加してない人はあらい宛 に直接問い合わせても構わないです。
     • 記述内容にわかりにくい箇所とかもあれば上記の方法で問い合わせてくだ さいませ。できるだけ改善したいと思います。
3. メソッドの記述には「---」ではじめるリストMethodListを使います。以下の例を参照して下さい。

#
--- Array#each {|i| ... } 
    各項目に対してブロックを評価する。

Array#each {|i| ... }

各項目に対してブロックを評価する。

さらに詳しくは [ruby-list:24445] などを参照して下さい。

文章中の引数名に関しては ((|variable|)) と書くと、 variable (<var>variable</var>) とマークアップされます。

その他雑多なこと

その他雑多なことに関しては Manuals' styleも参照してください。

作業中のページ

ToDo