rabbit 2.0.0 → 2.0.1

data/Rakefile

@@ -28,6 +28,10 @@ $LOAD_PATH.unshift(File.join(base_dir, 'lib'))
 rsync_base_path = "rabbit@rabbit-shockers.org:public_html/"
 
 helper = Bundler::GemHelper.new(base_dir)
+def helper.version_tag
+  version
+end
+
 helper.install
 spec = helper.gemspec
 version = spec.version.to_s
@@ -164,11 +168,6 @@ EOC
   end
 end
 
-desc "Tag the current revision."
-task :tag do
-  sh("git tag -a #{version} -m 'release #{version}!!!'")
-end
-
 task :build => "gettext"
 task :package => "gettext"
 

data/doc/_config.yml

@@ -1,7 +1,7 @@
 markdown: rdiscount
 pygments: true
-version: 2.0.0
-release_date: 2012-08-29
+version: 2.0.1
+release_date: 2012-08-31
 rabbiter_version: 2.0.0
 rabbiter_release_date: 2012-08-29
 rabbirack_version: 2.0.0

data/doc/en/news.rd

@@ -3,6 +3,119 @@ layout: en
 title: News
 apply_data: false
 ---
+== 2.0.1: 2012-08-31
+
+A bug fix release.
+
+=== Improvements
+
+==== rabbit
+
+  * The slide source specified by command line is use rather than the
+    slide source specified by .rabbit.
+
+=== Fixes
+
+==== rabbit
+
+  * Fixed a bug that information window doesn't work.
+    [Fixed by Narihiro Nakamura]
+  * Fixed a bug that index mode doesn't work.
+    [Reported by Masaomi Hatakeyama]
+  * Fixed a bug that TeX formater doesn't work.
+    [Reported by Masaomi Hatakeyama]
+
+=== THanks
+
+  * Narihiro Nakamura
+  * Masaomi Hatakeyama
+
+== 2.0.0: 2012-08-29
+
+Major version up!
+
+Slides and themes can be shared. Both of them can be registered as gem
+at RubyGems.org. If you specify a slide gem, ((%rabbit%)) command
+installs and shows it automatically. If you specify a theme gem,
+((%rabbit%)) command installs and uses it automatically.
+
+A tool that publishes your slide to SlideShare with one command is
+also added. You can share your slide more easily.
+
+Some utilities such as RabbiRack and Rabbiter are splited as new
+packages. You needed to install related libraries manually. Now, you
+can install them automatically by installing those tools. It's easy to
+install.
+
+=== Improvements
+
+==== rabbit
+
+  * Made gettext gem required library.
+  * Made rttool gem required library.
+  * Supported relative path image in slide that is specified as URL.
+  * Supported .rabbit file in the current directory. If the file exists,
+    command line arguments are read from the file.
+  * Supported a directory that has .rabbit as source file.
+  * Supported a slide that is published as gem.
+  * Supported a theme that is published as gem.
+  * Added --options-file option that reads command line arguments from
+    the specified file.
+  * Removed setup.rb.
+  * Removed obsoleted --druby-uri option.
+  * Removed the default image directory customization feature on
+    install. It's not neeed now.
+  * Used (({theme.rb})) as the Ruby script file for theme.
+    (({#{THEME_NAME}.rb})) is still available but it's obsoleted.
+  * Supported (({.})) as the special theme name. It uses a theme in
+    the current directory.
+
+==== rabbit-slide
+
+New feature. It provides the following slide related features.
+
+  * Scaffolds a new slide.
+  * Uploads a slide to RubyGems.org.
+  * Uploads a slide to SlideShare.
+  * Shows a slide easily.
+  * Generates a PDF easily.
+
+==== rabbit-theme
+
+New feature. It proves the following theme related features.
+
+  * Scaffolds a new theme.
+  * Uploads a theme to RubyGems.org.
+  * Shows a theme by benchmark slide.
+  * Generates a PDF easily.
+
+==== Theme
+
+  * background-image-toolkit: Supported a background image specified by URL.
+    [Suggested by Youhei SASAKI]
+  * image-slide-number: Showed page number in flags by default.
+  * default: Enabled hare and tortoise by default.
+
+=== Fixes
+
+==== Documentation
+
+  * Fixed wrong description of numerical character reference.
+    [Reported by znz]
+
+=== Changes
+
+  * Split up RabbiRack into rabbirack gem.
+  * Split up Rabbiter into rabbiter gem.
+  * Split up RabWii into rabwii gem.
+  * Split up theme benchmark slide to
+    rabbit-slide-rabbit-theme-benchmark-en gem.
+
+=== Thanks
+
+  * znz
+  * Youhei SASAKI
+
 == 1.0.9: 2012-07-21
 
 A bug fix release of 1.0.8.

data/doc/en/usage.rd

@@ -9,6 +9,8 @@ Rabbit. Rabbit also provides convenient tools. They are described in
 other pages.
 
   * ((<"usage/rabbit.rd"/rabbit command usage>))
+  * ((<"usage/rabbit-slide.rd"/rabbit-slide command usage>))
+  * ((<"usage/rabbit-theme.rd"/rabbit-theme command usage>))
   * ((<"rabbirack/"/RabbiRack>)): A Web interface for Rabbit. You can
     control Rabbit on your Web browser.
   * ((<"rabbiter/"/Rabbiter>)): It's a tool that receives comments

data/doc/en/usage/rabbit-slide.rd

@@ -0,0 +1,5 @@
+---
+layout: en
+title: rabbit-slide command usage
+---
+TODO

data/doc/en/usage/rabbit-theme.rd

@@ -0,0 +1,5 @@
+---
+layout: en
+title: rabbit-theme command usage
+---
+TODO

data/doc/ja/news.rd

@@ -3,6 +3,117 @@ layout: ja
 title: お知らせ
 apply_data: false
 ---
+== 2.0.1: 2012-08-31
+
+バグフィックスリリース。
+
+=== 改良
+
+==== rabbit
+
+  * .rabbitで指定したスライドソースよりもコマンドラインで指定したスライ
+    ドソースの方を優先して使うようにした。
+
+=== 修正
+
+==== rabbit
+
+  * 情報ウィンドウが動作しない問題を修正。 [nariさんが修正]
+  * インデックスモードが動作しない問題を修正。 [畠山さんが報告]
+  * TeXフォーマット機能が動作しない問題を修正。 [畠山さんが報告]
+
+=== 感謝
+
+  * nariさん
+  * 畠山さん
+
+== 2.0.0: 2012-08-29
+
+約一年ぶりのメジャーバージョンアップ！
+
+スライドとテーマを共有できるようになりました。スライドもテーマも
+RubyGems.orgにgemとして登録しておきます。スライドgemを指定すると自動で
+インストールして表示します。gemで公開されているテーマを指定したときも自
+動でインストールしてそのテーマを使います。
+
+また、コマンド一発でスライドをSlideShareに公開するユーティリティも追加
+しました。よりスライドを共有しやすくなっています。
+
+また、RabbiRackやRabbiterといったRabbitを便利にするツールを別パッケージ
+にしました。これまでは、これらのツールを使うために別途依存ライブラリを
+手動でインストールする必要がありましたが、別パッケージにしたことにより、
+それらを自動化できるようになりました。これでインストールが楽になってい
+ます。
+
+=== 改良
+
+==== rabbit
+
+  * gettext gemを必須ライブラリにした。
+  * rttool gemを必須ライブラリにした。
+  * URL指定のスライド中で使っている相対パスの画像を扱えるようにした。
+  * カレントディレクトリに.rabbitファイルがある場合は、そのファイルから
+    コマンドライン引数を読むようにした。
+  * スライドとして.rabbitファイルがあるディレクトリを指定できるようにした。
+  * gemで公開されたスライドを直接表示できるようにした。
+  * gemで公開されたテーマを自動でインストールして使うようにした。
+  * ファイルに書かれたコマンドライン引数を指定する--options-fileオプショ
+    ンを追加。
+  * setup.rbを削除。
+  * 非推奨になっていた--druby-uriオプションを削除。
+  * インストール時にデフォルト画像ディレクトリのパスをカスタマイズする
+    機能を削除。不必要になったため。
+  * テーマ用のRubyスクリプトファイル名として(({theme.rb}))を使うように
+    した。これまで通り(({#{テーマ名}.rb}))も使えるが非推奨。
+  * テーマ名として(({.}))を指定した場合はカレントディレクトリのテーマを
+    使うようにした。
+
+==== rabbit-slide
+
+新規追加した機能。以下のようなスライドに関する便利機能を提供する。
+
+  * 新規スライドの雛形を生成機能。
+  * スライドをRubyGems.orgにアップロードする機能。
+  * SlideShareにアップロードする機能。
+  * 簡単にスライドを表示する機能。
+  * 簡単にPDFを生成する機能。
+
+==== rabbit-theme
+
+新規追加した機能。以下のようなテーマに関する便利機能を提供する。
+
+  * 新規テーマの雛形を生成機能。
+  * テーマをRubyGems.orgにアップロードする機能。
+  * 簡単にテーマ確認用スライドでテーマを確認する機能。
+  * 簡単にPDFを生成する機能。
+
+==== テーマ
+
+  * background-image-toolkit: 背景画像をURLで指定できるようにした。
+    [佐々木さんが提案]
+  * image-slide-number: デフォルトで旗にページ番号を表示するようにし
+    た。
+  * default: デフォルトでうさぎとかめを有効にした。
+
+=== 修正
+
+==== ドキュメント
+
+  * 数値文字参照の間違った説明を修正。[znzさんが報告]
+
+=== 変更
+
+  * RabbiRackを別パッケージ（rabbirack gem）にした。
+  * Rabbiterを別パッケージ（rabbiter gem）にした。
+  * RabWiiを別パッケージ（rabwii gem）にした。
+  * テーマベンチマーク用のスライドを別パッケージ
+    （rabbit-slide-rabbit-theme-benchmark-ja）にした。
+
+=== 感謝
+
+  * znzさん
+  * 佐々木さん
+
 == 1.0.9: 2012-07-21
 
 1.0.8のバグフィックスリリース

data/doc/ja/usage.rd

@@ -9,6 +9,8 @@ Rabbitはスライドを表示する((%rabbit%))コマンドがメインのツ
 ぞれ別ページで詳しく説明します。
 
   * ((<"usage/rabbit.rd"/rabbitコマンドの使い方>))
+  * ((<"usage/rabbit-slide.rd"/rabbit-slideコマンドの使い方>))
+  * ((<"usage/rabbit-theme.rd"/rabbit-themeコマンドの使い方>))
   * ((<"rabbirack/"/RabbiRack>)): RabbitのWebインターフェイス。Rabbitを
     Webブラウザーから操作できるようになる。
   * ((<"rabbiter/"/Rabbiter>)): Twitterからコメントを収集してRabbitに渡

data/doc/ja/usage/rabbit-slide.rd

@@ -0,0 +1,212 @@
+---
+layout: ja
+title: rabbit-slideコマンドの使い方
+---
+== 概要
+
+rabbit-slideはスライドの雛形を生成するコマンドです。
+
+簡単なスライドを作成するにはソースファイルが1つあれば十分ですが、1から
+作り始めるよりも雛形があった方が作り始めやすいです。また、スライドを公
+開する場合はソースファイル以外にも必要なファイルがあります。それらのス
+ライド作成のとっかかりに便利なファイル一式を生成してくれます。
+
+スライドの雛形を生成したら、スライド自体を作成します。スライドの作成時
+およびスライド作成後の支援機能も含まれています。支援機能はRakeタスクと
+して提供されています。この支援機能を使うと、スライドの表示やPDFの生成、
+RubyGems.orgやSlideShareへの公開をコマンド一発で実行できます。
+
+Rabbitでよいスライドを作成し、よい発表をし、そして、共有しましょう！
+
+TODO: RubyGems.orgに公開したスライドは
+((<URL:http://slide.rabbit-shockers.org/>))で閲覧できるようになる予定で
+す。
+
+== 雛形作成
+
+まず、((%rabbit-slide%))コマンドで雛形を生成します。コマンドに新しいス
+ライドの情報を渡します。たくさんの情報を渡さないといけないため少し不便
+です。今後、GUIで情報を指定できるようにする予定です。
+
+以下はテーマベンチマーク用のスライドの雛形を生成するコマンドです。
+
+  % rabbit-slide new \
+     --id theme-benchmark-ja \
+     --base-name theme-benchmark \
+     --markup-language rd \
+     --name "Kouhei Sutou" \
+     --email kou@cozmixng.org \
+     --rubygems-user kou \
+     --tags rabbit
+
+必須のパラメータは((%--id%))と((%--base-name%))です。
+
+((%--id%))はスライドのIDです。ASCII文字のみで指定してください。
+
+((%--base-name%))はスライドのソースファイルの拡張子を除いた部分です。こ
+ちらもASCII文字のみで指定してください。
+
+RubyGems.orgで公開する場合は((%--name%))、((%--email%))、
+((%--rubygems-user%))などのユーザー情報も指定します。
+
+TODO: すべてのパラメーターの説明を書く。
+
+すべてのパラメーターは((%--help%))で確認できます。
+
+  % rabbit-slide --help
+  使い方: rabbit-slide new [オプション]
+      例: rabbit-slide new \
+            --id rubykaigi2012 \
+            --base-name rabbit-introduction \
+            --markup-language rd \
+            --name "Kouhei Sutou" \
+            --email kou@cozmixng.org \
+            --rubygems-user kou \
+            --slideshare-user kou \
+            --speaker-deck-user kou
+
+  スライドの情報
+          --id=ID                      スライドID
+                                       （例: --id=rubykaigi2012）
+                                       （必須）
+          --base-name=NAME             スライドのソースファイルとソースから生成するPDFファイルのベースファイル名
+                                       （例: --base-name=rabbit-introduction）
+                                       （必須）
+          --markup-language=LANGUAGE   新しいスライドのマークアップ言語
+                                       （例: --markup-language=rd）
+                                       （利用可能なマークアップ言語: [rd, hiki, markdown]）
+                                       (デフォルト: rd)
+                                       （省略可能）
+          --title=TITLE                新しいスライドのタイトル
+                                       （例: --title="Rabbitの紹介"）
+                                       （省略可能）
+          --tags=TAG,TAG,...           新しいスライドのタグ
+                                       （例: --tags=rabbit,presentation,ruby）
+                                       （省略可能）
+          --allotted-time=TIME         プレゼンの持ち時間
+                                       （例: --allotted-time=5m）
+                                       （省略可能）
+          --presentation-date=DATE     新しいスライドでプレゼンする日
+                                       （例: --presentation-date=2012/06/29）
+                                       （省略可能）
+  あなたの情報
+          --name=NAME                  新しいスライドの作者の名前
+                                       （例: --name="Kouhei Sutou"）
+                                       (デフォルト: Rabbit)
+                                       （省略可能）
+          --email=EMAIL                新しいスライドの作者のEメールアドレス
+                                       （例: --email=kou@cozmixng.org）
+                                       (デフォルト: lavie@rabbit-shockers.org)
+                                       （省略可能）
+          --rubygems-user=USER         RubyGems.orgのアカウント
+                                       RubyGems.orgにスライドを公開するときに使います
+                                       （例: --rubygems-user=kou）
+                                       (デフォルト: rabbit)
+                                       （省略可能）
+          --slideshare-user=USER       SlideShareのアカウント
+                                       SlideShareにスライドを公開するときに使います
+                                       （例: --slideshare-user=kou）
+                                       (デフォルト: kou)
+                                       （省略可能）
+          --speaker-deck-user=USER     Speaker Deckのアカウント
+                                       Speaker Deckにスライドを公開するときに使います
+                                       （例: --speaker-deck-user=kou）
+                                       （省略可能）
+
+  共通のオプション
+          --options-file=FILE          FILEからオプションを読み込みます。
+                                       （なし）
+
+          --locale-dir=DIR             ロケールディレクトリを[DIR]にします．
+                                       (自動)
+
+          --logger-type=TYPE           ログの出力種類を[TYPE]にします．
+                                       [gui, stderr]から選びます．
+                                       (STDERR)
+          --log-level=LEVEL            ログの出力レベルを[LEVEL]にします．
+                                       [debug, info, warning, error, fatal, unknown]から選びます．
+                                       (info)
+
+          --help                       このメッセージを表示します．
+          --version                    バージョンを表示します．
+
+== 表示
+
+雛形を作成したらスライドIDと同じ名前のディレクトリができているのでそこ
+に移動します。ここでは((%--id theme-benchmark-ja%))と指定したとします。
+
+  % cd theme-benchmark-ja
+
+ここで((%rake%))とするとスライドが表示できます。
+
+  % rake
+
+スライドを確認しながらソースファイルを編集してください。ソースファイル
+を変更すると自動でスライドの内容が更新されます。
+
+== PDF生成
+
+発表が終わったらPDFでスライドを配布しましょう。配布する前に手元で
+PDFを確認したいですよね。((%rake pdf%))でPDFを生成できます。
+
+  % rake pdf
+
+((%pdf/theme-benchmark-ja.pdf%))ができているのでそれをPDFビューアーで開
+いてください。なお、((%rabbit%))コマンドもPDFビューアーになるので
+((%rabbit%))コマンドでも確認できます。
+
+  % cd pdf
+  % rabbit theme-benchmark-ja.pdf
+
+== 公開
+
+現在のところ、RubyGems.orgとSlideShareへ簡単にスライドを公開する機能が
+あります。Speaker Deckにも簡単に公開できるようにしようとしましたが、
+APIがなかったので諦めました。
+
+公開する場合は雛形作成時に以下のパラメーターを指定しておいてください。
+
+  * ((%--name%))
+  * ((%--email%))
+  * ((%--rubygems-user%)): RubyGems.orgへ公開する場合
+  * ((%--slideshare-user%)): SlideShareへ公開する場合
+
+また、((%README.rd%))の先頭にある以下の部分をスライドにあわせて更新して
+ください。
+
+
+  = TODO: スライドのタイトル
+
+  TODO: スライドの説明
+
+例えば、theme-benchmark-jaの場合は以下のようになっています。
+
+  = テーマベンチマーク
+
+  Rabbitのテーマを確認するためのスライドです。スライドで使われる要素がた
+  くさん入っているためテーマの確認に便利です。
+
+準備ができたら((%rabbit publish%))でRubyGems.orgとSlideShareにまとめて
+公開できます。別々に公開する方法は以下の通りです。
+
+=== RubyGems.orgへ公開
+
+((%rabbit publish:rubygems%))でRubyGems.orgに公開できます。
+
+  % rake publish:rubygems
+
+RubyGems.orgに公開したスライドは
+((%rabbit #{RubyGems.orgのユーザー名}-#{スライドID}.gem%))
+で表示できます。theme-benchmark-jaの場合は
+RubyGems.orgのユーザー名が((%kou%))でスライドIDが
+((%theme-benchmark-ja%))なので以下のコマンドで表示できます。
+
+  % rabbit rabbit-theme-benchmark-ja.gem
+
+=== SlideShareへ公開
+
+((%rabbit publish:slideshare%))でSlideShareに公開できます。
+
+  % rake publish:slideshare
+
+無事に公開できたら自動でスライドページを開きます。