Skip to content
Newer
Older
100644 246 lines (178 sloc) 9.97 KB
3dc1064 @takaxp Add README
authored
1 #+TITLE: README for Org Tree Slide
2 #+AUTHOR: Takaaki Ishikawa
3 #+EMAIL: takaxp@ieee.org
4 #+STARTUP: content
78a5c46 @takaxp Add autoload magic comments
authored
5 #+Last Update: 2012-01-11@23:02
3dc1064 @takaxp Add README
authored
6
b8feee3 @takaxp Update README
authored
7 * 1. What's this?
3dc1064 @takaxp Add README
authored
8
b8feee3 @takaxp Update README
authored
9 The main purpose of this elisp is to handle each tree in an org buffer as a slide by simple narrowing. This emacs lisp is a minor mode for Emacs Org-mode.
3dc1064 @takaxp Add README
authored
10
e22f05c @takaxp Update README
authored
11 Main features:
12
13 - Live editable presentation
14 - Fast switching of narrowing/widen
15 - TODO pursuit with narrowing
16 - Displaying the current number of slides
17 - Countdown timer
18 - CONTENT view during a presentation
97e26e3 @takaxp Update README
authored
19 - Slide-in effect
e22f05c @takaxp Update README
authored
20 - Slide header from org file's header
21
22 ** 1-1. Related packages
be2d679 @takaxp Add a link
authored
23
24 see [[http://orgmode.org/worg/org-tutorials/non-beamer-presentations.html]].
25
e22f05c @takaxp Update README
authored
26 * 2. Install
3dc1064 @takaxp Add README
authored
27
28 1. Put this elisp into your load-path
e22f05c @takaxp Update README
authored
29 2. Add =(require 'org-tree-slide)= in your =.emacs=
3dc1064 @takaxp Add README
authored
30
31 OR
32
97e26e3 @takaxp Update README
authored
33 1. Eval: =(auto-install-from-url "https://raw.github.com/takaxp/org-tree-slide/master/org-tree-slide.el")= (for auto-install users)
b656a83 @takaxp Update README
authored
34 2. Add =(require 'org-tree-slide)= in your =.emacs=
3dc1064 @takaxp Add README
authored
35
b8feee3 @takaxp Update README
authored
36 Then open an org file, just type =<right>= and =<left>=. A presentation will begin with a header, slide-in effect, and slide number.
e22f05c @takaxp Update README
authored
37
78a5c46 @takaxp Add autoload magic comments
authored
38 ** el-get recipe
39
40 If you are an [[https://github.com/dimitri/el-get][el-get]] user, please use this recipe.
41
42 #+BEGIN_SRC emacs-lisp
43 (:name org-tree-slide
44 :description "A presentation tool for org-mode"
45 :type git
46 :url "git://github.com/takaxp/org-tree-slide.git"
47 :required nil)
48 #+END_SRC
49
e22f05c @takaxp Update README
authored
50 ** 2.1 Requirements
3dc1064 @takaxp Add README
authored
51 - Org-mode 6.33x or higher version is required.
52 - This elisp doesn't require any additional packages.
e22f05c @takaxp Update README
authored
53 * 3. Recommended settings
3dc1064 @takaxp Add README
authored
54
e22f05c @takaxp Update README
authored
55 Assigning a single key to =org-tree-slide-mode= is recommended.
3dc1064 @takaxp Add README
authored
56
40fe86f @takaxp Update README
authored
57 #+BEGIN_SRC emacs-lisp
3dc1064 @takaxp Add README
authored
58 (global-set-key (kbd "<f8>") 'org-tree-slide-mode)
59 (global-set-key (kbd "S-<f8>") 'org-tree-slide-skip-done-toggle)
36fefc1 @takaxp Update README
authored
60 #+END_SRC
3dc1064 @takaxp Add README
authored
61
62 OR
63
af59475 @takaxp Update README
authored
64 #+BEGIN_SRC emacs-lisp
3dc1064 @takaxp Add README
authored
65 (define-key org-mode-map (kbd "<f8>") 'org-tree-slide-mode)
66 (define-key org-mode-map (kbd "S-<f8>") 'org-tree-slide-skip-done-toggle)
af59475 @takaxp Update README
authored
67 #+END_SRC
3dc1064 @takaxp Add README
authored
68
e22f05c @takaxp Update README
authored
69 * 4. Profiles
70
b8feee3 @takaxp Update README
authored
71 Three useful profiles are available. Please select a profile that is the most suitable for your using scenario.
3dc1064 @takaxp Add README
authored
72
e22f05c @takaxp Update README
authored
73 If you select =simple= profile, call the following command while =org-tree-slide-mode= is ON.
3dc1064 @takaxp Add README
authored
74
af59475 @takaxp Update README
authored
75 #+BEGIN_SRC emacs-lisp
3dc1064 @takaxp Add README
authored
76 M-x org-tree-slide-simple-profile
af59475 @takaxp Update README
authored
77 #+END_SRC
3dc1064 @takaxp Add README
authored
78
e22f05c @takaxp Update README
authored
79 If you want to use this setting as the default, put the following configuration including recommended settings into your =.emacs=.
3dc1064 @takaxp Add README
authored
80
af59475 @takaxp Update README
authored
81 #+BEGIN_SRC emacs-lisp
3dc1064 @takaxp Add README
authored
82 (when (require 'org-tree-slide nil t)
83 (global-set-key (kbd "<f8>") 'org-tree-slide-mode)
84 (global-set-key (kbd "S-<f8>") 'org-tree-slide-skip-done-toggle)
85 (org-tree-slide-simple-profile))
af59475 @takaxp Update README
authored
86 #+END_SRC
3dc1064 @takaxp Add README
authored
87
b656a83 @takaxp Update README
authored
88 =org-tree-slide-presentation-profile= and =org-tree-slide-narrowing-control-profile= are also available.
3dc1064 @takaxp Add README
authored
89
e22f05c @takaxp Update README
authored
90 ** 4-1. `Simple'
91
92 This profile will display trees of your org buffer by simple narrowing. You can change trees without =widen= command. Most of the visual effect is disabled.
3dc1064 @takaxp Add README
authored
93
e22f05c @takaxp Update README
authored
94 Type =M-x org-tree-slide-simple-profile= while =org-tree-slide-mode= is ON.
3dc1064 @takaxp Add README
authored
95
96 1. No header display
97 2. No slide-in effect
e22f05c @takaxp Update README
authored
98 3. The cursor will move to the head of the buffer when exit
3dc1064 @takaxp Add README
authored
99 4. No slide number display in mode line
100 5. Display every type of tree
101
e22f05c @takaxp Update README
authored
102 ** 4-2. `Presentation'
103
b8feee3 @takaxp Update README
authored
104 This profile is used as the default setting of org-tree-slide. If an org buffer includes =#+TITLE:=, =#+EMAIL:=, and =#+AUTHOR:=, org-tree-slide attempts to use those variables in the slide header. A date in the header will be set with the presentation of the day. You can enjoy a slide-in effect, the current slide number in mode line. A presentation with a count down timer is started by =M-x org-tree-slide-play-with-timer=.
105
78a5c46 @takaxp Add autoload magic comments
authored
106 If you want to show the content of your presentation, type =C-x s c= or =M-x org-tree-slide-content=. All of the headings will be shown like a Table Of Content. Find a heading that you want to show, and type =<right>=, the presentation will be resumed.
e22f05c @takaxp Update README
authored
107
b8feee3 @takaxp Update README
authored
108 It is possible to skip slides when a heading level is higher than or equal to a value of =org-tree-slide-skip-outline-level=. see User variables.
e22f05c @takaxp Update README
authored
109
b8feee3 @takaxp Update README
authored
110 To exit a presentation, set =org-tree-slide-mode= OFF. The cursor move to the head of the buffer and the trees will be displayed using =#+STARTUP:= if possible.
3dc1064 @takaxp Add README
authored
111
b656a83 @takaxp Update README
authored
112 =M-x org-tree-slide-presentation-profile=
3dc1064 @takaxp Add README
authored
113
114 1. Display header
115 2. Enable slide-in effect
116 3. The cursor will move to the head of buffer when exit
117 4. Display slide number in mode line
118 5. Display every type of tree
119
e22f05c @takaxp Update README
authored
120 ** 4-3. `TODO Pursuit with narrowing'
121
b8feee3 @takaxp Update README
authored
122 This profile will display trees restricted to =TODO status= without a header and slide-in effect. It is very useful to concentrate your focus on the current TODO item that is not done, and go to the next task by a single typing of =<right>=. This is "TODO Pursuit with narrowing". If you want to track every kind of tree including finished items, toggle =M-x org-tree-slide-skip-done-toggle= OFF.
e22f05c @takaxp Update README
authored
123
1687d83 @takaxp Fix typo README.org
authored
124 When you exit =org-tree-slide-mode=, the cursor will keep the same position, it is therefore possible to focus again by toggle =M-x org-tree-slide-mode=.
3dc1064 @takaxp Add README
authored
125
1ab152f @takaxp Fix typo README.org
authored
126 If you feel the cursor moving is very slow, please change a value of =org-tree-slide-modeline-display= to 'outside or =nil=.
73182af @takaxp Update README
authored
127
b656a83 @takaxp Update README
authored
128 =M-x org-tree-slide-narrowing-control-profile=
3dc1064 @takaxp Add README
authored
129
130 1. No header display
131 2. No slide-in effect
132 3. The cursor will keep the same position when exit
133 4. Display slide number in mode line
134 5. Display TODO trees only
135
e22f05c @takaxp Update README
authored
136 * 5. User variables
3dc1064 @takaxp Add README
authored
137
0a399b2 @takaxp Update README
authored
138 |---+-------------------------------------+---------------+---------|
420342f @takaxp Update README
authored
139 | | Variable | Default value | Select |
140 |---+-------------------------------------+---------------+---------|
b8feee3 @takaxp Update README
authored
141 | 1 | org-tree-slide-skip-outline-level | 0 | Numeric |
142 | 2 | org-tree-slide-header | t | Boolean |
143 | 3 | org-tree-slide-slide-in-effect | t | Boolean |
144 | 4 | org-tree-slide-slide-in-brank-lines | 10 | Numeric |
145 | 5 | org-tree-slide-slide-in-waiting | 0.02 | Float |
146 | 6 | org-tree-slide-cursor-init | t | Boolean |
147 | 7 | org-tree-slide-heading-emphasis | nil | Boolean |
148 | 8 | org-tree-slide-skip-done | nil | Boolean |
e22f05c @takaxp Update README
authored
149 | 9 | org-tree-slide-modeline-display | 'outside | [*1] |
faf9421 @takaxp Update README
authored
150
420342f @takaxp Update README
authored
151
0a399b2 @takaxp Update README
authored
152 #+BEGIN_SRC
085a4e2 @takaxp Update README
authored
153 [*1] { nil| 'lighter | 'outside }
154 'outside: shown in the mode line outside of lighter
155 'lighter: shown in lighter (slow)
156 nil: nothing to be shown"
0a399b2 @takaxp Update README
authored
157 #+END_SRC
3dc1064 @takaxp Add README
authored
158
b8feee3 @takaxp Update README
authored
159 ** 5-1. Useful settings for experts
160
161 If you like this elisp, the following setting is more useful. Try it!
162
163 =<f8>= / =<f9>= / =<f10>= / =<f11>= are assigned to control org-tree-slide.
164
af59475 @takaxp Update README
authored
165 #+BEGIN_SRC emacs-lisp
b8feee3 @takaxp Update README
authored
166 (when (require 'org-tree-slide nil t)
167 (global-set-key (kbd "<f8>") 'org-tree-slide-mode)
168 (global-set-key (kbd "S-<f8>") 'org-tree-slide-skip-done-toggle)
169 (define-key org-tree-slide-mode-map (kbd "<f9>")
170 'org-tree-slide-move-previous-tree)
171 (define-key org-tree-slide-mode-map (kbd "<f10>")
172 'org-tree-slide-move-next-tree)
173 (define-key org-tree-slide-mode-map (kbd "<f11>")
174 'org-tree-slide-content)
175 ;; Reset the default setting
176 (define-key org-tree-slide-mode-map (kbd "<left>") 'backward-char)
177 (define-key org-tree-slide-mode-map (kbd "<right>") 'forward-char)
178 (setq org-tree-slide-skip-outline-level 4)
179 (org-tree-slide-narrowing-control-profile)
180 (setq org-tree-slide-skip-done nil)))
af59475 @takaxp Update README
authored
181 #+END_SRC
b8feee3 @takaxp Update README
authored
182
183 * 6. Functions
184
185 ** Control functions
186
187 - org-tree-slide-move-next-tree (=<right>=)
188 - org-tree-slide-move-previous-tree (=<left>=)
d273905 @takaxp Update README
authored
189 - org-tree-slide-content (=C-x s c=)
b8feee3 @takaxp Update README
authored
190
191 ** Startup options
192
cfe834c @takaxp Fix typo of README.org
authored
193 These functions will toggle =org-tree-slide-mode= ON, automatically.
b8feee3 @takaxp Update README
authored
194
195 - org-tree-slide-without-init-play
196 - org-tree-slide-play-with-timer
197
198 ** Toggle variables
199
200 - org-tree-slide-display-header-toggle
201 - org-tree-slide-slide-in-effect-toggle
202 - org-tree-slide-skip-done-toggle
203 - org-tree-slide-heading-emphasis-toggle
204
205 ** Batch setting of user variables
206
207 - org-tree-slide-simple-profile
208 - org-tree-slide-presentation-profile
209 - org-tree-slide-narrowing-control-profile
210
211 * 7. History
3dc1064 @takaxp Add README
authored
212
e22f05c @takaxp Update README
authored
213 see also ChangeLog
3dc1064 @takaxp Add README
authored
214
215 |---------+------------------+-----------------------------------------------|
216 | Version | Date | Description |
217 |---------+------------------+-----------------------------------------------|
78a5c46 @takaxp Add autoload magic comments
authored
218 | v2.5.4 | 2012-01-11@23:02 | Add autoload magic comments |
09e9987 @takaxp Fix a bug for an org buffer without header
authored
219 | v2.5.3 | 2011-12-18@00:50 | Fix a bug for an org buffer without header |
b8feee3 @takaxp Update README
authored
220 | v2.5.2 | 2011-12-17@17:52 | Set presentation profile as the default |
3dc1064 @takaxp Add README
authored
221 | v2.5.1 | 2011-12-17@13:34 | org-tree-slide-skip-done set nil as default |
222 | v2.5.0 | 2011-12-12@18:16 | Remove auto-play function (TBD) |
223 | v2.4.1 | 2011-12-09@11:46 | Add an option to control mode line display |
224 | v2.4.0 | 2011-12-08@10:51 | Support TODO pursuit in a slideshow |
225 | v2.3.2 | 2011-12-08@09:22 | Reduce redundant processing |
226 | v2.3.1 | 2011-12-07@20:30 | Add a new profile to control narrowing status |
227 | v2.3.0 | 2011-12-07@16:17 | Support displaying a slide number |
228 | v2.2.0 | 2011-12-07@02:15 | Support minor mode |
229 | v2.1.7 | 2011-12-06@00:26 | Support TITLE/AUTHOR/EMAIL in a header |
230 | v2.1.5 | 2011-12-05@17:08 | Fix an issue of title display |
231 | v2.1.3 | 2011-12-05@15:08 | Fix the end of slide for skip control |
232 | v2.1.1 | 2011-12-05@11:08 | Add skip control by heading level |
233 | v2.0.1 | 2011-12-02@18:29 | Change function names, ots- is introduced. |
234 | v2.0.0 | 2011-12-01@17:41 | Add profiles and support org 6.33x |
235 | v1.2.5 | 2011-10-31@18:34 | Add CONTENT view to see all the subtrees. |
236 | v1.2.3 | 2011-10-30@20:42 | Add a variable to control slide-in duration |
237 | v1.2.1 | 2011-10-30@16:10 | Add slide-in visual effect |
238 | v1.1.1 | 2011-10-28@16:16 | Add functions to start and stop slide view |
239 | v1.0.0 | 2011-09-28@20:59 | Release the initial version |
240
b8feee3 @takaxp Update README
authored
241 * 8. Contact
3dc1064 @takaxp Add README
authored
242
e22f05c @takaxp Update README
authored
243 The author is Takaaki ISHIKAWA (takaxp@ieee.org).
b656a83 @takaxp Update README
authored
244 Feel free to email me or use a mention of twitter ([[https://twitter.com/#!/takaxp][@takaxp]])
3dc1064 @takaxp Add README
authored
245
Something went wrong with that request. Please try again.