rabbit 0.9.2 → 0.9.3

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/doc/API/2.4/pango/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記法を使います。
+
+((<rd.html/RD>))はRuby Documentの略で、素の状態でも読み書きし
+やすいようにデザインされたテキストの書式です。Wiki記法に近い
+書きかたなので比較的簡単に理解できます。
+
+Wiki記法にはいくつか亜種がありますが、Rabbitでは
+((<hiki.html/Hiki記法>))を採用しています。
+
+=== インターフェイス
+
+Rabbitはスライド操作のインターフェイスが充実しています。特に
+キーボードによる操作に力を入れていて、「それっぽいキーを押し
+たら期待通り動く」ことを目指してています。また、
+マウスジェスチャーをサポートしていたり、「うさぎとかめ」を使っ
+た残り時間表示など便利でユニークな機能が揃っています。
+（TODO: マウスジェスチャーやうさぎとかめを使っているところが
+わかる画像や動画を入れる。）
+
+== インストール方法
+
+((<"install/"/インストール>))ページで説明しています。
+
+== 使い方
+
+((<usage.html/使い方>))ページで説明しています。
+
+== スライドの作り方
+
+((<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
+
+やまだあきらさん
+
+=== Rabbitter
+
+bin/rabbitter
+
+おばたさん
+
+== 共同開発者
+
+  * みやむこさん
+  * noritadaさん
+  * 武田くん
+
+== 著作権
+
+コードの著作権はそれぞれのコードを書いたものにあります。つま
+り、コミットされたコードの著作権はそのコミッタにあり、パッチ
+のコードの著作権はそのパッチ作者にあります。
+
+画像の著作権は上述の作者にあります。
+
+== ライセンス
+
+プログラム、画像ともにGPLv2 or laterです。詳しくはGPLファイル
+を見てください。取り込まれたパッチやコードなどを提供してもらっ
+た場合、それらのライセンスがGPLv2 or laterとすることに同意し
+てもらったこととします。また、それらも含めて須藤がライセンス
+を変更できる権利を持つことに同意してもらったこととします。
+
+lib/rabbit/div/prototype.jsはMITスタイルのライセンスになりま
+す。
+詳しくは((<Prototype JavaScript
+Framework|URL:http://prototype.conio.net/>))を見てください。
+
+== メーリングリスト
+
+((<users.html/ユーザー>))ページにメーリングリストへの参
+加方法があります。
+
+== 開発への参加方法
+
+((<development.html/開発>))ページを見てください。
+
+== FAQ
+
+((<faq.html/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でコンソールが利用可能かどうかを検出する方法を
+      教えてくれました。

data/doc/ja/install/homebrew.rd

@@ -0,0 +1,196 @@
+---
+layout: ja
+title: Homebrewでインストール
+---
+== Mac OS XでHomebrewを使ったインストール方法
+
+Mac OS X のパッケージ管理システムのひとつである Homebrew と RubyGems を利用して
+Rabbit をインストール、利用する手順について説明します。
+
+=== 事前に準備するもの
+
+* Intel Mac
+* Mac OS X Leopard 以上
+* Xcode と X11
+
+=== Homebrew のインストール
+
+ $ ruby -e "$(curl -fsS http://gist.github.com/raw/323731/install_homebrew.rb)"
+
+環境変数 PATH に /usr/local/bin を追加します。
+
+=== Rabbit に必要なソフトウェアのインストール (brew install)
+
+/usr/local/Library/Formula/*.rb の設定を変更してから brew install を実行します。
+
+==== /usr/local/Library/Formula/pango.rb
+
+  require 'formula'
+
+  class Pango < Formula
+    homepage 'http://www.pango.org/'
+    url 'http://ftp.gnome.org/pub/GNOME/sources/pango/1.28/pango-1.28.4.tar.bz2'
+    sha256 '7eb035bcc10dd01569a214d5e2bc3437de95d9ac1cfa9f50035a687c45f05a9f'
+
+    depends_on 'pkg-config' => :build
+    depends_on 'glib'
+
+    fails_with_llvm "Undefined symbols when linking", :build => "2326"
+
+    if MacOS.leopard?
+      depends_on 'fontconfig' # Leopard's fontconfig is too old.
+      depends_on 'cairo' # Leopard doesn't come with Cairo.
+    end
+
+    def install
+      system "./configure", "--prefix=#{prefix}", "--without-x",
+                            "--enable-static",
+                            "--disable-introspection",
+                            "--x-include=#{prefix}/include",
+                            "--x-lib=#{prefix}/lib"
+      system "make install"
+    end
+  end
+
+==== /usr/local/Library/Formula/cairo.rb
+
+  require 'formula'
+
+  class Cairo < Formula
+    homepage 'http://cairographics.org/'
+    url 'http://www.cairographics.org/releases/cairo-1.10.2.tar.gz'
+    sha1 'ccce5ae03f99c505db97c286a0c9a90a926d3c6e'
+
+    depends_on 'pkg-config' => :build
+    depends_on 'pixman'
+
+    keg_only :provided_by_osx,
+              "The Cairo provided by Leopard is too old for newer software to link against."
+
+    fails_with_llvm "Gives an LLVM ERROR with Xcode 4 on some CPUs"
+
+    def install
+      system "./configure", "--disable-dependency-tracking",
+                            "--prefix=#{prefix}",
+                            "--without-x",
+                            "--enable-quartz",
+                            "--enable-quartz-font",
+                            "--enable-quartz-image",
+                            "--disable-xlib",
+                            "--disable-xlib-xrender"
+
+      system "make install"
+    end
+  end
+
+==== /usr/local/Library/Formula/gtk+.rb
+
+  require 'formula'
+
+  class Gtkx < Formula
+    homepage 'http://www.gtk.org/'
+    url 'http://ftp.gnome.org/pub/gnome/sources/gtk+/2.24/gtk+-2.24.4.tar.bz2'
+    sha256 '7d3033ad83647079977466d3e8f1a7533f47abd5cc693f01b8797ff43dd407a5'
+
+    depends_on 'pkg-config' => :build
+    depends_on 'glib'
+    depends_on 'jpeg'
+    depends_on 'libtiff'
+    depends_on 'gdk-pixbuf'
+
+    # Used by pango, but keg-only, so needs to be added to
+    # the flags for gtk+ explicitly.
+    depends_on 'cairo' if MacOS.leopard?
+
+    depends_on 'pango'
+    depends_on 'jasper' => :optional
+    depends_on 'atk' => :optional
+
+    fails_with_llvm "Undefined symbols when linking", :build => "2326"
+
+    def install
+      system "./configure", "--disable-debug", "--disable-dependency-tracking",
+                            "--prefix=#{prefix}",
+                            "--disable-glibtest",
+                            "--with-gdktarget=quartz"
+      system "make install"
+    end
+
+    def test
+      system "gtk-demo"
+    end
+  end
+
+==== /usr/local/Library/Formula/poppler.rb
+
+  require 'formula'
+
+  class PopplerData < Formula
+    url 'http://poppler.freedesktop.org/poppler-data-0.4.4.tar.gz'
+    md5 'f3a1afa9218386b50ffd262c00b35b31'
+  end
+
+  class Poppler < Formula
+    url 'http://poppler.freedesktop.org/poppler-0.16.6.tar.gz'
+    homepage 'http://poppler.freedesktop.org/'
+    md5 '592a564fb7075a845f75321ed6425424'
+
+    depends_on 'pkg-config' => :build
+    depends_on "qt" if ARGV.include? "--with-qt4"
+
+    def options
+      [
+        ["--with-qt4", "Include Qt4 support (which compiles all of Qt4!)"],
+        ["--enable-xpdf-headers", "Also install XPDF headers."]
+      ]
+    end
+
+    def install
+      ENV.x11 # For Fontconfig headers
+
+      if ARGV.include? "--with-qt4"
+        ENV['POPPLER_QT4_CFLAGS'] = `pkg-config QtCore QtGui --libs`.chomp.strip
+        ENV.append 'LDFLAGS', "-Wl,-F#{HOMEBREW_PREFIX}/lib"
+      end
+
+      args = ["--disable-dependency-tracking", "--prefix=#{prefix}"]
+      args << "--disable-poppler-qt4" unless ARGV.include? "--with-qt4"
+      args << "--enable-xpdf-headers" if ARGV.include? "--enable-xpdf-headers"
+      args << "--enable-cairo-output"
+      args << "--enable-poppler-glib"
+      args << "--disable-gtk-test"
+
+      system "./configure", *args
+      system "make install"
+
+      # Install poppler font data.
+      PopplerData.new.brew do
+        system "make install prefix=#{prefix}"
+      end
+    end
+  end
+
+==== brew install と brew link の実行
+
+  $ brew install cairo
+  $ brew link cairo
+  $ brew install pango
+  $ brew install gtk+
+  $ brew install poppler
+
+=== Rabbit に必要なソフトウェアのインストール (gem install)
+
+gem install を実行します。
+
+  $ sudo gem install pango
+  $ sudo gem install cairo
+  $ sudo gem install gtk2
+  $ sudo gem install gdk_pixbuf2
+  $ sudo gem install poppler
+  $ sudo gem install hikidoc # Wiki 記法を使う場合
+
+=== Rabbit のインストール
+
+gem install を実行します。
+
+  $ sudo gem install rabbit