File: faq.rd

package info (click to toggle)
rabbit 3.0.5-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 14,220 kB
  • sloc: ruby: 29,637; lisp: 309; makefile: 43; sh: 7
file content (152 lines) | stat: -rw-r--r-- 4,625 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
---
layout: en
title: FAQ
---
== FAQ

This page lists frequently asked questions. Here is the format used on this page.

== Question...

Answer...

== How can I embed tweets on a Rabbit slide?

Use the "rabbiter" command. For exapmle, you use the rabbiter command as follows:
 (after starting Rabbit, you will see tweets including the word "ruby" at the bottom of the slides in the form of comments)

  % rabbiter --filter ruby

== How can I flow tweets on slides like an 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 create a PDF with multiple 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.

Note that not all themes support the hare and tortoise feature. For example, the "default" theme supports it but the "lightning-talk" theme doesn't support it.

== 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: Formerly we used &NewLine; but now can use \n
, which means following sentence is oblsolete. 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.