Skip to content
Browse files

Update README

  • Loading branch information...
1 parent e22f05c commit b8feee3b60d9d0b5f28eca18700f1d2ec4c12735 @takaxp committed Dec 17, 2011
Showing with 76 additions and 21 deletions.
  1. +75 −20 README.org
  2. +1 −1 org-tree-slide.el
View
95 README.org
@@ -2,10 +2,11 @@
#+AUTHOR: Takaaki Ishikawa
#+EMAIL: takaxp@ieee.org
#+STARTUP: content
+#+Last Update: 2011-12-17@18:17
-* 1. What's this
+* 1. What's this?
-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.
+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.
Main features:
@@ -32,7 +33,7 @@ OR
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=
-Then open an org file, just type =<right>= and =<left>=. An presentation will begin with a header, slide-in effect, and slide number.
+Then open an org file, just type =<right>= and =<left>=. A presentation will begin with a header, slide-in effect, and slide number.
** 2.1 Requirements
- Org-mode 6.33x or higher version is required.
@@ -53,10 +54,9 @@ OR
(define-key org-mode-map (kbd "S-<f8>") 'org-tree-slide-skip-done-toggle)
#+end_src
-
* 4. Profiles
-Three useful profiles are available. Please select a profile which is the most suitable for your useing scenario.
+Three useful profiles are available. Please select a profile that is the most suitable for your using scenario.
If you select =simple= profile, call the following command while =org-tree-slide-mode= is ON.
@@ -89,11 +89,13 @@ Type =M-x org-tree-slide-simple-profile= while =org-tree-slide-mode= is ON.
** 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=.
+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=.
+
+If you want to show the content of your presentation, 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 =<right>=, the presentation will be resumed.
-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.
+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.
-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.
+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.
=M-x org-tree-slide-presentation-profile=
@@ -105,9 +107,9 @@ To exit a presentation, set =org-tree-slide-mode= OFF. The cursor move to the he
** 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.
+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.
-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.
+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= again.
=M-x org-tree-slide-narrowing-control-profile=
@@ -122,14 +124,14 @@ When you exit =org-tree-slide-mode=, the cursor will keep the same position, it
|---+-------------------------------------+---------------+---------|
| | Variable | Default value | Select |
|---+-------------------------------------+---------------+---------|
-| 1 | org-tree-slide-skip-outline-level | 0 | numeric |
-| 2 | org-tree-slide-header | t | boolean |
-| 3 | org-tree-slide-slide-in-effect | t | boolean |
-| 4 | org-tree-slide-slide-in-brank-lines | 10 | numeric |
-| 5 | org-tree-slide-slide-in-waiting | 0.02 | float |
-| 6 | org-tree-slide-cursor-init | t | boolean |
-| 7 | org-tree-slide-heading-emphasis | nil | boolean |
-| 8 | org-tree-slide-skip-done | nil | boolean |
+| 1 | org-tree-slide-skip-outline-level | 0 | Numeric |
+| 2 | org-tree-slide-header | t | Boolean |
+| 3 | org-tree-slide-slide-in-effect | t | Boolean |
+| 4 | org-tree-slide-slide-in-brank-lines | 10 | Numeric |
+| 5 | org-tree-slide-slide-in-waiting | 0.02 | Float |
+| 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 | 'outside | [*1] |
|---+-------------------------------------+---------------+---------|
@@ -140,13 +142,66 @@ When you exit =org-tree-slide-mode=, the cursor will keep the same position, it
nil: nothing to be shown"
#+end_src
-* 6. History
+** 5-1. Useful settings for experts
+
+If you like this elisp, the following setting is more useful. Try it!
+
+=<f8>= / =<f9>= / =<f10>= / =<f11>= are assigned to control org-tree-slide.
+
+#+begin_src emacs-lisp
+(when (require 'org-tree-slide nil t)
+ (global-set-key (kbd "<f8>") 'org-tree-slide-mode)
+ (global-set-key (kbd "S-<f8>") 'org-tree-slide-skip-done-toggle)
+ (define-key org-tree-slide-mode-map (kbd "<f9>")
+ 'org-tree-slide-move-previous-tree)
+ (define-key org-tree-slide-mode-map (kbd "<f10>")
+ 'org-tree-slide-move-next-tree)
+ (define-key org-tree-slide-mode-map (kbd "<f11>")
+ 'org-tree-slide-content)
+ ;; Reset the default setting
+ (define-key org-tree-slide-mode-map (kbd "<left>") 'backward-char)
+ (define-key org-tree-slide-mode-map (kbd "<right>") 'forward-char)
+ (setq org-tree-slide-skip-outline-level 4)
+ (org-tree-slide-narrowing-control-profile)
+ (setq org-tree-slide-skip-done nil)))
+#+end_src
+
+* 6. Functions
+
+** Control functions
+
+ - org-tree-slide-move-next-tree (=<right>=)
+ - org-tree-slide-move-previous-tree (=<left>=)
+ - org-tree-slide-content (=C-x s r=)
+
+** Startup options
+
+These function will toggle =org-tree-slide-mode= ON, automatically.
+
+ - org-tree-slide-without-init-play
+ - org-tree-slide-play-with-timer
+
+** Toggle variables
+
+ - org-tree-slide-display-header-toggle
+ - org-tree-slide-slide-in-effect-toggle
+ - org-tree-slide-skip-done-toggle
+ - org-tree-slide-heading-emphasis-toggle
+
+** Batch setting of user variables
+
+ - org-tree-slide-simple-profile
+ - org-tree-slide-presentation-profile
+ - org-tree-slide-narrowing-control-profile
+
+* 7. History
see also ChangeLog
|---------+------------------+-----------------------------------------------|
| Version | Date | Description |
|---------+------------------+-----------------------------------------------|
+| v2.5.2 | 2011-12-17@17:52 | Set presentation profile as the default |
| v2.5.1 | 2011-12-17@13:34 | org-tree-slide-skip-done set nil as default |
| v2.5.0 | 2011-12-12@18:16 | Remove auto-play function (TBD) |
| v2.4.1 | 2011-12-09@11:46 | Add an option to control mode line display |
@@ -168,7 +223,7 @@ see also ChangeLog
| v1.0.0 | 2011-09-28@20:59 | Release the initial version |
|---------+------------------+-----------------------------------------------|
-* 7. Contact
+* 8. Contact
The author is Takaaki ISHIKAWA (takaxp@ieee.org).
Feel free to email me or use a mention of twitter ([[https://twitter.com/#!/takaxp][@takaxp]])
View
2 org-tree-slide.el
@@ -64,7 +64,7 @@
(require 'org-timer)
(require 'org-clock) ; org-clock-in, -out, -clocking-p
-(defconst org-tree-slide "2.5.1"
+(defconst org-tree-slide "2.5.2"
"The version number of the org-tree-slide.el")
(defgroup org-tree-slide nil

0 comments on commit b8feee3

Please sign in to comment.
Something went wrong with that request. Please try again.