Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

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