[DRE-commits] [rabbiter] 02/02: Import Documents from upstream Git repos.

Fri Jun 27 08:54:46 UTC 2014

This is an automated email from the git hooks/post-receive script.

uwabami-guest pushed a commit to branch patch-queue/master
in repository rabbiter.

commit 4348811901313eb173bf1527feb401da70de1a69
Author: Youhei SASAKI <uwabami at gfd-dennou.org>
Date:   Wed Jun 25 20:09:51 2014 +0900

    Import Documents from upstream Git repos.
    
    Signed-off-by: Youhei SASAKI <uwabami at gfd-dennou.org>
---
 doc/en/index.rd | 177 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 doc/en/news.rd  |  36 +++++++++++
 doc/ja/index.rd | 183 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 doc/ja/news.rd  |  34 +++++++++++
 4 files changed, 430 insertions(+)

diff --git a/doc/en/index.rd b/doc/en/index.rd
new file mode 100644
index 0000000..a2606a4
--- /dev/null
+++ b/doc/en/index.rd
@@ -0,0 +1,177 @@
+---
+layout: en
+title: Rabbiter
+---
+== About Rabbiter
+
+Rabbiter is a tool that collects tweets related to the talk and sends
+them to Rabbit as comments.
+
+In public conference such as RubyKaigi, audiences tweet comments about
+the listening talk to Twitter. To show the comments to your slide
+showed by Rabbit, you can use Rabbiter.
+
+If you have room to breathe, you can reply to the comments to reflect
+audiences' opinions. An audience can listen your talk with some
+different points of view because an audience can know other's
+comments. Note that you have a risk that audiences are interested in
+audiences' comments rather than your talk. You should ready your talk
+to make very interesting talk rather than audiences' comments.
+
+== Install
+
+You can install Rabbiter by RubyGems. Required packages are also
+installed.
+
+  % gem install rabbiter
+
+=== Special OS X installation instructions
+
+Most packages necessary for Rabbiter are commonly already installed.
+
+You must install the ((%glib-networking%)) package. If you are using
+Homebrew, use the following command to install the package:
+
+  % brew install glib-networking
+
+== Usage
+
+Rabbiter filters target tweets by specified keywords. It's good idea
+that you use hash tag for the conference. Here is an example command
+line for "#rubykaigi" hash tag:
+
+  % rabbiter --filter "#rubykaigi"
+
+Rabbiter collects target tweets that have specified
+keywords. ((-Because Rabbiter uses ((<Twitter's streaming API
+API|URL:https://dev.twitter.com/docs/streaming-apis>)).-))
+
+If you don't run Rabbit yet, the following error message will be
+shown:
+
+  [ERROR]
+  Rabbiter: DRb::DRbConnError: druby://localhost:10101 - #<Errno::ECONNREFUSED: Connection refused - connect(2)>
+
+You can run Rabbit before Rabbiter and Rabbiter before Rabbit. You can
+show tweets from Twitter on your slide by running Rabbit after the
+above error message is showen.
+
+  % rabbit rabbit-theme-bench-en.gem
+
+This example hash tag "#rubykaigi" isn't suitable for test because
+RubyKaigi isn't always sitting. "twitter" keyword is suitable for
+test. Someone tweets a message that contain "twitter" at the world.
+
+  % rabbiter --filter "twitter"
+
+Can you show tweets on your slide?
+OK. Use your rest time to ready your talk.
+
+== Advanced usage
+
+Normally, the above description is enough. In some cases, you need
+more description. The below is description for those cases.
+
+=== Register multiple keywords
+
+Many conferences use only one conference hash tag. But some
+conferences use one ore more conference hash tags. For example, one
+conference hash tag is for the whole conference and other conference
+hash tag is for a session in the conference. Or you may want to
+collect tweets that don't have hash tag but have related keyword. For
+example, you want to collect not only "#rubykaigi" but also "Ruby".
+
+You can use ((%--filter%)) option multiple times to specify multiple
+keywords. Here is an example command line that specify "#rubykaigi"
+and "Ruby" as keywords:
+
+  % rabbiter --filter "#rubykaigi" --filter "Ruby"
+
+=== Filter by user's language
+
+Global keyword is used all over the world. For example, "twitter" is
+used all over the world. So you can collect many tweets in many
+language by the keyword. If a conference is holed at Japan, tweets in
+Japanese will be related to the conference but tweets in French will
+not be related to the conference.
+
+You may want to show many comments in your slides but you should show
+only related comments to your talk. You can use user's language to
+filter related tweets.
+
+Here is an example command line that filters by Japanese:
+
+  % rabbiter --filter "#rubykaigi" --user-language "ja"
+
+You can specify ((%--user-language%)) option multiple times like
+((%--filter%)) option. You can collect only specified languages. Here
+is an example command line that filters by Japanese or French.
+
+  % rabbiter --filter "#rubykaigi" --user-language "ja" --user-language "fr"
+
+=== Sends comments to Rabbit that is run at other host
+
+TODO
+
+=== More information
+
+You can see all available options by running with ((%--help%))
+option. Look the output to find a feature what you want.
+
+  % rabbiter --help
+
+== Authors
+
+  * Kouhei Sutou <kou at cozmixng.org>
+  * OBATA Akio <obata at lins.jp>
+
+== Copyright
+
+The code author retains copyright of the source code. In
+other words the committer retains copyright of his or her
+committed code and patch authors retain the copyright of
+their submitted patch code.
+
+== License
+
+Licensed under GPLv2 or later. For more information see
+'GPL' file. Provided patches, codes and so on are also
+licensed under GPLv2 or later. Kouhei Sutou can change their
+license. Authores of them are cosidered agreeing with those
+rules when they contribute their patches, codes and so on.
+
+== Mailing list
+
+See ((<Rabbit's users page
+|URL:http://rabbit-shocker.org/en/users.html>)).
+
+== Join development
+
+=== Repository
+
+Rabbiter's repository is
+((<GitHub|URL:https://github.com/rabbit-shocker/rabbiter/>)).
+
+=== Commit mail
+
+You can stay up to date on the latest development by
+subscribing to the git commit ML. If you want to subscribe
+to the ML, send an e-mail like the following.
+
+  To: commit at ml.rabbit-shocker.org
+  Cc: null at rabbit-shocker.org
+  Subject: Subscribe
+
+  Subscribe
+
+=== Bug report
+
+Use the mailing list or ((<Issues on
+GitHub|URL:https://github.com/rabbit-shocker/rabbiter/issues>)) for
+reporting a bug or a request.
+
+== Thanks
+
+Here is a contributor list. Thanks to them!!!
+
+  * OBATA Akio: He wrote the initial verison.
diff --git a/doc/en/news.rd b/doc/en/news.rd
new file mode 100644
index 0000000..05b5c27
--- /dev/null
+++ b/doc/en/news.rd
@@ -0,0 +1,36 @@
+---
+layout: en
+title: News
+apply_data: false
+---
+== 2.0.2: 2014-06-05
+
+Ruby/GIO2 2.2.0 supported release!
+
+=== Improvements
+
+  * doc: Added description about ((%glib-networking%)) to install
+    documentation for OS X.
+    [GitHub#4] [Patch by Colin Dean]
+    [shocker-ja:1190] [Reported by Kazuhiro NISHIYAMA]
+  * Supported Ruby/GIO2 2.2.0.
+
+=== Thanks
+
+  * Colin Dean
+  * Kazuhiro NISHIYAMA
+
+== 2.0.1: 2013-08-29
+
+A bug fix release for the first time in a year!
+
+=== Improvements
+
+  * Supported initial setup on environments that don't support opening
+    a URI from GTK+ such as OS X.
+
+== 2.0.0: 2012-08-29
+
+The first release!
+
+Rabbiter is derived from Rabbit package.
diff --git a/doc/ja/index.rd b/doc/ja/index.rd
new file mode 100644
index 0000000..2e697ec
--- /dev/null
+++ b/doc/ja/index.rd
@@ -0,0 +1,183 @@
+---
+layout: ja
+title: Rabbiter
+---
+== Rabbiterとは
+
+RabbiterはTwitterから発表に関連するツイートを収集して、それをコメントと
+してRabbitに流しこむためのツールです。
+
+日本Ruby会議など公開されたイベントで発表する場合は、観客が発表を聴きな
+がらコメントをTwitterに書き込むことが増えてきました。Rabbiterを使うとそ
+のようなコメントをRabbitで表示しているスライド中に表示することができま
+す。
+
+発表者に余裕がある場合は、発表中にそのコメントに返事をして観客の意見を
+反映した発表にすることもできます。観客は他の観客のコメントも知ることが
+でき、発表中に自分とは違った視点の考えを取り入れながら発表を聴くことが
+できます。ただし、発表内容よりも観客のコメントの方に観客の注意が向いて
+しまう危険もあることに注意してください。観客のコメントに負けないくらい
+魅力的な発表となるように事前準備をしっかりしましょう。
+
+== インストール
+
+RubyGemsでインストールできます。関連パッケージも一緒にインストールされ
+ます。
+
+  % gem install rabbiter
+
+=== OS X特有のインストール手順
+
+Rabbiterに必要なパッケージは自動でインストールされますが、OS Xでは足り
+ないパッケージがあります。
+
+((%glib-networking%))パッケージを自分でインストールする必要があります。
+Homebrewを使っているなら以下のようにインストールしてください。
+
+  % brew install glib-networking
+
+== 使い方
+
+Rabbiterが収集するツイートは特定のキーワードで絞り込みます。最近のイベ
+ントではイベント用のハッシュタグが指定されていることが多いので、それを
+指定するのがよいでしょう。例えば、ハッシュタグが「#rubykaigi」の場合は
+以下のように実行します。
+
+  % rabbiter --filter "#rubykaigi"
+
+Rabbiterを起動した後にキーワードを含むツイートが投稿されるとすぐに収集
+します((-これは((<Twitterのストリーミング
+API|URL:https://dev.twitter.com/docs/streaming-apis>))というものを使っ
+ているからです。-))。
+
+Rabbitが起動していない場合は以下のようなエラーメッセージが表示されます。
+
+  [ERROR]
+  Rabbiter: DRb::DRbConnError: druby://localhost:10101 - #<Errno::ECONNREFUSED: 接続を拒否されました - connect(2)>
+
+RabbitとRabbiterはどちらを先に起動しても大丈夫です。上記のエラーメッセー
+ジが出力された後に以下のようにRabbitを起動してもスライド上にTwitterから
+のメッセージが表示されます。
+
+  % rabbit rabbit-theme-bench-ja.gem
+
+今回の例の「#rubykaigi」は日本Ruby会議中以外はあまり使われないのでテス
+トには向いていません。動作確認をするなら「twitter」というキーワードがお
+すすめです。常に世界中の誰かが「twitter」というキーワードをツイートして
+います。
+
+  % rabbiter --filter "twitter"
+
+スライドにツイートが表示されましたか？
+それでは発表の準備をしっかりして発表に備えてください。
+
+== より詳しい使い方
+
+通常はここまで説明した使い方で十分ですが、それでは足りないこともありま
+す。そのようなときのためにより詳しい使い方を説明します。
+
+=== 複数のキーワードを登録する
+
+多くのイベントではハッシュタグが1つですが、複数のハッシュタグを設定して
+いる場合もあります。例えば、イベント全体のハッシュタグとセッションごと
+のハッシュタグを設定している場合もあります。また、ハッシュタグだけでは
+なく関連するキーワードを含むツイートもコメントとして取り込みたい場合が
+あります。例えば、「#rubykaigi」を含むツイートだけではなく「Ruby」を含
+むツイートも取り込みたいという場合です。
+
+このように複数のキーワードを登録したい場合は((%--filter%))オプションを
+キーワードの数だけ指定してください。例えば、「#rubykaigi」と「Ruby」を
+キーワードとして登録したい場合は以下のようにします。
+
+  % rabbiter --filter "#rubykaigi" --filter "Ruby"
+
+=== ユーザーの言語で絞り込む
+
+世界的なキーワードは世界中で使われています。例えば、「twitter」というキー
+ワードは世界中でツイートされているため、いろんな言語のツイートが収集さ
+れます。日本で開催されているイベントでは、日本語のツイートは関連するツ
+イートである可能性が高いですが、フランス語のツイートは関連する可能性は
+低いでしょう。
+
+スライドには多くのコメントを表示したくなるかもしれませんが、発表してい
+る間は観客にはできるだけ発表に集中できるように、表示するコメントはでき
+るだけ発表に関連するものだけにした方にしましょう。ツイートが関連するか
+どうかをツイートしたユーザーの言語で絞り込むことができます。
+
+例えば、自分の言語を日本語に設定しているユーザーのツイートだけにする場
+合は以下のように((%--user-language "ja"%))を指定します。
+
+  % rabbiter --filter "#rubykaigi" --user-language "ja"
+
+((%--filter%))と同じように((%--user-language%))も複数回指定することがで
+きます。複数回指定すると指定したどれかの言語のユーザーのツイートのみが
+収集されます。以下は日本語またはフランス語に設定したユーザーのツイート
+のみを収集する例です。
+
+  % rabbiter --filter "#rubykaigi" --user-language "ja" --user-language "fr"
+
+=== 違うホストで起動しているRabbitにコメントを送る
+
+TODO
+
+=== もっと知りたい
+
+((%--help%))オプションを指定すると使えるオプションがすべて表示されます。
+自分が使いたい機能がないか調べてみてください。
+
+  % rabbiter --help
+
+== 作者
+
+  * Kouhei Sutou <kou at cozmixng.org>
+  * OBATA Akio <obata at lins.jp>
+
+== 著作権
+
+著作権はそれぞれのコードを書いた人が持っています。つまり、コミットされ
+たコードの著作権はそのコミッタが持っていて、パッチのコードの著作権はそ
+のパッチ作者が持っています。
+
+== ライセンス
+
+GPLv2 or laterです。詳しくはGPLファイルを見てください。取り込まれたパッ
+チやコードなどを提供してもらった場合、それらのライセンスがGPLv2 or
+laterとすることに同意してもらったこととします。また、それらも含めて須藤
+がライセンスを変更できる権利を持つことに同意してもらったこととします。
+
+== メーリングリスト
+
+((<Rabbitのユーザーページ
+|URL:http://rabbit-shocker.org/ja/users.html>))を参照してください。
+
+== 開発への参加方法
+
+=== リポジトリ
+
+Rabbiterのリポジトリは((<GitHub|URL:https://github.com/rabbit-shocker/rabbiter/>))にあります。
+
+=== コミットメール
+
+以下のメーリングリストにコミットメール毎に変更点が流れます。メーリング
+リストに参加することで開発状況を確認できます。メーリングリストに参加す
+るには以下のようなメールを送信してください。
+
+  To: commit at ml.rabbit-shocker.org
+  Cc: null at rabbit-shocker.org
+  Subject: 登録
+
+  登録
+
+=== バグの報告方法
+
+ご意見ご要望不具合報告等は作者へのメール、メーリングリスト、((<GitHubの
+Issues|URL:https://github.com/rabbit-shocker/rabbiter/issues>))をご利用くださ
+い。
+
+== 感謝
+
+以下の方々はRabbiterを助けてくれたみなさんです。ありがとうございま
+す！！！
+
+  * おばたさん: 最初のバージョンを書いてくれました。
+
diff --git a/doc/ja/news.rd b/doc/ja/news.rd
new file mode 100644
index 0000000..fd93fe5
--- /dev/null
+++ b/doc/ja/news.rd
@@ -0,0 +1,34 @@
+---
+layout: ja
+title: お知らせ
+apply_data: false
+---
+== 2.0.2: 2014-06-05
+
+Ruby/GIO2 2.2.0対応リリース！
+
+=== 改良
+
+  * doc: OS Xのインストールドキュメントに((%glib-networking%))の説明を追加。
+    [GitHub#4] [Colin Deanさんがパッチ提供]
+    [shocker-ja:1190] [znzさんが報告]
+  * Ruby/GIO2 2.2.0に対応。
+
+=== 感謝
+
+  * Colin Deanさん
+  * znzさん
+
+== 2.0.1: 2013-08-29
+
+1年ぶりのバグフィックスリリース！
+
+=== 改良
+
+  * OS XなどGTK+からURLを開けない環境でも初期設定できるようにした。
+
+== 2.0.0: 2012-08-29
+
+初めてのリリース！
+
+Rabbitパッケージから分離しました。

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-ruby-extras/rabbiter.git

