rabbit 0.9.2 → 0.9.3

data/doc/en/how-to-make/hiki.hiki

@@ -0,0 +1,9 @@
+---
+layout: en
+title: How to make Hiki notation slide source
+---
+! About Rabbit Hiki notation
+
+TODO
+
+See [[sample slide|../sample/]] about sample slide.

data/doc/en/how-to-make/index.rd

@@ -0,0 +1,25 @@
+---
+layout: en
+title: How to make a slide
+---
+== How to make a slide source
+
+Rabbit slide is made by text format or PDF format. To
+make text format slide, RD or Hiki notation is used. To
+make PDF format slide, make slide by other presentation
+tool and export slide as PDF format.
+
+See the following pages for details:
+
+  * ((<rd.html/How to make a RD format slide>))
+  * ((<hiki.html/How to make a Hiki notation slide>))
+  * ((<pdf.html/How to make a PDF format slide>))
+
+== How to make a theme
+
+Slide look and feel can be customizable by theme even if
+slide source is RD format or Hiki notation. ((-PDF format
+slide can also be customizable but layout by PDF can't be
+changed.-)) See the following page for details:
+
+  * ((<theme.html/How to make a theme>))

data/doc/en/how-to-make/pdf.rd

@@ -0,0 +1,7 @@
+---
+layout: en
+title: How to make a PDF format slide
+---
+== About PDF format and Rabbit
+
+Rabbit can be a PDF viewer... TODO

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

@@ -0,0 +1,66 @@
+---
+layout: en
+title: How to make a RD format slide source
+---
+== About RD format for Rabbit slide
+
+Rabbit uses RD format but it uses different usage with
+normal document. See ((<"../rd.html"/RD>)) about basic RD
+syntax, ((<"../sample/"/sample slide>)) about sample slide.
+
+== Page
+
+The largest headline (=) is title of page. The page follows
+next title.
+
+  = Title
+
+  SOMETHING
+
+  ...
+
+  = Next Page
+
+  ...
+
+This example has two pages.
+
+== Title page
+
+The first page is the title page. You can specify meta
+information of the slide by using a labeled list (:) in the
+title page.
+
+  = Title of slide
+
+  : author
+     Kouhei Sutou
+  : institution
+     COZMIXNG
+
+This example shows the author is Kouhei Sutou and his
+institution is COZMIXNG.
+
+At the moment, you can specify subtitle, content_source and
+even the theme. `theme" is the default theme of this slide.
+
+== Image
+
+Written as a verbatim block. See sample/rabbit-en.rd.
+
+== Entity reference
+
+Written as an inline verbatim. See sample/rabbit-en.rd.
+
+== Sub/Superscript
+
+Written as an inline verbatim. See sample/rabbit-en.rd.
+
+== Headline
+
+You can only use headlines for the biggest headline. (The
+only headline you really need is the title, right?)
+
+== Footnote
+
+You can footnotes but you shouldn't use it in a presentation.

data/doc/en/how-to-make/theme.rd

@@ -0,0 +1,135 @@
+---
+layout: en
+title: How to make a theme
+---
+== About theme
+
+Slide look and feel is independent of slide source
+format. It's theme.
+
+There is a slide for testing theme at
+sample/theme-bench-en.rab. It's useful to confirm theme.
+
+== Where do I place the theme?
+
+Rabbit searches for themes by using ruby's $LOAD_PATH. If you make
+a theme, place it into
+((|PATH_OF_INCLUDED_IN_$LOAD_PATH/rabbit/theme/THEME_NAME/THEME_NAME.rb|))
+or ((|DIRECTORY_OF_SOURCE_FILE/THEME_NAME.rb|)).
+
+== How do I write a theme?
+
+A theme is just a Ruby script.
+
+You may enumerate the following descriptions in your theme.
+
+  (1) Select some elements (paragraphs, titles and so on) of
+      the slide as a target.
+
+  (2) Change properties of selected elements and add actions.
+
+For example, the following changes color of the title of each
+page except the title page.
+
+  match(Page, HeadLine) do |heads|
+    heads.prop_set("foreground", "red")
+  end
+
+== Property
+
+You can set some properties by using
+(({prop_set})). ((<Pango Text Attribute
+Markup|URL:http://developer.gnome.org/doc/API/2.4/pango/PangoMarkupFormat.html>))
+has more information.
+
+: font_desc
+   Specifies font description.
+
+: font_family
+   Specifies font family.
+   
+   You can get a list of font families by using (({font_families})).
+
+: face
+   Same as font_family.
+
+: size
+   Specifies size of font.
+   
+   If you specify size of font by numeric value, you should
+   convert the value by (({screen_size})) and multiply it by
+   (({Pango::SCALE})). The following example shows how to
+   specify size of font to 2 (in the Rabbit's theme world).
+
+     screen_size(2) * Pango::SCALE
+
+: style
+   Specifies style of font.
+
+: weight
+   Specifies weight of font.
+
+: variant
+   Specifies variant of font.
+
+: stretch
+   Specifies stretch of font.
+
+: foreground
+   Specifies foreground.
+
+: background
+   Specifies background.
+
+: underline
+   Specifies kind of underline.
+
+: rise
+   Specifies vertical position of character.
+
+: strike through
+   Specifies whether use strike line or not.
+
+: fallback
+   Specifies whether use alternative font or not when
+   specified font is not found.
+
+: lang
+   Specifies the language.
+
+: b
+   Changed to bold.
+
+: big
+   Changed size of font to big.
+
+: i
+   Changed to italic.
+
+: s
+   Draws a strike line.
+
+: sub
+   Changed to subscript.
+
+: sup
+   Changed to superscript.
+
+: small
+   Changed size of font to small.
+
+: tt
+   Changed font family to fixed width font.
+
+: u
+   Draws a underline.
+
+== Hooks
+
+You can add procedures which are executed before/after
+element is drawn by
+(({add_pre_draw_proc}))/(({add_post_draw_proc})).  And you
+can remove them by
+(({clear_pre_draw_procs}))/(({clear_post_draw_procs})).
+
+The `default' theme has more code. Please see it.

data/doc/en/index.rd

@@ -0,0 +1,276 @@
+---
+layout: ja
+title: README
+---
+== What is Rabbit?
+
+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.
+
+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.
+
+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.
+
+=== Format
+
+Rabbit supports RD and Wiki notation for text format.
+
+((<rd.html/RD>)) is an abbreviation of Ruby Document. It's
+easy to read text format.
+
+Rabbit supports a ((<hiki.html/Hiki notation>)) that is a
+dialect of Wiki notations.
+
+=== Interface
+
+Rabbit has useful slide operation interface.
+
+  * Keybord interface: If you type 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.
+
+== Install
+
+See ((<"install/"/Install>)) page.
+
+== Usage
+
+See ((<usage.html/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
+
+=== Rabbitter
+
+bin/rabbitter
+
+OBATA Akio
+
+== 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 copyright 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 their
+license. Authores of them are cosidered agreeing with those
+rules when they contribute their patches, codes and so on.
+
+lib/rabbit/div/prototype.js released under an MIT-style
+licence. For more information see ((<Prototype JavaScript
+Framework|URL:http://prototype.conio.net/>)).
+
+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.html/Users>)) page.
+
+== Join development
+
+See ((<development.html/Development>)) page.
+
+== FAQ
+
+See ((<faq.html/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.