branch: elpa/org-tree-slide
commit e22f05ce09f15fe5771cf5627da45d31eade0ec9
Author: Takaaki ISHIKAWA <tak...@ieee.org>
Commit: Takaaki ISHIKAWA <tak...@ieee.org>
Update README
---
README.org | 75 ++++++++++++++++++++++++++++++++++++-------------------
org-tree-slide.el | 2 +-
2 files changed, 51 insertions(+), 26 deletions(-)
diff --git a/README.org b/README.org
index 8ae2b1d64c..d535af5466 100644
--- a/README.org
+++ b/README.org
@@ -1,33 +1,45 @@
-# -*- mode: org -*-
#+TITLE: README for Org Tree Slide
#+AUTHOR: Takaaki Ishikawa
#+EMAIL: tak...@ieee.org
#+STARTUP: content
-* What's this
+* 1. What's this
-This emacs lisp is a minor mode for Emacs Org-mode. The main purpose of this
elisp is to handle each tree in a org buffer as a slide by simple narrowing.
+The main purpose of this elisp is to handle each tree in a org buffer as a
slide by simple narrowing. This emacs lisp is a minor mode for Emacs Org-mode.
-** Related packages
+Main features:
+
+ - Live editable presentation
+ - Fast switching of narrowing/widen
+ - TODO pursuit with narrowing
+ - Displaying the current number of slides
+ - Countdown timer
+ - CONTENT view during a presentation
+ - Slide in effect
+ - Slide header from org file's header
+
+** 1-1. Related packages
see [[http://orgmode.org/worg/org-tutorials/non-beamer-presentations.html]].
-* Install
+* 2. Install
1. Put this elisp into your load-path
-2. Add =(require 'org-tree-slide)= in your .emacs
+2. Add =(require 'org-tree-slide)= in your =.emacs=
OR
-1. Eval: =(auto-install-from-url
"https://raw.github.com/takaxp/org-tree-slide/master/org-tree-slide.el";)=
+1. Eval: =(auto-install-from-url
"https://raw.github.com/takaxp/org-tree-slide/master/org-tree-slide.el";)= (for
auto-install user)
2. Add =(require 'org-tree-slide)= in your =.emacs=
-** Requirements
+Then open an org file, just type =<right>= and =<left>=. An presentation will
begin with a header, slide-in effect, and slide number.
+
+** 2.1 Requirements
- Org-mode 6.33x or higher version is required.
- This elisp doesn't require any additional packages.
-* Recommended settings
+* 3. Recommended settings
-Aissign single key to org-tree-slide-mode is recommended.
+Assigning a single key to =org-tree-slide-mode= is recommended.
#+begin_src emacs lisp
(global-set-key (kbd "<f8>") 'org-tree-slide-mode)
@@ -41,17 +53,18 @@ OR
(define-key org-mode-map (kbd "S-<f8>") 'org-tree-slide-skip-done-toggle)
#+end_src
-* Profiles
-Three useful profiles are available. Please choise a profile which is the most
closing your use.
+* 4. Profiles
+
+Three useful profiles are available. Please select a profile which is the most
suitable for your useing scenario.
-If you select =simple= profile, first of all, toggle =org-tree-slide-mode= and
call a fuction to set this profile.
+If you select =simple= profile, call the following command while
=org-tree-slide-mode= is ON.
#+begin_src emacs lisp
M-x org-tree-slide-simple-profile
#+end_src
-If you want to use this setting as the default, please put a setting including
recommended settings into your =.emacs=.
+If you want to use this setting as the default, put the following
configuration including recommended settings into your =.emacs=.
#+begin_src emacs lisp
(when (require 'org-tree-slide nil t)
@@ -62,17 +75,25 @@ If you want to use this setting as the default, please put
a setting including r
=org-tree-slide-presentation-profile= and
=org-tree-slide-narrowing-control-profile= are also available.
-** `Simple'
+** 4-1. `Simple'
+
+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.
-=M-x org-tree-slide-simple-profile=
+Type =M-x org-tree-slide-simple-profile= while =org-tree-slide-mode= is ON.
1. No header display
2. No slide-in effect
- 3. The cursor will move to the head of buffer when exit
+ 3. The cursor will move to the head of the buffer when exit
4. No slide number display in mode line
5. Display every type of tree
-** `Presentation'
+** 4-2. `Presentation'
+
+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 varialbes 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=.
+
+If you want to show the content of your presentatison, type =C-x s r= 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 =<rihgt>=, the
presentation will be resumed.
+
+To exit a presentation, set =org-tree-slide-mode= OFF. The cursor move to the
head of the buffer and trees will be displayed using =#+STARTUP:= if possible.
=M-x org-tree-slide-presentation-profile=
@@ -82,7 +103,11 @@ If you want to use this setting as the default, please put
a setting including r
4. Display slide number in mode line
5. Display every type of tree
-** `TODO Pursuit with narrowing'
+** 4-3. `TODO Pursuit with narrowing'
+
+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 which 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=
OFF.
+
+When you exit =org-tree-slide-mode=, the cursor will keep the same position,
it is therfore possible to focus again by toggle =M-x org-tree-slide-mode=
again.
=M-x org-tree-slide-narrowing-control-profile=
@@ -92,7 +117,7 @@ If you want to use this setting as the default, please put a
setting including r
4. Display slide number in mode line
5. Display TODO trees only
-* User variables
+* 5. User variables
|---+-------------------------------------+---------------+---------|
| | Variable | Default value | Select |
@@ -105,7 +130,7 @@ If you want to use this setting as the default, please put
a setting including r
| 6 | org-tree-slide-cursor-init | t | boolean |
| 7 | org-tree-slide-heading-emphasis | nil | boolean |
| 8 | org-tree-slide-skip-done | nil | boolean |
-| 9 | org-tree-slide-modeline-display | nil | [*1] |
+| 9 | org-tree-slide-modeline-display | 'outside | [*1] |
|---+-------------------------------------+---------------+---------|
#+begin_src org
@@ -115,9 +140,9 @@ If you want to use this setting as the default, please put
a setting including r
nil: nothing to be shown"
#+end_src
-* History
+* 6. History
-see also [[ChangeLog]]
+see also ChangeLog
|---------+------------------+-----------------------------------------------|
| Version | Date | Description |
@@ -143,8 +168,8 @@ see also [[ChangeLog]]
| v1.0.0 | 2011-09-28@20:59 | Release the initial version |
|---------+------------------+-----------------------------------------------|
-* Contact
+* 7. Contact
-The author is Takaaki ISHIKAWA ([[mailto:tak...@ieee.org][tak...@ieee.org]]).
+The author is Takaaki ISHIKAWA (tak...@ieee.org).
Feel free to email me or use a mention of twitter
([[https://twitter.com/#!/takaxp][@takaxp]])
diff --git a/org-tree-slide.el b/org-tree-slide.el
index fa0a08db5b..afaa4721db 100644
--- a/org-tree-slide.el
+++ b/org-tree-slide.el
@@ -121,7 +121,7 @@
:type 'boolean
:group 'org-tree-slide)
-(defcustom org-tree-slide-modeline-display nil
+(defcustom org-tree-slide-modeline-display 'outside
"Specify how to display the slide number in mode line.
'outside: shown in the mode line outside of lighter
'lighter: shown in lighter (slow)
