Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 270 lines (198 sloc) 12.011 kB
3dc1064 @takaxp Add README
authored
1 #+TITLE: README for Org Tree Slide
2 #+AUTHOR: Takaaki Ishikawa
3 #+EMAIL: takaxp@ieee.org
8b44ae8 @takaxp Default keymap was changed
authored
4 #+DATE: 2015-02-20
5 #+UPDATE: 21:49:07
3dc1064 @takaxp Add README
authored
6 #+STARTUP: content
7
b8feee3 @takaxp Update README
authored
8 * 1. What's this?
3dc1064 @takaxp Add README
authored
9
b8feee3 @takaxp Update README
authored
10 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
11
e22f05c @takaxp Update README
authored
12 Main features:
13
14 - Live editable presentation
15 - Fast switching of narrowing/widen
16 - TODO pursuit with narrowing
8b44ae8 @takaxp Default keymap was changed
authored
17 - Displaying the current number of slides in mode line
e22f05c @takaxp Update README
authored
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
dd344a2 @takaxp Merge branch 'master' of https://github.com/takaxp/org-tree-slide
authored
21 - Countdown timer
e22f05c @takaxp Update README
authored
22
23 ** 1-1. Related packages
be2d679 @takaxp Add a link
authored
24
8b44ae8 @takaxp Default keymap was changed
authored
25 There are various packages to make a presentation with org-mode. See [[http://orgmode.org/worg/org-tutorials/non-beamer-presentations.html]].
be2d679 @takaxp Add a link
authored
26
e22f05c @takaxp Update README
authored
27 * 2. Install
3dc1064 @takaxp Add README
authored
28
29 1. Put this elisp into your load-path
e22f05c @takaxp Update README
authored
30 2. Add =(require 'org-tree-slide)= in your =.emacs=
3dc1064 @takaxp Add README
authored
31
32 OR
33
97e26e3 @takaxp Update README
authored
34 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
35 2. Add =(require 'org-tree-slide)= in your =.emacs=
3dc1064 @takaxp Add README
authored
36
8b44ae8 @takaxp Default keymap was changed
authored
37 Then open an org file, just type =C-<= and =C->=, which means =C-M-,= and =C-M-.=, you can see a presentation will begin with a header, slide-in effect, and slide number in mode line.
e22f05c @takaxp Update README
authored
38
8b44ae8 @takaxp Default keymap was changed
authored
39 ** 2.1 el-get recipe
78a5c46 @takaxp Add autoload magic comments
authored
40
996ed8c @yyr * README.org: update as el-get has recipe already included.
yyr authored
41 If you are an [[https://github.com/dimitri/el-get][el-get]] user, just do
78a5c46 @takaxp Add autoload magic comments
authored
42
996ed8c @yyr * README.org: update as el-get has recipe already included.
yyr authored
43 : M-x el-get-install RET org-tree-slide
78a5c46 @takaxp Add autoload magic comments
authored
44
8b44ae8 @takaxp Default keymap was changed
authored
45 ** 2.2 MELPA
46
47 Now, you can install `org-tree-slide' via [[http://melpa.org/#/org-tree-slide][MELPA]].
48
49 ** 2.2 Requirements
3dc1064 @takaxp Add README
authored
50 - Org-mode 6.33x or higher version is required.
51 - This elisp doesn't require any additional packages.
a85c6e2 @takaxp Added a new toggle to skip commented trees
authored
52
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
8b44ae8 @takaxp Default keymap was changed
authored
92 This profile will display trees in 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
a85c6e2 @takaxp Added a new toggle to skip commented trees
authored
100 5. Display every type of tree except =org-comment-string= (e.g. COMMENT)
3dc1064 @takaxp Add README
authored
101
e22f05c @takaxp Update README
authored
102 ** 4-2. `Presentation'
103
8b44ae8 @takaxp Default keymap was changed
authored
104 This profile is 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.
105
106 # A presentation with a count down timer is started by =M-x org-tree-slide-play-with-timer=.
b8feee3 @takaxp Update README
authored
107
8b44ae8 @takaxp Default keymap was changed
authored
108 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 in a buffer like a Table Of Content except some headings configured as skipping by =org-tree-slide-slip-outline-level=. Find a heading that you want to show, and type =C->=, the presentation will be resumed.
e22f05c @takaxp Update README
authored
109
b8feee3 @takaxp Update README
authored
110 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
111
8b44ae8 @takaxp Default keymap was changed
authored
112 To exit a presentation, set =org-tree-slide-mode= OFF. The cursor move to the head of the buffer and the trees will be rendered according to the value of =#+STARTUP:= if possible.
3dc1064 @takaxp Add README
authored
113
b656a83 @takaxp Update README
authored
114 =M-x org-tree-slide-presentation-profile=
3dc1064 @takaxp Add README
authored
115
116 1. Display header
117 2. Enable slide-in effect
118 3. The cursor will move to the head of buffer when exit
119 4. Display slide number in mode line
a85c6e2 @takaxp Added a new toggle to skip commented trees
authored
120 5. Display every type of tree except =org-comment-string= (e.g. COMMENT)
3dc1064 @takaxp Add README
authored
121
e22f05c @takaxp Update README
authored
122 ** 4-3. `TODO Pursuit with narrowing'
123
8b44ae8 @takaxp Default keymap was changed
authored
124 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 typing of =C->=. 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
125
1687d83 @takaxp Fix typo README.org
authored
126 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
127
8b44ae8 @takaxp Default keymap was changed
authored
128 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
129
b656a83 @takaxp Update README
authored
130 =M-x org-tree-slide-narrowing-control-profile=
3dc1064 @takaxp Add README
authored
131
132 1. No header display
133 2. No slide-in effect
134 3. The cursor will keep the same position when exit
135 4. Display slide number in mode line
a85c6e2 @takaxp Added a new toggle to skip commented trees
authored
136 5. Display TODO trees only except =org-comment-string= (e.g. COMMENT)
3dc1064 @takaxp Add README
authored
137
e22f05c @takaxp Update README
authored
138 * 5. User variables
3dc1064 @takaxp Add README
authored
139
a85c6e2 @takaxp Added a new toggle to skip commented trees
authored
140 |----+-------------------------------------+---------------+---------|
141 | | Variable | Default value | Select |
142 |----+-------------------------------------+---------------+---------|
143 | 1 | org-tree-slide-skip-outline-level | 0 | Numeric |
144 | 2 | org-tree-slide-header | t | Boolean |
145 | 3 | org-tree-slide-slide-in-effect | t | Boolean |
8b44ae8 @takaxp Default keymap was changed
authored
146 | 4 | org-tree-slide-cursor-init | t | Boolean |
147 | 5 | org-tree-slide-slide-in-brank-lines | 10 | Numeric |
148 | 6 | org-tree-slide-slide-in-waiting | 0.02 | Float |
a85c6e2 @takaxp Added a new toggle to skip commented trees
authored
149 | 7 | org-tree-slide-heading-emphasis | nil | Boolean |
8b44ae8 @takaxp Default keymap was changed
authored
150 | 8 | org-tree-slide-never-touch-face | nil | Boolean |
151 | 9 | org-tree-slide-skip-done | nil | Boolean |
a85c6e2 @takaxp Added a new toggle to skip commented trees
authored
152 | 10 | org-tree-slide-skip-comments | t | Boolean |
153 | 11 | org-tree-slide-activate-message | Hello... | String |
154 | 12 | org-tree-slide-deactivate-message | Quit, Bye! | String |
8b44ae8 @takaxp Default keymap was changed
authored
155 | 13 | org-tree-slide-modeline-display | 'outside | [*1] |
420342f @takaxp Update README
authored
156
ed95fa6 Update descriptions related to version 2.6.0
Takaaki ISHIKAWA authored
157 #+BEGIN_QUOTE
085a4e2 @takaxp Update README
authored
158 [*1] { nil| 'lighter | 'outside }
159 'outside: shown in the mode line outside of lighter
160 'lighter: shown in lighter (slow)
161 nil: nothing to be shown"
ed95fa6 Update descriptions related to version 2.6.0
Takaaki ISHIKAWA authored
162 #+END_QUOTE
3dc1064 @takaxp Add README
authored
163
b8feee3 @takaxp Update README
authored
164 ** 5-1. Useful settings for experts
165
166 If you like this elisp, the following setting is more useful. Try it!
167
8b44ae8 @takaxp Default keymap was changed
authored
168 In this case, =<f8>= / =<f9>= / =<f10>= / =<f11>= are assigned in order to control org-tree-slide.
b8feee3 @takaxp Update README
authored
169
af59475 @takaxp Update README
authored
170 #+BEGIN_SRC emacs-lisp
b8feee3 @takaxp Update README
authored
171 (when (require 'org-tree-slide nil t)
172 (global-set-key (kbd "<f8>") 'org-tree-slide-mode)
173 (global-set-key (kbd "S-<f8>") 'org-tree-slide-skip-done-toggle)
174 (define-key org-tree-slide-mode-map (kbd "<f9>")
175 'org-tree-slide-move-previous-tree)
176 (define-key org-tree-slide-mode-map (kbd "<f10>")
177 'org-tree-slide-move-next-tree)
178 (define-key org-tree-slide-mode-map (kbd "<f11>")
179 'org-tree-slide-content)
180 (setq org-tree-slide-skip-outline-level 4)
181 (org-tree-slide-narrowing-control-profile)
182 (setq org-tree-slide-skip-done nil)))
af59475 @takaxp Update README
authored
183 #+END_SRC
b8feee3 @takaxp Update README
authored
184
185 * 6. Functions
186 ** Control functions
187
8b44ae8 @takaxp Default keymap was changed
authored
188 - org-tree-slide-move-next-tree (=C->=)
189 - org-tree-slide-move-previous-tree (=C-<=)
d273905 @takaxp Update README
authored
190 - org-tree-slide-content (=C-x s c=)
b8feee3 @takaxp Update README
authored
191
192 ** Startup options
193
cfe834c @takaxp Fix typo of README.org
authored
194 These functions will toggle =org-tree-slide-mode= ON, automatically.
b8feee3 @takaxp Update README
authored
195
196 - org-tree-slide-without-init-play
197 - org-tree-slide-play-with-timer
198
199 ** Toggle variables
200
201 - org-tree-slide-display-header-toggle
202 - org-tree-slide-slide-in-effect-toggle
203 - org-tree-slide-skip-done-toggle
a85c6e2 @takaxp Added a new toggle to skip commented trees
authored
204 - org-tree-slide-skip-comments-toggle
b8feee3 @takaxp Update README
authored
205 - org-tree-slide-heading-emphasis-toggle
206
207 ** Batch setting of user variables
208
209 - org-tree-slide-simple-profile
210 - org-tree-slide-presentation-profile
211 - org-tree-slide-narrowing-control-profile
212
fe51f9e @takaxp Added hooks for start and stop presentation
authored
213 ** Hooks
214
8b44ae8 @takaxp Default keymap was changed
authored
215 - org-tree-slide-play-hook
216 - org-tree-slide-stop-hook
217 - org-tree-slide-before-narrow-hook
218 - org-tree-slide-after-narrow-hook
219 - org-tree-slide-before-move-next-hook
220 - org-tree-slide-before-move-previous-hook
221
222 NOTE: For senior user, some hook were renamed, please update your configurations
fe51f9e @takaxp Added hooks for start and stop presentation
authored
223
b8feee3 @takaxp Update README
authored
224 * 7. History
3dc1064 @takaxp Add README
authored
225
e22f05c @takaxp Update README
authored
226 see also ChangeLog
3dc1064 @takaxp Add README
authored
227
fe51f9e @takaxp Added hooks for start and stop presentation
authored
228 |---------+------------------+-------------------------------------------------|
229 | Version | Date | Description |
230 |---------+------------------+-------------------------------------------------|
362bea8 @takaxp Hide org-clock related code
authored
231 | v2.8.1 | 2015-02-27@10:42 | Hide org-clock related code |
8b44ae8 @takaxp Default keymap was changed
authored
232 | v2.8.0 | 2015-02-20@21:27 | Changed Keymap, and renamed/added hooks |
3cd42fd @takaxp Replace ots- with org-tree-slide--
authored
233 | v2.7.5 | 2015-02-15@16:29 | Replace ots- with org-tree-slide-- |
69e8cd0 @takaxp Refine displaying slide number in modeline
authored
234 | v2.7.4 | 2015-02-14@23:30 | Refine displaying slide number in modeline |
0abef68 @takaxp Suppress an error message from org-timer
authored
235 | v2.7.2 | 2015-01-12@19:56 | Suppress an error message from org-timer |
caa2a20 @takaxp Hide skipped slides in CONTENT mode
authored
236 | v2.7.1 | 2015-01-12@18:28 | Hide skipped slides when CONTENT mode |
6cf6e4e @takaxp Support buffers without headings
authored
237 | v2.7.0 | 2013-07-21@05:21 | Support buffers without headings |
c9c413b @takaxp Added a flag to control face setting
authored
238 | v2.6.8 | 2013-02-19@12:49 | Added a flag to control face setting |
a85c6e2 @takaxp Added a new toggle to skip commented trees
authored
239 | v2.6.6 | 2013-02-19@11:22 | Added a new toggle to skip commented trees |
06e1a28 @takaxp Added some features (issue #2, #5, and #7)
authored
240 | v2.6.4 | 2013-02-12@01:43 | Added some features (issue #2, #5, and #7) |
fe51f9e @takaxp Added hooks for start and stop presentation
authored
241 | v2.6.2 | 2013-01-27@21:21 | Added hooks for start and stop the presentation |
242 | v2.6.0 | 2012-11-21@02:14 | Support dark color theme (by @uk-ar) |
243 | v2.5.4 | 2012-01-11@23:02 | Add autoload magic comments |
244 | v2.5.3 | 2011-12-18@00:50 | Fix a bug for an org buffer without header |
245 | v2.5.2 | 2011-12-17@17:52 | Set presentation profile as the default |
246 | v2.5.1 | 2011-12-17@13:34 | org-tree-slide-skip-done set nil as default |
247 | v2.5.0 | 2011-12-12@18:16 | Remove auto-play function (TBD) |
248 | v2.4.1 | 2011-12-09@11:46 | Add an option to control mode line display |
249 | v2.4.0 | 2011-12-08@10:51 | Support TODO pursuit in a slideshow |
250 | v2.3.2 | 2011-12-08@09:22 | Reduce redundant processing |
251 | v2.3.1 | 2011-12-07@20:30 | Add a new profile to control narrowing status |
252 | v2.3.0 | 2011-12-07@16:17 | Support displaying a slide number |
253 | v2.2.0 | 2011-12-07@02:15 | Support minor mode |
254 | v2.1.7 | 2011-12-06@00:26 | Support TITLE/AUTHOR/EMAIL in a header |
255 | v2.1.5 | 2011-12-05@17:08 | Fix an issue of title display |
256 | v2.1.3 | 2011-12-05@15:08 | Fix the end of slide for skip control |
257 | v2.1.1 | 2011-12-05@11:08 | Add skip control by heading level |
258 | v2.0.1 | 2011-12-02@18:29 | Change function names, ots- is introduced. |
259 | v2.0.0 | 2011-12-01@17:41 | Add profiles and support org 6.33x |
260 | v1.2.5 | 2011-10-31@18:34 | Add CONTENT view to see all the subtrees. |
261 | v1.2.3 | 2011-10-30@20:42 | Add a variable to control slide-in duration |
262 | v1.2.1 | 2011-10-30@16:10 | Add slide-in visual effect |
263 | v1.1.1 | 2011-10-28@16:16 | Add functions to start and stop slide view |
264 | v1.0.0 | 2011-09-28@20:59 | Release the initial version |
3dc1064 @takaxp Add README
authored
265
b8feee3 @takaxp Update README
authored
266 * 8. Contact
3dc1064 @takaxp Add README
authored
267
e22f05c @takaxp Update README
authored
268 The author is Takaaki ISHIKAWA (takaxp@ieee.org).
b656a83 @takaxp Update README
authored
269 Feel free to email me or use a mention of twitter ([[https://twitter.com/#!/takaxp][@takaxp]])
Something went wrong with that request. Please try again.