rabbit-qt 0.1.0

data/doc/ja/sample/rd/rabbit.rd

@@ -0,0 +1,471 @@
+---
+layout: ja
+title: "サンプルスライド: Rabbit"
+---
+  # To run with it without system install.
+  #  % ruby -I./lib bin/rabbit -f sample/rabbit.rd
+
+  = Rabbit
+
+  : subtitle
+     RDでプレゼンテーション
+  : author
+     須藤功平
+  : institution
+     COZMIXNG
+  #: content_source
+  #   出典
+  : theme
+     rabbit
+
+  = Rabbit
+
+  プレゼンテーションツール
+
+    * 実装: Ruby/GTK+ 2/cairo
+    * 動作: PC-UNIX/Win/Mac
+    * 書式: RD/Wiki/PDF
+    * 見た目: Ruby(('note:（ソースと分離）'))
+
+  = 機能: 表示（1）
+
+    * ((*強調*))・(('del:削除'))
+    * 下付き(('sub:文字'))・上付き(('sup:文字'))
+    * 数式記号: (('∑'))(('sub:i=0'))(('∑sub:i=0'))
+    * ソースの色付け
+
+  = 機能: 表示（2）
+
+    * 表
+    * おもしろテーマ
+    * 画像
+      * 対応フォーマット多数
+      * PNG/JPEG/.../PDF/EPS/SVG
+
+  = 機能: 表示（3）
+
+    * 長い行の折り畳み
+    * ソースの色付け
+    * 大きな文字
+
+  = 機能: UI（1）
+
+    * 豊富なキーバインド
+    * 右クリックメニュー
+    * マウスジェスチャ
+    * スポットライト
+    * 虫眼鏡
+
+  = 機能: UI（2）
+
+    # wait
+    * 一覧ページ
+    * 落書き
+    * (('wait'))ポーズ
+    * (('wait'))国際化
+    * スライド内検索
+
+  = 機能: UI（3）
+
+    * ホワイト・ブラックアウト
+      * スライド白塗り・黒塗り
+    * ラビットホール
+      * スライドに穴
+    * 持ち時間の残りを視覚化
+      * うさぎとかめ
+
+  = 機能: 入力
+
+    * ファイル
+    * 標準入力
+    * HTTP
+    * Hiki
+    * SlideShare
+
+  = 機能: 入力書式
+
+    * RD
+    * Wiki（Hiki）
+    * PDF
+      * (('→'))PDFビューア
+
+  = 機能: 出力
+
+    * 画像
+    * 画像 + HTML
+    * PS/PDF
+    * 印刷用PS/PDF
+      * nスライド/ページ
+
+  = 機能: 外部API
+
+    * HTTP
+    * dRuby
+    * XML-RPC
+    * SOAP
+
+  = 機能: 作成支援
+
+    * ソースの自動再読み込み
+    * テーマの再読み込み
+    * テーマの切り替え
+
+  = 機能: タグ
+
+  (('tag:x-large:大きなテキスト'))
+
+  (('tag:center'))中央寄せされたテキスト
+
+  (('tag:right'))右寄せされたテキスト
+
+  = ToDo
+
+    * インラインでの画像表示
+    * リンク先へのジャンプ
+    * サウンド
+    * ビデオ
+    * 3D
+
+  = 画像
+
+    # image
+    # src = lavie.png
+    # caption = Lavie
+    # width = 100
+    # height = 100
+  #  # relative_width = 100
+  #  # relative_height = 50
+
+  = 画像: 鏡面反射
+
+    # image
+    # src = shocker.jpg
+    # relative_height = 80
+    # reflect_ratio = 0.5
+
+  = 画像: 背景（1）
+
+    * 背景画像
+    * デフォルトはセンタリング
+
+  == プロパティ
+
+  : background-image
+     lavie.png
+
+  : background-image-relative-width
+     50
+
+  # : background-image-align
+  #    right
+
+  # : background-image-relative-margin-right
+  #    3
+
+  = 画像: 背景（2）
+
+      # image
+      # src = lavie.png
+      # relative-width = 30
+      # align = right
+  #    # vertical-align = top
+      # relative-margin-right = -5
+
+    * 右寄せ背景画像
+    * スライド内で指定
+      * align = right
+
+  = 画像サイズ
+
+  スライドサイズに応じて変更可能
+
+    # image
+    # src = usagi.png
+    # caption = 兎
+  #  # relative_width = 100
+    # relative_height = 80
+
+  = 外部画像
+
+  URL先の画像をダウンロード
+
+    # image
+    # src = https://raw.githubusercontent.com/rabbit-shocker/rabbit/master/data/rabbit/image/cozmixng-images/cozmixchu.png
+    # caption = こずみっくちゅー
+
+  = 数式
+
+    * 書式: TeX(('note:（っぽい）'))
+    * バックエンド
+      * LaTeX
+      * mimeTeX
+
+  = LaTeX
+
+    # LaTeX
+    # relative_width = 80
+
+    $f(x)=\displaystyle\int_{-\infty}^x~e^{-t^2}dt$
+
+    \LaTeX
+
+  = mimeTeX
+
+    # mimeTeX
+    # relative_width = 80
+
+    \Large f(x)=\Bigint_{-\infty}^x~e^{-t^2}dt
+
+  = EPS
+
+  事前にEPSで作成((-gsが必要-))
+
+    # image
+    # src = equation.eps
+    # relative_width = 80
+
+  = SVG
+
+    # image
+    # src = spiral.svg
+    # relative_height = 100
+
+  = Dia
+
+    # image
+    # src = rabbit.dia
+    # relative_width = 90
+
+  = GIMP
+
+    # image
+    # src = rabbit.xcf
+    # relative_height = 100
+
+  = aafigure
+
+    # aafigure
+    # relative_width = 90
+  #  # foreground = #ff3333
+  #  # option = font=mikachan
+    あいうえお
+    A   B   C   D   E   F   G   H   I   J   K   L   M
+     AA  BB  CC  DD  EE  FF  GG  HH  II  JJ  KK  LL  MM
+     AA  BB  CC  DD  EE  FF  GG  HH  II  JJ  KK  LL  MM
+
+     aa  bb  cc  dd  ee  ff  gg  hh  ii  jj  kk  ll  mm
+     aa  bb  cc  dd  ee  ff  gg  hh  ii  jj  kk  ll  mm
+
+    N   O   P   Q   R   S   T   U   V   W   X   Y   Z
+     NN  OO  PP  QQ  RR  SS  TT  UU  VV  WW  XX  YY  ZZ
+     NN  OO  PP  QQ  RR  SS  TT  UU  VV  WW  XX  YY  ZZ
+
+     nn  oo  pp  qq  rr  ss  tt  uu  vv  ww  xx  yy  zz
+     nn  oo  pp  qq  rr  ss  tt  uu  vv  ww  xx  yy  zz
+
+  = 折り返し
+
+  なーーーーーーーーーーーーーーーーーーーーーーーーーーーーーがーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーーい行
+
+  = ソース
+
+  以下がソース
+
+    # comment
+    def method_name
+      body
+    end
+
+  以上がソース
+
+  = ソース: 色付き
+
+  以下がソース
+
+    # enscript ruby
+    # comment
+    def method_name
+      body
+    end
+
+  以上がソース
+
+  = 引用
+
+    # blockquote
+    # title = The Matrix
+    You take the ((*red pill*)), you stay in Wonderland and 
+    I show you how deep the ((*rabbit-hole*)) goes.
+
+  = 箇条書き
+
+    (1) レベル1-1
+
+        (1) レベル2-1
+
+            (1) レベル3-1
+
+            (1) レベル3-2
+
+        (1) レベル2-2
+
+    (1) レベル1-2
+
+
+  = ラベル付きリスト
+
+  : Rabbit
+     うさぎ
+
+     : Tortoise
+        かめ
+
+  : うさぎ
+     Rabbit
+
+  = 表
+
+    # RT
+    caption = 表のサンプル
+
+    みだし1, みだし2
+
+    内容1, 内容2
+    長ーーーーーい内容3, 長ーーーーーーーーーーーーーーーーーーい内容4
+
+  = Anthy
+
+  ひらがなをかんじにへんかんできます。
+
+  ((*変換後:*))
+
+    # anthy
+    ひらがなをかんじにへんかんできます。
+
+  = 操作: 移動
+
+  : 次ページ
+     次に進みそうなキー/左クリック
+
+     n, f, j, l, Spc, Ret, +, (('↓')), (('→')), ...
+
+  : 前ページ
+     前に進みそうなキー/中クリック
+
+     p, b, k, h, BS, Del, -, (('↑')), (('←')), ...
+
+  = 操作: 高度な移動
+
+  : タイトルページへ移動
+     a, 0, <, Home
+
+  : nページ目へ移動
+     1-9, +Ctrl = +10, +Alt = +20
+
+  : 最後のページへ移動
+     e, $, >, End
+
+  = 操作: 本番用（1）
+
+  : フルスクリーン切替え
+     F5, F10, F11, ジェスチャ(('&DownArrow;'))(('&UpArrow;'))
+
+  : 一覧モード切替え
+     i
+
+  : 一覧モードからページ移動
+     ダブルクリック
+
+  = 操作: 本番用（2）
+
+  : キャッシュ作成
+     c
+
+  : 情報ウィンドウ表示切替え
+     I
+
+  = 操作: 本番用（3）
+
+  : 虫眼鏡
+     Ctrl+右クリック
+
+     ホイールで拡大率変更
+
+  : スポットライト
+     ダブル右クリック
+
+     ホイールで半径変更
+
+  = 操作: 本番用（4）
+
+  : 落書き
+     ポップアップ（右クリック）→\n落書きモード
+
+  : マウスジェスチャー
+     右ドラッグ
+
+  = 操作: 本番用（5）
+
+  : ホワイトアウト
+     W
+
+  : ブラックアウト
+     B
+
+  = 操作: 保存
+
+  : スクリーンショット
+     各ページを画像として保存
+
+     s
+
+  : 印刷
+     各ページをPS/PDFとして保存
+
+     Ctrl+p
+
+  = 操作: 描画
+
+  : 再描画
+     Ctrl+l
+
+  : テーマ再読み込み
+     t, r
+
+  : スライドの調整値をリセット
+     Alt+a
+
+  = 操作: 穴
+
+  : 穴を広げる
+     E
+
+  : 穴を狭める
+     N
+
+  = 操作: 検索
+
+  : 次を検索
+     C-s, /
+
+  : 前を検索
+     C-r, ?
+
+  : 検索終了
+     C-g
+
+  = 操作: 終了
+
+  : 終了
+     q, Escape
+
+  : アイコン化
+     z
+
+  = まとめ
+
+    * プレゼンテーションツール
+    * マルチプラットフォーム
+    * 機能/UI: 高機能/ユニーク
+    * キーボード重視
+      * UI・テキストベースのソース

data/doc/ja/slides.rd

@@ -0,0 +1,29 @@
+---
+layout: ja
+title: スライド
+---
+== Rabbitで作ったスライド
+
+Rabbitで作ったスライドがたくさん公開されています。Rabbitで作っ
+たスライドを公開したら自由に追加してください。
+
+* ((<kou|URL:https://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>))さん
+* かずひこさん
+  [((<1|URL:http://kazuhiko.tdiary.net/20041023.html#p01>))]
+  [((<2|URL:http://kazuhiko.tdiary.net/20041203.html#p01>))]
+  [((<3|URL:http://kazuhiko.tdiary.net/20050312.html#p01>))]
+  [((<4|URL:http://kazuhiko.tdiary.net/20050326.html#p03>))]
+  [((<5|URL:http://kazuhiko.tdiary.net/20050603.html#p01>))]
+  [((<6|URL:http://kazuhiko.tdiary.net/20050603.html#p02>))]
+  [((<7|URL:http://kazuhiko.tdiary.net/20051029.html#p01>))]
+* かくたにさん
+  * ((<『ビルドツールを知ろう』|URL:http://kakutani.com/articles/esm-tokyo-study/buildtool/>))
+  * ((<『self.wake_up :from => "The Matrix"』|URL:http://kakutani.com/articles/xpmatsuri2005/>))
+* コウイチ(koic)さん
+  * ((<『刺激を受けた5冊』|URL://www.edit.ne.jp/~koic/rabbits/without-ejb_13th/>))
+* 小林
+  * 『Debian Weekly News翻訳フロー』 [((<付随情報つき|URL:http://dolphin.c.u-tokyo.ac.jp/~nori1/w/?cmd=view;name=TokyoDebianMeeting20051112DWN>))] [((<スライドのみ|URL:http://dolphin.c.u-tokyo.ac.jp/~nori1/w-images/TokyoDebianMeeting/20051112DWN/>))]
+* 向井
+  * 『RHG読書会 - モナドについていろいろ』[((<スライド|URL:http://www.city5.org/rhg_200605/>))][((<RDファイル|URL:http://www.city5.org/rhg2006_05.rd>))]

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

@@ -0,0 +1,220 @@
+---
+layout: ja
+title: rabbit-slideコマンドの使い方
+---
+== 概要
+
+rabbit-slideはスライドの雛形を生成するコマンドです。
+
+簡単なスライドを作成するにはソースファイルが1つあれば十分ですが、1から
+作り始めるよりも雛形があった方が作り始めやすいです。また、スライドを公
+開する場合はソースファイル以外にも必要なファイルがあります。それらのス
+ライド作成のとっかかりに便利なファイル一式を生成してくれます。
+
+スライドの雛形を生成したら、スライド自体を作成します。スライドの作成時
+およびスライド作成後の支援機能も含まれています。支援機能はRakeタスクと
+して提供されています。この支援機能を使うと、スライドの表示やPDFの生成、
+RubyGems.orgやSlideShareへの公開をコマンド一発で実行できます。
+
+Rabbitでよいスライドを作成し、よい発表をし、そして、共有しましょう！
+
+RubyGems.orgに公開したスライドは((<Rabbit Slide
+Show|URL:https://slide.rabbit-shocker.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"）
+                                       (デフォルト: nil)
+                                       （省略可能）
+          --email=EMAIL                新しいスライドの作者のEメールアドレス
+                                       （例: --email=kou@cozmixng.org）
+                                       (デフォルト: nil)
+                                       （省略可能）
+          --rubygems-user=USER         RubyGems.orgのアカウント
+                                       RubyGems.orgにスライドを公開するときに使います
+                                       （例: --rubygems-user=kou）
+                                       (デフォルト: nil)
+                                       （省略可能）
+          --slideshare-user=USER       SlideShareのアカウント
+                                       SlideShareにスライドを公開するときに使います
+                                       （例: --slideshare-user=kou）
+                                       (デフォルト: nil)
+                                       （省略可能）
+          --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のテーマを確認するためのスライドです。スライドで使われる要素がた
+  くさん入っているためテーマの確認に便利です。
+
+準備ができたら((%rake publish%))でRubyGems.orgとSlideShareにまとめて
+公開できます。別々に公開する方法は以下の通りです。
+
+=== RubyGems.orgへ公開
+
+((%rake publish:rubygems%))でRubyGems.orgに公開できます。
+
+  % rake publish:rubygems
+
+RubyGems.orgに公開したスライドは
+((%rabbit #{RubyGems.orgのユーザー名}-#{スライドID}.gem%))
+で表示できます。theme-benchmark-jaの場合は
+RubyGems.orgのユーザー名が((%rabbit%))でスライドIDが
+((%theme-benchmark-ja%))なので以下のコマンドで表示できます。
+
+  % rabbit rabbit-theme-benchmark-ja.gem
+
+RubyGems.orgに公開したスライドは((<Rabbit Slide
+Show|URL:https://slide.rabbit-shocker.org/>))で閲覧できます。URLは
+((%https://slide.rabbit-shocker.org/authors/#{RubyGems.orgのユーザー
+名}/#{スライドID}/%))です。
+
+Rabbit Slide ShowはRubyGems.orgに公開されているスライドを自動で収集して
+表示しているので、明示的にRabbit Slide Showにスライドを公開する操作を
+する必要はありません。RubyGems.orgに公開するだけでOKです。
+
+=== SlideShareへ公開
+
+((%rake publish:slideshare%))でSlideShareに公開できます。
+
+  % rake publish:slideshare
+
+無事に公開できたら自動でスライドページを開きます。