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