rabbit 2.0.5 → 2.0.6

data/doc/index.html.ja

@@ -8,9 +8,9 @@ no_sidebar: true
   <p>{{ site.release_date }}にリリースされた<a href="/ja/news.html">{{ site.version }}</a>が最新リリースです。</p>
 </div>
 
-<section class="screenshots">
+<section id="screenshots">
   <h2>スクリーンショット</h2>
-  <ul id="screenshots">
+  <ul>
     <li><img src="images/screenshots/ja/blue-circle.png"
              alt="青い円テーマ" /></li>
     <li><img src="images/screenshots/ja/clear-blue.png"

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

@@ -50,10 +50,37 @@ TODO: 他にもメタデータが増えているはず。
 
 === 画像
 
-verbatim blockとして記述します。詳しくはsample/rabbit.rdを見
-てください。
+verbatim blockとして記述します。
 
-TODO: ここに書き方を入れる。
+最初の行は「(({# image}))」からはじめます。「(({src = 画像のパス}))」は
+必ず指定しなければいけません。以下はスライドと同じディレクトリにある
+(({lavie.png}))を表示する例です。
+
+  # image
+  # src = lavie.png
+
+「(({caption = キャプション}))」でキャプションも指定できます。
+
+  # image
+  # src = lavie.png
+  # caption = Lavie
+
+「(({relative_width = 90}))」を指定するとスライドの横幅ほとんどを使って
+大きく画像を表示します。横長の画像を大きく表示するときはこの指定をする
+とよいでしょう。
+
+  # image
+  # src = lavie.png
+  # relative_width = 90
+
+縦長の画像は「(({relative_height = 90}))」を指定してください。スライド
+の縦幅ほとんどを使って大きく画像を表示します。
+
+  # image
+  # src = lavie.png
+  # relative_height = 90
+
+TODO: 指定できるオプションのリストを書く
 
 === 実体参照
 

data/doc/ja/index.rd

@@ -175,7 +175,7 @@ Framework|URL:http://prototype.conio.net/>))を見てください。
 data/rabbit/image/rubykaigi2011-images/rubykaigi2011-background-white.jpg
 と
 data/rabbit/image/rubykaigi2011-images/rubykaigi2011-background-black.jpg
-の作者はnorioさんでラインセンスはCC-by-3.0です。
+の作者はnorioさんでラインセンスはCC-BY-3.0です。
 
 == メーリングリスト
 

data/doc/ja/news.rd

@@ -3,6 +3,52 @@ layout: ja
 title: お知らせ
 apply_data: false
 ---
+== 2.0.6: 2012-12-29
+
+ビデオサポートリリース！2012年最後のリリース！
+
+=== 改良
+
+==== rabbit-slide
+
+  * Ustreamに対応。
+  * Vimeoに対応。
+  * SlideShareでのURLにはタイトルではなくIDを使うようにした。
+    [Masafumi Yokoyamaさんがパッチ提供]
+  * changeコマンドで設定を変更できるようにした。
+
+==== ドキュメント
+
+  * RDを使った時の画像の使い方を追加。 [ほっかいさんが追加]
+
+==== rabbit
+
+  * ファイルの拡張子もチェックしてPDFを認識するようにした。
+  * [非互換] 画像としてPDFを使うときに指定するページ番号を0スタートでは
+    なく1スタートにした。これは、PDFが1ページからカウントするので、それ
+    にあわせるためである。
+  * [実験的] スライドにビデオを埋め込めるようにした。
+    [Narihiro Nakamuraさんがパッチ提供]
+  * テキストの影を元のテキストから離れ過ぎないようにした。
+
+==== rabbit-theme-manager
+
+  * 必要がないので削除。
+
+=== 修正
+
+==== rabbit
+
+  * .rabbitディレクトリを起動オプションを指定したファイルとはみなさない
+    ようにした。 [Koichi Akabeさんが報告]
+
+=== 感謝
+
+  * Masafumi Yokoyamaさん
+  * Koichi Akabeさん
+  * ほっかいさん
+  * Narihiro Nakamuraさん
+
 == 2.0.5: 2012-09-14
 
 バグフィックスリリース。

data/doc/ja/slides.rd

@@ -7,7 +7,7 @@ title: スライド
 Rabbitで作ったスライドがたくさん公開されています。Rabbitで作っ
 たスライドを公開したら自由に追加してください。
 
-* ((<kou|URL:http://pub.cozmixng.org/~kou/archives/TokyoRubyKaigi01/>))
+* ((<kou|URL:http://slide.rabbit-shocker.org/authors/kou/>))
 * ((<zunda|URL:http://zunda.freeshell.org/d/?year=2004;month=3Q;category=rabbit>))さん
 * ((<oxy|URL:http://mono.kmc.gr.jp/~oxy/d/?date=20041019#p02>))さん
 * かずひこさん

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

@@ -29,7 +29,7 @@ TODO: RubyGems.orgに公開したスライドは
 
 以下は札幌Ruby会議2012用のテーマの雛形を生成するコマンドです。
 
-  % rabbit-slide new \
+  % rabbit-theme new \
      --id sprk2012 \
      --name "Kouhei Sutou" \
      --email kou@cozmixng.org \

data/doc/ja/users.rd

@@ -8,8 +8,22 @@ Rabbitユーザのコミュニティとして「Rabbitショッカー」があ
 
 == 活動の場
 
-Rabbitショッカーの活動場所はプレゼンテーションの場以外にもいくつか
-あります。
+Rabbitショッカーの主な活動場所はプレゼンテーションの場です。ただし、プ
+レゼンテーションの場に限らずいくつか活動場所があります。
+
+=== slide.rabbit-shocker.org
+
+RabbitショッカーのみなさんはRabbitを使ってプレゼンテーションした後は使っ
+たスライドを
+((<slide.rabbit-shocker.org|URL:http://slide.rabbit-shocker.org/>))へアッ
+プロードしています。slide.rabbit-shocker.orgへ行けばRabbitでどんなスラ
+イドを作れるかを確認することができます。
+
+あなたもRabbitショッカーとしてプレゼンテーションしたらスライドを
+slide.rabbit-shocker.orgへアップロードしましょう。
+
+アップロード方法については((<"usage/rabbit-slide.rb"|rabbit-slideコマン
+ドの使い方>))に書かれています。
 
 === メーリングリスト
 

data/lib/rabbit/author-configuration.rb

@@ -63,12 +63,12 @@ module Rabbit
     end
 
     def merge!(conf)
-      @markup_language   ||= conf["markup_language"]
-      @name              ||= conf["name"]
-      @email             ||= conf["email"]
-      @rubygems_user     ||= conf["rubygems_user"]
-      @slideshare_user   ||= conf["slideshare_user"]
-      @speaker_deck_user ||= conf["speaker_deck_user"]
+      @markup_language   = conf["markup_language"]   || @markup_language
+      @name              = conf["name"]              || @name
+      @email             = conf["email"]             || @email
+      @rubygems_user     = conf["rubygems_user"]     || @rubygems_user
+      @slideshare_user   = conf["slideshare_user"]   || @slideshare_user
+      @speaker_deck_user = conf["speaker_deck_user"] || @spearker_deck_user
     end
 
     def to_hash

data/lib/rabbit/command/rabbit-slide.rb

@@ -43,7 +43,7 @@ module Rabbit
       end
 
       def run(arguments)
-        @options, @logger = parse_command_line_arguments(arguments)
+        parse_command_line_arguments(arguments)
 
         validate
         unless @validation_errors.empty?
@@ -52,7 +52,7 @@ module Rabbit
           return false
         end
 
-        generate
+        run_command
         @author_conf.save
         true
       end
@@ -60,164 +60,186 @@ module Rabbit
       private
       def parse_command_line_arguments(arguments)
         Rabbit::Console.parse!(ARGV) do |parser, options|
-          @logger = options.default_logger
-          @author_conf = AuthorConfiguration.new(@logger)
-          @author_conf.load
-          @slide_conf = SlideConfiguration.new(@logger)
-          @slide_conf.author = @author_conf
-
-          format = _("Usage: %s new [options]\n" \
-                     " e.g.: %s new \\\n" \
-                     "          --id rubykaigi2012 \\\n" \
-                     "          --base-name rabbit-introduction \\\n" \
-                     "          --markup-language rd \\\n" \
-                     "          --name \"Kouhei Sutou\" \\\n" \
-                     "          --email kou@cozmixng.org \\\n" \
-                     "          --rubygems-user kou \\\n" \
-                     "          --slideshare-user kou \\\n" \
-                     "          --speaker-deck-user kou")
-
-          program = File.basename($0, ".*")
-          parser.banner = format % [program, program]
-
-          parser.separator("")
-
-          parser.separator(_("Slide information"))
-
-          parser.on("--id=ID",
-                    _("Slide ID"),
-                    _("(e.g.: %s)") % "--id=rubykaigi2012",
-                    _("(must)")) do |id|
-            @slide_conf.id = id
-          end
+          setup_options(parser, options)
+        end
+        @command = @options.rest.first || default_command
+      end
 
-          messages = [
-            _("Base name for the slide source file and generated PDF file"),
-            _("(e.g.: %s)") % "--base-name=rabbit-introduction",
-            _("(must)"),
-          ]
-          parser.on("--base-name=NAME",
-                    *messages) do |base_name|
-            @slide_conf.base_name = base_name
-          end
+      def setup_options(parser, options)
+        @options = options
+        @logger = @options.default_logger
+        @author_conf = AuthorConfiguration.new(@logger)
+        @author_conf.load
+        @slide_conf = SlideConfiguration.new(@logger)
+        @slide_conf.author = @author_conf
+
+        format = _("Usage: %s COMMAND [OPTIONS]\n" \
+                   " e.g.: %s new \\\n" \
+                   "          --id rubykaigi2012 \\\n" \
+                   "          --base-name rabbit-introduction \\\n" \
+                   "          --markup-language rd \\\n" \
+                   "          --name \"Kouhei Sutou\" \\\n" \
+                   "          --email kou@cozmixng.org \\\n" \
+                   "          --rubygems-user kou \\\n" \
+                   "          --slideshare-user kou \\\n" \
+                   "          --speaker-deck-user kou")
+
+        program = File.basename($0, ".*")
+        parser.banner = format % [program, program]
+
+        parser.separator("")
+        parser.separator(_("COMMAND"))
+        parser.separator(_("  new:    create a new slide"))
+        parser.separator(_("  change: change an existing slide"))
+
+        parser.separator("")
+        parser.separator(_("Slide information"))
+
+        parser.on("--id=ID",
+                  _("Slide ID"),
+                  _("(e.g.: %s)") % "--id=rubykaigi2012",
+                  _("(must)")) do |id|
+          @slide_conf.id = id
+        end
 
-          available_markup_languages = [:rd, :hiki, :markdown]
-          label = "[" + available_markup_languages.join(", ") + "]"
-          messages = [
-            _("Markup language for the new slide"),
-            _("(e.g.: %s)") % "--markup-language=rd",
-            _("(available markup languages: %s)") % label,
-          ]
-          if @author_conf.markup_language
-            messages << _("(default: %s)") % @author_conf.markup_language
-          end
-          messages << _("(optional)")
-          parser.on("--markup-language=LANGUAGE", available_markup_languages,
-                    *messages) do |language|
-            @author_conf.markup_language = language
-          end
+        messages = [
+          _("Base name for the slide source file and generated PDF file"),
+          _("(e.g.: %s)") % "--base-name=rabbit-introduction",
+          _("(must)"),
+        ]
+        parser.on("--base-name=NAME",
+                  *messages) do |base_name|
+          @slide_conf.base_name = base_name
+        end
 
-          parser.on("--title=TITLE",
-                    _("Title of the new slide"),
-                    _("(e.g.: %s)") % _("--title=\"Rabbit Introduction\""),
-                    _("(optional)")) do |title|
-            @title = title
-          end
+        available_markup_languages = [:rd, :hiki, :markdown]
+        label = "[" + available_markup_languages.join(", ") + "]"
+        messages = [
+          _("Markup language for the new slide"),
+          _("(e.g.: %s)") % "--markup-language=rd",
+          _("(available markup languages: %s)") % label,
+        ]
+        if @author_conf.markup_language
+          messages << _("(default: %s)") % @author_conf.markup_language
+        end
+        messages << _("(optional)")
+        parser.on("--markup-language=LANGUAGE", available_markup_languages,
+                  *messages) do |language|
+          @author_conf.markup_language = language
+        end
 
-          parser.on("--tags=TAG,TAG,...",
-                    Array,
-                    _("Tags of the new slide"),
-                    _("(e.g.: %s)") % "--tags=rabbit,presentation,ruby",
-                 _("(optional)")) do |tags|
-            @slide_conf.tags.concat(tags)
-          end
+        parser.on("--title=TITLE",
+                  _("Title of the new slide"),
+                  _("(e.g.: %s)") % _("--title=\"Rabbit Introduction\""),
+                  _("(optional)")) do |title|
+          @title = title
+        end
 
-          parser.on("--allotted-time=TIME",
-                    _("Allotted time in presentaion"),
-                    _("(e.g.: %s)") % "--allotted-time=5m",
-                    _("(optional)")) do |allotted_time|
-            @allotted_time = allotted_time
-          end
+        parser.on("--tags=TAG,TAG,...",
+                  Array,
+                  _("Tags of the new slide"),
+                  _("(e.g.: %s)") % "--tags=rabbit,presentation,ruby",
+               _("(optional)")) do |tags|
+          @slide_conf.tags.concat(tags)
+        end
 
-          parser.on("--presentation-date=DATE",
-                    _("Presentation date with the new slide"),
-                    _("(e.g.: %s)") % "--presentation-date=2012/06/29",
-                    _("(optional)")) do |date|
-            @slide_conf.presentation_date = date
-          end
+        parser.on("--allotted-time=TIME",
+                  _("Allotted time in presentaion"),
+                  _("(e.g.: %s)") % "--allotted-time=5m",
+                  _("(optional)")) do |allotted_time|
+          @allotted_time = allotted_time
+        end
 
-          parser.separator(_("Your information"))
+        parser.on("--presentation-date=DATE",
+                  _("Presentation date with the new slide"),
+                  _("(e.g.: %s)") % "--presentation-date=2012/06/29",
+                  _("(optional)")) do |date|
+          @slide_conf.presentation_date = date
+        end
 
-          messages = [
-            _("Author name of the new slide"),
-            _("(e.g.: %s)") % "--name=\"Kouhei Sutou\"",
-          ]
-          if @author_conf.name
-            messages << _("(default: %s)") % @author_conf.name
-          end
-          messages << _("(optional)")
-          parser.on("--name=NAME",
-                    *messages) do |name|
-            @author_conf.name = name
-          end
+        parser.separator(_("Your information"))
 
-          messages = [
-            _("Author e-mail of the new slide"),
-            _("(e.g.: %s)") % "--email=kou@cozmixng.org",
-          ]
-          if @author_conf.email
-            messages << _("(default: %s)") % @author_conf.email
-          end
-          messages << _("(optional)")
-          parser.on("--email=EMAIL",
-                    *messages) do |email|
-            @author_conf.email = email
-          end
+        messages = [
+          _("Author name of the new slide"),
+          _("(e.g.: %s)") % "--name=\"Kouhei Sutou\"",
+        ]
+        if @author_conf.name
+          messages << _("(default: %s)") % @author_conf.name
+        end
+        messages << _("(optional)")
+        parser.on("--name=NAME",
+                  *messages) do |name|
+          @author_conf.name = name
+        end
 
-          messages = [
-            _("Account for %s") % "RubyGems.org",
-            _("It is used to publish your slide to %s") % "RubyGems.org",
-            _("(e.g.: %s)") % "--rubygems-user=kou",
-          ]
-          if @author_conf.rubygems_user
-            messages << _("(default: %s)") % @author_conf.rubygems_user
-          end
-          messages << _("(optional)")
-          parser.on("--rubygems-user=USER",
-                    *messages) do |user|
-            @author_conf.rubygems_user = user
-          end
+        messages = [
+          _("Author e-mail of the new slide"),
+          _("(e.g.: %s)") % "--email=kou@cozmixng.org",
+        ]
+        if @author_conf.email
+          messages << _("(default: %s)") % @author_conf.email
+        end
+        messages << _("(optional)")
+        parser.on("--email=EMAIL",
+                  *messages) do |email|
+          @author_conf.email = email
+        end
 
-          messages = [
-            _("Account for %s") % "SlideShare",
-            _("It is used to publish your slide to %s") % "SlideShare",
-            _("(e.g.: %s)") % "--slideshare-user=kou",
-          ]
-          if @author_conf.slideshare_user
-            messages << _("(default: %s)") % @author_conf.slideshare_user
-          end
-          messages << _("(optional)")
-          parser.on("--slideshare-user=USER",
-                    *messages) do |user|
-            @author_conf.slideshare_user = user
-          end
+        messages = [
+          _("Account for %s") % "RubyGems.org",
+          _("It is used to publish your slide to %s") % "RubyGems.org",
+          _("(e.g.: %s)") % "--rubygems-user=kou",
+        ]
+        if @author_conf.rubygems_user
+          messages << _("(default: %s)") % @author_conf.rubygems_user
+        end
+        messages << _("(optional)")
+        parser.on("--rubygems-user=USER",
+                  *messages) do |user|
+          @author_conf.rubygems_user = user
+        end
 
-          messages = [
-            _("Account for %s") % "Speaker Deck",
-            _("It is used to publish your slide to %s") % "Speaker Deck",
-            _("(e.g.: %s)") % "--speaker-deck-user=kou",
-          ]
-          if @author_conf.speaker_deck_user
-            messages << _("(default: %s)") % @author_conf.speaker_deck_user
-          end
-          messages << _("(optional)")
-          parser.on("--speaker-deck-user=USER",
-                    *messages) do |user|
-            @author_conf.speaker_deck_user = user
-          end
+        messages = [
+          _("Account for %s") % "SlideShare",
+          _("It is used to publish your slide to %s") % "SlideShare",
+          _("(e.g.: %s)") % "--slideshare-user=kou",
+        ]
+        if @author_conf.slideshare_user
+          messages << _("(default: %s)") % @author_conf.slideshare_user
+        end
+        messages << _("(optional)")
+        parser.on("--slideshare-user=USER",
+                  *messages) do |user|
+          @author_conf.slideshare_user = user
+        end
+
+        messages = [
+          _("Account for %s") % "Speaker Deck",
+          _("It is used to publish your slide to %s") % "Speaker Deck",
+          _("(e.g.: %s)") % "--speaker-deck-user=kou",
+        ]
+        if @author_conf.speaker_deck_user
+          messages << _("(default: %s)") % @author_conf.speaker_deck_user
+        end
+        messages << _("(optional)")
+        parser.on("--speaker-deck-user=USER",
+                  *messages) do |user|
+          @author_conf.speaker_deck_user = user
         end
       end
 
+      def default_command
+        if File.file("config.yaml")
+          "change"
+        else
+          "new"
+        end
+      end
+
+      def available_commands
+        ["new", "change"]
+      end
+
       def validate
         @validation_errors = []
         validate_command
@@ -226,17 +248,13 @@ module Rabbit
       end
 
       def validate_command
-        if @options.rest.empty?
-          @options.rest << "new"
-        end
-        if @options.rest.size != 1
+        if @options.rest.size > 1
           message = _("too many commands: %s") % @options.rest.inspect
           @validation_errors << message
         end
-        @command = @options.rest[0]
-        if @command != "new"
+        unless available_commands.include?(@command)
           format = _("invalid command: <%s>: available commands: %s")
-          message = format % [@command, "[new]"]
+          message = format % [@command, "[#{available_commands.join(', ')}]"]
           @validation_errors << message
         end
       end
@@ -253,8 +271,33 @@ module Rabbit
         end
       end
 
-      def generate
+      def run_command
+        __send__("run_command_#{@command}")
+      end
+
+      def run_command_new
         generate_directory
+        generate_template
+      end
+
+      def run_command_change
+        merge_config_yaml
+        generate_template
+      end
+
+      def merge_config_yaml
+        existing_slide_conf = SlideConfiguration.new(@logger)
+        existing_slide_conf.load
+        existing_slide_conf.merge!(@slide_conf.to_hash)
+        @slide_conf = existing_slide_conf
+        @author_conf = @slide_conf.author
+      end
+
+      def generate_directory
+        create_directory(base_directory)
+      end
+
+      def generate_template
         generate_dot_gitignore
         generate_dot_rabbit
         generate_slide_configuration
@@ -263,10 +306,6 @@ module Rabbit
         generate_slide
       end
 
-      def generate_directory
-        create_directory(@slide_conf.id)
-      end
-
       def generate_dot_gitignore
         create_file(".gitignore") do |dot_gitignore|
           dot_gitignore.puts(<<-EOD)
@@ -289,7 +328,7 @@ EOD
       end
 
       def generate_slide_configuration
-        @slide_conf.save(@slide_conf.id)
+        @slide_conf.save(base_directory)
       end
 
       def generate_readme
@@ -342,7 +381,6 @@ require "rabbit/task/slide"
 # Edit ./config.yaml to customize meta data
 
 Rabbit::Task::Slide.new do |task|
-  # task.spec.licenses = ["CC BY-SA 3.0"]
   # task.spec.files += Dir.glob("doc/**/*.*")
   # task.spec.files -= Dir.glob("private/**/*.*")
   # task.spec.add_runtime_dependency("YOUR THEME")
@@ -429,7 +467,7 @@ EOR
             end
           end
         end
-        source << "\n\n"
+        source << "\n"
       end
 
       def slide_source_items(source, generator)
@@ -449,8 +487,17 @@ EOR
         source << "\n"
       end
 
+      def base_directory
+        case @command
+        when "change"
+          "."
+        else
+          @slide_conf.id
+        end
+      end
+
       def create_file(path, &block)
-        super(File.join(@slide_conf.id, path), &block)
+        super(File.join(base_directory, path), &block)
       end
     end
   end