rabbit 2.1.2 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8c2b87def8b701bea8696194849162927addb0b
-  data.tar.gz: 1dd74a34a9a042082f2316b2993a555fc67d1722
+  metadata.gz: 8aa40eb58148060ffc901519695ddd120b0f4ad8
+  data.tar.gz: 994990cef70ff133e2f68f23177f83e8b6111624
 SHA512:
-  metadata.gz: 119e64350b07ec0e9b5b3da3e6fca45727af38cfdfd43bbed5cccc17b511cea613acc1c1a0ba483f8d6d1f069d5f4e8ce2eab2e0551e6ce89e544d982b65941c
-  data.tar.gz: e33feeb726d0dff6156c2eda5765d084f83ab254162e18678369a5f01026866e184f2b529485e7fbf431ec2c05e258f0a10351fe042951ea3834c0f4f2d0c8cc
+  metadata.gz: cc87a88ddfcdf9d7520cbb651ab727de41d6ed6d1a3a1f9cfe88105ac98d0118177cf39cf975dc492394285958054e5277b938858156ebd52e52b52ae777b6b5
+  data.tar.gz: 454f959ece8a8b5530f9d3781bf70819722dd3a19f266be4493c2a30688a384e6d515dd03cb16ea1e42257a092667e07f43304288eea20e4c05be038ea00e886

data/Rakefile

@@ -232,3 +232,29 @@ desc "Run test"
 task :test do
   ruby("test/run-test.rb")
 end
+
+namespace :doc do
+  related_products = [
+    "rabwii",
+    "rabbirack",
+    "rabbiter",
+  ]
+  related_product_directories = []
+  related_products.each do |related_product|
+    related_product_directory = "../#{related_product}"
+    related_product_directories << related_product_directory
+    directory related_product_directory do
+      sh("git",
+         "clone",
+         "https://github.com/rabbit-shocker/#{related_product}.git",
+         related_product_directory)
+    end
+  end
+
+  desc "Run documentation server"
+  task :server => related_product_directories do
+    Dir.chdir("doc") do
+      sh("jekyll", "server", "--watch")
+    end
+  end
+end

data/doc/_config.yml

@@ -1,7 +1,6 @@
 markdown: kramdown
-pygments: true
-version: 2.1.2
-release_date: 2014-03-08
+version: 2.1.3
+release_date: 2014-08-03
 rabbiter_version: 2.0.1
 rabbiter_release_date: 2013-08-29
 rabbirack_version: 2.0.0

data/doc/en/development.rd

@@ -1,5 +1,5 @@
 ---
-layout: ja
+layout: en
 title: Development
 ---
 == Repository
@@ -10,8 +10,8 @@ Rabbit's repository is
 == Commit mail
 
 You can stay up to date on the latest development by
-subscribing to the git commit ML. If you want to subscribe
-to the ML, send an e-mail like the following.
+subscribing to the git commit ML. If you want to join,
+send an e-mail like the following.
 
   To: commit@ml.rabbit-shocker.org
   Cc: null@cozmixng.org
@@ -28,22 +28,22 @@ reporting a bug or a request.
 
 == Contribution
 
-We welcome to your contribution. :)
+We welcome your contribution. :)
 
 === Theme
 
-We always welcome to a new theme. Please send your theme
-when you create a theme.
+We always welcome new theme. Please tell us your own theme
+when you create one.
 
 === Documentation
 
-Rabbit lacks documentation in English. Please consider that
-you write your tips to ((<faq.rd/FAQ>)) page.
+Rabbit lacks of documentation in English. Please consider 
+to write your tips to ((<faq.rd/FAQ>)) page.
 
 === Translation
 
 Please translate messages in Rabbit into your native
-language. You can make po/#{LANG}/rabbit.po by the running
+language. You can make po/#{LANG}/rabbit.po by running
 the following:
 
   % mkdir po/#{LANG}

data/doc/en/faq.rd

@@ -10,9 +10,141 @@ This page lists frequently asked questions. Here is a format used in this page.
 
 Answer...
 
+== How can I embed tweets on Rabbit slide?
+
+Use "rabbiter" command. For exapmle, you hit rabbitter command as follows
+ after starting Rabbit and you will see tweets including word "ruby" in the bottom of the slides in form of comment.
+
+  % rabbiter --filter ruby
+
+== How can I flow tweets on slides like embeded video?
+
+Run ((%rabbit%)) command with ((%--comment-theme stream-comment%)) options.
+
+  % rabbit --comment-theme stream-comment slide.rab
+
+Taking into tweets with ((%rabbiter%)) command,
+you can flow them on your slides.
+
 == How to make a PDF which has some slides per page?
 
 For example, we make XXX_multi.pdf which has 8 slides per
 page from XXX.rd.
 
   % rabbit -p --slides-per-page 8 -o XXX_multi.pdf XXX.rd
+
+== What should I do to use hare and tortoise on PDF slide?
+
+Use --allotted-time option.
+
+  % rabbit --allotted-time 5m slide.pdf
+
+The same value format of 
+
+  # _
+  : allotted-time
+      5m
+
+on slides are available for that of --allotted-time. 
+
+For this example you set "5m" and the tortoise runs just 5 minutes.
+
+== How can I reset tortoise to start?
+
+Hit Alt+t
+
+== How can I include default style slides with one used "Takahashi method"?
+
+Takahashi method is called lightning-talk as far as Rabbit.
+
+We generally use the theme when we want to make pure Takahashi method slides.
+
+  = Title
+  : author
+      Anonymous
+  : theme
+     lightning-talk # <= like this
+
+  = I am
+
+  = a Rubyist!
+
+If you'd like to include plain slide which has e.g. unordered list as well as Takahashi method, you cannot do it in that way. Because the theme lightning-talk does not have any style definition for its display like list.
+
+You can resolve the issue with including theme. Some themes which are mixed with lightning-talk theme are prepared. For example, a theme named "lightning-rabbit" is a mixture of "rabbit" and "lightning-talk". With this, you will get what you want as follows:
+
+  = Title
+  : author
+     anonymous
+  : theme
+     lightning-rabbit
+
+  = I am
+
+  = ．．．
+
+    * ．．．
+    * ．．．
+    * ．．．
+
+  = a Rubyist
+
+ The theme "lightning-rabbit" is very neat like below.
+
+  # 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
+
+So in other words,
+
+  (1) Apply a theme for its base.（(1)）
+  (2) For only slides for lightning-talk（(2)）
+      overwrite its definition for look in one for lightning-talk. （(3)）
+
+In this way, you can include Takahashi method to your slide. Note that ((*slide.lightning_talkは最後に！*)) should be loaded in the last owing to overwrite default settings.
+
+Finally, some themes have another name, for example, (({slide.lightning_talk})) also can be called (({slide.takahashi})) and (({slide.lightning_talk?}))can be called (({slide.takahashi?})).
+
+Happy Rabbitting!
+
+== How can I change property of specific slides?
+
+In following example, you can change font to Italic on slides containing phrase "Redhanded".
+
+  match Slide do |slides|
+    slides.each do |slide|
+      if slide.match?(/Redhanded/)
+        slide.prop_set("style", "italic")
+      end
+    end
+  end
+
+== How can I set new line?
+
+Use following charachters.
+
+  \n
+
+This is available in both content and title.
+
+TODO: Formery we should use &NewLine; but now can use \n
+, which means following sentence is oblsolate. Oh my god...
+
+Rabbit has got into the magic as well as Ruby, which "makes what you shouldn't looks ugly". ((-Using (({$})) for global vars is a kind of "Magic Powder" for Ruby. -))．
+
+The reason it is difficult to put new lines in Rabbit and they makes source dirty is that Rabbit wants you not to use so many new lines.
+
+The most important reason of it is that you shouldn't take too long sentences to set new line on slides. You'd better think of shorter one rather than use long terms with many new lines.
+
+If you show so long sentence on your stage, they will achieve more attention than that towards you. Note that some says you should be appearant when want to tell them the most important thing((-sure ?-)). Longer sentence makes it much difficult for you to do so.

data/doc/en/hiki.hiki

@@ -1,8 +1,8 @@
 ---
 layout: ja
 title: Hiki notation
-apply_data: false
 ---
+{% raw %}
 !Paragraphs
 
 Consecutive lines are concatenated into a single paragraph.
@@ -323,3 +323,4 @@ which is not surrounded by <p> ... </p>.
  {{pre('
  ...
  ')}}
+{% endraw %}

data/doc/en/index.rd

@@ -2,47 +2,37 @@
 layout: en
 title: README
 ---
-== What is Rabbit?
+== About Rabbit
 
-Rabbit is a presentation tool for programmer, especially
-Rubyist.
+Rabbit is a presentation tool for programmer, especially Rubyist.
 
-You can create presentation slides as a text format. So you
-can use your favorite editor and version control system for
-creating presentation slides.
+Slide is written in text format, so you can use your favorite editor or versioning tool to make it.
 
-Rabbit has programmer-friendly keybord interface. If you
-type a key then you will get what you want because Rabbit
-uses Emacs/Vi like key bindings by default.
+Rabbit also has programmer-friendly keybord interface. 
+You can use Rabbit just as a slide viewer because Rabbit also supports PDF format.
+It means even after making slide in other tool like Keynote, you can use Rabbit for displaying it.
 
-You can just use Rabbit as a slide viewer because Rabbit can
-also show PDF format slide. You can create by Keynote or
-what you like and use Rabbit as a slide viewer for
-programmer-friendly keybord interface.
-
-You can customize slide look and feed by Ruby. It's very
-important for Rubyist that you can program when you make
-presentation slides.
+You can customize its look with Ruby code, so you can hack even when making slides! 
 
 === Format
 
-Rabbit supports RD, Wiki notation and Markdown for text format.
+Rabbit supports RD, Wiki markup and Markdown for its format.
 
-((<rd.rd/RD>)) is an abbreviation of Ruby Document. It's
-easy to read text format.
+((<rd.rd/RD>)) is an abbreviation of Ruby Document, which is
+easy to read for its simple text format.
 
-Rabbit supports a ((<hiki.rd/Hiki notation>)) that is a
-dialect of Wiki notations.
+Rabbit supports a ((<hiki.rd/Hiki notation>)); one of
+the dialects of Wiki notations.
 
 === Interface
 
-Rabbit has useful slide operation interface.
+Rabbit has useful slide operation interface as follows.
 
-  * Keybord interface: If you type a key then you will get
+  * Keybord interface: If you hit a key, then you will get
     what you want.
-  * Mouse gesture: Just for a fun. It'll not be used while
-    presentation but it's fun while creating.
-  * Here and tortoise: Visualize remaining time.
+  * Mouse gesture: Just for a fun. It'll not be used during
+    presentation but it's fun for creating.
+  * Hare and tortoise: Visualize remaining time with animation of their race.
 
 == Install
 
@@ -158,14 +148,14 @@ other words the committer retains copyright of his or her
 committed code and patch authors retain the copyright of
 their submitted patch code.
 
-The images above are copyright their respective owners.
+The images above are copyrighted by their respective owners.
 
 == License
 
 Licensed under GPLv2 or later. For more information see 'GPL'
 file. Provided patches, codes and so on are also licensed under GPLv2
 or later. Kouhei Sutou can change the license of them. He considers
-that authores of them agree with the rule when they contribute their
+that authors of them agree with the rule when they contribute their
 patches, codes and so on.
 
 lib/rabbit/div/prototype.js released under an MIT-style

data/doc/en/install/homebrew.rd

@@ -26,6 +26,7 @@ Then add /usr/local/bin to your PATH.
   $ brew install pango
   $ brew install gtk+
   $ brew install poppler --with-glib
+  $ brew install libsvg
 
 === Install Rabbit
 

data/doc/en/install/windows.rd

@@ -20,11 +20,14 @@ Here are required softwares.
 
 Install Ruby 2.0.0 from ((<download page of RubyInstall for
 Windows|URL:http://rubyinstaller.org/downloads/>)). For
-example, Ruby 2.0.0-p247 installer can be downloaded via the
+example, Ruby 2.0.0-p451 installer can be downloaded via the
 following URL.
 
-: rubyinstaller-2.0.0-p247.exe
-   ((<URL:http://dl.bintray.com/oneclick/rubyinstaller/rubyinstaller-2.0.0-p247.exe>))
+: rubyinstaller-2.0.0-p451.exe
+   ((<URL:http://dl.bintray.com/oneclick/rubyinstaller/rubyinstaller-2.0.0-p451.exe>))
+
+Note: You need to install 32bit version Ruby instead of 64bit, even if you use 64bit Windows.
+Currently Rabbit doesn't work with 64bit Ruby on Windows.
 
 ==== Install Rabbit
 

data/doc/en/news.rd

@@ -1,8 +1,74 @@
 ---
 layout: en
 title: News
-apply_data: false
 ---
+{% raw %}
+== 2.1.3: 2014-08-03
+
+A drawing performance improved release.
+
+=== Improvements
+
+==== rabbit
+
+  * Improved input encoding detection for UTF-8 case.
+    [GitHub#34] [Reported by Colin Dean]
+  * Markdown: Supported no text item list.
+    [GitHub#37] [Reported by Colin Dean]
+  * Improved drawing performance when vertical centering isn't used.
+    [GitHub#35] [Reported by Colin Dean]
+  * Avoided memory usage growing.
+    [GitHub#41] [Reported by Enrico Rivarola]
+
+==== Theme
+
+  * default-preformatted: Changed text size element to
+    (({PreformattedBlock})) from (({PreformattedText})).
+  * tag: Supported (({xx-small})) tag and (({xx-large})) tag.
+    [GitHub#39] [Patch by Enrico Rivarola]
+  * syntax-highlighting: Supported float literal.
+
+==== Document
+
+  * Updated Ruby Installer version. [Masafumi Yokoyama]
+  * Updated how to install with Homebrew.
+    [GitHub#30] [Patch by Bert Chang]
+  * Improved English and translated into English.
+    [GitHub#33] [Patch by Tomohiro Imaizumi]
+  * Added a description about Rabbit doesn't support 64bit Ruby on Windows.
+    [GitHub#43] [Patch by YUKI Hiroshi]
+
+=== Fixes
+
+==== rabbit
+
+  * Fixed a bug that rabbit command's exit code is always non-zero.
+  * Fixed a crash bug when rabbit command is ran on no window system
+    environment.
+    [shocker-ja:1189] [Reported by Kazuhiro NISHIYAMA]
+  * Information window: Fixed a bug that note text isn't changed when
+    window size is changed.
+    [shocker-en:71][shocker-en:74] [Reported by Enrico Rivarola]
+  * Information window: Fixed a bug that long word in note text is cut.
+    [shocker-en:78] [Reported by Enrico Rivarola]
+  * Information window: Fixed a bug that markup in note text isn't applied.
+    [GitHub#38] [Patch by Enrico Rivarola]
+  * Fixed a bug that temporary files aren't removed when they aren't needed.
+    [GitHub#40] [Patch by Enrico Rivarola]
+
+==== rabbit-slide
+
+  * Fixed a bug that tags are ignored on uploading SlideShare.
+
+=== Thanks
+
+  * Masafumi Yokoyama
+  * Kazuhiro NISHIYAMA
+  * Bert Chang
+  * Enrico Rivarola
+  * Colin Dean
+  * YUKI Hiroshi
+
 == 2.1.2: 2014-03-08
 
 A bug fix release of 2.1.1.
@@ -1786,3 +1852,4 @@ SASAKI]
 === Other news
 
   * Mac OS X package (DarwinPorts) is available by kimura wataru.
+{% endraw %}