rabbit-qt 0.1.0

data/doc/en/index.rd

@@ -0,0 +1,268 @@
+---
+layout: en
+title: README
+---
+== About Rabbit
+
+Rabbit is a presentation tool for programmer, especially Rubyist.
+
+Slide is written in text format, so you can use your favorite editor or versioning tool to make it.
+
+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 customize its look with Ruby code, so you can hack even when making slides! 
+
+=== Format
+
+Rabbit supports RD, Wiki markup and Markdown for its 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>)); one of
+the dialects of Wiki notations.
+
+=== Interface
+
+Rabbit has useful slide operation interface as follows.
+
+  * 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 during
+    presentation but it's fun for creating.
+  * Hare and tortoise: Visualize remaining time with animation of their race.
+
+== Install
+
+See ((<"install/"/Install>)) page.
+
+== Usage
+
+See ((<usage.rd/Usage>)) page.
+
+== How to make slides
+
+See ((<"how-to-make/"/How to make a slide>)) page.
+
+== Author
+
+=== Program
+
+Kouhei Sutou <kou@cozmixng.org>
+
+=== Images (1)
+
+* Lavie (mascot) ((-Lavie's sense of language is from Rabbit
+  and spell is from `la vie' in French.-)) and Rabbit logos.
+
+  (cute rabbit)
+
+* Tailavi and Taiyaki
+
+  gluttonous rabbit loves Taiyaki.
+
+* Banner
+
+  (cute banner)
+
+MoMo
+
+=== Images (2)
+
+* USAGI (in Kanji)
+
+  the cool rabbit.
+
+* KAME
+
+  the cute turtle.
+
+sode
+
+=== Images (3)
+
+Flags.
+
+gan
+
+=== Images (4)
+
+* Rabbit pink logo
+
+* Ruby pink logo
+
+* USA-TARO
+
+* KAME-TARO
+
+* TANU-KITARO (TANU-san)
+
+* YUKIDARU-TARO (YUKIDARU-san)
+
+usatti
+
+=== Images (5)
+
+* YUKI-USA
+
+  pretty rabbit girl in Japanese dress.
+
+* Alice
+
+  pretty girl in blue dress.
+
+asahina
+
+((<URL:http://littleblue.chu.jp/>))
+
+=== Mode for xyzzy
+
+misc/xyzzy/
+
+Mr. MIYAMUKO
+
+=== Mode for Emacs
+
+misc/emacs/
+
+Atsushi Takeda
+
+=== RabbIRC
+
+bin/rabbirc
+
+akira yamada
+
+== Co-Authors
+
+  * Mr. MIYAMUKO
+  * Mr. noritada
+  * Atsushi Takeda
+
+== Copyright
+
+The code author retains copyright of the source code. In
+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 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 authors of them agree with the rule when they contribute their
+patches, codes and so on.
+
+The author of
+data/rabbit/image/rubykaigi2011-images/rubykaigi2011-background-white.jpg
+and
+data/rabbit/image/rubykaigi2011-images/rubykaigi2011-background-black.jpg
+is norio. And it's licensed under the
+((<CC-BY-3.0|URL:http://creativecommons.org/licenses/by/3.0/>)).
+
+If you want to get a copy of the mascot character PSD files
+ask the program author. He'll forward the request to the
+author of the image.
+
+== Mailing list
+
+See ((<users.rd/Users>)) page.
+
+== Join development
+
+See ((<development.rd/Development>)) page.
+
+== FAQ
+
+See ((<faq.rd/FAQ>)) page.
+
+== Thanks
+
+Here is a contributor list. Thanks to them!!!
+
+  * MoMo: Drew some pretty images.
+  * MIYAMUKO: Wrote rabbit mode for xyzzy, and helps
+    make Rabbit work on Windows.
+  * zunda:
+    * Fixed EPS handling.
+    * Gave me advise for --margin.
+    * Makes presentations with Rabbit.
+    * Updated INSTALL.win32.ja.
+    * Updated INSTALL.macosx-macports.{ja,en}.
+  * Vincent: Helped make Rabbit work on Max OS X. He also
+    made french messages.
+  * sode: Made the cool rabbit, cute rabbit and cute
+    turtle.
+  * Kazuhiko: Sent me many bug reports. He also makes
+    presentations with Rabbit and gives me ideas for theme
+    design.
+  * noritada: Sent me a bug report for document.
+  * gan: Wrote some flags.
+  * KAKUTANI:
+    * Sent me a bug report for document.
+    * Makes presentations with Rabbit.
+    * Gave me ideas for new features and theme design.
+    * Gave me a patch to fix a bug related HTML
+      generation.
+    * Made a Mac OS X (Intel) package.
+  * atzm: Made Gentoo package (*.ebuild).
+  * akira yamada:
+    * Made Debian package (*.deb).
+    * Reports some bugs and also fixes them.
+    * Made rabbirc.
+  * usatti: Drew some logos and taro series images.
+  * dot: Helps with installation on Windows.
+  * tanaka: Checked operations on Windows.
+  * asahina: Drew the pretty rabbit girl and Alice.
+  * nskj77: Gave a name to FAQ page. He sends action
+    reporting and some bug reports.
+  * Atsushi Takeda: Wrote rabbit mode for Emacs.
+  * kimura wataru: Made a Mac OS X package.
+  * kitaj:
+    * Makes presentations with Rabbit.
+    * Improved INSTALL.win32.en.
+    * Improved a theme.
+  * akapy: Wrote a document for emerge.
+  * OBATA Akio:
+    * Made a pkgsrc package.
+    * Makes presentations with Rabbit.
+    * Reports some bugs and also fixes them.
+    * Helps debug many problems.
+    * Made Rabbitter.
+  * Masao Mutoh:
+    * Makes presentations with Rabbit.
+    * Updated INSTALL.win32.ja.
+  * TADA Tadashi:
+    * Makes presentations with Rabbit.
+    * Contributed his themes.
+    * Propposed the idea to have Rabbit provide a slide for
+      benchmarking your theme.
+  * Shugo Maeda:
+    * Makes presentations with Rabbit.
+    * Reported a bug.
+  * JunichiNakai: Reports bugs.
+  * Eduardo Gonzalez: Improves documents in English.
+  * Kazuhiro NISHIYAMA: Reported a bug.
+  * Masaki Suketa: Reported bugs related Ruby 1.9.
+  * kdmsnr: Reported a bug.
+  * Youhei SASAKI: The official Debian package maintainer.
+  * Matz:
+    * Makes presentations with Rabbit.
+    * Suggested about information window.
+  * tmtms:
+    * Reported a bug related Ruby 1.9.
+  * Kiwamu Okabe:
+    * Contributed twitter-footer theme.
+    * Contributed Rabbit control command by Wii Remote.
+  * Nobuyoshi Nakada:
+    * Suggested about console availability check way on Windows.
+  * Ken Muryoi:
+    * Fixed a bug in document.
+  * TAKATSU Tomonari:
+    * The official FreeBSD Ports maintainer.
+    * Fixed many bugs.

data/doc/en/install/homebrew.rd

@@ -0,0 +1,22 @@
+---
+layout: en
+title: Install with Homebrew
+---
+== How to install Rabbit with Homebrew on macOS
+
+This document describes how to install Rabbit with Homebrew and RubyGems on macOS.
+
+=== Requirements
+
+* A macOS machine
+* Xcode with X11 (XQuartz is required)
+
+=== Install Homebrew
+
+Follow the instruction on ((<URL:https://brew.sh>)).
+
+=== Install Rabbit
+
+Exec gem install.
+
+  $ gem install rabbit

data/doc/en/install/index.rd

@@ -0,0 +1,50 @@
+---
+layout: en
+title: Install
+---
+== About how to install
+
+Many package system supports Rabbit. So it's easy to
+install Rabbit. You can use RubyGems or package system on
+your platform.
+
+== Hot to install by RubyGems
+
+  % gem install rabbit
+  % gem install rabbiter # If you want to use Twitter related features
+
+== How to install on Debian GNU/Linux
+
+  % sudo aptitude install -y rabbit
+
+== How to install on Ubuntu
+
+  % sudo aptitude install -y rabbit
+
+== How to install on Gentoo Linux
+
+  % sudo env ACCEPT_KEYWORDS=~x86 FEATURES="digest" emerge rabbit
+
+== How to install on NetBSD (or pkgsrc ready platform)
+
+  % sudo pkg_add ruby18-rabbit
+
+or
+
+  % sudo pkg_add ruby19-rabbit
+
+== How to install on FreeBSD
+
+  % sudo portupgrade -NRr rabbit
+
+== How to install with MacPorts on Mac OS X
+
+See ((<macports.rd/Install with MacPorts>)).
+
+== How to install with Homebrew on Mac OS X
+
+See ((<homebrew.rd/Install with Homebrew>)).
+
+== How to install on Windows.
+
+See ((<windows.rd/Install on Windows>)).

data/doc/en/install/macports.rd

@@ -0,0 +1,77 @@
+---
+layout: en
+title: Install with MacPorts
+---
+== How to install Rabbit with MacPorts on Mac OS X
+
+This document describes how to install Rabbit with MacPorts and how to use
+Rabbit on Mac OS X.
+
+=== Requirements
+
+The following programs are needed.
+
+* Xcode Tools (from Xcode Tools DVD or ADC)
+* X11 (from Mac OS X System DVD)
+
+Remember to select "X11 SDK" when installing the Xcode Tools.
+
+=== Install MacPorts
+
+see ((<URL:http://www.macports.org/>)).
+
+=== installing Rabbit
+
+You might want to do the following to update information for
+required ports.
+
+  ~% sudo port sync
+
+The following command will install rabbit and its dependencies.
+
+  ~% sudo port install rb-rabbit
+
+You can install these ports to make rabbit even better.
+
+* Ruby-GetText-Package (rb-gettext) - enable I18N message catalogs
+* net/irc (rb-net-irc) - rabbirc requires net/irc
+
+  ~% sudo port install rb-gettext
+  ~% sudo port install rb-net-irc
+
+==== Rabbit without X11
+
+If you want to run rabbit without X11, install pango, cairo and gtk2 without
+X11 before install rb-rabbit.
+
+  ~% sudo port install pango +no_x11 +quartz
+  ~% sudo port install cairo +no_x11 +quartz
+  ~% sudo port install gtk2 +no_x11 +quartz
+
+=== tips for X11 environment
+
+==== launch X11.app
+
+Rabbit requires X11.app, which is under /Applications/Utilities/.
+
+==== DISPLAY environment variable
+
+Mac OS X 10.4 or earlier, DISPLAY environment was not declared.
+Remember to set this variable.
+
+=== upgrade Rabbit
+
+the following operation upgrades your Rabbit.
+
+  ~% sudo port sync
+  ~% sudo port upgrade rb-rabbit
+
+If you want to upgrade Rabbit only (rb-rabbit), you can upgrade with the "-n"
+option.
+
+  ~% sudo port -n upgrade rb-rabbit
+
+=== Contact
+
+* ((<"../users.rd"/Users group>))
+* Kimura Wataru (kimuraw at i nifty.jp) - maintainer of Rabbit MacPorts

data/doc/en/install/windows.rd

@@ -0,0 +1,45 @@
+---
+layout: en
+title: Install on Windows
+---
+== How to install on Windows
+
+This document describes how to install and use Rabbit on
+Windows.
+
+=== How to install
+
+Install the following software:
+
+  * Ruby
+  * Rabbit
+
+==== How to install Ruby
+
+Download and execute Ruby installer from ((<download page of
+RubyInstall for
+Windows|URL:http://rubyinstaller.org/downloads/>)). You can use both
+32bit version and 64bit version.
+
+==== How to install Rabbit
+
+RubyInstaller install "Start Command Prompt with Ruby" program into
+start menu. This program shows command prompt with PATH configuration
+for (({ruby.exe})). You can install Rabbit by the following command on
+the command prompt:
+
+  > gem install rabbit
+
+Related softwares (e.g. Ruby/GTK2 and so on) are also
+install automatically.
+
+=== How to run Rabbit
+
+Run the following command on command prompt that is used for
+installing Rabbit:
+
+  > rabbit
+
+It opens a dialog to open a slide file.
+
+See also ((<How to make a slide source|URL:../how-to-make/>)).