rabbit-qt 0.1.0

data/doc/ja/how-to-make/theme.rd

@@ -0,0 +1,142 @@
+---
+layout: ja
+title: テーマの作り方
+---
+== テーマについて
+
+スライドの見た目はRDとは別に指定します。それがテーマです。
+
+テーマのテスト用のスライドがsample/theme-bench.rabにあるので
+活用してください。
+
+== 置き場所
+
+テーマはrubyの$LOAD_PATHから検索されます。新しくテーマを作成
+した場合は((|$LOAD_PATHに含まれているパス/rabbit/theme/テーマ
+名/テーマ名.rb|))あるいは((|ソースがあるディレクトリ/テーマ
+名.rb|))に置いてください。
+
+== 書き方
+
+テーマはRubyスクリプトです。難しいと思われるかもしれませんが，
+凝ったことをしなければそれほど難しいことはありません。
+
+テーマは以下のような記述を列挙していくことになると思います。
+
+  (1) 対象となるスライド中の要素（段落とか、ページタイトルと
+      か）を選択
+
+  (2) 選択した要素に対して属性を変更したり、描画時の動作を加
+      えたりする。
+
+例えば、各ページ（タイトルページは含まない）にあるタイトルの
+文字の色を変更したい場合は以下のように書きます。
+
+  match(Page, HeadLine) do |heads|
+    heads.prop_set("foreground", "red")
+  end
+
+((|heads|))というように複数形になっているのは、((|heads|))は
+タイトル（見出し，head line）を0個以上含んでいるからです。
+
+== プロパティ
+
+(({prop_set}))では前景色（foreground）以外にも以下のものが指
+定できます。詳しくは((<Pango Text Attribute
+Markup|URL:http://developer.gnome.org/pango/stable/PangoMarkupFormat.html>))
+を見てください。
+
+: font_desc
+   フォント情報を指定します。
+
+: font_family
+   フォント名を指定します。
+   
+   フォント名の一覧は(({font_families}))とやればフォント名の
+   配列として取得できます。
+
+: face
+   font_familyと同じです。
+
+: size
+   フォントの大きさを指定します。
+   
+   フォントの大きさを数値で指定する場合は、指定する数値を
+   (({screen_size}))で変換してから(({Pango::SCALE}))を掛けて
+   ください。例えば，フォントの大きさを（Rabbitのテーマの世
+   界の単位で）2にする場合は以下のようにします。
+
+     screen_size(2) * Pango::SCALE
+
+: style
+   フォントのスタイルを指定します。
+
+: weight
+   フォントの重みを指定します。
+
+: variant
+   フォントのvariant（変形方法って感じ？）を指定します。
+
+: stretch
+   フォントの伸び縮みの具合を指定します。
+
+: foreground
+   前景色を指定します。
+
+: background
+   背景色を指定します。
+
+: underline
+   下線の種類をします。
+
+: rise
+   文字の上下の位置を指定します。
+
+: strikethrough
+   取消線を引くかどうかを指定します。
+
+: fallback
+   指定したフォントがなかった場合に似たようなフォントで代用
+   するかどうかを指定します。
+
+: lang
+   言語を指定します。
+
+: b
+   太字にします。
+
+: big
+   フォントのサイズを大きくします。
+
+: i
+   斜体にします。
+
+: s
+   取消線を引きます。
+
+: sub
+   下付き文字にします。
+
+: sup
+   上付き文字にします。
+
+: small
+   フォントのサイズを小さくします。
+
+: tt
+   固定スペースフォントにします。
+
+: u
+   下線を引きます。
+
+== フック
+
+要素が描画される前、又は後に実行される手続きを指定することが
+できます。それぞれ，(({add_pre_draw_proc}))，
+(({add_post_draw_proc}))で指定できます。これらの手続きを削除
+するときは、それぞれ(({clear_pre_draw_procs}))、
+(({clear_post_draw_procs}))を使います。
+
+詳しくは。。。とりあえず，今のところはdefaultテーマを参考に
+してください。
+

data/doc/ja/index.rd

@@ -0,0 +1,283 @@
+---
+layout: ja
+title: はじめに
+---
+== Rabbitとは
+
+Rabbitはプログラマ向け（主にRubyist向け）のプレゼンテーション
+ツールです。
+
+Rabbitはテキスト形式でプレゼン資料を作成できるので、常にエディ
+タとバージョン管理システムを使っているプログラマ向きのプレゼ
+ンテーションツールです。
+
+また、キーボードによるインターフェイスが充実していることもプ
+ログラマにはうれしい機能です。Keynoteや他のプレゼンテーションツールで
+スライドを作成しているユーザでも、スライド表示にRabbitを使う
+ことができます。具体的には、見栄えの調整などのスライド作成は
+GUIのプレゼンテーションツールで行い、スライド表示・操作のイン
+ターフェイスだけキーボード操作に強いRabbitを使う、というよう
+に使い分けられます。
+
+さらに、Rabbitではスライドの見た目をRubyでカスタマイズできま
+す。プレゼンテーションの時もプログラムできるなんて、Rubyistに
+は嬉しすぎますね。
+
+=== 書式
+
+テキストの書式にはRDまたはWiki記法またはMarkdown記法を使います。
+
+((<rd.rd/RD>))はRuby Documentの略で、素の状態でも読み書きし
+やすいようにデザインされたテキストの書式です。Wiki記法に近い
+書きかたなので比較的簡単に理解できます。
+
+Wiki記法にはいくつか亜種がありますが、Rabbitでは
+((<hiki.rd/Hiki記法>))を採用しています。
+
+=== インターフェイス
+
+Rabbitはスライド操作のインターフェイスが充実しています。特に
+キーボードによる操作に力を入れていて、「それっぽいキーを押し
+たら期待通り動く」ことを目指してています。また、
+マウスジェスチャーをサポートしていたり、「うさぎとかめ」を使っ
+た残り時間表示など便利でユニークな機能が揃っています。
+（TODO: マウスジェスチャーやうさぎとかめを使っているところが
+わかる画像や動画を入れる。）
+
+== インストール方法
+
+((<"install/"/インストール>))ページで説明しています。
+
+== 使い方
+
+((<usage.rd/使い方>))ページで説明しています。
+
+== スライドの作り方
+
+((<how-to-make/スライドの作り方>))ページで説明しています。
+
+== 作者
+
+=== プログラム
+
+Kouhei Sutou <kou@cozmixng.org>
+
+=== 画像（1）
+
+* マスコットキャラクタLavie（ラヴィ）((-語感はRabbitから、スペ
+  ルはフランス語のla vieからとりました。-))とRabbitのロゴ
+
+  カワイイ方のうさぎです。
+
+* たいらびとたいやき
+
+  たいやきが好きな食いしん坊なうさぎです。
+
+* バナー
+
+  カワイイバナーです。
+
+モモ
+
+=== 画像（2）
+
+* 兎
+
+  カッコいい方のうさぎです。
+
+* かめ
+
+  カワイイかめです。
+
+sode
+
+=== 画像（3）
+
+旗
+
+gan
+
+=== 画像（4）
+
+* ピンクのRabbitのロゴ
+
+* ピンクのRubyのロゴ
+
+* うさたろう
+
+* かめたろう
+
+* たぬ・きたろう（たぬさん）
+
+* ゆきだるたろう（ゆきだるさん）
+
+うさっち
+
+=== 画像（5）
+
+* ゆきうさ
+
+  和服うさぎ少女です。
+
+* アリス
+
+  青いドレスの少女です。
+
+朝比奈 理乃（あさひな　りの）
+
+((<URL:http://littleblue.chu.jp/>))
+
+=== xyzzy用モード
+
+misc/xyzzy/
+
+みやむこさん
+
+=== Emacs用モード
+
+misc/emacs/
+
+武田くん
+
+=== RabbIRC
+
+bin/rabbirc
+
+やまだあきらさん
+
+== 共同開発者
+
+  * みやむこさん
+  * noritadaさん
+  * 武田くん
+
+== 著作権
+
+コードの著作権はそれぞれのコードを書いた人が持っています。つまり、コミッ
+トされたコードの著作権はそのコミッタが持っていて、パッチのコードの著作
+権はそのパッチ作者が持っています。
+
+画像の著作権は上述の作者が持っています。
+
+== ライセンス
+
+プログラム、画像ともにGPLv2 or laterです。詳しくはGPLファイルを見てくだ
+さい。パッチやコードなどを提供してもらった場合、それらのライセンスも同
+じライセンスとすることに同意してもらったこととします。また、それらも含
+めて須藤がライセンスを変更できる権利を持つことに同意してもらったことと
+します。
+
+data/rabbit/image/rubykaigi2011-images/rubykaigi2011-background-white.jpg
+と
+data/rabbit/image/rubykaigi2011-images/rubykaigi2011-background-black.jpg
+の作者はnorioさんでライセンスは
+((<CC-BY-3.0|URL:http://creativecommons.org/licenses/by/3.0/>))です。
+
+== メーリングリスト
+
+((<users.rd/ユーザー>))ページにメーリングリストへの参
+加方法があります。
+
+== 開発への参加方法
+
+((<development.rd/開発>))ページを見てください。
+
+== FAQ
+
+((<faq.rd/FAQ>))ページを見てください。
+
+== 感謝
+
+以下の方々はRabbitを助けてくれたみなさんです。ありがとうござ
+います！！！
+
+  * モモさん: かわいいうさぎとかかわいいバナーなどを書いてく
+    れました。
+  * みやむこさん: xyzzy用のrabbitモードを書いてくれました。
+    Windowsまわりでいろいろ助けてくれます。
+  * zundaさん:
+    * EPSの扱いを修正してくれました。
+    * --marginの指定方法についてアドバイスしてくれました。
+    * Rabbitを使ってプレゼンしてくれます。
+    * Windowsへのインストール用ドキュメントを更新してくれま
+      した。
+    * Mac OS Xへのインストール用ドキュメントを更新してくれま
+      した。
+  * Vincentさん: Max OS Xでの動作確認をしてくれます。フラン
+    ス語のメッセージを用意してくれました。
+  * sodeさん: かっこいい兎とかかわいいうさぎとかかわいいかめ
+    を書いてくれました。
+  * かずひこさん: いろいろバグ報告をしてくれました。Rabbitを
+    使ってプレゼンしてくれます。テーマデザインのアイディアを
+    くれました。
+  * noritadaさん: ドキュメントに関するバグ報告をしてくれまし
+    た。
+  * ganちゃん: 旗を書いてくれました。
+  * かくたにさん:
+    * ドキュメントに関するバグ報告をしてくれました。
+    * Rabbitを使ってプレゼンしてくれます。
+    * テーマデザインや機能拡張のアイディアをくれました。
+    * HTML出力に関するバグを修正するパッチをくれました。
+    * Mac OS X(Intel)用のパッケージを作ってくれました。
+  * atzmさん: Gentoo用のパッケージ（*.ebuild）を作ってくれま
+    した。
+  * やまだあきらさん:
+    * Debian用のパッケージ（*.deb）を作ってくれました。
+    * バグ報告をし、修正もしてくれます。
+    * rabbircを作ってくれました。
+  * うさっちさん: ロゴとか、たろうシリーズなどを書いてくれま
+    した。
+  * dotさん: Windowsのインストールについてアドバイスしてくれ
+    ました。
+  * 田中さん: Windowsで動作確認してくれました。
+  * 朝比奈さん: かわいいうさぎ少女とかアリスを書いてくれまし
+    た。
+  * 西川さん: FAQページの名前を考えてくれました。動作報告を
+    してくれます。
+  * 武田くん: Emacs用のrabbitモードを書いてくれました。
+  * 木村さん: Mac OS X用のパッケージを作ってくれました。
+  * kitajさん:
+    * Rabbitを使ってプレゼンしてくれます。
+    * Windowsのインストールドキュメントを修正してくれます。
+    * テーマを改良してくれます。
+  * あかぴさん: emergeについてのドキュメントを書いてくれました。
+  * おばたさん:
+    * pkgsrc用のパッケージを作ってくれました。
+    * Rabbitを使ってプレゼンしてくれます。
+    * バグ報告をし、修正もしてくれます。
+    * たくさんデバッグしてくれます。
+    * Rabbitterを作ってくれました。
+  * むとうさん:
+    * Rabbitを使ってプレゼンしてくれます。
+    * Windowsへのインストール用ドキュメントを更新してくれま
+      した。
+  * たださん:
+    * Rabbitを使ってプレゼンしてくれます。
+    * テーマを提供してくれました。
+    * テーマベンチを作成するというアイディアをくれました。
+  * 前田さん:
+    * Rabbitを使ってプレゼンしてくれます。
+    * プレゼンの中でこっそりバグレポートをしてくれました。
+  * 中井さん: 不具合を報告してくれます。
+  * Eduardo Gonzalezさん: 英語のドキュメントをよくしてくれま
+    した。
+  * 西山さん: バグレポートしてくれました。
+  * 助田さん: Ruby 1.9関連のバグを報告してくれました。
+  * kdmsnrさん: バグレポートしてくれました。
+  * 佐々木さん: Debianパッケージのメンテナンスをしてくれます。
+  * まつもとさん:
+    * Rabbitを使ってプレゼンしてくれます。
+    * 情報ウィンドウの機能について提案してくれました。
+  * とみたまさひろさん:
+    * Ruby 1.9関連のバグを報告してくれました。
+  * Kiwamu Okabeさん:
+    * twitter-footerテーマを提供してくれました。
+    * Wii RemoteでRabbitを操作するコマンドを提供してくれました。
+  * なかださん:
+    * Windowsでコンソールが利用可能かどうかを検出する方法を
+      教えてくれました。
+  * 無量井健さん:
+    * ドキュメントのバグを直してくれました。
+  * TAKATSU Tomonariさん:
+    * FreeBSDのPortsをメンテナンスしてくれます。
+    * たくさんバグを直してくれました。

data/doc/ja/install/homebrew.rd

@@ -0,0 +1,23 @@
+---
+layout: ja
+title: Homebrewでインストール
+---
+== macOSでHomebrewを使ったインストール方法
+
+macOS のパッケージ管理システムのひとつである Homebrew と RubyGems を利用して
+Rabbit をインストール、利用する手順について説明します。
+
+=== 事前に準備するもの
+
+* macOS
+* Xcode と X11（XQuartzをインストール）
+
+=== Homebrew のインストール
+
+((<URL:https://brew.sh/>)) に記載の方法に従ってインストールしてください。
+
+=== Rabbit のインストール
+
+gem install を実行します。
+
+  $ sudo gem install rabbit

data/doc/ja/install/index.rd

@@ -0,0 +1,53 @@
+---
+layout: ja
+title: インストール
+---
+== インストール方法について
+
+Rabbitはgemまたはそれぞれのプラットフォームにあるパッケージ管
+理システムを使ってインストールすることができるため、導入が非
+常に簡単です。
+
+== gemを使う方法
+
+  % gem install rabbit
+  % gem install rabbiter # Twitter関連機能を利用する場合
+
+== Debian GNU/Linuxでのインストール方法
+
+  % sudo aptitude install -y rabbit
+
+== Ubuntuでのインストール方法
+
+  % sudo aptitude install -y rabbit
+
+== Gentoo Linuxでのインストール方法
+
+  % sudo env ACCEPT_KEYWORDS=~x86 FEATURES="digest" emerge rabbit
+
+== NetBSD（またはpkgsrcが使えるプラットフォーム）でのインストール方法
+
+  % sudo pkg_add ruby18-rabbit
+
+または
+
+  % sudo pkg_add ruby19-rabbit
+
+== FreeBSDでのインストール方法
+
+  % sudo portupgrade -NRr rabbit
+
+== Mac OS XでMacPortsを使ったインストール方法
+
+((<macports.rd/MacPortsを使ったインストール方法>))を参照してく
+ださい。
+
+== Mac OS XでHomebrewを使ったインストール方法
+
+((<homebrew.rd/Homebrewを使ったインストール方法>))を参照してく
+ださい。
+
+== Windowsでのインストール方法
+
+((<windows.rd/Windowsでのインストール方法>))を参照してくださ
+い。

data/doc/ja/install/macports.rd

@@ -0,0 +1,100 @@
+---
+layout: ja
+title: MacPortsでインストール
+---
+== Mac OS XでMacPortsを使ったインストール方法
+
+Mac OS X のパッケージ管理システムのひとつである、MacPorts を利用して
+Rabbit をインストール、利用する手順について説明します。
+
+=== 事前に準備するもの
+
+以下のソフトウェアが必要です。Mac OS X のシステムDVDなどからインストール
+してください。
+
+* Xcode Tools
+* X11
+
+Xcode Tools のインストール時には、X11 SDK を選択するのを忘れないでください。
+
+=== MacPorts のインストール
+
+MacPorts の公式サイト ((<URL:http://www.macports.org/>)) からダウンロード、
+インストールします。ディスクイメージ(.dmg)からインストールするのが簡単です。
+
+とくに指定しなければ、/opt/local 以下に MacPorts 関連のファイル群がインストール
+されます。MacPorts のコマンドを利用するために、環境変数 PATH に /opt/local/bin
+を追加します。
+
+=== Rabbit のインストール
+
+まず、以下のコマンドで、Rabbitに必要なソフトウェアの情報を更新し
+ておくのも良いかもしれません。
+
+  ~% sudo port sync
+
+以下のコマンドで Rabbit と、それに必要なソフトウェアがインストールされます。
+
+  ~% sudo port install rb-rabbit
+
+glib や Gtk2 がインストールされていないときは、これらのインストールのために
+ある程度の時間がかかります。
+
+他にも以下の port をインストールするとよいでしょう。
+
+* Ruby-GetText-Package (rb-gettext) - メッセージなどの国際化が有効になります
+* net/irc (rb-net-irc) - rabbircが利用できるようになります
+
+インストール方法は同様です。
+
+  ~% sudo port install rb-gettext
+  ~% sudo port install rb-net-irc
+
+注) Ruby-GetText-Package が、すでに RubyGems からインストールされているときは
+rb-gettext のインストールは不要です。
+
+==== X11なしでRabbitを利用したい
+
+もしRabbitをX11なしで利用したい場合は、rb-rabbitパッケージをインストールする
+前に、pango・cairoおよびgtk2をX11なしでインストールしてください。
+
+  ~% sudo port install pango +no_x11 +quartz
+  ~% sudo port install cairo +no_x11 +quartz
+  ~% sudo port install gtk2 +no_x11 +quartz
+
+=== X11 環境に関する Tips
+
+一般的な PC-UNIX 環境とは異なり、Mac OS X ではウィンドウシステムとして X を
+利用していません。そのため、いくつかの注意が必要になります。
+
+==== X11.app を起動する
+
+X11.app が起動していなければ、rabbit は実行できません。X11.app は 
+/アプリケーション/ユーティリティ/X11.app にあります。
+
+==== DISPLAY 環境変数
+
+X11 上で動作する Rabbit を利用するためには、DISPLAY 環境変数が設定されて
+いなければなりません。X11.app 上の xterm では設定されていますが、標準の
+ターミナルや iTerm、JTerminal を利用しているときは自分で設定する必要が
+あることに注意してください。
+
+=== Rabbit をバージョンアップする
+
+port sync コマンドで Portfile を最新のものに更新したうえで、
+port upgrade コマンドにより、Rabbit を最新のバージョンに更新することが
+できます。
+
+  ~% sudo port sync
+  ~% sudo port upgrade rb-rabbit
+
+Rabbit だけをバージョンアップしたいときは、-n オプションを指定します。この
+オプションの指定により、関連するソフトウェアは更新せずに Rabbit だけを更新
+することができます。
+
+  ~% sudo port -n upgrade rb-rabbit
+
+=== 連絡先
+
+お気づきの点やリクエストなどは、((<"../users.rd"/Rabbitショッカー>))
+や Rabbit MacPorts 担当の木村 (kimuraw at i.nifty.jp) までどうぞ。

data/doc/ja/install/windows.rd

@@ -0,0 +1,46 @@
+---
+layout: ja
+title: Windowsへインストール
+---
+== Windowsでのインストール方法
+
+Windows上でRabbitをインストールする方法、起動方法について説明します。
+
+=== インストール方法
+
+以下のソフトウェアをインストールします。
+
+  * Ruby
+  * Rabbit
+
+それぞれ説明します。
+
+==== Rubyのインストール方法
+
+((<RubyInstall for Windowsのダウンロードページ（英語）
+|URL:http://rubyinstaller.org/downloads/>))からインストーラーをダウン
+ロードして実行します。32bit版のRubyでも64bit版のRubyでもかまいません。
+
+==== Rabbitのインストール方法
+
+RubyInstallerをインストールするとスタートメニューに「Start Command
+Prompt with Ruby」（日本語の場合は「Ruby コマンドプロンプトを開く」）
+というプログラムが追加されます。このプログラムを実行すると
+(({ruby.exe}))にパスが通ったコマンドプロンプトが表示されます。ここで以
+下のコマンドを実行することでRabbitをインストールできます。Ruby/GTK2な
+ど関連するソフトウェアも一緒にインストールされます。
+
+  > gem install rabbit
+
+=== 起動方法
+
+Rabbitのインストール時に使ったコマンドプロンプトで次のコマンドを実行し
+ます。
+
+  > rabbit
+
+実行するとスライドファイルを開くダイアログが表示されるので作成したスラ
+イドファイルを指定します。
+
+スライドファイルの作成方法は((<スライドの作り方|URL:../how-to-make/>))
+を参考にしてください。