Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

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