rabbit 0.9.2 → 0.9.3

data/doc/index.html.en

@@ -0,0 +1,48 @@
+---
+layout: en
+title: A presentation tool for Rubyist
+lang_suffix: true
+no_sidebar: true
+---
+<section class="screenshots">
+  <ul id="screenshots">
+    <li><img src="images/screenshots/en/blue-circle.png"
+             alt="Blue Circle theme" /></li>
+    <li><img src="images/screenshots/en/clear-blue.png"
+             alt="Clear Blue theme" /></li>
+    <li><img src="images/screenshots/en/cozmixng.png"
+             alt="COZMIXNG theme" /></li>
+    <li><img src="images/screenshots/en/dark-gradation.png"
+             alt="Dark Gradation theme" /></li>
+    <li><img src="images/screenshots/en/day-white.png"
+             alt="Day White theme" /></li>
+    <li><img src="images/screenshots/en/debian.png"
+             alt="Debian theme" /></li>
+    <li><img src="images/screenshots/en/green-circle.png"
+             alt="Green Circle theme" /></li>
+    <li><img src="images/screenshots/en/night-black.png"
+             alt="Night Black theme" /></li>
+    <li><img src="images/screenshots/en/rabbit.png"
+             alt="Rabbit theme" /></li>
+    <li><img src="images/screenshots/en/ranguba.png"
+             alt="Ranguba theme" /></li>
+    <li><img src="images/screenshots/en/red-frame.png"
+             alt="Red Frame theme" /></li>
+    <li><img src="images/screenshots/en/ruby-gnome2.png"
+             alt="Ruby-GNOME2 theme" /></li>
+  </ul>
+</section>
+
+<div class="main">
+  <section class="contents">
+    <h2>About Rabbit</h2>
+    <nav>
+      <ul>
+        <li><a href="en/">README</a></li>
+        <li><a href="en/news.html">News</a></li>
+        <li><a href="en/faq.html">FAQ</a></li>
+        <li><a href="en/users.html">Shockers - Rabbit users group</a></li>
+      </ul>
+    </nav>
+  </section>
+</div>

data/doc/index.html.ja

@@ -0,0 +1,48 @@
+---
+layout: ja
+title: Rubyist用プレゼンツール
+lang_suffix: true
+no_sidebar: true
+---
+<section class="screenshots">
+  <ul id="screenshots">
+    <li><img src="images/screenshots/ja/blue-circle.png"
+             alt="青い円テーマ" /></li>
+    <li><img src="images/screenshots/ja/clear-blue.png"
+             alt="きれいな青テーマ" /></li>
+    <li><img src="images/screenshots/ja/cozmixng.png"
+             alt="COZMIXNGテーマ" /></li>
+    <li><img src="images/screenshots/ja/dark-gradation.png"
+             alt="暗めのグラデーションテーマ" /></li>
+    <li><img src="images/screenshots/ja/day-white.png"
+             alt="Day Whiteテーマ" /></li>
+    <li><img src="images/screenshots/ja/debian.png"
+             alt="Debianテーマ" /></li>
+    <li><img src="images/screenshots/ja/green-circle.png"
+             alt="緑の円テーマ" /></li>
+    <li><img src="images/screenshots/ja/night-black.png"
+             alt="Night Blackテーマ" /></li>
+    <li><img src="images/screenshots/ja/rabbit.png"
+             alt="Rabbitテーマ" /></li>
+    <li><img src="images/screenshots/ja/ranguba.png"
+             alt="ラングバテーマ" /></li>
+    <li><img src="images/screenshots/ja/red-frame.png"
+             alt="赤い枠テーマ" /></li>
+    <li><img src="images/screenshots/ja/ruby-gnome2.png"
+             alt="Ruby-GNOME2テーマ" /></li>
+  </ul>
+</section>
+
+<div id="main">
+  <section class="contents">
+    <h2>Rabbitについて</h2>
+    <nav>
+      <ul>
+	<li><a href="ja/">はじめに</a></li>
+	<li><a href="ja/news.html">お知らせ</a></li>
+	<li><a href="ja/faq.html">よくある質問</a></li>
+	<li><a href="ja/users.html">ショッカー - ユーザのみなさん</a></li>
+      </ul>
+    </nav>
+  </section>
+</div>

data/doc/ja/about.rd

@@ -0,0 +1,21 @@
+---
+layout: ja
+title: Rabbitとは？
+---
+== Rabbit
+
+RabbitはRubyでカスタマイズできるプレゼンテーションツールです。
+
+Rabbitはテキスト形式でプレゼン資料を作成できるので、常にエディ
+タとバージョン管理システムを使っているプログラマ向きのプレゼ
+ンテーションツールです。テキストの書式にはRDまたはWiki記法を
+使います。
+
+((<RD|URL:rd.html>))はRuby Documentの略で、素の状態でも読み書
+きしやすいようにデザインされたテキストの書式です。Wiki記法に
+近い書きかたなので比較的簡単に理解できます。
+
+Wiki記法にはいくつか亜種がありますが、Rabbitでは((<Hiki記法
+|URL:hiki.html>))を採用しています。
+
+

data/doc/ja/development.rd

@@ -0,0 +1,49 @@
+---
+layout: ja
+title: 開発
+---
+== リポジトリ
+
+Rabbitのリポジトリは
+((<GitHub|URL:https://github.com/shockers/rabbit/>))にありま
+す。
+
+== コミットメール
+
+以下のメーリングリストにコミットメール毎に変更点が流れます。
+メーリングリストに参加することで開発状況を確認できます。メー
+リングリストに参加するには以下のようなメールを送信してくださ
+い。
+
+  To: rabbit-commit@ml.cozmixng.org
+  Cc: null@cozmixng.org
+  Subject: 登録
+
+  登録
+
+== バグの報告方法
+
+ご意見ご要望不具合報告等は作者へのメール、メーリングリスト
+（メーリングリストについては((<users.html/ユーザ>))ページを見
+てください）、((<GitHubの
+Issues|URL:https://github.com/shockers/rabbit/issues>))をご利
+用ください。
+
+== 開発へ参加
+
+Rabbitプロジェクトはみなさんが開発に参加してくれることを歓迎
+します！
+
+=== テーマ
+
+新しいテーマを作ったら、ぜひメーリングリストなどで教えてくだ
+さい。Rabbit本体に取り込みませんか？
+
+=== ドキュメント
+
+Rabbitのドキュメントが不足しています。まずは、あなたの知って
+いることを((<faq.html/FAQ>))ページに書いてみませんか？
+
+慣れてきたら((<"how-to-make/"/スライドの作り方>))ページの内
+容を充実させませんか？あるいは、既存の日本語のドキュメントを
+英語に翻訳しませんか？

data/doc/ja/faq.rd

@@ -0,0 +1,177 @@
+---
+layout: ja
+title: FAQ
+---
+== FAQ
+
+以下のような形式でよくある質問に対する答えが書かれています。
+
+== 質問...
+
+答え...
+
+== 1ページに複数枚のスライドが入ったPDFを作るには？
+
+XXX.rdから1ページに8枚のスライドが入ったPDF（XXX_multi.pdf）を
+作成する手順は以下の通りです．
+
+  % rabbit -p --slides-per-page 8 -o XXX_multi.pdf XXX.rd
+
+== PDFでうさぎと亀を使いたいときは？
+
+pdf-tortoise-and-hareテーマとRABBIT_ALLOTTED_TIME環境変数を使います。
+
+  % RABBIT_ALLOTTED_TIME=5m rabbit --theme pdf-tortoise-and-hare slide.pdf
+
+RABBIT_ALLOTTED_TIMEの値の書式はスライド中に
+
+  # _
+  : allotted-time
+      5m
+
+と書くときと同じものが使えます。
+
+上の例だと「5m」なので、亀が5分かけて走ります。
+
+== 亀を元に戻したいときは？
+
+ Alt+t
+
+== 高橋メソッドスライドの中に普通のスライドを混ぜたいときは？
+
+高橋メソッド用のテーマはRabbitではlightning-talkと呼ばれています．
+
+通常，高橋メソッドのみを使ったスライドを作成する場合は以下のように「lightning-talk」テーマを使います．
+
+  = タイトル
+  : author
+     オレ
+  : theme
+     lightning-talk # <= こんな感じ
+
+  = オレは
+
+  = オレだ
+
+もし，高橋メソッドを使ったスライドだけではなく，箇条書きなどを使った「普通の」スライドを混ぜたい場合はこれではうまくいきません．なぜなら，「lightning-talk」テーマは箇条書きなどの見栄え定義を持たないからです．
+
+これを解決するには，テーマを混ぜます．実は，「ligntning-talk」と混ざったテーマが標準でいくつか用意されています．例えば，「rabbit」テーマと「lignting-talk」テーマを混ぜた「lightning-rabbit」です．このテーマを使うと以下のように，高橋メソッドを使ったスライドと普通の「rabbit」テーマのスライドを混ぜることができます．
+
+  = タイトル
+  : author
+     オレ
+  : theme
+     lightning-rabbit
+
+  = オレは
+
+  = ．．．
+
+    * ．．．
+    * ．．．
+    * ．．．
+
+  = オレだ
+
+「lightning-rabbit」テーマは以下のようにとても小さなテーマです．
+
+  # enscript ruby
+  include_theme("rabbit")       # (1)
+
+  @lightning_talk_proc_name = "lightning-rabbit"
+  @lightning_talk_as_large_as_possible = true
+  include_theme("lightning-talk-toolkit")
+
+  match(Slide) do |slides|
+    slides.each do |slide|
+      if slide.lightning_talk?  # (2)
+        slide.lightning_talk    # (3)
+      end
+    end
+  end
+
+作戦は，以下のようになっています．
+
+  (1) ベースとなるテーマを適用する．（(1)の部分）
+  (2) lightning-talk用のスライドだけ（(2)の部分）
+      見栄えをlightning-talk用の見栄え定義で上書きする．（(3)の部分）
+
+これを応用すれば，簡単にちょっとだけ高橋メソッドを使ったプレゼンテーションを行うことができます．注意点は「((*slide.lightning_talkは最後に！*))」ということです．これは，既存の見栄えを上書きするという作戦を用いているためです．
+
+ちなみに，(({slide.lightning_talk}))の別名として(({slide.takahashi}))が，(({slide.lightning_talk?}))の別名として(({slide.takahashi?}))が用意されています．
+
+Happy Rabbitting!
+
+== 特定のスライドだけプロパティを変えたい時は？
+
+例えば以下は "Redhanded" を含むスライドのフォントをイタリックに変更します。
+  match Slide do |slides|
+    slides.each do |slide|
+      if slide.match?(/Redhanded/)
+        slide.prop_set("style", "italic")
+      end
+    end
+  end
+
+== 改行をするには？
+
+以下のように書きます．
+
+  \n
+
+これはスライドの内容だけではなく，スライドタイトルでも有効です．
+
+TODO: 前は&NewLine;と書かなきゃいけなかったけど、今は\nで書
+けるようにしたから↓は古くなっている。どうしよう。
+
+RabbitにはRubyと同じ魔法の粉がかかっています．つまり，「やってはいけないことは汚く見える」ようになっています((-Rubyの魔法の粉は，例えばグローバル変数に(({$}))を使うというものです．-))．
+
+Rabbitで改行が書きづらくて，書くとソースが見づらくるのも，Rabbitが改行をできるだけ使わないで欲しいからです．
+
+できるだけ使わないで欲しい一番の理由は「スライドには改行をしなければいけないくらい長い文章は書かない方がよい」からです．文章が長くなってしまった場合は，改行をすることを考える前にその文章を短く言い替えられないかなどを考えた方がよいでしょう．
+
+スライドに長い文章を書くと，聞いている人はスライドの内容を読むことに集中して，発表者への注意が少なくなってしまいがちです．プレゼンテーションのテクニックとして，「大事なこと，一番言いたいことを話すときは発表者に注目させる」というものがあります((-ホント？-))．スライドに長い文章を書いていると，このテクニックが使いづらくなってしまいます．
+
+== ブラックアウト？ホワイトアウト？
+
+スライド全体を黒または白くして，スライドの内容を見えなくして，「発表者に注目させる」というテクニックを使うときに利用するための機能です．
+
+ブラックアウトは((%B%))で，ホワイトアウトは((%W%))で切替えることができます．それぞれのキーバインドの理由は((*B*))lackと((*W*))hiteです．
+
+== タイトルスライドの背景を指定するには？
+
+title-background-colorテーマを使います．
+
+例えば，背景を赤くしたい場合は以下のようにします．
+
+  @title_background_color = "red"
+  include_theme("title-background-color")
+
+背景色の指定には(({#RRGGBB}))形式も使えます．以下の例も背景を赤くします．
+
+  @title_background_color = "#ff0000"
+  include_theme("title-background-color")
+
+色ではなくて，画像を指定したいときはtitle-background-imageテーマを使います．
+
+以下は背景にマスコットキャラクタ「ラビィ」を指定する例です．
+
+  @title_background_image = "lavie.png"
+  include_theme("title-background-image")
+
+== スライドの背景を指定するには？
+
+例えば，背景を赤くしたい場合は以下のようにします．
+
+  set_background("red")
+
+背景色の指定には(({#RRGGBB}))形式も使えます．以下の例も背景を赤くします．
+
+  set_background("#ff0000")
+
+色ではなくて，画像を指定したいときはslide-background-imageテーマを使います．
+
+以下は背景にマスコットキャラクタ「ラビィ」を指定する例です．
+
+  @slide_background_image = "lavie.png"
+  include_theme("slide-background-image")